Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ra1028/DiffableDataSources
💾 A library for backporting UITableView/UICollectionViewDiffableDataSource.
https://github.com/ra1028/DiffableDataSources
algorithm collectionview datasource diff diffable diffing tableview wwdc19
Last synced: 3 months ago
JSON representation
💾 A library for backporting UITableView/UICollectionViewDiffableDataSource.
- Host: GitHub
- URL: https://github.com/ra1028/DiffableDataSources
- Owner: ra1028
- License: apache-2.0
- Created: 2019-06-14T22:19:57.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-04-11T23:18:42.000Z (over 1 year ago)
- Last Synced: 2024-07-18T20:19:21.043Z (4 months ago)
- Topics: algorithm, collectionview, datasource, diff, diffable, diffing, tableview, wwdc19
- Language: Swift
- Homepage: https://ra1028.github.io/DiffableDataSources
- Size: 4.12 MB
- Stars: 844
- Watchers: 11
- Forks: 68
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-ios - DiffableDataSources - A library for backporting UITableView/UICollectionViewDiffableDataSource. (UI / Table View / Collection View)
- awesome-swift - DiffableDataSources - 💾 A library for backporting UITableView/UICollectionViewDiffableDataSource. (Libs / UI)
- awesome-ios-star - DiffableDataSources - A library for backporting UITableView/UICollectionViewDiffableDataSource. (UI / Table View / Collection View)
- awesome-swift - DiffableDataSources - 💾 A library for backporting UITableView/UICollectionViewDiffableDataSource. (Libs / UI)
- fucking-awesome-swift - DiffableDataSources - 💾 A library for backporting UITableView/UICollectionViewDiffableDataSource. (Libs / UI)
- awesome-swift - DiffableDataSources - A library for backporting UITableView/UICollectionViewDiffableDataSource. ` 📝 19 days ago` (UI [🔝](#readme))
README
DiffableDataSources
💾 A library for backporting UITableView/UICollectionViewDiffableDataSource
powered by DifferenceKit.
Made with ❤️ by Ryo Aoyama
---
## Introduction
Apple has announced a diffable data source at WWDC 2019.
It's a great API that easily updating our table view and collection view items using automatic diffing.
However, it's a little while before we can use it in a production service.
That because it requires the latest OS to use.
DiffableDataSources make it possible to introduce almost the same functionality from now on.
Uses a sophisticated open source [DifferenceKit](https://github.com/ra1028/DifferenceKit) for the algorithm engine.
It's extremely fast and completely avoids synchronization bugs, exceptions, and crashes.
---
## Difference from the Official
#### Spec
- Supports iOS 9.0+ / macOS 10.11+ / tvOS 9.0+
- Open sourced algorithm.
- Duplicate sections or items are allowed.
- Using `performBatchUpdates` for diffing updates.
#### Namings
`DiffableDataSources` have different class names to avoid conflicts with the official API.
Correspondence table is below.
|Official |Backported |
|:---------------------------------------------------------------------------|:------------------------------------|
|[NSDiffableDataSourceSnapshot][NSDiffableDataSourceSnapshot_doc] |DiffableDataSourceSnapshot |
|[UITableViewDiffableDataSource][UITableViewDiffableDataSource_doc] |TableViewDiffableDataSource |
|[UICollectionViewDiffableDataSource][UICollectionViewDiffableDataSource_doc]|CollectionViewDiffableDataSource |
|[NSCollectionViewDiffableDataSource][NSCollectionViewDiffableDataSource_doc]|CocoaCollectionViewDiffableDataSource|
[NSDiffableDataSourceSnapshot_doc]: https://developer.apple.com/documentation/uikit/uitableviewdiffabledatasource
[UITableViewDiffableDataSource_doc]: https://developer.apple.com/documentation/uikit/uitableviewdiffabledatasource
[UICollectionViewDiffableDataSource_doc]: https://developer.apple.com/documentation/uikit/uicollectionviewdiffabledatasource
[NSCollectionViewDiffableDataSource_doc]: https://developer.apple.com/documentation/appkit/nscollectionviewdiffabledatasource
---
## Getting Started
- [API Documentation](https://ra1028.github.io/DiffableDataSources)
- [Example Apps](https://github.com/ra1028/DiffableDataSources/tree/master/Examples)
- [WWDC 2019 Session](https://developer.apple.com/videos/play/wwdc2019/220)
#### Build Project
```sh
$ git clone https://github.com/ra1028/DiffableDataSources.git
$ cd DiffableDataSources/
$ make setup
$ open DiffableDataSources.xcworkspace
```
---
## Basic Usage
First, define the type representing section.
It should conforms to `Hashable` for identifies from the all sections.
Type of enum can used conveniently because it conforms `Hashable` by default.
```swift
enum Section {
case main
}
```
Then, define the item type conforms to `Hashable`.
```swift
struct User: Hashable {
var name: String
}
```
Create a data source object, it will be set to table view automatically.
You should dequeue the non nil cells via closure.
```swift
final class UsersViewController: UIViewController {
let tableView: UITableView = ...
lazy var dataSource = TableViewDiffableDataSource(tableView: tableView) { tableView, indexPath, user in
let cell = tableView.dequeueReusableCell(withIdentifier: "Cell", for: indexPath)
cell.textLabel?.text = user.name
return cell
}
override func viewDidLoad() {
super.viewDidLoad()
tableView.register(UITableViewCell.self, forCellReuseIdentifier: "Cell")
}
}
```
Manages and updates the data sources intuitively by intermediating `DiffableDataSourceSnapshot`.
The UI isn't updated until you apply the edited snapshot object.
Update the UI with diffing animation automatically calculated by applying an edited snapshot.
```swift
let users = [
User(name: "Steve Jobs"),
User(name: "Stephen Wozniak"),
User(name: "Tim Cook"),
User(name: "Jonathan Ive")
]
let snapshot = DiffableDataSourceSnapshot()
snapshot.appendSections([.main])
snapshot.appendItems(users)
dataSource.apply(snapshot) {
// completion
}
```
Check the documentation for more detailed API.
[See More Usage]
---
## Requirements
- Swift 5.0+
- iOS 9.0+
- macOS 10.11+
- tvOS 9.0+
---
## Installation
### [CocoaPods](https://cocoapods.org)
Add the following to your `Podfile`:
```ruby
pod 'DiffableDataSources'
```
### [Carthage](https://github.com/Carthage/Carthage)
Add the following to your `Cartfile`:
```
github "ra1028/DiffableDataSources"
```
### [Swift Package Manager](https://swift.org/package-manager/)
Add the following to the dependencies of your `Package.swift`:
```swift
.package(url: "https://github.com/ra1028/DiffableDataSources.git", from: "x.x.x")
```
---
## Contributing
Pull requests, bug reports and feature requests are welcome 🚀
Please see the [CONTRIBUTING](https://github.com/ra1028/DiffableDataSources/blob/master/CONTRIBUTING.md) file for learn how to contribute to DiffableDataSources.
---
## Relations
#### [DifferenceKit](https://github.com/ra1028/DifferenceKit)
A fast and flexible O(n) difference algorithm framework for Swift collection.
#### [Carbon](https://github.com/ra1028/Carbon)
A declarative library for building component-based user interfaces in UITableView and UICollectionView.
---
## License
DiffableDataSources is released under the [Apache 2.0 License](https://github.com/ra1028/DiffableDataSources/blob/master/LICENSE).