2016-09-07 22:37:59 +00:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< title > IGListKit Reference< / title >
< link rel = "stylesheet" type = "text/css" href = "css/jazzy.css" / >
< link rel = "stylesheet" type = "text/css" href = "css/highlight.css" / >
< meta charset = 'utf-8' >
< script src = "js/jquery.min.js" defer > < / script >
< script src = "js/jazzy.js" defer > < / script >
2016-11-23 20:42:52 +00:00
2016-09-07 22:37:59 +00:00
< / head >
< body >
< a title = "IGListKit Reference" > < / a >
< header >
< div class = "content-wrapper" >
2016-11-21 23:36:26 +00:00
< p > < a href = "index.html" > IGListKit Docs< / a > (100% documented)< / p >
2016-09-07 22:37:59 +00:00
< p class = "header-right" > < a href = "https://github.com/Instagram/IGListKit" > < img src = "img/gh.png" / > View on GitHub< / a > < / p >
< / div >
< / header >
< div class = "content-wrapper" >
< p id = "breadcrumbs" >
< a href = "index.html" > IGListKit Reference< / a >
< img id = "carat" src = "img/carat.png" / >
IGListKit Reference
< / p >
< / div >
< div class = "content-wrapper" >
< nav class = "sidebar" >
< ul class = "nav-groups" >
2016-11-23 20:42:52 +00:00
< li class = "nav-group-name" >
< a href = "Guides.html" > Guides< / a >
< ul class = "nav-group-tasks" >
< li class = "nav-group-task" >
< a href = "getting-started.html" > Getting Started< / a >
< / li >
2016-11-28 00:53:20 +00:00
< li class = "nav-group-task" >
< a href = "iglistdiffable-and-equality.html" > IGListDiffable and Equality< / a >
< / li >
2016-12-27 20:37:57 +00:00
< li class = "nav-group-task" >
< a href = "installation.html" > Installation< / a >
< / li >
2016-11-23 20:42:52 +00:00
< li class = "nav-group-task" >
< a href = "migration.html" > Migration< / a >
< / li >
< / ul >
< / li >
2016-09-07 22:37:59 +00:00
< li class = "nav-group-name" >
< a href = "Categories.html" > Categories< / a >
< ul class = "nav-group-tasks" >
< li class = "nav-group-task" >
2016-11-22 07:18:30 +00:00
< a href = "Categories.html#/c:objc(cy)NSNumber@IGListDiffable" > NSNumber(IGListDiffable)< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Categories.html#/c:objc(cy)NSString@IGListDiffable" > NSString(IGListDiffable)< / a >
2016-09-07 22:37:59 +00:00
< / li >
< / ul >
< / li >
< li class = "nav-group-name" >
< a href = "Classes.html" > Classes< / a >
< ul class = "nav-group-tasks" >
< li class = "nav-group-task" >
< a href = "Classes/IGListAdapter.html" > IGListAdapter< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Classes/IGListAdapterUpdater.html" > IGListAdapterUpdater< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Classes/IGListBatchUpdateData.html" > IGListBatchUpdateData< / a >
< / li >
< li class = "nav-group-task" >
2016-11-21 23:36:26 +00:00
< a href = "Classes.html#/c:objc(cs)IGListCollectionView" > IGListCollectionView< / a >
2016-09-07 22:37:59 +00:00
< / li >
2016-11-22 07:18:30 +00:00
< li class = "nav-group-task" >
< a href = "Classes/IGListGridCollectionViewLayout.html" > IGListGridCollectionViewLayout< / a >
< / li >
2016-09-07 22:37:59 +00:00
< li class = "nav-group-task" >
< a href = "Classes/IGListIndexPathResult.html" > IGListIndexPathResult< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Classes/IGListIndexSetResult.html" > IGListIndexSetResult< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Classes/IGListMoveIndex.html" > IGListMoveIndex< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Classes/IGListMoveIndexPath.html" > IGListMoveIndexPath< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Classes.html#/c:objc(cs)IGListReloadDataUpdater" > IGListReloadDataUpdater< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Classes/IGListSectionController.html" > IGListSectionController< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Classes/IGListSingleSectionController.html" > IGListSingleSectionController< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Classes/IGListStackedSectionController.html" > IGListStackedSectionController< / a >
< / li >
< / ul >
< / li >
< li class = "nav-group-name" >
< a href = "Constants.html" > Constants< / a >
< ul class = "nav-group-tasks" >
< li class = "nav-group-task" >
< a href = "Constants.html#/c:@IGListKitVersionNumber" > IGListKitVersionNumber< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Constants.html#/c:@IGListKitVersionString" > IGListKitVersionString< / a >
< / li >
< / ul >
< / li >
< li class = "nav-group-name" >
< a href = "Enums.html" > Enums< / a >
< ul class = "nav-group-tasks" >
< li class = "nav-group-task" >
< a href = "Enums/IGListDiffOption.html" > IGListDiffOption< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Enums/IGListExperiment.html" > IGListExperiment< / a >
< / li >
< / ul >
< / li >
< li class = "nav-group-name" >
< a href = "Protocols.html" > Protocols< / a >
< ul class = "nav-group-tasks" >
< li class = "nav-group-task" >
< a href = "Protocols/IGListAdapterDataSource.html" > IGListAdapterDataSource< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Protocols/IGListAdapterDelegate.html" > IGListAdapterDelegate< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Protocols/IGListAdapterUpdaterDelegate.html" > IGListAdapterUpdaterDelegate< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Protocols/IGListCollectionContext.html" > IGListCollectionContext< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Protocols/IGListDiffable.html" > IGListDiffable< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Protocols/IGListDisplayDelegate.html" > IGListDisplayDelegate< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Protocols/IGListScrollDelegate.html" > IGListScrollDelegate< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Protocols/IGListSectionType.html" > IGListSectionType< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Protocols/IGListSingleSectionControllerDelegate.html" > IGListSingleSectionControllerDelegate< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Protocols/IGListSupplementaryViewSource.html" > IGListSupplementaryViewSource< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Protocols/IGListUpdatingDelegate.html" > IGListUpdatingDelegate< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Protocols/IGListWorkingRangeDelegate.html" > IGListWorkingRangeDelegate< / a >
< / li >
< / ul >
< / li >
< li class = "nav-group-name" >
< a href = "Type Definitions.html" > Type Definitions< / a >
< ul class = "nav-group-tasks" >
< li class = "nav-group-task" >
< a href = "Type Definitions.html#/c:IGListUpdatingDelegate.h@T@IGListItemUpdateBlock" > IGListItemUpdateBlock< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Type Definitions.html#/c:IGListUpdatingDelegate.h@T@IGListObjectTransitionBlock" > IGListObjectTransitionBlock< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Type Definitions.html#/c:IGListUpdatingDelegate.h@T@IGListReloadUpdateBlock" > IGListReloadUpdateBlock< / a >
< / li >
2016-11-21 23:36:26 +00:00
< li class = "nav-group-task" >
< a href = "Type Definitions.html#/c:IGListSingleSectionController.h@T@IGListSingleSectionCellConfigureBlock" > IGListSingleSectionCellConfigureBlock< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Type Definitions.html#/c:IGListSingleSectionController.h@T@IGListSingleSectionCellSizeBlock" > IGListSingleSectionCellSizeBlock< / a >
< / li >
2016-09-07 22:37:59 +00:00
< li class = "nav-group-task" >
< a href = "Type Definitions.html#/c:IGListAdapter.h@T@IGListUpdaterCompletion" > IGListUpdaterCompletion< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Type Definitions.html#/c:IGListUpdatingDelegate.h@T@IGListUpdatingCompletion" > IGListUpdatingCompletion< / a >
< / li >
< / ul >
< / li >
< li class = "nav-group-name" >
< a href = "Functions.html" > Functions< / a >
< ul class = "nav-group-tasks" >
< li class = "nav-group-task" >
< a href = "Functions.html#/c:@F@IGListDiff" > IGListDiff< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Functions.html#/c:@F@IGListDiffExperiment" > IGListDiffExperiment< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Functions.html#/c:@F@IGListDiffPaths" > IGListDiffPaths< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Functions.html#/c:@F@IGListDiffPathsExperiment" > IGListDiffPathsExperiment< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Functions.html#/c:IGListExperiments.h@F@IGListExperimentEnabled" > IGListExperimentEnabled< / a >
< / li >
< / ul >
< / li >
< / ul >
< / nav >
< article class = "main-content" >
< section >
< section class = "section" >
2016-11-23 20:42:52 +00:00
2016-09-07 22:37:59 +00:00
< p align = "center" >
2016-10-11 18:38:22 +00:00
< img src = "https://raw.githubusercontent.com/Instagram/IGListKit/master/Resources/logo-animation.gif" width = 400 / >
2016-09-07 22:37:59 +00:00
< / p >
2016-11-21 23:36:26 +00:00
< p align = "center" >
< a href = "https://travis-ci.org/Instagram/IGListKit" >
< img src = "https://travis-ci.org/Instagram/IGListKit.svg?branch=master&style=flat"
alt="Build Status">
< / a >
< a href = "https://coveralls.io/github/Instagram/IGListKit?branch=master" >
< img src = "https://coveralls.io/repos/github/Instagram/IGListKit/badge.svg?branch=master"
alt="Coverage Status" />
< / a >
< a href = "https://cocoapods.org/pods/IGListKit" >
< img src = "https://img.shields.io/cocoapods/v/IGListKit.svg?style=flat"
alt="Pods Version">
< / a >
2016-12-14 22:39:01 +00:00
< a href = "https://instagram.github.io/IGListKit/" >
< img src = "https://img.shields.io/cocoapods/p/IGListKit.svg?style=flat"
alt="Platforms">
< / a >
2016-11-21 23:36:26 +00:00
< a href = "https://github.com/Carthage/Carthage" >
< img src = "https://img.shields.io/badge/Carthage-compatible-brightgreen.svg?style=flat"
alt="Carthage Compatible">
< / a >
< / p >
2016-09-07 22:37:59 +00:00
< hr >
< p > A data-driven < code > UICollectionView< / code > framework for building fast and flexible lists.< / p >
< table > < thead >
< tr >
< th > < / th >
< th > Main Features< / th >
< / tr >
< / thead > < tbody >
< tr >
2016-10-11 18:38:22 +00:00
< td > 🙅 < / td >
2016-09-07 22:37:59 +00:00
< td > Never call < code > performBatchUpdates(_:, completion:)< / code > or < code > reloadData()< / code > again< / td >
< / tr >
< tr >
2016-10-11 18:38:22 +00:00
< td > 🏠 < / td >
2016-09-07 22:37:59 +00:00
< td > Better architecture with reusable cells and components< / td >
< / tr >
< tr >
2016-10-11 18:38:22 +00:00
< td > 🔠 < / td >
2016-09-07 22:37:59 +00:00
< td > Create collections with multiple data types< / td >
< / tr >
< tr >
2016-10-11 18:38:22 +00:00
< td > 🔑 < / td >
< td > Decoupled diffing algorithm< / td >
2016-09-07 22:37:59 +00:00
< / tr >
< tr >
2016-10-11 18:38:22 +00:00
< td > ✅ < / td >
2016-09-07 22:37:59 +00:00
< td > Fully unit tested< / td >
< / tr >
< tr >
2016-10-11 18:38:22 +00:00
< td > 🔍 < / td >
< td > Customize your diffing behavior for your models< / td >
2016-09-07 22:37:59 +00:00
< / tr >
< tr >
2016-10-11 18:38:22 +00:00
< td > 📱 < / td >
< td > Simply < code > UICollectionView< / code > at its core< / td >
2016-09-07 22:37:59 +00:00
< / tr >
< tr >
2016-10-11 18:38:22 +00:00
< td > 🚀 < / td >
2016-11-21 23:36:26 +00:00
< td > Extendable API< / td >
2016-09-07 22:37:59 +00:00
< / tr >
< tr >
2016-10-11 18:38:22 +00:00
< td > 🐦 < / td >
< td > Written in Objective-C with full Swift interop support< / td >
2016-09-07 22:37:59 +00:00
< / tr >
< / tbody > < / table >
2016-12-14 22:39:01 +00:00
< p > < code > IGListKit< / code > is built and maintained with ❤ ️ by < a href = "https://engineering.instagram.com/" > Instagram engineering< / a > .
We use the open source version < code > master< / code > branch in the Instagram app.< / p >
2016-11-21 23:36:26 +00:00
< a href = '#requirements' class = 'anchor' aria-hidden = true > < span class = "header-anchor" > < / span > < / a > < h2 id = 'requirements' > Requirements< / h2 >
< ul >
< li > Xcode 8.0+< / li >
< li > iOS 8.0+< / li >
< li > tvOS 9.0+< / li >
2016-12-29 18:56:56 +00:00
< li > macOS 10.10+ < em > (diffing algorithm components only)< / em > < / li >
2016-11-21 23:36:26 +00:00
< li > Interoperability with Swift 3.0+< / li >
< / ul >
2016-09-07 22:37:59 +00:00
< a href = '#installation' class = 'anchor' aria-hidden = true > < span class = "header-anchor" > < / span > < / a > < h2 id = 'installation' > Installation< / h2 >
2016-11-21 23:36:26 +00:00
< a href = '#cocoapods' class = 'anchor' aria-hidden = true > < span class = "header-anchor" > < / span > < / a > < h3 id = 'cocoapods' > CocoaPods< / h3 >
2016-09-07 22:37:59 +00:00
2016-12-27 20:37:57 +00:00
< p > The preferred installation method is with < a href = "https://cocoapods.org" > CocoaPods< / a > . Add the following to your < code > Podfile< / code > :< / p >
< pre class = "highlight ruby" > < code > < span class = "n" > pod< / span > < span class = "s1" > 'IGListKit'< / span > < span class = "p" > ,< / span > < span class = "s1" > '~> 2.0.0'< / span >
2016-09-07 22:37:59 +00:00
< / code > < / pre >
2016-11-21 23:36:26 +00:00
< a href = '#carthage' class = 'anchor' aria-hidden = true > < span class = "header-anchor" > < / span > < / a > < h3 id = 'carthage' > Carthage< / h3 >
2016-09-07 22:37:59 +00:00
2016-12-27 20:37:57 +00:00
< p > For < a href = "https://github.com/Carthage/Carthage" > Carthage< / a > , add the following to your < code > Cartfile< / code > :< / p >
2016-12-09 19:43:09 +00:00
< pre class = "highlight plaintext" > < code > github "Instagram/IGListKit" ~> 2.0.0
2016-11-21 23:36:26 +00:00
< / code > < / pre >
2016-12-27 20:37:57 +00:00
< blockquote >
< p > For advanced usage, see our < a href = "https://instagram.github.io/IGListKit/installation.html" > Installation Guide< / a > .< / p >
< / blockquote >
2016-11-23 20:42:52 +00:00
< a href = '#getting-started' class = 'anchor' aria-hidden = true > < span class = "header-anchor" > < / span > < / a > < h2 id = 'getting-started' > Getting Started< / h2 >
2016-09-07 22:37:59 +00:00
2016-12-14 22:39:01 +00:00
< ul >
< li > Our < a href = "https://instagram.github.io/IGListKit/getting-started.html" > Getting Started guide< / a > < / li >
< li > Ray Wenderlich’ s < a href = "https://www.raywenderlich.com/147162/iglistkit-tutorial-better-uicollectionviews" > IGListKit Tutorial: Better UICollectionViews< / a > < / li >
< li > Ryan Nystrom’ s < a href = "https://realm.io/news/tryswift-ryan-nystrom-refactoring-at-scale-lessons-learned-rewriting-instagram-feed/" > talk at try! Swift NYC< / a > < / li >
< / ul >
2016-09-07 22:37:59 +00:00
< a href = '#documentation' class = 'anchor' aria-hidden = true > < span class = "header-anchor" > < / span > < / a > < h2 id = 'documentation' > Documentation< / h2 >
2016-11-21 23:36:26 +00:00
< p > You can find < a href = "https://instagram.github.io/IGListKit" > the docs here< / a > . Documentation is generated with < a href = "https://github.com/realm/jazzy" > jazzy< / a > and hosted on < a href = "https://pages.github.com" > GitHub-Pages< / a > .< / p >
2016-09-07 22:37:59 +00:00
< a href = '#contributing' class = 'anchor' aria-hidden = true > < span class = "header-anchor" > < / span > < / a > < h2 id = 'contributing' > Contributing< / h2 >
2016-12-14 22:39:01 +00:00
< p > Please see the < a href = "https://github.com/Instagram/IGListKit/blob/master/.github/CONTRIBUTING.md" > CONTRIBUTING< / a > file for how to help out. At Instagram we sync the open source version of < code > IGListKit< / code > daily, so we’ re always testing the latest changes. But that requires all changes be thoroughly tested and follow our style guide.< / p >
2016-09-07 22:37:59 +00:00
< a href = '#license' class = 'anchor' aria-hidden = true > < span class = "header-anchor" > < / span > < / a > < h2 id = 'license' > License< / h2 >
< p > < code > IGListKit< / code > is BSD-licensed. We also provide an additional patent grant.< / p >
2016-12-14 22:39:01 +00:00
< p > The files in the < code > /Examples/< / code > directory are licensed under a separate license as specified in each file. Documentation is licensed < a href = "https://creativecommons.org/licenses/by/4.0/" > CC-BY-4.0< / a > .< / p >
2016-09-07 22:37:59 +00:00
< / section >
< / section >
< section id = "footer" >
2017-01-04 18:09:57 +00:00
< p > © 2017 < a class = "link" href = "https://twitter.com/fbOpenSource" target = "_blank" rel = "external" > Instagram< / a > . All rights reserved. (Last updated: 2017-01-04)< / p >
2016-12-08 18:03:33 +00:00
< p > Generated by < a class = "link" href = "https://github.com/realm/jazzy" target = "_blank" rel = "external" > jazzy ♪♫ v0.7.3< / a > , a < a class = "link" href = "http://realm.io" target = "_blank" rel = "external" > Realm< / a > project.< / p >
2016-09-07 22:37:59 +00:00
< / section >
< / article >
< / div >
< / body >
< / div >
< / html >
