e5bc6bcae6
Summary: ## Changes in this pull request [As was announced in late 2024](https://blog.cocoapods.org/CocoaPods-Specs-Repo/), CocoaPods will be eventually sunset with the tentative end date being at the end of 2026. While we had already migrated all of IGListKit's sample apps to use SPM, the main Xcode project was still relying on CocoaPods to import OCMock as a dependency of running its test suite. In order to get ahead of this eventual shut down, this PR completely removes CocoaPods as a dependency of running any of the projects in this repo and moves OCMock over to an SPM import. This ends up actually being a better experience since now, all anyone needs to do is open `IGListKit.xcodeproj` without needing to run anything beforehand, and Xcode will automatically handle the rest. Please note this doesn't remove IGListKit from CocoaPods itself. IGListKit will still be available as a CocoaPods dependency. ### Checklist - [x] All tests pass. Demo project builds and runs. - [x] I added tests, an experiment, or detailed why my change isn't tested. - [ ] I added an entry to the `CHANGELOG.md` for any breaking changes, enhancements, or bug fixes. - [x] I have reviewed the [contributing guide](https://github.com/Instagram/IGListKit/blob/main/.github/CONTRIBUTING.md) Pull Request resolved: https://github.com/instagram/IGListKit/pull/1641 Test Plan: All GitHub pipelines still working: {F1982500959} Reviewed By: fabiomassimo Differential Revision: D83946914 Pulled By: TimOliver fbshipit-source-id: 3542451379b57c87c88fc95684fb3595a09c8fd6 |
||
|---|---|---|
| .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.0.0'
Carthage
For Carthage, add the following to your Cartfile:
github "Instagram/IGListKit" ~> 5.0.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