A data-driven UICollectionView framework for building fast and flexible lists.
Find a file
Tim Oliver baf38ea4d4 Bump library version to 5.0.0
Summary: Updates the version of IGListKit in its Info.plist file to 5.0.0

Reviewed By: lorixx

Differential Revision: D57265035

fbshipit-source-id: 5adb37d4230a8bc6e07f2f2016904258acfb08b5
2024-05-12 23:39:45 -07:00
.github Remove legacy build pipeline from GitHub Actions 2024-03-18 00:29:33 -07:00
docs Regenerate IGListKit documentation via jazzy 2024-05-12 21:14:35 -07:00
Examples Update example app icon with latest IG branding 2024-05-08 07:32:36 -07:00
Guides Improve SwiftPM support (#1546) 2023-03-06 23:29:41 -08:00
IGListKit.xcodeproj Remove privacy manifest file and related build tooling 2024-04-26 00:43:54 -07:00
remodel-plugin Standarize the copyright notice in all source files 2023-04-06 02:44:16 -07:00
Resources Add new dark/light mode compatible logo 2024-05-08 07:32:12 -07:00
scripts Remove privacy manifest file and related build tooling 2024-04-26 00:43:54 -07:00
Source Bump library version to 5.0.0 2024-05-12 23:39:45 -07:00
spm/Sources Remove privacy manifest file and related build tooling 2024-04-26 00:43:54 -07:00
Tests Add IGListTestCollectionViewLayout class to XCTest suite 2024-03-07 19:35:34 -08:00
.gitignore Improve SwiftPM support (#1546) 2023-03-06 23:29:41 -08:00
.slather.yml Omit the test suite from code coverage stats 2023-04-17 20:41:49 -07:00
.swiftlint.yml Updated and reintegrated Danger into GitHub Actions CI 2023-02-28 18:53:02 -08:00
CHANGELOG.md Update the CHANGELOG 2024-04-28 02:49:22 -07: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 pipeline to improve reliability 2023-11-13 09:50:13 -08:00
IGListDiffKit.podspec Remove privacy manifest file and related build tooling 2024-04-26 00:43:54 -07:00
IGListKit.podspec Remove privacy manifest file and related build tooling 2024-04-26 00:43:54 -07:00
IGListSwiftKit.podspec Remove privacy manifest file and related build tooling 2024-04-26 00:43:54 -07:00
LICENSE.md Standarize the copyright notice in all source files 2023-04-06 02:44:16 -07:00
Package.swift Remove privacy manifest file and related build tooling 2024-04-26 00:43:54 -07:00
Podfile Update deployment targets to silence Xcode 14 warnings (#1573) 2023-05-01 22:48:23 -07:00
README.md Add new logo to EN and ZH README files 2024-05-12 21:14:35 -07:00
README.zh.md Add new logo to EN and ZH README files 2024-05-12 21:14:35 -07: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 11.0+
  • iOS 11.0+
  • tvOS 11.0+
  • macOS 10.13+ (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