mirror of
https://github.com/Instagram/IGListKit
synced 2026-05-06 06:58:26 +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
67 lines
2.2 KiB
Objective-C
67 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 IGListBindingSectionController;
|
|
|
|
@protocol IGListBindable;
|
|
@protocol IGListDiffable;
|
|
|
|
NS_ASSUME_NONNULL_BEGIN
|
|
|
|
/**
|
|
A protocol that returns data to power cells in an `IGListBindingSectionController`.
|
|
*/
|
|
NS_SWIFT_NAME(ListBindingSectionControllerDataSource)
|
|
@protocol IGListBindingSectionControllerDataSource <NSObject>
|
|
|
|
/**
|
|
Create an array of view models given a top-level object.
|
|
|
|
@param sectionController The section controller requesting view models.
|
|
@param object The top-level object that powers the section controller.
|
|
|
|
@return A new array of view models.
|
|
*/
|
|
- (NSArray<id<IGListDiffable>> *)sectionController:(IGListBindingSectionController *)sectionController
|
|
viewModelsForObject:(id)object;
|
|
|
|
/**
|
|
Return a dequeued cell for a given view model.
|
|
|
|
@param sectionController The section controller requesting a cell.
|
|
@param viewModel The view model for the cell.
|
|
@param index The index of the view model.
|
|
|
|
@return A dequeued cell.
|
|
|
|
@note The section controller will call `-bindViewModel:` with the provided view model after the cell is dequeued. You
|
|
should handle cell configuration using this method. However, you can do additional configuration at this stage as well.
|
|
*/
|
|
- (UICollectionViewCell<IGListBindable> *)sectionController:(IGListBindingSectionController *)sectionController
|
|
cellForViewModel:(id)viewModel
|
|
atIndex:(NSInteger)index;
|
|
|
|
/**
|
|
Return a cell size for a given view model.
|
|
|
|
@param sectionController The section controller requesting a size.
|
|
@param viewModel The view model for the cell.
|
|
@param index The index of the view model.
|
|
|
|
@return A size for the view model.
|
|
*/
|
|
- (CGSize)sectionController:(IGListBindingSectionController *)sectionController
|
|
sizeForViewModel:(id)viewModel
|
|
atIndex:(NSInteger)index;
|
|
|
|
@end
|
|
|
|
NS_ASSUME_NONNULL_END
|