mirror of
https://github.com/Instagram/IGListKit
synced 2026-05-24 09:48:21 +00:00
bfc97f908f
Summary: Issue fixed: #1220 - [x] All tests pass. Demo project builds and runs. - [x] Added proper documentation to the decelerate param. The documentation is taken from [Apple docs](https://developer.apple.com/documentation/uikit/uiscrollviewdelegate/1619436-scrollviewdidenddragging) - [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) - This is my first pull request for IGListKit so please let me know if I am following the pattern correctly or not. Pull Request resolved: https://github.com/Instagram/IGListKit/pull/1222 Differential Revision: D8990058 Pulled By: rnystrom fbshipit-source-id: 7011427c242a61efb79183dbb588c11086926180
63 lines
2.2 KiB
Objective-C
63 lines
2.2 KiB
Objective-C
/**
|
|
* Copyright (c) 2016-present, Facebook, Inc.
|
|
*
|
|
* This source code is licensed under the MIT license found in the
|
|
* LICENSE file in the root directory of this source tree.
|
|
*/
|
|
|
|
#import <UIKit/UIKit.h>
|
|
|
|
@class IGListAdapter;
|
|
@class IGListSectionController;
|
|
|
|
|
|
|
|
NS_ASSUME_NONNULL_BEGIN
|
|
|
|
/**
|
|
Implement this protocol to receive display events for a section controller when it is on screen.
|
|
*/
|
|
NS_SWIFT_NAME(ListScrollDelegate)
|
|
@protocol IGListScrollDelegate <NSObject>
|
|
|
|
/**
|
|
Tells the delegate that the section controller was scrolled on screen.
|
|
|
|
@param listAdapter The list adapter whose collection view was scrolled.
|
|
@param sectionController The visible section controller that was scrolled.
|
|
*/
|
|
- (void)listAdapter:(IGListAdapter *)listAdapter didScrollSectionController:(IGListSectionController *)sectionController;
|
|
|
|
/**
|
|
Tells the delegate that the section controller will be dragged on screen.
|
|
|
|
@param listAdapter The list adapter whose collection view will drag.
|
|
@param sectionController The visible section controller that will drag.
|
|
*/
|
|
- (void)listAdapter:(IGListAdapter *)listAdapter willBeginDraggingSectionController:(IGListSectionController *)sectionController;
|
|
|
|
/**
|
|
Tells the delegate that the section controller did end dragging on screen.
|
|
|
|
@param listAdapter The list adapter whose collection view ended dragging.
|
|
@param sectionController The visible section controller that ended dragging.
|
|
@param decelerate 'Yes' if the scrolling movement will continue, but decelerate, after a touch-up gesture during a
|
|
dragging operation. If the value is 'No', scrolling stops immediately upon touch-up.
|
|
*/
|
|
- (void)listAdapter:(IGListAdapter *)listAdapter didEndDraggingSectionController:(IGListSectionController *)sectionController willDecelerate:(BOOL)decelerate;
|
|
|
|
@optional
|
|
|
|
/**
|
|
Tells the delegate that the section controller did end decelerating on screen.
|
|
|
|
@param listAdapter The list adapter whose collection view ended decelerating.
|
|
@param sectionController The visible section controller that ended decelerating.
|
|
|
|
@note This method is `@optional` until the next breaking-change release.
|
|
*/
|
|
- (void)listAdapter:(IGListAdapter *)listAdapter didEndDeceleratingSectionController:(IGListSectionController *)sectionController;
|
|
|
|
@end
|
|
|
|
NS_ASSUME_NONNULL_END
|