Elgato_dark/IGListKit
1
0
Fork 0
mirror of https://github.com/Instagram/IGListKit synced 2026-05-22 00:38:42 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
A data-driven UICollectionView framework for building fast and flexible lists.
139 commits 16 branches 13 tags 23 MiB
Objective-C 89.8%
Objective-C++ 4.9%
Swift 1.5%
TypeScript 1.3%
Shell 0.7%
Other 1.7%
Find a file
Jesse Squires b994a40bfd project organization, 'sort by name' 
Summary: Closes https://github.com/Instagram/IGListKit/pull/271

Differential Revision: D4259848

Pulled By: jessesquires

fbshipit-source-id: 4a7a1159bbb335b88243e4fbc7bf62c54ce7b6dc
2016-12-01 11:59:10 -08:00
.github Fixed link to contributing in pull request template 2016-11-22 06:29:01 -08:00
docs gen docs for equality guide updates. 2016-11-30 18:14:09 -08:00
Examples project organization, 'sort by name' 2016-12-01 11:59:10 -08:00
Guides Update IGListDiffable and Equality.md 2016-11-27 17:43:58 -08:00
IGListKit.xcodeproj Unit tests for -scrollToObject horizontal end position 2016-11-22 06:44:01 -08:00
IGListKit.xcworkspace Initial commit 2016-10-11 10:12:17 -04:00
Pods add example setup script. run pod install. 2016-11-30 06:44:02 -08:00
Resources Update working range docs 2016-10-19 19:14:24 -07:00
Source Skip reloading objects that are not found 2016-11-23 16:28:58 -08:00
Tests Skip reloading objects that are not found 2016-11-23 16:28:58 -08:00
.gitignore Use bundler to manage CocoaPods and xcpretty 2016-10-13 19:29:09 -07:00
.slather.yml Ignore Xcode dir in coverage reports 2016-11-20 07:58:58 -08:00
.travis.yml Update .travis.yml 2016-12-01 11:59:10 -08:00
build_docs.sh Initial setup for guides 2016-11-23 12:44:01 -08:00
CHANGELOG.md Update CHANGELOG.md 2016-11-24 15:44:04 -08:00
IGListKit.podspec Add tvOS support. Close #118 2016-10-29 14:44:11 -07:00
LICENSE.md Initial commit 2016-10-11 10:12:17 -04:00
PATENTS.md Initial commit 2016-10-11 10:12:17 -04:00
Podfile Add tvOS support. Close #118 2016-10-29 14:44:11 -07:00
Podfile.lock internal diff for PR #209 2016-11-16 12:44:19 -08:00
README.md Fix links in README, close #256 2016-11-24 13:58:58 -08:00

README.md

Build Status Coverage Status Pods Version 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, using the open source version for the Instagram app.

Requirements

  • Xcode 8.0+
  • iOS 8.0+
  • tvOS 9.0+
  • Interoperability with Swift 3.0+

Installation

CocoaPods

The preferred installation method for IGListKit is with CocoaPods. Simply add the following to your Podfile:

# Latest release of IGListKit
pod 'IGListKit'

# Use the master branch (we use this at Instagram)
pod 'IGListKit', :git => 'https://github.com/Instagram/IGListKit.git', :branch => 'master'

Carthage

To integrate IGListKit into your Xcode project using Carthage, specify it in your Cartfile:

github "Instagram/IGListKit" ~> 1.0.0

Manually

You can also manually install the framework by dragging and dropping the IGListKit.xcodeproj into your project or workspace.

Getting Started

See the Getting Started guide here.

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 almost daily, so we're always testing the latest changes. But that requires all changes be thoroughly tested follow our style guide.

License

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

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