8676a3e6b9
Some checks failed
IGListKit CI / Unit Test macOS (push) Has been cancelled
IGListKit CI / Unit Test iOS (push) Has been cancelled
IGListKit CI / Unit Test tvOS (push) Has been cancelled
IGListKit CI / CocoaPods Lint (push) Has been cancelled
IGListKit CI / Verify generate_spm_sources_layout.sh is not broken (push) Has been cancelled
IGListKit CI / Verify SPM build by invoking `xcodebuild` on Package.swift (push) Has been cancelled
IGListKit CI / Verify Carthage build XCFramework (push) Has been cancelled
IGListKit CI / Build Examples and UI tests. (push) Has been cancelled
IGListKit CI / Run Danger (push) Has been cancelled
Summary: ## Plan This module doesn't need A/B testing and will be migrated directly. ## This Diff Removes the `__covariant ObjectType : id<IGListDiffable>` lightweight generic type parameter from `IGListBindingSectionController`. Swift generic types cannot be exposed to ObjC, so any generic ObjC class must lose its type parameter when converted to Swift. This degenerification is a required prerequisite for future Swift migration. Changes: - Removed the generic type parameter from the class header, replacing `ObjectType` with `id<IGListDiffable>` in the `object` property declaration - Removed the generic specialization from the `IGContentAppreciationGiftSectionController` subclass header - Simplified 87 Swift files that referenced `ListBindingSectionController<ListDiffable>` or `ListBindingSectionController<any ListDiffable>` or other specializations to plain `ListBindingSectionController` - Added ObjC casts at 3 callsites where the `.object` property was used with specialized type access (`IGAudioSearchResultsViewController.mm`, `IGDSShowcaseListExampleModel.m`) - Added Swift casts at callsites in `BCNComposerPostSectionController`, `BCNComposerViewController`, `BCNPostingStatusDatasource`, `BCNComposerAssetSectionController`, and `GiftsFeedSectionController` where `.object` was accessed as the previously-specialized type Differential Revision: D104311510 fbshipit-source-id: 6f54a761aa70fc39ffcd789fe74e3d83609ef61f |
||
|---|---|---|
| .github | ||
| docs | ||
| Examples | ||
| Guides | ||
| IGListKit.xcodeproj | ||
| remodel-plugin | ||
| Resources | ||
| scripts | ||
| Source | ||
| spm/Sources | ||
| Tests | ||
| .gitignore | ||
| .slather.yml | ||
| .swiftlint.yml | ||
| CHANGELOG.md | ||
| CODE_OF_CONDUCT.md | ||
| Dangerfile | ||
| Gemfile | ||
| IGListDiffKit.podspec | ||
| IGListKit.podspec | ||
| IGListSwiftKit.podspec | ||
| LICENSE.md | ||
| Package.swift | ||
| 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 main branch in the Instagram app.
Multilingual translation
Requirements
- Swift 5.1+
- 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. Add the following to your Podfile:
pod 'IGListKit', '~> 5.2.0'
Carthage
For Carthage, add the following to your Cartfile:
github "Instagram/IGListKit" ~> 5.2.0
Swift 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.
Getting Started
Try out IGListKit by opening any of the sample apps available in the Examples directory.
- 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.
Legal
Copyright © Meta Platforms, Inc • Terms of Use • Privacy Policy