Installation

This guide provides details on how to install IGListKit.

CocoaPods

The preferred method of installation for IGListKit is using CocoaPods.

In order to use the latest release of the framework, add the following to your Podfile:

pod 'IGListKit', '~> 4.0'

Using main

Alternatively, you can use the latest version from the main branch. This is what we use at Instagram, so you can be confident that main is always stable and reliable.

pod 'IGListKit', :git => 'https://github.com/Instagram/IGListKit.git', :branch => 'main'

Note: while main is stable, it may have breaking changes. Before updating to main, be sure to check the CHANGELOG for details on changes.

Subspecs

With the exception of macOS (which currently only supports the diffing algorithm components), using pod 'IGListKit' will get you the full library, including the flexible UICollectionView system. Learn more about how to get started in our Getting Started guide.

However, if you only want to use the diffing components of this library, then you can use the diffing subspec in your Podfile:

pod 'IGListKit/Diffing', '~> 4.0'

Regardless of whether you only use the diffing components, or the entire library, the imports are the same:

import IGListKit

Carthage

If using Carthage, add the following to your Cartfile:

github "Instagram/IGListKit" ~> 4.0