A data-driven UICollectionView framework for building fast and flexible lists.
Objective-C Objective-C++ TypeScript Gherkin Ruby Swift Other
Clone or download
Adam Stern and facebook-github-bot log instead of assert for duplicate object identifiers
Summary: The `IGFailAssert` for duplicate object identifiers causes unit tests to fail in CI / IGListKit because assertions aren't silenced. Changing this to a log for now.

Reviewed By: rnystrom

Differential Revision: D8773452

fbshipit-source-id: 369415fda4ba3eef8fe8684dc792b0a9905a4759
Latest commit bee2178 Jul 10, 2018
Permalink
Failed to load latest commit information.
.github Update ISSUE_TEMPLATE.md Apr 26, 2017
Examples Remove optional (#1186) Jun 26, 2018
Guides Add correct comment syntax for Remodel May 30, 2018
IGListKit.xcodeproj give section controllers access to collection view scrolling traits May 14, 2018
IGListKit.xcworkspace Minimum fixes for Xcode 9.3 build errors Apr 9, 2018
Pods Bump min macOS version to 10.11 #trivial Feb 3, 2018
Resources Create binding and modeling guide/tutorial Aug 21, 2017
Source log instead of assert for duplicate object identifiers Jul 10, 2018
Tests Remove optional (#1186) Jun 26, 2018
docs Regenerate docs for 3.4 May 2, 2018
remodel-plugin Add missing preprocessors value May 30, 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 log instead of assert for duplicate object identifiers Jul 10, 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 .travis.yml and lint.sh, try to fix #1060 and lint errors #tri… Feb 2, 2018
IGListKit.podspec Update README and podspec with new license, bump version to 3.4 May 1, 2018
LICENSE.md Relicense to MIT May 1, 2018
Podfile Update Travis to Xcode 9.2 #trivial Jan 22, 2018
Podfile.lock Update Travis to Xcode 9.2 #trivial Jan 22, 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.