mirror of
https://github.com/Instagram/IGListKit
synced 2026-05-24 01:38:26 +00:00
CHANGELOG updates, refinements. Close #210.
Summary: Closes https://github.com/Instagram/IGListKit/pull/234 Differential Revision: D4213532 Pulled By: jessesquires fbshipit-source-id: 32b706f0319e35bdcb13002e6c1e50738af7174c
This commit is contained in:
Jesse Squires
Facebook Github Bot
parent
c48a39aefe
commit
1648840299
1 changed files with 62 additions and 8 deletions
70
CHANGELOG.md
70
CHANGELOG.md
|
|
@ -5,33 +5,87 @@ The changelog for `IGListKit`. Also see the [releases](https://github.com/instag
|
|||
2.0.0
|
||||
-----
|
||||
|
||||
This release closes the [2.0.0 milestone](https://github.com/Instagram/IGListKit/milestone/1?closed=1). Thanks to the [19 contributors](https://github.com/Instagram/IGListKit/graphs/contributors) who helped with this release!
|
||||
This release closes the [2.0.0 milestone](https://github.com/Instagram/IGListKit/milestone/1?closed=1). We've increased test coverage to 95%. Thanks to the [21 contributors](https://github.com/Instagram/IGListKit/graphs/contributors) who helped with this release!
|
||||
|
||||
### Breaking Changes
|
||||
|
||||
- Diff result method `-resultWithUpdatedMovesAsDeleteInserts` removed and replaced with `-resultForBatchUpdates` [(b5aa5e3)](https://github.com/Instagram/IGListKit/commit/b5aa5e39002854c947e777c11ae241f67f24d19c)
|
||||
- Diff result method on `IGListIndexPathResult` changed. `-resultWithUpdatedMovesAsDeleteInserts` was removed and replaced with `-resultForBatchUpdates` [(b5aa5e3)](https://github.com/Instagram/IGListKit/commit/b5aa5e39002854c947e777c11ae241f67f24d19c)
|
||||
|
||||
```
|
||||
// OLD
|
||||
- (IGListIndexPathResult *)resultWithUpdatedMovesAsDeleteInserts;
|
||||
|
||||
// NEW
|
||||
- (IGListIndexPathResult *)resultForBatchUpdates;
|
||||
```
|
||||
|
||||
- `IGListDiffable` equality method changed from `isEqual:` to `isEqualToDiffableObject:` [(ab890fc)](https://github.com/Instagram/IGListKit/commit/ab890fc6070f170a2db5a383a6296e62dcf75678)
|
||||
- Scrolling method changed from `-scrollToObject:supplementaryKinds:scrollDirection:animated` to `-scrollToObject:supplementaryKinds:scrollDirection:atScrollPosition:animated`. Added support for specifying end position. [Bofei Zhu](https://github.com/zhubofei) [(#196)](https://github.com/Instagram/IGListKit/pull/196)
|
||||
- Change `NSUInteger` to `NSInteger` in public API [Suraya Shivji](https://github.com/surayashivji) [(#200)](https://github.com/Instagram/IGListKit/issues/200)
|
||||
|
||||
- Added support for specifying an end position when scrolling. [Bofei Zhu](https://github.com/zhubofei) [(#196)](https://github.com/Instagram/IGListKit/pull/196). The `IGListAdapter` scrolling method changed:
|
||||
```objc
|
||||
// OLD
|
||||
- (void)scrollToObject:(id)object
|
||||
supplementaryKinds:(nullable NSArray<NSString *> *)supplementaryKinds
|
||||
scrollDirection:(UICollectionViewScrollDirection)scrollDirection
|
||||
animated:(BOOL)animated;
|
||||
|
||||
// NEW
|
||||
- (void)scrollToObject:(id)object
|
||||
supplementaryKinds:(nullable NSArray<NSString *> *)supplementaryKinds
|
||||
scrollDirection:(UICollectionViewScrollDirection)scrollDirection
|
||||
scrollPosition:(UICollectionViewScrollPosition)scrollPosition
|
||||
animated:(BOOL)animated;
|
||||
```
|
||||
|
||||
|
||||
- Changed `NSUInteger` to `NSInteger` in all public APIs. [Suraya Shivji](https://github.com/surayashivji) [(#200)](https://github.com/Instagram/IGListKit/issues/200)
|
||||
|
||||
### Enhancements
|
||||
|
||||
- Added support for supplementaryViews created from nibs. [Rawlinxx](https://github.com/rawlinxx) [(#90)](https://github.com/Instagram/IGListKit/pull/90)
|
||||
|
||||
- Added support for cells created from nibs. [Sven Bacia](https://github.com/svenbacia) [(#56)](https://github.com/Instagram/IGListKit/pull/56)
|
||||
|
||||
- Added an additional initializer for `IGListSingleSectionController` to be able to support single sections created from nibs. An example can be found [here](Examples/Examples-iOS/IGListKitExamples/ViewControllers/SingleSectionViewController.swift).
|
||||
- Fixed `-[IGListAdapter reloadDataWithCompletion:]` not returning early when `collectionView` or `dataSource` is nil and `completion` is nil. [Ben Asher](https://github.com/benasher44) [(#51)](https://github.com/Instagram/IGListKit/pull/51)
|
||||
|
||||
```objc
|
||||
- (instancetype)initWithNibName:(NSString *)nibName
|
||||
bundle:(nullable NSBundle *)bundle
|
||||
configureBlock:(IGListSingleSectionCellConfigureBlock)configureBlock
|
||||
sizeBlock:(IGListSingleSectionCellSizeBlock)sizeBlock;
|
||||
```
|
||||
|
||||
- Added `-isFirstSection` and `-isLastSection` APIs to `IGListSectionController`
|
||||
- Added support for cells and supplementaryViews created from storyboard. [Bofei Zhu](https://github.com/zhubofei) [(#92)](https://github.com/Instagram/IGListKit/pull/92)
|
||||
- Added examples for Today & iMessage extensions. [Sherlouk](https://github.com/Sherlouk) [(#112)](https://github.com/Instagram/IGListKit/pull/112)
|
||||
|
||||
- Added support for cells and supplementaryViews created from storyboard in `IGListCollectionContext`. [Bofei Zhu](https://github.com/zhubofei) [(#92)](https://github.com/Instagram/IGListKit/pull/92)
|
||||
|
||||
```objc
|
||||
// IGListCollectionContext
|
||||
- (__kindof UICollectionViewCell *)dequeueReusableCellFromStoryboardWithIdentifier:(NSString *)identifier
|
||||
forSectionController:(IGListSectionController<IGListSectionType> *)sectionController
|
||||
atIndex:(NSInteger)index;
|
||||
```
|
||||
|
||||
- Added `tvOS` support. [Jesse Squires](https://github.com/jessesquires) [(#137)](https://github.com/Instagram/IGListKit/pull/137)
|
||||
- Added `tvOS` example pack. [Sherlouk](https://github.com/Sherlouk) [(#141)](https://github.com/Instagram/IGListKit/pull/141)
|
||||
|
||||
- Added new `-[IGListAdapter visibleObjects]` API. [Ryan Nystrom](https://github.com/rnystrom) [(386ae07)](https://github.com/Instagram/IGListKit/commit/386ae0786445c06e1eabf074a4181614332f155f)
|
||||
|
||||
- Added new `-[IGListAdapter objectForSectionController:]` API. [Ayush Saraswat](https://github.com/saraswatayu) [(#204)](https://github.com/Instagram/IGListKit/pull/204)
|
||||
|
||||
### Fixes
|
||||
|
||||
- Fixed `-[IGListAdapter reloadDataWithCompletion:]` not returning early when `collectionView` or `dataSource` is `nil` and `completion` is `nil`. [Ben Asher](https://github.com/benasher44) [(#51)](https://github.com/Instagram/IGListKit/pull/51)
|
||||
|
||||
- Prevent `UICollectionView` bug when accessing a cell during working range updates. [Ryan Nystrom](https://github.com/rnystrom) [(#216)](https://github.com/Instagram/IGListKit/pull/216)
|
||||
|
||||
### Documentation
|
||||
|
||||
- We now have 100% documentation coverage. Docs been refined and clarified. [Jesse Squires](https://github.com/jessesquires) [(#207)](https://github.com/Instagram/IGListKit/pull/207)
|
||||
|
||||
- Added examples for Today & iMessage extensions. [Sherlouk](https://github.com/Sherlouk) [(#112)](https://github.com/Instagram/IGListKit/pull/112)
|
||||
|
||||
- Added `tvOS` example pack. [Sherlouk](https://github.com/Sherlouk) [(#141)](https://github.com/Instagram/IGListKit/pull/141)
|
||||
|
||||
1.0.0
|
||||
-----
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue