mirror of
https://github.com/Instagram/IGListKit
synced 2026-05-14 21:08:48 +00:00
Summary: Started work on the plane to get this moving since #418 is up and ready to land. We'll likely need to spend some time fleshing out the API of this, and I think I'll split it up into a couple different PRs once ready for review. Putting this up now to get early feedback. This adds an auto-diffing section controller as outlined in #38. There are several key parts: - Subclass a new section controller `IGListAutoSectionController` (naming wip) - Connect a data source - Implement the data source methods that do 3 things: - Given a top-level object, transform it into an array of **diffable** view models - Given a view model, return a cell - Given a view model, return a size for a cell - A new protocol for the cell `IGListBindable` so that we can control when the cell is updated w/ the view model. - The most important part of this is that it unlocks moving and reloading a cell, which you can't do w/ `UICollectionView` - [ ] Unit test `reloadObjects:` - [x] Add Closes https://github.com/Instagram/IGListKit/pull/494 Reviewed By: amonshiz Differential Revision: D4696966 Pulled By: rnystrom fbshipit-source-id: f21b8341b3ed4389f2a4a106d0d316f481ba6943
63 lines
2.2 KiB
Objective-C
63 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`.
|
|
*/
|
|
@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
|