247e7cac65
Summary: It's time to ship the new updater! `IGListExperimentalAdapterUpdater` has been running on Instagram for a couple months with better performance and stability. In this diff, we're renaming `IGListExperimentalAdapterUpdater` (and related classes) to `IGListAdapterUpdater`. Here's a recap: ## Stability * `[IGListAdapter setDataSource]` isn't safe * We're changing the underlying data without telling the `UICollectionView`. * Fix: Lets invalidate the `UICollectionView` data by changing its dataSource. * `[IGListAdapter setCollectionView]` isn't safe * This is synchronous, but we might have pending or on-going updates. The `UICollectionView` might get synced before the pending update actually start executing, so the diff results will be off. * Fix: Lets wrap updates in a transaction that can be cancelled. * Returning a nil `IGListSectionController` from `IGListAdapterDataSource` could crash * The `IGListAdapterUpdater` will still perform the diffing assuming that all the objects will have a section, which isn't the case. * Fix: Lets generate the `IGListSectionController` before the diffing. * Other improvements * Lets ask for the `fromObject` just before diffing, instead of asking when scheduling the update. * If the `UICollectionView` section count doesn't match `fromObject`, lets fallback to a reload. ## Performance * Re-test background diffing * `IGListExperimentBackgroundDiffing` and coalescing updates wasn't safe because of the issues mentioned above. The longer we wait, the more likely we'll end up in a race condition. Lets try re-testing with the stability improvements. * Unblocks background layout calculation * This is a larger project, but these improvements are required to make background work safe. * Only create the `backgroundView` if needed (although this doesn't really require the new updater) ## Other * Transactions * `IGListAdapterUpdater` is the workhorse of `IGListKit` and has become a bit hard to follow over the years. We want to break it apart into simpler, more manageable parts. * Avoid blocks * There's a lot of blocks flying around, making crash logs hard to read. Lets try to use methods/functions where possible. Reviewed By: Haud, lorixx Differential Revision: D25884782 fbshipit-source-id: 1357fa23513a239051d5b1766823effa3199f656 |
||
|---|---|---|
| .github | ||
| docs | ||
| Examples | ||
| Guides | ||
| IGListKit.xcodeproj | ||
| IGListKit.xcworkspace | ||
| Pods | ||
| remodel-plugin | ||
| Resources | ||
| scripts | ||
| Source | ||
| Tests | ||
| .gitignore | ||
| .slather.yml | ||
| .travis.yml | ||
| CHANGELOG.md | ||
| CODE_OF_CONDUCT.md | ||
| Dangerfile | ||
| Gemfile | ||
| Gemfile.lock | ||
| IGListDiffKit.podspec | ||
| IGListKit.podspec | ||
| IGListSwiftKit.podspec | ||
| LICENSE.md | ||
| Package.swift | ||
| Podfile | ||
| Podfile.lock | ||
| README.md | ||
| README.zh.md | ||
A data-driven UICollectionView framework for building fast and flexible lists.
| Main Features | |
|---|---|
| 🙅 | Never call performBatchUpdates(_:, completion:) or reloadData() again |
| 🏠 | Better architecture with reusable cells and components |
| 🔠 | Create collections with multiple data types |
| 🔑 | Decoupled diffing algorithm |
| ✅ | Fully unit tested |
| 🔍 | Customize your diffing behavior for your models |
| 📱 | Simply UICollectionView at its core |
| 🚀 | Extendable API |
| 🐦 | Written in Objective-C with full Swift interop support |
IGListKit is built and maintained with ❤️ by Instagram engineering.
We use the open source version master branch in the Instagram app.
Multilingual translation
Requirements
- Xcode 9.0+
- iOS 9.0+
- tvOS 9.0+
- macOS 10.11+ (diffing algorithm components only)
- Interoperability with Swift 3.0+
Installation
CocoaPods
The preferred installation method is with CocoaPods. Add the following to your Podfile:
pod 'IGListKit', '~> 4.0.0'
Carthage
For Carthage, add the following to your Cartfile:
github "Instagram/IGListKit" ~> 4.0.0
For advanced usage, see our Installation Guide.
Getting Started
$ git clone https://github.com/Instagram/IGListKit.git
$ cd IGListKit/
$ ./scripts/setup.sh
- Our Getting Started guide
- Ray Wenderlich's IGListKit Tutorial: Better UICollectionViews
- Our example projects
- Ryan Nystrom's talk at try! Swift NYC(Note: this talk was for an earlier version. Some APIs have changed.)
- Migrating an UITableView to IGListCollectionView, by Rodrigo Cavalcante
- Keeping data fresh in Buffer for iOS with AsyncDisplayKit, IGListKit & Pusher, Andy Yates, Buffer
Documentation
You can find the docs here. Documentation is generated with jazzy and hosted on GitHub-Pages.
To regenerate docs, run ./scripts/build_docs.sh from the root directory in the repo.
Vision
For the long-term goals and "vision" of IGListKit, please read our Vision doc.
Contributing
Please see the CONTRIBUTING file for how to help. At Instagram, we sync the open source version of IGListKit daily, so we're always testing the latest changes. But that requires all changes be thoroughly tested and follow our style guide.
We have a set of starter tasks that are great for beginners to jump in on and start contributing.
License
IGListKit is MIT-licensed.
The files in the /Examples/ directory are licensed under a separate license as specified in each file. Documentation is licensed CC-BY-4.0.