A data-driven UICollectionView framework for building fast and flexible lists.
Find a file
Cameron Roth e3facbed27 Replace IGFailAssert with NSLog for delegate recursion checks
Summary:
The delegate recursion protection code (for GitHub issue #1658) uses IGFailAssert to warn about invalid delegate configurations. However, IGFailAssert is defined as NSCAssert which throws exceptions in debug/test builds, preventing the recovery code from executing.

This change replaces IGFailAssert with NSLog for these 4 specific cases
where the code is designed to gracefully recover:

1. When setting collectionView and _scrollViewDelegate points to it
2. When setting collectionView and _collectionViewDelegate points to it
3. When calling setCollectionViewDelegate: with the collectionView itself
4. When calling setScrollViewDelegate: with the collectionView itself

By using NSLog instead, the warning is still logged but execution continues, allowing the recovery code (clearing delegates or returning early) to run.
This fixes 23 test failures in IGListKitTests where tests were either:
- Intentionally testing the delegate protection behavior
- Inadvertently triggering the assertion when swapping adapters/collection views

Differential Revision: D101185192

fbshipit-source-id: 1f7cdc70b39f69364ce540d6b46bc8eb7ec22f9d
2026-04-16 16:42:39 -07:00
.github Enable unit test suite for tvOS (#1649) 2025-12-11 00:46:38 -08:00
docs Updated the IGListKit docs to v5.2.0 (#1656) 2026-02-16 23:54:31 -08:00
Examples Refine Demo Apps for iOS 26 (#1655) 2026-02-16 23:57:23 -08:00
Guides Improve SwiftPM support (#1546) 2023-03-06 23:29:41 -08:00
IGListKit.xcodeproj Bring Test Coverage back to > 99% (#1654) 2026-01-27 21:10:09 -08:00
remodel-plugin Standarize the copyright notice in all source files 2023-04-06 02:44:16 -07:00
Resources Add new dark/light mode compatible logo 2024-05-08 07:32:12 -07:00
scripts Remove privacy manifest file and related build tooling 2024-04-26 00:43:54 -07:00
Source Replace IGFailAssert with NSLog for delegate recursion checks 2026-04-16 16:42:39 -07:00
spm/Sources Fix missing project and SPM references (#1621) 2025-03-11 09:13:03 -07:00
Tests Fix VoiceOver infinite recursion crash when delegate set to collectionView (Issue 1658) 2026-04-13 19:35:45 -07:00
.gitignore Improve SwiftPM support (#1546) 2023-03-06 23:29:41 -08:00
.slather.yml Omit the test suite from code coverage stats 2023-04-17 20:41:49 -07:00
.swiftlint.yml Updated and reintegrated Danger into GitHub Actions CI 2023-02-28 18:53:02 -08:00
CHANGELOG.md Fix public compilation by making METAUIKitBridge conditional 2026-04-16 12:51:41 -07:00
CODE_OF_CONDUCT.md Adopt Contributor Covenant 2019-08-29 23:20:54 -07:00
Dangerfile Updated and reintegrated Danger into GitHub Actions CI 2023-02-28 18:53:02 -08:00
Gemfile Remove using CocoaPods to build IGListKit's test suite (#1641) 2025-10-06 08:21:43 -07:00
IGListDiffKit.podspec Remove privacy manifest file and related build tooling 2024-04-26 00:43:54 -07:00
IGListKit.podspec Remove privacy manifest file and related build tooling 2024-04-26 00:43:54 -07:00
IGListSwiftKit.podspec Remove privacy manifest file and related build tooling 2024-04-26 00:43:54 -07:00
LICENSE.md Standarize the copyright notice in all source files 2023-04-06 02:44:16 -07:00
Package.swift General fixes to restore GitHub CI (#1622) 2025-03-14 23:56:06 -07:00
README.md Updated the IGListKit docs to v5.2.0 (#1656) 2026-02-16 23:54:31 -08:00
README.zh.md Updated the IGListKit docs to v5.2.0 (#1656) 2026-02-16 23:54:31 -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 main branch in the Instagram app.

Multilingual translation

Chinese README

Requirements

  • Swift 5.1+
  • iOS 11.0+
  • tvOS 11.0+
  • macOS 10.13+ (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', '~> 5.2.0'

Carthage

For Carthage, add the following to your Cartfile:

github "Instagram/IGListKit" ~> 5.2.0

Swift Package Manager

For Swift Package Manager:

To integrate using Xcode:

File -> Swift Packages -> Add Package Dependency

Enter package URL: https://github.com/Instagram/IGListKit, and select the latest release.

For advanced usage, see our Installation Guide.

Getting Started

Try out IGListKit by opening any of the sample apps available in the Examples directory.

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.

Copyright © Meta Platforms, Inc • Terms of UsePrivacy Policy