mirror of
https://github.com/Instagram/IGListKit
synced 2026-05-22 16:58:23 +00:00
f15b167e85
Summary: I had a desire for interactive reordering in a personal project, so here's a first attempt at adding support in IGListKit. I figured I might as well get a WIP PR up for comments before I continue further as there are a few aspects to interactive reordering that don't interplay perfectly with IGListKit. As discussed in #291, I went after two prime use cases: 1. Moving items amongst a section 2. Rearranging whole sections I also "disabled" moving items between sections by having those moves revert, to mimic interactive reordering cancellation as closely as possible. You can see both in the Mixed Data example. Grid items can be moved within a section, while users can be moved to reorder whole sections. But trying to move a grid item out of a grid or a user item into a grid will auto-revert. The revert animation isn't as tight as it should be. It may be more desirable to disable the animation - though you lose the visual cue. There is a also a new example, `ReorderableViewController`, that demonstrates 2 in its pure form (likely the most desired use case), where all sections are reorderable single rows. Happy to take feedback -- this is my first experience working on IGListKit, so I would expect there to be gaps. (Ex. I haven't used `IGListStackedSectionController`, and its tests failed as I hadn't implemented reordering delegates for it. Those are simply stubbed out for now.) Issue fixed: #291 - [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/master/.github/CONTRIBUTING.md) - [x] Proper support in `IGListStackedSectionController` Closes https://github.com/Instagram/IGListKit/pull/976 Differential Revision: D6674493 Pulled By: rnystrom fbshipit-source-id: cd53c5fdc6fb59636edc4747c4bbd0f81a4610e5
102 lines
3.6 KiB
Objective-C
102 lines
3.6 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 <Foundation/Foundation.h>
|
|
|
|
@class IGListSectionController;
|
|
|
|
|
|
|
|
NS_ASSUME_NONNULL_BEGIN
|
|
|
|
/**
|
|
Objects conforming to the IGListBatchContext protocol provide a way for section controllers to mutate their cells or
|
|
reload everything within the section.
|
|
*/
|
|
NS_SWIFT_NAME(ListBatchContext)
|
|
@protocol IGListBatchContext <NSObject>
|
|
|
|
/**
|
|
Reloads cells in the section controller.
|
|
|
|
@param sectionController The section controller who's cells need reloading.
|
|
@param indexes The indexes of items that need reloading.
|
|
*/
|
|
- (void)reloadInSectionController:(IGListSectionController *)sectionController
|
|
atIndexes:(NSIndexSet *)indexes;
|
|
|
|
/**
|
|
Inserts cells in the list.
|
|
|
|
@param sectionController The section controller who's cells need inserting.
|
|
@param indexes The indexes of items that need inserting.
|
|
*/
|
|
- (void)insertInSectionController:(IGListSectionController *)sectionController
|
|
atIndexes:(NSIndexSet *)indexes;
|
|
|
|
/**
|
|
Deletes cells in the list.
|
|
|
|
@param sectionController The section controller who's cells need deleted.
|
|
@param indexes The indexes of items that need deleting.
|
|
*/
|
|
- (void)deleteInSectionController:(IGListSectionController *)sectionController
|
|
atIndexes:(NSIndexSet *)indexes;
|
|
|
|
/**
|
|
Moves a cell from one index to another within the section controller.
|
|
|
|
@param sectionController The section controller who's cell needs moved.
|
|
@param fromIndex The index the cell is currently in.
|
|
@param toIndex The index the cell should move to.
|
|
*/
|
|
- (void)moveInSectionController:(IGListSectionController *)sectionController
|
|
fromIndex:(NSInteger)fromIndex
|
|
toIndex:(NSInteger)toIndex;
|
|
|
|
/**
|
|
Reloads the entire section controller.
|
|
|
|
@param sectionController The section controller who's cells need reloading.
|
|
*/
|
|
- (void)reloadSectionController:(IGListSectionController *)sectionController;
|
|
|
|
/**
|
|
Moves a section controller from one index to another during interactive reordering.
|
|
|
|
@param sectionController The section controller to move.
|
|
@param fromIndex The index where the section currently resides.
|
|
@param toIndex The index the section should move to.
|
|
*/
|
|
- (void)moveSectionControllerInteractive:(IGListSectionController *)sectionController
|
|
fromIndex:(NSInteger)fromIndex
|
|
toIndex:(NSInteger)toIndex NS_AVAILABLE_IOS(9_0);
|
|
|
|
/**
|
|
Moves an object within a section controller from one index to another during interactive reordering.
|
|
|
|
@param sectionController The section controller containing the object to move.
|
|
@param fromIndex The index where the object currently resides.
|
|
@param toIndex The index the object should move to.
|
|
*/
|
|
- (void)moveInSectionControllerInteractive:(IGListSectionController *)sectionController
|
|
fromIndex:(NSInteger)fromIndex
|
|
toIndex:(NSInteger)toIndex NS_AVAILABLE_IOS(9_0);
|
|
|
|
/**
|
|
Reverts an move from one indexPath to another during interactive reordering.
|
|
|
|
@param sourceIndexPath The indexPath the item was originally in.
|
|
@param destinationIndexPath The indexPath the item was moving to.
|
|
*/
|
|
- (void)revertInvalidInteractiveMoveFromIndexPath:(NSIndexPath *)sourceIndexPath
|
|
toIndexPath:(NSIndexPath *)destinationIndexPath NS_AVAILABLE_IOS(9_0);
|
|
@end
|
|
|
|
NS_ASSUME_NONNULL_END
|