ios/sdk/WeexSDK/Sources/Component/WXScrollerComponent.h

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

#import <WeexSDK/WXScrollerProtocol.h>
#import <WeexSDK/WXComponent.h>

NS_ASSUME_NONNULL_BEGIN

@class WXScrollSnapData, WXScrollAnimator;

@interface WXScrollerComponent : WXComponent <WXScrollerProtocol, UIScrollViewDelegate>

@property (nonatomic, copy) void (^onScroll)(UIScrollView *scrollView);

@property (nonatomic, copy) void (^scrollEventListener)(WXScrollerComponent* sender, NSString* event, NSDictionary* _Nullable params);

@property (nonatomic, assign) NSUInteger loadmoreretry;

@property (nonatomic, assign) CGSize contentSize;

@property (nonatomic, strong) WXScrollSnapData *snapData;

@property (nonatomic, strong) WXScrollAnimator * _Nullable scrollAnimator;

- (void)handleAppear;

- (CGPoint)absolutePositionForComponent:(WXComponent *)component;

@end

typedef NS_ENUM(NSUInteger, WXScrollSnapStatus) {
    WXScrollSnapToNext,
    WXScrollSnapToPrev,
    WXScrollSnapStay,
    WXScrollSnapNone,
};

typedef NS_ENUM(NSUInteger, WXScrollSnapAlignment) {
    WXScrollSnapAlignStart,
    WXScrollSnapAlignCenter,
    WXScrollSnapAlignEnd,
    WXScrollSnapAlignNone,
};

typedef NS_ENUM(NSUInteger, WXScrollAnimateFunction) {
    WXScrollAnimateNone = 0,
    WXScrollAnimateLinear,
    WXScrollAnimateQuadOut,
    WXScrollAnimateQuadInOut,
    WXScrollAnimateQuadIn,
    WXScrollAnimateCubicIn,
    WXScrollAnimateCubicOut,
    WXScrollAnimateCubicInOut,
    WXScrollAnimateQuartIn,
    WXScrollAnimateQuartOut,
    WXScrollAnimateQuartInOut,
    WXScrollAnimateSineIn,
    WXScrollAnimateSineOut,
    WXScrollAnimateSineInOut,
    WXScrollAnimateQuintIn,
    WXScrollAnimateQuintOut,
    WXScrollAnimateQuintInOut,
    WXScrollAnimateExpoIn,
    WXScrollAnimateExpoOut,
    WXScrollAnimateExpoInOut,
    WXScrollAnimateCircleIn,
    WXScrollAnimateCircleOut,
    WXScrollAnimateCircleInOut,
};

@interface WXScrollSnapData : NSObject

@property (nonatomic, assign) BOOL useSnap;

@property (nonatomic, assign) WXScrollDirection axis;

@property (nonatomic, assign) WXScrollSnapAlignment alignment;

@property (nonatomic, assign) UIEdgeInsets padding;

@property (nonatomic, strong) NSIndexPath *targetIndexPath;

@property (nonatomic, weak) UIScrollView *scrollView;

@property (nonatomic, assign) CGPoint startPosition;

@property (nonatomic, assign) CGPoint targetPosition;

@property (nonatomic, assign) BOOL snapping;

/// scroll animate
@property (nonatomic, assign) WXScrollAnimateFunction timingFunction;
@property (nonatomic, assign) CGFloat scrollAnimateDuration;

/// bind scrollView
- (void)bindingScrollView:(UIScrollView *)scrollView;
/// calc snap status;
- (WXScrollSnapStatus)shouldTriggerSnap:(CGPoint)offset velocity:(CGPoint)velocity;
/// 
- (CGFloat)calcScrollSnapPositionOffset;

@end

typedef void(^WXScrollAnimatorCompletion)(void);

@interface WXScrollAnimator : NSObject

@property (nonatomic, weak) UIScrollView *scrollView;

@property (nonatomic, assign) WXScrollAnimateFunction timingFunction;

@property (nonatomic, assign) NSTimeInterval startTime;
@property (nonatomic, assign) NSTimeInterval duration;
@property (nonatomic, assign) NSTimeInterval runTime;

@property (nonatomic, assign) CGPoint startOffset;
@property (nonatomic, assign) CGPoint destinationOffset;

@property (nonatomic, copy) WXScrollAnimatorCompletion completion;

@property (nonatomic, strong) CADisplayLink *timer;

- (instancetype)initWithScrollView:(UIScrollView *)scrollView timingFunction:(WXScrollAnimateFunction)timingFunction;

- (void)setContentOffset:(CGPoint)offset duration:(NSTimeInterval)duration;

- (CGFloat)computeAnimateWithTime:(CGFloat)time begin:(CGFloat)begin change:(CGFloat)change duration:(CGFloat)duration;

@end

NS_ASSUME_NONNULL_END