mirror of
https://github.com/Instagram/IGListKit
synced 2026-05-15 13:28:18 +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
84 lines
3 KiB
Objective-C
84 lines
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/IGListMacros.h>
|
|
|
|
#import <IGListKit/IGListSectionController.h>
|
|
#import <IGListKit/IGListBindingSectionControllerSelectionDelegate.h>
|
|
#import <IGListKit/IGListBindingSectionControllerDataSource.h>
|
|
|
|
@protocol IGListDiffable;
|
|
@protocol IGListBindable;
|
|
|
|
@class IGListBindingSectionController;
|
|
|
|
NS_ASSUME_NONNULL_BEGIN
|
|
|
|
/**
|
|
This section controller uses a data source to transform its "top level" object into an array of diffable view models.
|
|
It then automatically binds each view model to cells via the `IGListBindable` protocol.
|
|
|
|
Models used with `IGListBindingSectionController` should take special care to always return `YES` for identical
|
|
objects. That is, any objects with matching `-diffIdentifier`s should always be equal, that way the section controller
|
|
can create new view models via the data source, create a diff, and update the specific cells that have changed.
|
|
|
|
In Objective-C, your `-isEqualToDiffableObject:` can simply be:
|
|
```
|
|
- (BOOL)isEqualToDiffableObject:(id)object {
|
|
return YES;
|
|
}
|
|
```
|
|
|
|
In Swift:
|
|
```
|
|
func isEqual(toDiffableObject object: IGListDiffable?) -> Bool {
|
|
return true
|
|
}
|
|
```
|
|
|
|
Only when `-diffIdentifier`s match is object equality compared, so you can assume the class is the same, and the
|
|
instance has already been checked.
|
|
*/
|
|
NS_SWIFT_NAME(ListBindingSectionController)
|
|
@interface IGListBindingSectionController<__covariant ObjectType : id<IGListDiffable>> : IGListSectionController
|
|
|
|
/**
|
|
A data source that transforms a top-level object into view models, and returns cells and sizes for given view models.
|
|
*/
|
|
@property (nonatomic, weak, nullable) id<IGListBindingSectionControllerDataSource> dataSource;
|
|
|
|
/**
|
|
A delegate that receives selection events from cells in an `IGListBindingSectionController` instance.
|
|
*/
|
|
@property (nonatomic, weak, nullable) id<IGListBindingSectionControllerSelectionDelegate> selectionDelegate;
|
|
|
|
/**
|
|
The object currently assigned to the section controller, if any.
|
|
*/
|
|
@property (nonatomic, strong, readonly, nullable) ObjectType object;
|
|
|
|
/**
|
|
The array of view models created from the data source. Values are changed when the top-level object changes or by
|
|
calling `-updateAnimated:completion:` manually.
|
|
*/
|
|
@property (nonatomic, strong, readonly) NSArray<id<IGListDiffable>> *viewModels;
|
|
|
|
/**
|
|
Tells the section controller to query for new view models, diff the changes, and update its cells.
|
|
|
|
@param animated A flag indicating if the transition should be animated or not.
|
|
@param completion An optional completion block executed after updates finish. Parameter is YES if updates were applied.
|
|
*/
|
|
- (void)updateAnimated:(BOOL)animated completion:(nullable void (^)(BOOL updated))completion;
|
|
|
|
@end
|
|
|
|
NS_ASSUME_NONNULL_END
|