mirror of
https://github.com/Instagram/IGListKit
synced 2026-05-23 01:08:27 +00:00
4dec244416
Summary: Adding an API to do item-level (cell) moves on the collection view. This complicates things a little bit because of all the issues that moving sections have while in batch updates (e.g. simultaneous animation UICV bugs). Thankfully we use pretty strict types so the compiler does most of the work for us. Closes #145 - [x] Tests build and pass - [x] Add `IGListBatchUpdateData` tests to check moves during - [x] ~~Moving within a reloaded section (no op)~~ can't reload sections - [x] Moving within a deleted section (no op) - [x] Moving within a moved section (convert section ops to delete+insert) - [x] Moving an index path that is also reloaded (convert to delete+insert path) - [x] Add move unit tests to `IGListAdapterUpdater` - [x] Add move unit tests to `IGListReloadDataUpdater` (mostly for code coverage...) - [x] Add move unit tests to `IGListStackedSectionController` - [x] Add `CHANGELOG.md` entry for 3.0.0 - [x] Test moving without batch Closes https://github.com/Instagram/IGListKit/pull/418 Reviewed By: jessesquires Differential Revision: D4521732 Pulled By: rnystrom fbshipit-source-id: 99a46d1cbb0cc1f857a62ff6ca257aff6e8b7f25
144 lines
6.3 KiB
Objective-C
144 lines
6.3 KiB
Objective-C
/**
|
|
* Copyright (c) 2016-present, Facebook, Inc.
|
|
* All rights reserved.
|
|
*
|
|
* This source code is licensed under the BSD-style license found in the
|
|
* LICENSE file in the root directory of this source tree. An additional grant
|
|
* of patent rights can be found in the PATENTS file in the same directory.
|
|
*/
|
|
|
|
#import <UIKit/UIKit.h>
|
|
|
|
#import <IGListKit/IGListBatchUpdateData.h>
|
|
|
|
@class IGListAdapterUpdater;
|
|
|
|
NS_ASSUME_NONNULL_BEGIN
|
|
|
|
/**
|
|
A protocol that receives events about `IGListAdapterUpdater` operations.
|
|
*/
|
|
@protocol IGListAdapterUpdaterDelegate <NSObject>
|
|
|
|
/**
|
|
Notifies the delegate that the updater will call `-[UICollectionView performBatchUpdates:completion:]`.
|
|
|
|
@param listAdapterUpdater The adapter updater owning the transition.
|
|
@param collectionView The collection view that will perform the batch updates.
|
|
*/
|
|
- (void)listAdapterUpdater:(IGListAdapterUpdater *)listAdapterUpdater willPerformBatchUpdatesWithCollectionView:(UICollectionView *)collectionView;
|
|
|
|
/**
|
|
Notifies the delegate that the updater succesfully finished `-[UICollectionView performBatchUpdates:completion:]`.
|
|
|
|
@param listAdapterUpdater The adapter updater owning the transition.
|
|
@param updates The batch updates that were applied to the collection view.
|
|
@param collectionView The collection view that performed the batch updates.
|
|
|
|
@note This event is called in the completion block of the batch update.
|
|
*/
|
|
- (void)listAdapterUpdater:(IGListAdapterUpdater *)listAdapterUpdater
|
|
didPerformBatchUpdates:(IGListBatchUpdateData *)updates
|
|
withCollectionView:(UICollectionView *)collectionView;
|
|
|
|
/**
|
|
Notifies the delegate that the updater will call `-[UICollectionView insertItemsAtIndexPaths:]`.
|
|
|
|
@param listAdapterUpdater The adapter updater owning the transition.
|
|
@param indexPaths An array of index paths that will be inserted.
|
|
@param collectionView The collection view that will perform the insert.
|
|
|
|
@note This event is only sent when outside of `-[UICollectionView performBatchUpdates:completion:]`.
|
|
*/
|
|
- (void)listAdapterUpdater:(IGListAdapterUpdater *)listAdapterUpdater
|
|
willInsertIndexPaths:(NSArray<NSIndexPath *> *)indexPaths
|
|
collectionView:(UICollectionView *)collectionView;
|
|
|
|
/**
|
|
Notifies the delegate that the updater will call `-[UICollectionView deleteItemsAtIndexPaths:]`.
|
|
|
|
@param listAdapterUpdater The adapter updater owning the transition.
|
|
@param indexPaths An array of index paths that will be deleted.
|
|
@param collectionView The collection view that will perform the delete.
|
|
|
|
@note This event is only sent when outside of `-[UICollectionView performBatchUpdates:completion:]`.
|
|
*/
|
|
- (void)listAdapterUpdater:(IGListAdapterUpdater *)listAdapterUpdater
|
|
willDeleteIndexPaths:(NSArray<NSIndexPath *> *)indexPaths
|
|
collectionView:(UICollectionView *)collectionView;
|
|
|
|
/**
|
|
Notifies the delegate that the updater will call `-[UICollectionView moveItemAtIndexPath:toIndexPath:]`
|
|
|
|
@param listAdapterUpdater The adapter updater owning the transition.
|
|
@param fromIndexPath The index path of the item that will be moved.
|
|
@param toIndexPath The index path to move the item to.
|
|
@param collectionView The collection view that will perform the move.
|
|
|
|
@note This event is only sent when outside of `-[UICollectionView performBatchUpdates:completion:]`.
|
|
*/
|
|
- (void)listAdapterUpdater:(IGListAdapterUpdater *)listAdapterUpdater
|
|
willMoveFromIndexPath:(NSIndexPath *)fromIndexPath
|
|
toIndexPath:(NSIndexPath *)toIndexPath
|
|
collectionView:(UICollectionView *)collectionView;
|
|
|
|
/**
|
|
Notifies the delegate that the updater will call `-[UICollectionView reloadItemsAtIndexPaths:]`.
|
|
|
|
@param listAdapterUpdater The adapter updater owning the transition.
|
|
@param indexPaths An array of index paths that will be reloaded.
|
|
@param collectionView The collection view that will perform the reload.
|
|
|
|
@note This event is only sent when outside of `-[UICollectionView performBatchUpdates:completion:]`.
|
|
*/
|
|
- (void)listAdapterUpdater:(IGListAdapterUpdater *)listAdapterUpdater
|
|
willReloadIndexPaths:(NSArray<NSIndexPath *> *)indexPaths
|
|
collectionView:(UICollectionView *)collectionView;
|
|
|
|
/**
|
|
Notifies the delegate that the updater will call `-[UICollectionView reloadSections:]`.
|
|
|
|
@param listAdapterUpdater The adapter updater owning the transition.
|
|
@param sections The sections that will be reloaded
|
|
@param collectionView The collection view that will perform the reload.
|
|
|
|
@note This event is only sent when outside of `-[UICollectionView performBatchUpdates:completion:]`.
|
|
*/
|
|
- (void)listAdapterUpdater:(IGListAdapterUpdater *)listAdapterUpdater
|
|
willReloadSections:(NSIndexSet *)sections
|
|
collectionView:(UICollectionView *)collectionView;
|
|
|
|
/**
|
|
Notifies the delegate that the updater will call `-[UICollectionView reloadData]`.
|
|
|
|
@param listAdapterUpdater The adapter updater owning the transition.
|
|
@param collectionView The collection view that will be reloaded.
|
|
*/
|
|
- (void)listAdapterUpdater:(IGListAdapterUpdater *)listAdapterUpdater willReloadDataWithCollectionView:(UICollectionView *)collectionView;
|
|
|
|
/**
|
|
Notifies the delegate that the updater successfully called `-[UICollectionView reloadData]`.
|
|
|
|
@param listAdapterUpdater The adapter updater owning the transition.
|
|
@param collectionView The collection view that reloaded.
|
|
*/
|
|
- (void)listAdapterUpdater:(IGListAdapterUpdater *)listAdapterUpdater didReloadDataWithCollectionView:(UICollectionView *)collectionView;
|
|
|
|
/**
|
|
Notifies the delegate that the collection view threw an exception in `-[UICollectionView performBatchUpdates:completion:]`.
|
|
|
|
@param listAdapterUpdater The adapter updater owning the transition.
|
|
@param exception The exception thrown by the collection view.
|
|
@param fromObjects The items transitioned from in the diff, if any.
|
|
@param toObjects The items transitioned to in the diff, if any.
|
|
@param updates The batch updates that were applied to the collection view.
|
|
*/
|
|
- (void)listAdapterUpdater:(IGListAdapterUpdater *)listAdapterUpdater
|
|
willCrashWithException:(NSException *)exception
|
|
fromObjects:(nullable NSArray *)fromObjects
|
|
toObjects:(nullable NSArray *)toObjects
|
|
updates:(IGListBatchUpdateData *)updates;
|
|
|
|
@end
|
|
|
|
NS_ASSUME_NONNULL_END
|