mirror of
https://github.com/Instagram/IGListKit
synced 2026-05-08 10:00:43 +00:00
e4c60650f2
Summary: Pull Request resolved: https://github.com/Instagram/IGListKit/pull/1377 This splits the diffing-only components from `IGListKit` out into a separate library, `IGListDiffKit`, allowing them to be used independently of the rest of `IGListKit`. We've found that the diffing components of the library are useful independently of the rest of the `UICollectionView` infrastructure, and separating the libraries allows apps to take advantage of those components without paying the full binary size cost of `IGListKit`. The diffing components are available as a subspec in Cocoapods, and as an independent framework in Carthage and direct Xcode project import (i.e. Git submodules). This is a breaking change, necessitating a major version bump, although it should have only minor impact for projects using the umbrella header `IGListKit.h`, as that header continues to import the diffing utilities. In particular, for a project using Cocoapods and importing `IGListKit.h`, there should be no code changes required. Reviewed By: calimarkus Differential Revision: D18114249 fbshipit-source-id: 363b5a427e32800bbc6e82f897230963b4167245
85 lines
2.1 KiB
Objective-C
85 lines
2.1 KiB
Objective-C
/**
|
|
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
*
|
|
* This source code is licensed under the MIT license found in the
|
|
* LICENSE file in the root directory of this source tree.
|
|
*/
|
|
|
|
#import <Foundation/Foundation.h>
|
|
|
|
#import <IGListDiffKit/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
|