Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/instagram/iglistkit
A data-driven UICollectionView framework for building fast and flexible lists.
https://github.com/instagram/iglistkit
diffing instagram ios objective-c uicollectionview
Last synced: 6 days ago
JSON representation
A data-driven UICollectionView framework for building fast and flexible lists.
- Host: GitHub
- URL: https://github.com/instagram/iglistkit
- Owner: Instagram
- License: mit
- Created: 2016-09-07T08:39:27.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2024-10-25T20:00:08.000Z (about 2 months ago)
- Last Synced: 2024-10-29T12:37:47.647Z (about 2 months ago)
- Topics: diffing, instagram, ios, objective-c, uicollectionview
- Language: Objective-C
- Homepage: https://instagram.github.io/IGListKit/
- Size: 8.57 MB
- Stars: 12,870
- Watchers: 342
- Forks: 1,540
- Open Issues: 159
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
----------------
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](https://engineering.instagram.com/).
We use the open source version `main` branch in the Instagram app.
## Multilingual translation
[Chinese README](README.zh.md)
## Requirements
- Xcode 11.0+
- iOS 11.0+
- tvOS 11.0+
- macOS 10.13+ *(diffing algorithm components only)*
- Interoperability with Swift 3.0+
## Installation
### CocoaPods
The preferred installation method is with [CocoaPods](https://cocoapods.org). Add the following to your `Podfile`:
```ruby
pod 'IGListKit', '~> 5.0.0'
```
### Carthage
For [Carthage](https://github.com/Carthage/Carthage), add the following to your `Cartfile`:
```ogdl
github "Instagram/IGListKit" ~> 5.0.0
```
### Swift Package Manager
For [Swift Package Manager](https://swift.org/package-manager/):
```
To integrate using Xcode:
File -> Swift Packages -> Add Package Dependency
Enter package URL: https://github.com/Instagram/IGListKit, and select the latest release.
```
> For advanced usage, see our [Installation Guide](https://instagram.github.io/IGListKit/installation.html).
## Getting Started
Try out IGListKit by opening any of the sample apps available in the `Examples ` directory.
- Our [Getting Started guide](https://instagram.github.io/IGListKit/getting-started.html)
- Ray Wenderlich's [IGListKit Tutorial: Better UICollectionViews](https://www.raywenderlich.com/147162/iglistkit-tutorial-better-uicollectionviews)
- Our [example projects](https://github.com/Instagram/IGListKit/tree/main/Examples)
- Ryan Nystrom's [talk at try! Swift NYC](https://academy.realm.io/posts/tryswift-ryan-nystrom-refactoring-at-scale-lessons-learned-rewriting-instagram-feed/)(Note: this talk was for an earlier version. Some APIs have changed.)
- [Migrating an UITableView to IGListCollectionView](https://medium.com/cocoaacademymag/iglistkit-migrating-an-uitableview-to-iglistkitcollectionview-65a30cf9bac9), by Rodrigo Cavalcante
- [Keeping data fresh in Buffer for iOS with AsyncDisplayKit, IGListKit & Pusher](https://overflow.buffer.com/2017/04/10/keeping-data-fresh-buffer-ios-asyncdisplaykit-iglistkit-pusher/), Andy Yates, Buffer
## Documentation
You can find [the docs here](https://instagram.github.io/IGListKit). Documentation is generated with [jazzy](https://github.com/realm/jazzy) and hosted on [GitHub-Pages](https://pages.github.com).
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](https://github.com/Instagram/IGListKit/blob/main/Guides/VISION.md) doc.
## Contributing
Please see the [CONTRIBUTING](https://github.com/Instagram/IGListKit/blob/main/.github/CONTRIBUTING.md) 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](https://github.com/Instagram/IGListKit/issues?q=is%3Aissue+is%3Aopen+label%3Astarter-task) that are great for beginners to jump in on and start contributing.
## License
`IGListKit` is [MIT-licensed](./LICENSE.md).
The files in the `/Examples/` directory are licensed under a separate license as specified in each file. Documentation is licensed [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/).
## Legal
Copyright © Meta Platforms, Inc • Terms of Use • Privacy Policy