Swiftgram/Source/Details/ASCollectionLayoutDelegate.h
Huy Nguyen 78c133e44c [ASCollectionLayout] Add ASCollectionGalleryLayoutSizeProviding (#451)
* Add ASCollectionGalleryLayoutSizeProviding
- This allows users to return different sizes based on certain conditions, such as the collection node's bounds or grid constants.
- ASPagerNode will also act as a size provider to ensure all pages have an up-to-date size that is its bounds.

* Update CHANGELOG

* ASPagerNode to use gallery layout delegate if told to
2017-07-18 10:08:12 +00:00

68 lines
2.8 KiB
Objective-C

//
// ASCollectionLayoutDelegate.h
// Texture
//
// Copyright (c) 2014-present, Facebook, Inc. All rights reserved.
// This source code is licensed under the BSD-style license found in the
// LICENSE file in the /ASDK-Licenses directory of this source tree. An additional
// grant of patent rights can be found in the PATENTS file in the same directory.
//
// Modifications to this file made after 4/13/2017 are: Copyright (c) 2017-present,
// Pinterest, Inc. Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
#import <Foundation/Foundation.h>
#import <UIKit/UIKit.h>
#import <AsyncDisplayKit/ASScrollDirection.h>
@class ASElementMap, ASCollectionLayoutContext, ASCollectionLayoutState;
NS_ASSUME_NONNULL_BEGIN
@protocol ASCollectionLayoutDelegate <NSObject>
/**
* @abstract Returns the scrollable directions of the coming layout (@see @c -calculateLayoutWithContext:).
* It will be available in the context parameter in +calculateLayoutWithContext:
*
* @return The scrollable directions.
*
* @discusstion This method will be called on main thread.
*/
- (ASScrollDirection)scrollableDirections;
/**
* @abstract Returns any additional information needed for a coming layout pass (@see @c -calculateLayoutWithContext:) with the given elements.
*
* @param elements The elements to be laid out later.
*
* @discussion The returned object must support equality and hashing (i.e `-isEqual:` and `-hash` must be properly implemented).
* It should contain all the information needed for the layout pass to perform. It will be available in the context parameter in +calculateLayoutWithContext:
*
* This method will be called on main thread.
*/
- (nullable id)additionalInfoForLayoutWithElements:(ASElementMap *)elements;
/**
* @abstract Prepares and returns a new layout for given context.
*
* @param context A context that contains all elements to be laid out and any additional information needed.
*
* @return The new layout calculated for the given context.
*
* @discussion This method is called ahead of time, i.e before the underlying collection/table view is aware of the provided elements.
* As a result, clients must solely rely on the given context and should not reach out to other objects for information not available in the context.
*
* This method can be called on background theads. It must be thread-safe and should not change any internal state of this delegate.
* It must block the calling thread but can dispatch to other theads to reduce total blocking time.
*/
+ (ASCollectionLayoutState *)calculateLayoutWithContext:(ASCollectionLayoutContext *)context;
@end
NS_ASSUME_NONNULL_END