A data-driven UICollectionView framework for building fast and flexible lists.
Clone or download
rnystrom and facebook-github-bot Update issue template to ask for example project
Summary: Frequently my first response to new issues. Codifying as part of new issue flow.

Reviewed By: maxoll

Differential Revision: D12839035

fbshipit-source-id: 81a907cd93c2d53e95d6f806242a06cc56368d6a
Latest commit 4387a48 Dec 7, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Update issue template to ask for example project Dec 7, 2018
Examples Fix SwiftLint warnings (#1283) Nov 28, 2018
Guides Fix typo (#1224) Jul 25, 2018
IGListKit.xcodeproj Run setup script with CocoaPods 1.5.3 (#1216) Jul 25, 2018
IGListKit.xcworkspace Update MIT license language (#1272) Nov 1, 2018
Pods Run setup script with CocoaPods 1.5.3 (#1216) Jul 25, 2018
Resources Create binding and modeling guide/tutorial Aug 21, 2017
Source Replace incorrect IGListSectionController dequeue calls Nov 29, 2018
Tests Fix some crash from IGListKit that nil dataSource might result in crash Nov 6, 2018
docs Regenerate docs for 3.4 May 2, 2018
remodel-plugin Update outdated javascript headers #trivial (#1281) Nov 26, 2018
scripts Update .travis.yml and lint.sh, try to fix #1060 and lint errors #tri… Feb 2, 2018
.gitignore Nitpicky comment fixes Mar 31, 2017
.slather.yml Ignore Xcode dir in coverage reports Nov 20, 2016
.travis.yml Minimum fixes for Xcode 9.3 build errors Apr 9, 2018
CHANGELOG.md Fix some crash from IGListKit that nil dataSource might result in crash Nov 6, 2018
CODE_OF_CONDUCT.md Add Code of Conduct (#1273) Oct 30, 2018
Dangerfile Update .travis.yml and lint.sh, try to fix #1060 and lint errors #tri… Feb 2, 2018
Gemfile Update .travis.yml and lint.sh, try to fix #1060 and lint errors #tri… Feb 2, 2018
Gemfile.lock Update bundler to fix nokogiri vulnerability warning (#1271) Nov 1, 2018
IGListKit.podspec Update README and podspec with new license, bump version to 3.4 May 1, 2018
LICENSE.md Update MIT license language (#1272) Nov 1, 2018
Podfile Update Travis to Xcode 9.2 #trivial Jan 22, 2018
Podfile.lock Run setup script with CocoaPods 1.5.3 (#1216) Jul 25, 2018
README.md Update README and podspec with new license, bump version to 3.4 May 1, 2018

README.md

Build Status Coverage Status Pods Version Platforms Carthage 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 8.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', '~> 3.0'

Carthage

For Carthage, add the following to your Cartfile:

github "Instagram/IGListKit" ~> 3.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.