https://github.com/RxSwiftCommunity/RxRealmDataSources

An easy way to bind an RxRealm observable to a table or collection view
https://github.com/RxSwiftCommunity/RxRealmDataSources

binding collectionview reactive realm realmswift tableview

Last synced: 2 months ago
JSON representation

An easy way to bind an RxRealm observable to a table or collection view

• Host: GitHub
• URL: https://github.com/RxSwiftCommunity/RxRealmDataSources
• Owner: RxSwiftCommunity
• License: mit
• Created: 2016-12-07T14:53:17.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2022-01-08T11:02:14.000Z (about 3 years ago)
• Last Synced: 2024-10-31T15:44:08.670Z (3 months ago)
• Topics: binding, collectionview, reactive, realm, realmswift, tableview
• Language: Swift
• Size: 92.8 KB
• Stars: 161
• Watchers: 8
• Forks: 48
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-rxswift - RxRealmDataSources

README

        
# RxRealmDataSources

[![Version](https://img.shields.io/cocoapods/v/RxRealmDataSources.svg?style=flat)](http://cocoapods.org/pods/RxRealmDataSources)

[![License](https://img.shields.io/cocoapods/l/RxRealmDataSources.svg?style=flat)](http://cocoapods.org/pods/RxRealmDataSources)

[![Platform](https://img.shields.io/cocoapods/p/RxRealmDataSources.svg?style=flat)](http://cocoapods.org/pods/RxRealmDataSources)

This library is currently WIP.

## Example

To run the example project, clone the repo, and run `pod install` from the Example directory first.

## Usage

This library is a light data source implementation for `RxRealm`. It allows you to easily bind an Observable sequence of Realm objects to a table or a collection view. The library is both iOS and macOS compatible.

### Binding to a table view

Check out the included demo app to see this in action.

```swift

// create data source

let dataSource = RxTableViewRealmDataSource(cellIdentifier: "Cell", cellType: PersonCell.self) {cell, ip, lap in

    cell.customLabel.text = "\(ip.row). \(lap.text)"

}

// RxRealm to get Observable

let realm = try! Realm(configuration: DataRandomizer.realmConfig)

let laps = Observable.changeset(from: realm.objects(Timer.self).first!.laps)

    .share()

// bind to table view

laps

    .bindTo(tableView.rx.realmChanges(dataSource))

    .disposed(by: bag)

```

### Binding to a collection view

Check out the included demo app to see this in action.

```swift

// create data source

let dataSource = RxCollectionViewRealmDataSource(cellIdentifier: "Cell", cellType: LapCollectionCell.self) {cell, ip, lap in

    cell.customLabel.text = "\(ip.row). \(lap.text)"

}

// RxRealm to get Observable

let realm = try! Realm(configuration: DataRandomizer.realmConfig)

let laps = Observable.changeset(from: realm.objects(Timer.self).first!.laps)

    .share()

// bind to collection view

laps

    .bindTo(collectionView.rx.realmChanges(dataSource))

    .disposed(by: bag)

```

### Reacting to cell taps

The library adds an extension to table views and collection views, allowing you to easily subscribe to the cell selected delegate event. Here's a snippet from the example demo app:

```swift

tableView.rx.realmModelSelected(Lap.self)

  .map({ $0.text })

  .bind(to: rx.title)

  .disposed(by: bag)

```

## Installation

This library depends on __RxSwift__,  __RealmSwift__, and __RxRealm__.

#### CocoaPods

RxRealm is available through [CocoaPods](http://cocoapods.org). To install it, simply add the following line to your Podfile:

```ruby

pod "RxRealmDataSources"

```

## TODO

* Test add platforms and add compatibility for the pod

## License

This library belongs to _RxSwiftCommunity_. It has been created by Marin Todorov.

RxRealm is available under the MIT license. See the LICENSE file for more info.