IGListKit README

The project's README from github.com/Instagram/IGListKit. As one markdown file: README.md.

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

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 Use • Privacy Policy

IGListKit (Instagram/IGListKit)

Searching Database…

13.1K ·GitHub
Что это такое?IGListKit — это фреймворк для iOS на основе данных поверх UICollectionView, который позволяет быстро и гибко создавать списки. Его разрабатывает и поддерживает инженерная команда Instagram.
Это замена UIKit или надстройка над UICollectionView?Это фреймворк, который работает поверх UICollectionView: он сравнивает данные и выполняет пакетные обновления, so reloadData() вызывать самому не нужно. Написан на Objective-C с полной совместимостью со Swift.
Как добавить его в проект?Установить можно через CocoaPods (предпочтительно), Carthage или Swift Package Manager: для этого нужно добавить зависимость в Podfile, Cartfile или Package.swift соответственно.
Какие минимальные версии ОС и Swift нужны?Нужны Swift 5.1+ и iOS 11.0+ (tvOS 11.0+), при этом совместимость поддерживается вплоть до Swift 3.0+. macOS 10.13+ требуется, только если вы используете отдельно компоненты алгоритма сравнения (diffing).
Нужно ли мне когда-нибудь вызывать performBatchUpdates или reloadData вручную?Нет — вся суть библиотеки в том, что performBatchUpdates(:, completion:) и reloadData() больше вызывать не нужно: обновлениями занимается движок сравнения.
Работает только на iPhone или также на tvOS и Mac?Поддерживаются коллекции UICollectionView на iOS и tvOS. Поддержка macOS ограничена использованием только компонентов алгоритма сравнения, без полного UI-фреймворка.
Лицензия одна на весь репозиторий, включая примеры?Основная библиотека распространяется под лицензией MIT, но файлы в /Examples/ имеют отдельную лицензию, а документация — под лицензией CC-BY-4.0.
Можно ли смешивать разные типы данных в одном списке?Да, фреймворк позволяет создавать коллекции, которые объединяют несколько типов данных в одном списке, с помощью переиспользуемых секций для ячеек и компонентов.
Можно ли настроить, как сравнение определяет, что элемент изменился?Да, IGListKit позволяет настраивать поведение сравнения для ваших собственных моделей, а сам алгоритм сравнения отделён от слоя UI.
Это используется в реальном приложении или только в демо-библиотеке?Instagram использует открытую основную ветку IGListKit напрямую в производственном приложении Instagram и синхронизирует изменения ежедневно.
Где можно посмотреть, как это работает?В репозитории есть примеры приложений в директории Examples, а также руководство Getting Started и сторонние материалы, например пошаговый разбор IGListKit от Ray Wenderlich.
Creator
Instagram
Size
9.2 MB
Stars
13.1K
Age
10y
Commits · 90 Days