Github url

IGListKit

by Instagram

Instagram /IGListKit

A data-driven UICollectionView framework for building fast and flexible lists.

11.3K Stars 1.3K Forks Last release: 8 months ago (4.0.0) MIT License 630 Commits 10 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

Build StatusCoverage StatusPods VersionPlatformsCarthage Compatible


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.

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

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.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.