A data-driven UICollectionView framework for building fast and flexible lists.
Find a file
Erich Graham efe66a44e3 Add Swift value type initializer override for IGListSingleSectionController
Summary: Adds an init override if the generic type is a Swift value conforming to `ListIdentifiable`.

Reviewed By: natestedman

Differential Revision: D27013270

fbshipit-source-id: 44f5c45e6396643d251c23bfedb6cd0a482e3913
2021-03-12 11:22:53 -08:00
.github Update issue template to ask for example project 2018-12-07 15:12:26 -08:00
docs Fix the build_doc.sh and regenerate all the docs! (#1393) 2019-11-20 16:23:15 -08:00
Examples IGListCollectionContext Examples 2021-02-05 09:36:53 -08:00
Guides Update the version to be 4.0 2019-11-20 16:23:15 -08:00
IGListKit.xcodeproj Add refined Swift wrapper for IGListSingleSectionController 2021-01-26 07:34:31 -08:00
IGListKit.xcworkspace Fix "new file header template" whitespace #trivial (#1324) 2019-05-20 16:39:14 -07:00
Pods Run ./script/setup.sh to generate project files (#1431) 2020-02-26 12:26:58 -08:00
remodel-plugin Update remodel iglistdiffable plugin to the latest 2019-08-14 12:23:59 -07:00
Resources Create binding and modeling guide/tutorial 2017-08-21 14:46:53 -07:00
scripts Run lint on IGListKit 2019-12-19 09:34:42 -08:00
Source Add Swift value type initializer override for IGListSingleSectionController 2021-03-12 11:22:53 -08:00
Tests graduate IGListExperimentBackgroundDiffing to a property 2021-01-21 19:58:49 -08:00
.gitignore Nitpicky comment fixes 2017-03-31 13:01:40 -07:00
.slather.yml Ignore Xcode dir in coverage reports 2016-11-20 07:58:58 -08:00
.travis.yml Fix the podlint error (#1428) 2020-02-25 23:20:25 -08:00
CHANGELOG.md graduate IGListExperimentBackgroundDiffing to a property 2021-01-21 19:58:49 -08:00
CODE_OF_CONDUCT.md Adopt Contributor Covenant 2019-08-29 23:20:54 -07:00
Dangerfile Update .travis.yml and lint.sh, try to fix #1060 and lint errors #trivial 2018-02-02 13:16:46 -08:00
Gemfile Update Cocoapods 2019-11-13 05:30:27 -08:00
Gemfile.lock Bump nokogiri from 1.10.8 to 1.11.1 (#1496) 2021-02-02 13:18:40 -08:00
IGListDiffKit.podspec Run lint on IGListKit 2019-12-19 09:34:42 -08:00
IGListKit.podspec Run lint on IGListKit 2019-12-19 09:34:42 -08:00
IGListSwiftKit.podspec Run lint on IGListKit 2019-12-19 09:34:42 -08:00
LICENSE.md Update MIT license language (#1272) 2018-11-01 10:58:46 -07:00
Package.swift Add support for Swift PM (#1323) 2019-05-21 14:50:56 -07:00
Podfile use cocoapods cdn (#1386) 2019-11-20 09:24:48 -08:00
Podfile.lock use cocoapods cdn (#1386) 2019-11-20 09:24:48 -08:00
README.md The README file in this repo has a bad link - [404:NotFound] - “MIT-licensed” (#1489) 2021-02-02 09:09:36 -08:00
README.zh.md Better chinese readme (#1480) 2020-12-15 10:46:25 -08:00

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.

Multilingual translation

Chinese README

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.