mirror of
https://github.com/Instagram/IGListKit
synced 2026-05-11 03:20:55 +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
88 lines
2.4 KiB
Objective-C
88 lines
2.4 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>
|
|
|
|
#import <IGListKit/IGListMacros.h>
|
|
#import <IGListKit/IGListMoveIndex.h>
|
|
#import <IGListKit/IGListMoveIndexPath.h>
|
|
|
|
NS_ASSUME_NONNULL_BEGIN
|
|
|
|
/**
|
|
An instance of `IGListBatchUpdateData` takes section indexes and item index paths
|
|
and performs cleanup on init in order to perform a crash-free
|
|
update via `-[UICollectionView performBatchUpdates:completion:]`.
|
|
*/
|
|
IGLK_SUBCLASSING_RESTRICTED
|
|
NS_SWIFT_NAME(ListBatchUpdateData)
|
|
@interface IGListBatchUpdateData : NSObject
|
|
|
|
/**
|
|
Section insert indexes.
|
|
*/
|
|
@property (nonatomic, strong, readonly) NSIndexSet *insertSections;
|
|
|
|
/**
|
|
Section delete indexes.
|
|
*/
|
|
@property (nonatomic, strong, readonly) NSIndexSet *deleteSections;
|
|
|
|
/**
|
|
Section moves.
|
|
*/
|
|
@property (nonatomic, strong, readonly) NSSet<IGListMoveIndex *> *moveSections;
|
|
|
|
/**
|
|
Item insert index paths.
|
|
*/
|
|
@property (nonatomic, strong, readonly) NSArray<NSIndexPath *> *insertIndexPaths;
|
|
|
|
/**
|
|
Item delete index paths.
|
|
*/
|
|
@property (nonatomic, strong, readonly) NSArray<NSIndexPath *> *deleteIndexPaths;
|
|
|
|
/**
|
|
Item moves.
|
|
*/
|
|
@property (nonatomic, strong, readonly) NSArray<IGListMoveIndexPath *> *moveIndexPaths;
|
|
|
|
/**
|
|
Creates a new batch update object with section and item operations.
|
|
|
|
@param insertSections Section indexes to insert.
|
|
@param deleteSections Section indexes to delete.
|
|
@param moveSections Section moves.
|
|
@param insertIndexPaths Item index paths to insert.
|
|
@param deleteIndexPaths Item index paths to delete.
|
|
@param moveIndexPaths Item index paths to move.
|
|
|
|
@return A new batch update object.
|
|
*/
|
|
- (instancetype)initWithInsertSections:(NSIndexSet *)insertSections
|
|
deleteSections:(NSIndexSet *)deleteSections
|
|
moveSections:(NSSet<IGListMoveIndex *> *)moveSections
|
|
insertIndexPaths:(NSArray<NSIndexPath *> *)insertIndexPaths
|
|
deleteIndexPaths:(NSArray<NSIndexPath *> *)deleteIndexPaths
|
|
moveIndexPaths:(NSArray<IGListMoveIndexPath *> *)moveIndexPaths NS_DESIGNATED_INITIALIZER;
|
|
|
|
/**
|
|
:nodoc:
|
|
*/
|
|
- (instancetype)init NS_UNAVAILABLE;
|
|
|
|
/**
|
|
:nodoc:
|
|
*/
|
|
+ (instancetype)new NS_UNAVAILABLE;
|
|
|
|
@end
|
|
|
|
NS_ASSUME_NONNULL_END
|