mirror of
https://github.com/Instagram/IGListKit
synced 2026-05-22 16:58:23 +00:00
40625f8ff9
Summary: This adds `NS_SWIFT_NAME` annotations to all public API's to provide cleaner integration into Swift: - Removes the need to prefix classes in Swift code, instead rely on Swift module name spacing - Adds more argument labels to C function API's like `IGListDiff([], [], .equality)` => `ListDiff(oldArray: [], newArray: [], option: .equality)` While this is a large API change it should be as easy as: - Find and replace `(IGList)([^K])` to `List$2` in Xcode with a scope set to Swift - Build and follow compiler's auto fix corrections for C API's or any missed renames I have not updated the documentation to reflect this yet, I am totally willing to do so but before I sink that amount of time into it I wanted to see if the Instagram team is even open to this change! - [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) - [ ] I have updated the documentation Closes https://github.com/Instagram/IGListKit/pull/593 Reviewed By: jessesquires Differential Revision: D5028039 Pulled By: rnystrom fbshipit-source-id: b473d874a1f9574e56b2ebaabd5b73d1b57d4bab
72 lines
2.2 KiB
Objective-C
72 lines
2.2 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;
|
|
|
|
@end
|
|
|
|
NS_ASSUME_NONNULL_END
|