mirror of
https://github.com/Instagram/IGListKit
synced 2026-05-18 14:58:34 +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
87 lines
2.3 KiB
Objective-C
87 lines
2.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 <Foundation/Foundation.h>
|
|
|
|
#import <IGListKit/IGListMoveIndexPath.h>
|
|
|
|
NS_ASSUME_NONNULL_BEGIN
|
|
|
|
/**
|
|
A result object returned when diffing with sections.
|
|
*/
|
|
NS_SWIFT_NAME(ListIndexPathResult)
|
|
@interface IGListIndexPathResult : NSObject
|
|
|
|
/**
|
|
The index paths inserted into the new collection.
|
|
*/
|
|
@property (nonatomic, copy, readonly) NSArray<NSIndexPath *> *inserts;
|
|
|
|
/**
|
|
The index paths deleted from the old collection.
|
|
*/
|
|
@property (nonatomic, copy, readonly) NSArray<NSIndexPath *> *deletes;
|
|
|
|
/**
|
|
The index paths in the old collection that need updated.
|
|
*/
|
|
@property (nonatomic, copy, readonly) NSArray<NSIndexPath *> *updates;
|
|
|
|
/**
|
|
The moves from an index path in the old collection to an index path in the new collection.
|
|
*/
|
|
@property (nonatomic, copy, readonly) NSArray<IGListMoveIndexPath *> *moves;
|
|
|
|
/**
|
|
A Read-only boolean that indicates whether the result has any changes or not.
|
|
`YES` if the result has changes, `NO` otherwise.
|
|
*/
|
|
@property (nonatomic, assign, readonly) BOOL hasChanges;
|
|
|
|
/**
|
|
Returns the index path of the object with the specified identifier *before* the diff.
|
|
|
|
@param identifier The diff identifier of the object.
|
|
|
|
@return The index path of the object before the diff, or `nil`.
|
|
|
|
@see `-[IGListDiffable diffIdentifier]`.
|
|
*/
|
|
- (nullable NSIndexPath *)oldIndexPathForIdentifier:(id<NSObject>)identifier;
|
|
|
|
/**
|
|
Returns the index path of the object with the specified identifier *after* the diff.
|
|
|
|
@param identifier The diff identifier of the object.
|
|
|
|
@return The index path of the object after the diff, or `nil`.
|
|
|
|
@see `-[IGListDiffable diffIdentifier]`.
|
|
*/
|
|
- (nullable NSIndexPath *)newIndexPathForIdentifier:(id<NSObject>)identifier;
|
|
|
|
/**
|
|
Creates a new result object with operations safe for use in `UITableView` and `UICollectionView` batch updates.
|
|
*/
|
|
- (IGListIndexPathResult *)resultForBatchUpdates;
|
|
|
|
/**
|
|
:nodoc:
|
|
*/
|
|
- (instancetype)init NS_UNAVAILABLE;
|
|
|
|
/**
|
|
:nodoc:
|
|
*/
|
|
+ (instancetype)new NS_UNAVAILABLE;
|
|
|
|
@end
|
|
|
|
NS_ASSUME_NONNULL_END
|