https://github.com/safx/ObservableArray-RxSwift
An array that can emit messages of elements and diffs on it's changing.
https://github.com/safx/ObservableArray-RxSwift
array observable rxswift swift
Last synced: 5 months ago
JSON representation
An array that can emit messages of elements and diffs on it's changing.
- Host: GitHub
- URL: https://github.com/safx/ObservableArray-RxSwift
- Owner: safx
- License: mit
- Archived: true
- Created: 2015-12-30T14:14:59.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2018-03-26T16:40:12.000Z (about 7 years ago)
- Last Synced: 2024-11-13T00:35:41.791Z (5 months ago)
- Topics: array, observable, rxswift, swift
- Language: Swift
- Homepage:
- Size: 46.9 KB
- Stars: 112
- Watchers: 6
- Forks: 25
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-rxswift - ObservableArray-RxSwift
README
[](https://travis-ci.org/safx/ObservableArray-RxSwift)
[](https://codecov.io/github/safx/ObservableArray-RxSwift?branch=master)
# ObservableArray-RxSwift
`ObservableArray` is an array that can emit messages of elements and diffs when it is mutated.
## Usage
`ObservableArray` has two `Observable`s:
```swift
func rx_elements() -> Observable<[Element]>
func rx_events() -> Observable
```
### `rx_elements`
`rx_elements()` emits own elements when mutated.
```swift
var array: ObservableArray = ["foo", "bar", "buzz"]
array.rx_elements().subscribeNext { print($0) }
array.append("coffee")
array[2] = "milk"
array.removeAll()
```
This will print:
["foo", "bar", "buzz"]
["foo", "bar", "buzz", "coffee"]
["foo", "bar", "milk", "coffee"]
[]
Please note that `rx_elements()` emits the current items first when it has subscribed because it is implemented by using `BehaviorSubject`.
`rx_elements` can work with `rx_itemsWithCellIdentifier`:
```swift
model.rx_elements()
.observeOn(MainScheduler.instance)
.bindTo(tableView.rx_itemsWithCellIdentifier("MySampleCell")) { (row, element, cell) in
guard let c = cell as? MySampleCell else { return }
c.model = self.model[row]
return
}
.addDisposableTo(disposeBag)
```
### `rx_events`
`rx_events()` emits `ArrayChangeEvent` that contains indices of diffs when mutated.
```swift
var array: ObservableArray = ["foo", "bar", "buzz"]
array.rx_events().subscribeNext { print($0) }
array.append("coffee")
array[2] = "milk"
array.removeAll()
```
This will print:
ArrayChangeEvent(insertedIndices: [3], deletedIndices: [], updatedIndices: [])
ArrayChangeEvent(insertedIndices: [], deletedIndices: [], updatedIndices: [2])
ArrayChangeEvent(insertedIndices: [], deletedIndices: [0, 1, 2, 3], updatedIndices: [])
`ArrayChangeEvent` is defined as:
```swift
struct ArrayChangeEvent {
let insertedIndices: [Int]
let deletedIndices: [Int]
let updatedIndices: [Int]
}
```
These indices can be used with table view methods, such like `insertRowsAtIndexPaths(_:withRowAnimation:)`.
For example, the following code will enable cell animations when the source array is mutated.
```swift
extension UITableView {
public func rx_autoUpdater(source: Observable) -> Disposable {
return source
.scan((0, nil)) { (a: (Int, ArrayChangeEvent!), ev) in
return (a.0 + ev.insertedIndices.count - ev.deletedIndices.count, ev)
}
.observeOn(MainScheduler.instance)
.subscribeNext { sourceCount, event in
guard let event = event else { return }
let tableCount = self.numberOfRowsInSection(0)
guard tableCount + event.insertedIndices.count - event.deletedIndices.count == sourceCount else {
self.reloadData()
return
}
func toIndexSet(array: [Int]) -> [NSIndexPath] {
return array.map { NSIndexPath(forRow: $0, inSection: 0) }
}
self.beginUpdates()
self.insertRowsAtIndexPaths(toIndexSet(event.insertedIndices), withRowAnimation: .Automatic)
self.deleteRowsAtIndexPaths(toIndexSet(event.deletedIndices), withRowAnimation: .Automatic)
self.reloadRowsAtIndexPaths(toIndexSet(event.updatedIndices), withRowAnimation: .Automatic)
self.endUpdates()
}
}
}
```
You can use `rx_autoUpdater(_:)` with `bindTo(_:)` in your view contollers:
```swift
model.rx_events()
.observeOn(MainScheduler.instance)
.bindTo(tableView.rx_autoUpdater)
.addDisposableTo(disposeBag)
```
Unfortunately, `rx_autoUpdater` doesn't work with `rx_elements()` binding to `rx_itemsWithCellIdentifier(_:source:configureCell:cellType:)`, because it uses `reloadData()` internally.
## Supported Methods
`ObservableArray` implements the following methods and properties, which work the same way as `Array`'s equivalent methods. You can also use additional `Array` methods defined in protocol extensions, such as `sort`, `reverse` and `enumerate`.
```swift
init()
init(count:Int, repeatedValue: Element)
init(_ s: S)
init(arrayLiteral elements: Element...)
var startIndex: Int
var endIndex: Int
var capacity: Int
func reserveCapacity(minimumCapacity: Int)
func append(newElement: Element)
func appendContentsOf(newElements: S)
func appendContentsOf(newElements: C)
func removeLast() -> Element
func insert(newElement: Element, atIndex i: Int)
func removeAtIndex(index: Int) -> Element
func removeAll(keepCapacity: Bool = false)
func insertContentsOf(newElements: [Element], atIndex i: Int)
func replaceRange(subRange: Range, with newCollection: C)
func popLast() -> Element?
var description: String
var debugDescription: String
subscript(index: Int) -> Element
subscript(bounds: Range) -> ArraySlice
```
## Install
### CocoaPods
pod 'ObservableArray-RxSwift'
**Important**: Use the following `import` statement to import `ObservableArray-RxSwift`:
`import ObservableArray_RxSwift`
### Carthage
github "safx/ObservableArray-RxSwift"
### Manual Install
Just copy `ObservableArray.swift` into your project.
## License
MIT