mirror of
https://github.com/Instagram/IGListKit
synced 2026-05-06 15:08:50 +00:00
3102852ce2
Summary: Removing the `IGListSectionType` protocol and adding default implementations into `IGListSectionController`. - `numberOfItems` returns 1 - `cellForItemAtIndex:` asserts (have to return a cell) - `didUpdateToObject:` no-ops - `didSelectItemAtIndex:` no-ops Fixes #168 Reviewed By: jessesquires Differential Revision: D4909585 fbshipit-source-id: 8816702504e3fc0683868914ff4dd20e4af7c166
130 lines
5 KiB
Objective-C
130 lines
5 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 <UIKit/UIKit.h>
|
|
|
|
#import <IGListKit/IGListSectionController.h>
|
|
|
|
#import <IGListKit/IGListMacros.h>
|
|
|
|
NS_ASSUME_NONNULL_BEGIN
|
|
|
|
|
|
/**
|
|
A block used to configure cells.
|
|
|
|
@param item The model with which to configure the cell.
|
|
@param cell The cell to configure.
|
|
*/
|
|
typedef void (^IGListSingleSectionCellConfigureBlock)(id item, __kindof UICollectionViewCell *cell);
|
|
|
|
/**
|
|
A block that returns the size for the cell given the collection context.
|
|
|
|
@param item The model for the section.
|
|
@param collectionContext The collection context for the section.
|
|
|
|
@return The size for the cell.
|
|
*/
|
|
typedef CGSize (^IGListSingleSectionCellSizeBlock)(id item, id<IGListCollectionContext> _Nullable collectionContext);
|
|
|
|
@class IGListSingleSectionController;
|
|
|
|
/**
|
|
A delegate that can receive selection events on an `IGListSingleSectionController`.
|
|
*/
|
|
@protocol IGListSingleSectionControllerDelegate <NSObject>
|
|
|
|
/**
|
|
Tells the delegate that the section controller was selected.
|
|
|
|
@param sectionController The section controller that was selected.
|
|
@param object The model for the given section.
|
|
*/
|
|
- (void)didSelectSectionController:(IGListSingleSectionController *)sectionController
|
|
withObject:(id)object;
|
|
|
|
@end
|
|
|
|
/**
|
|
This section controller is meant to make building simple, single-cell lists easier. By providing the type of cell, a block
|
|
to configure the cell, and a block to return the size of a cell, you can use an `IGListAdapter`-powered list with a
|
|
simpler architecture.
|
|
*/
|
|
IGLK_SUBCLASSING_RESTRICTED
|
|
@interface IGListSingleSectionController : IGListSectionController
|
|
|
|
/**
|
|
Creates a new section controller for a given cell type that will always have only one cell when present in a list.
|
|
|
|
@param cellClass The `UICollectionViewCell` subclass for the single cell.
|
|
@param configureBlock A block that configures the cell with the item given to the section controller.
|
|
@param sizeBlock A block that returns the size for the cell given the collection context.
|
|
|
|
@return A new section controller.
|
|
|
|
@warning Be VERY CAREFUL not to create retain cycles by holding strong references to: the object that owns the adapter
|
|
(usually `self`) or the `IGListAdapter`. Pass in locally scoped objects or use `weak` references!
|
|
*/
|
|
- (instancetype)initWithCellClass:(Class)cellClass
|
|
configureBlock:(IGListSingleSectionCellConfigureBlock)configureBlock
|
|
sizeBlock:(IGListSingleSectionCellSizeBlock)sizeBlock;
|
|
|
|
/**
|
|
Creates a new section controller for a given nib name and bundle that will always have only one cell when present in a list.
|
|
|
|
@param nibName The name of the nib file for the single cell.
|
|
@param bundle The bundle in which to search for the nib file. If `nil`, this method looks for the file in the main bundle.
|
|
@param configureBlock A block that configures the cell with the item given to the section controller.
|
|
@param sizeBlock A block that returns the size for the cell given the collection context.
|
|
|
|
@return A new section controller.
|
|
|
|
@warning Be VERY CAREFUL not to create retain cycles by holding strong references to: the object that owns the adapter
|
|
(usually `self`) or the `IGListAdapter`. Pass in locally scoped objects or use `weak` references!
|
|
*/
|
|
- (instancetype)initWithNibName:(NSString *)nibName
|
|
bundle:(nullable NSBundle *)bundle
|
|
configureBlock:(IGListSingleSectionCellConfigureBlock)configureBlock
|
|
sizeBlock:(IGListSingleSectionCellSizeBlock)sizeBlock;
|
|
|
|
/**
|
|
Creates a new section controller for a given storyboard cell identifier that will always have only one cell when present in a list.
|
|
|
|
@param identifier The identifier of the cell prototype in storyboard.
|
|
@param configureBlock A block that configures the cell with the item given to the section controller.
|
|
@param sizeBlock A block that returns the size for the cell given the collection context.
|
|
|
|
@return A new section controller.
|
|
|
|
@warning Be VERY CAREFUL not to create retain cycles by holding strong references to: the object that owns the adapter
|
|
(usually `self`) or the `IGListAdapter`. Pass in locally scoped objects or use `weak` references!
|
|
*/
|
|
- (instancetype)initWithStoryboardCellIdentifier:(NSString *)identifier
|
|
configureBlock:(IGListSingleSectionCellConfigureBlock)configureBlock
|
|
sizeBlock:(IGListSingleSectionCellSizeBlock)sizeBlock;
|
|
|
|
/**
|
|
An optional delegate that handles selection and deselection.
|
|
*/
|
|
@property (nonatomic, weak, nullable) id<IGListSingleSectionControllerDelegate> selectionDelegate;
|
|
|
|
/**
|
|
:nodoc:
|
|
*/
|
|
- (instancetype)init NS_UNAVAILABLE;
|
|
|
|
/**
|
|
:nodoc:
|
|
*/
|
|
+ (instancetype)new NS_UNAVAILABLE;
|
|
|
|
@end
|
|
|
|
NS_ASSUME_NONNULL_END
|