A data-driven UICollectionView framework for building fast and flexible lists.
Find a file
Tim Oliver d7574152d3 Add test coverage for list adapter debugger class
Summary: Adds additional functionality and coverage testing to the adapter debugger class

Reviewed By: candance

Differential Revision: D45004651

fbshipit-source-id: 40330f5f2fed2946cc5ead89b30cf4030b596b65
2023-04-17 20:41:49 -07:00
.github Update build environment to latest OS versions 2023-04-17 20:41:49 -07:00
docs Updated copyright symbol in documentation 2023-04-07 01:58:02 -07:00
Examples Standarize the copyright notice in all source files 2023-04-06 02:44:16 -07:00
Guides Improve SwiftPM support (#1546) 2023-03-06 23:29:41 -08:00
IGListKit.xcodeproj Add new test files to IGListKit 2023-04-17 20:41:49 -07:00
remodel-plugin Standarize the copyright notice in all source files 2023-04-06 02:44:16 -07:00
Resources Create binding and modeling guide/tutorial 2017-08-21 14:46:53 -07:00
scripts Regenerate docs via jazzy 2023-04-07 00:23:43 -07:00
Source Refactor code syntax in internal classes to be easier to provide code coverage 2023-04-17 20:41:49 -07:00
spm/Sources SPM number10 (#1487) 2021-08-31 19:28:37 -07:00
Tests Add test coverage for list adapter debugger class 2023-04-17 20:41:49 -07:00
.gitignore Improve SwiftPM support (#1546) 2023-03-06 23:29:41 -08:00
.slather.yml Redirect slather.yml from Travis CI to GitHub Actions 2023-02-09 01:38:19 -08:00
.swiftlint.yml Updated and reintegrated Danger into GitHub Actions CI 2023-02-28 18:53:02 -08:00
.travis.yml Update 'master' branch references to 'main' branch 2023-02-08 18:34:25 -08:00
CHANGELOG.md Update 'master' branch references to 'main' branch 2023-02-08 18:34:25 -08:00
CODE_OF_CONDUCT.md Adopt Contributor Covenant 2019-08-29 23:20:54 -07:00
Dangerfile Updated and reintegrated Danger into GitHub Actions CI 2023-02-28 18:53:02 -08:00
Gemfile Update build environment to latest OS versions 2023-04-17 20:41:49 -07:00
IGListDiffKit.podspec Standarize the copyright notice in all source files 2023-04-06 02:44:16 -07:00
IGListKit.podspec Standarize the copyright notice in all source files 2023-04-06 02:44:16 -07:00
IGListSwiftKit.podspec Standarize the copyright notice in all source files 2023-04-06 02:44:16 -07:00
LICENSE.md Standarize the copyright notice in all source files 2023-04-06 02:44:16 -07:00
Package.swift Improve SwiftPM support (#1546) 2023-03-06 23:29:41 -08:00
Podfile Fix the Gemfile.lock for the CI build (#1524) 2021-08-16 17:10:48 -07:00
README.md Updated copyright symbol in documentation 2023-04-07 01:58:02 -07:00
README.zh.md Update CI badge to point to GitHub Actions 2023-02-08 21:18:16 -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 main 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

Swift Package Manager

For 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.

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.

Copyright © Meta Platforms, Inc • Terms of UsePrivacy Policy