A data-driven UICollectionView framework for building fast and flexible lists.
Find a file
Jordan Smith 6414e778b4 Add an experiment for inline CATransaction commits
Summary:
**Context**

When performing non-animated updates, `IGListKit` does so by beginning a `CATransaction` before `performBatchUpdates:`, and ending it in the completion block. While this disables animations for the collection view updates, it is feasible that some other changes might be bundled into the same transaction, given that we have no guarantee of the completion block being called inline.

It seems that this is happening in practice and occasionally disrupting `UIViewPropertyAnimator` animations, forcing the completion immediately.

**This Change**

To fix this issue, we can commit the transaction inline. Here we use `performWithoutAnimation:`, although it's possible that this is just a wrapper around `CATransaction` calls anyway.

Because the change may have unknown side effects, this change is gated by an experiment.

Reviewed By: maxolls

Differential Revision: D19150307

fbshipit-source-id: f7cff46ac7141609f42caafaf69bad71a980ad29
2019-12-17 16:57:39 -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 Remove useless system version code (#1396) 2019-11-21 09:56:43 -08:00
Guides Update the version to be 4.0 2019-11-20 16:23:15 -08:00
IGListKit.xcodeproj Add missing files to Xcode project 2019-12-17 13:07:18 -08:00
IGListKit.xcworkspace Fix "new file header template" whitespace #trivial (#1324) 2019-05-20 16:39:14 -07:00
Pods use cocoapods cdn (#1386) 2019-11-20 09:24:48 -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 Fix the build_doc.sh and regenerate all the docs! (#1393) 2019-11-20 16:23:15 -08:00
Source Add an experiment for inline CATransaction commits 2019-12-17 16:57:39 -08:00
Tests Use IGListAssert, not IGAssert 2019-12-17 13:07:17 -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 Properly split IGListDiffKit and IGListKit podspecs (#1385) 2019-11-13 05:30:28 -08:00
CHANGELOG.md Update contributor's github page (#1399) 2019-11-27 09:23:18 -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 use cocoapods cdn (#1386) 2019-11-20 09:24:48 -08:00
IGListDiffKit.podspec Properly split IGListDiffKit and IGListKit podspecs (#1385) 2019-11-13 05:30:28 -08:00
IGListKit.podspec Properly split IGListDiffKit and IGListKit podspecs (#1385) 2019-11-13 05:30:28 -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 Update the version to be 4.0 2019-11-20 16:23:15 -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.

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.