IGListKit/README.md at 1c73ecb4e7b024bc90f078168a5bd143fc6883e2

mirror of https://github.com/Instagram/IGListKit synced 2026-05-06 06:58:26 +00:00

Kent Sutherland 3cd3a111dd Update deployment targets to silence Xcode 14 warnings (#1573 )

Summary:
## Changes in this pull request

Xcode 14 changed the minimum deployment target to iOS/tvOS 11.0 and macOS 10.13. This PR moves up the deployment targets so that a warning isn't shown on every build.

I also silenced the development region and base localization warnings.

### Checklist

- [x] All tests pass. Demo project builds and runs.
- [x] I added tests, an experiment, or detailed why my change isn't tested.
- [x] I added an entry to the `CHANGELOG.md` for any breaking changes, enhancements, or bug fixes.
- [x] I have reviewed the [contributing guide](https://github.com/Instagram/IGListKit/blob/main/.github/CONTRIBUTING.md)

Pull Request resolved: https://github.com/Instagram/IGListKit/pull/1573

Differential Revision: D45223095

Pulled By: TimOliver

fbshipit-source-id: 57fbd284809c09f86a9731d0676332de35fbe0df

2023-05-01 22:48:23 -07:00

5.3 KiB

Raw Blame History

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

Xcode 11.0+
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', '~> 4.0.0'

Carthage

For Carthage, add the following to your Cartfile:

github "Instagram/IGListKit" ~> 4.0.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.

Our Getting Started guide
Ray Wenderlich's IGListKit Tutorial: Better UICollectionViews
Our example projects
Ryan Nystrom's talk at try! Swift NYC(Note: this talk was for an earlier version. Some APIs have changed.)
Migrating an UITableView to IGListCollectionView, by Rodrigo Cavalcante
Keeping data fresh in Buffer for iOS with AsyncDisplayKit, IGListKit & Pusher, Andy Yates, Buffer

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.

5.3 KiB Raw Blame History