IGListKit/Source/IGListBindingSectionControllerDataSource.h
Ryan Nystrom 8d8a632b67 Update MIT license language (#1272)
Summary:
Updating license language to meet FB open source standards.
Pull Request resolved: https://github.com/Instagram/IGListKit/pull/1272

Differential Revision: D12844366

Pulled By: rnystrom

fbshipit-source-id: 27ae49ae00d963c5c012c79c5738365c232a5773
2018-11-01 10:58:46 -07:00

65 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>
@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