ReactiveLists

KO | EN

gitlite — search

#python #php #javascript #android #ruby #machine-learning #java #react #ontology #docker #docker-image #storage

★ 253 Open GitHub ↗

React-like API for UITableView & UICollectionView

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

*React-like API for `UITableView` & `UICollectionView`*

[![Build Status](https://travis-ci.org/plangrid/ReactiveLists.svg?branch=master)](https://travis-ci.org/plangrid/ReactiveLists) [![Version Status](https://img.shields.io/cocoapods/v/ReactiveLists.svg)][podLink] [![license MIT](https://img.shields.io/cocoapods/l/ReactiveLists.svg)][mitLink] [![codecov](https://codecov.io/gh/plangrid/ReactiveLists/branch/master/graph/badge.svg)](https://codecov.io/gh/plangrid/ReactiveLists) [![Platform](https://img.shields.io/cocoapods/p/ReactiveLists.svg)][docsLink]

`ReactiveLists` provides a React-like API for `UITableView` and `UICollectionView` that makes it easy to write stateless code that generates user interfaces.

In our experience this can make UI code significantly easier to read and maintain. Instead of spreading the definition of your content over various data source methods, you can define the content concisely. The table or collection content and layout are immediately obvious by scanning over the source code.

You can read more about the origins of this library in our [announcement blog post](https://medium.com/plangrid-technology/open-sourcing-reactivelists-for-ios-3abdf41b770a).

## Features

- React-like declarative API for `UITableView` and `UICollectionView`
- Automatic UI updates, whenever your models change

## Example

```swift
// Given a view controller with a table view

// 1. create cell models
let cell0 = ExampleTableCellModel(...)
let cell1 = ExampleTableCellModel(...)
let cell2 = ExampleTableCellModel(...)

// 2. create section models
let section0 = ExampleTableSectionViewModel(cellViewModels: [cell0, cell1, cell2])

// 3. create table model
let tableModel = TableViewModel(sectionModels: [section0])

// 4. create driver
self.driver = TableViewDriver(tableView: self.tableView, tableViewModel: tableModel)

// 5. update driver with new table model as it changes
let updatedTableModel = self.doSomethingToChangeModels()
self.driver.tableViewModel = updatedTableModel

// self.tableView will update automatically
```

## Project Status

An early version of the `UITableView` support has been shipping in the [PlanGrid app](https://itunes.apple.com/us/app/plangrid-construction-software/id498795789?mt=8) since late 2015 and is now used accross wide parts of the app. The support for `UICollectionView` is less mature as we only use `UICollectionView` in very few places.

| Feature                    |     Status      |
| -------------------------- | :-------------: |
| `UITableView` support      |        ✅        |
| `UICollectionView` support | ⚠️ Experimental |

## Vision

For long-term goals and direction, please see [`VISION.md`](https://github.com/plangrid/ReactiveLists/blob/master/Guides/VISION.md).

## Getting Started

Read our [Getting Started Guide](https://github.com/plangrid/ReactiveLists/blob/master/Guides/Getting%20Started.md) to learn how to use `ReactiveLists`.

## Documentation

Read our [documentation here][docsLink]. Generated with [jazzy](https://github.com/realm/jazzy). Hosted by [GitHub Pages](https://pages.github.com).

#### Generating docs

```bash
$ ./scripts/gen_docs.sh
```

## Requirements

* Xcode 10.2+
* Swift 4.2 or 5.0
* iOS 11+

## Installation

### [CocoaPods](https://cocoapods.org/) (recommended)

```ruby
use_frameworks!

# For latest release in CocoaPods
pod 'ReactiveLists'

# Latest on master branch
pod 'ReactiveLists', :git => 'https://github.com/plangrid/ReactiveLists.git', :branch => 'master'
```

### [Swift Package Manager](https://developer.apple.com/documentation/xcode/adding_package_dependencies_to_your_app)

Select Xcode menu File > Swift Packages > Add Package Dependency... and enter repository URL with GUI.

Repository: https://github.com/plangrid/ReactiveLists

## Contribute

Please read and follow our [Contributing Guide](https://github.com/plangrid/ReactiveLists/blob/master/.github/CONTRIBUTING.md) and our [Code of Conduct](https://github.com/plangrid/ReactiveLists/blob/master/CODE_OF_CONDUCT.md).

## License

`ReactiveLists` is released under an [MIT License][mitLink]. See `LICENSE` for details.

[docsLink]:https://plangrid.github.io/ReactiveLists
[podLink]:https://cocoapods.org/pods/ReactiveLists
[mitLink]:https://opensource.org/licenses/MIT

ReactiveLists

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README