A data-driven UICollectionView framework for building fast and flexible lists.
Objective-C Objective-C++ Other
Latest commit 1563fd0 Jan 18, 2017 Adam Roberts committed with facebook-github-bot Header/.m/.mm order clean up #416
Summary:
Moved .m and .mm files directly below header file for easier project
navigation.
Closes #417

Differential Revision: D4430737

Pulled By: rnystrom

fbshipit-source-id: 6e67566c38c1804ce995ba48148734587cb93c74

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 8.0+
  • iOS 8.0+
  • tvOS 9.0+
  • macOS 10.10+ (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', '~> 2.0.0'

Carthage

For Carthage, add the following to your Cartfile:

github "Instagram/IGListKit" ~> 2.0.0

For advanced usage, see our Installation Guide.

Getting Started

Documentation

You can find the docs here. Documentation is generated with jazzy and hosted on GitHub-Pages.

Contributing

Please see the CONTRIBUTING file for how to help out. 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.

License

IGListKit is BSD-licensed. We also provide an additional patent grant.

The files in the /Examples/ directory are licensed under a separate license as specified in each file. Documentation is licensed CC-BY-4.0.