reanimated-bottom-sheet/lib/typescript/index.d.ts

Bottom sheet component

import * as React from 'react';
import Animated from 'react-native-reanimated';
import { PanGestureHandler, TapGestureHandler } from 'react-native-gesture-handler';
declare type Props = {
    /**
     * Points for snapping of bottom sheet component. They define distance from bottom of the screen.
     * Might be number or percent (as string e.g. '20%') for points or percents of screen height from bottom.
     */
    snapPoints: (number | string)[];
    /**
     * Determines initial snap point of bottom sheet. Defaults to 0.
     */
    initialSnap: number;
    /**
     * Method for rendering scrollable content of bottom sheet.
     */
    renderContent?: () => React.ReactNode;
    /**
     * Method for rendering non-scrollable header of bottom sheet.
     */
    renderHeader?: () => React.ReactNode;
    /**
     * Defines if bottom sheet could be scrollable by gesture. Defaults to true.
     */
    enabledGestureInteraction?: boolean;
    enabledHeaderGestureInteraction?: boolean;
    enabledContentGestureInteraction?: boolean;
    /**
     * Defines if bottom sheet content responds to taps. Defaults to true.
     */
    enabledContentTapInteraction?: boolean;
    /**
     * When true, clamp bottom position to first snapPoint.
     */
    enabledBottomClamp?: boolean;
    /**
     * When true, sheet will grows up from bottom to initial snapPoint.
     */
    enabledBottomInitialAnimation?: boolean;
    /**
     * If false blocks snapping using snapTo method. Defaults to true.
     */
    enabledManualSnapping?: boolean;
    /**
     * Defines whether it's possible to scroll inner content of bottom sheet. Defaults to true.
     */
    enabledInnerScrolling?: boolean;
    /**
     * Reanimated node which holds position of bottom sheet, where 1 it the highest snap point and 0 is the lowest.
     */
    callbackNode?: Animated.Value<number>;
    /**
     * Reanimated node which holds position of bottom sheet;s content (in dp).
     */
    contentPosition?: Animated.Value<number>;
    /**
     * Reanimated node which holds position of bottom sheet's header (in dp).
     */
    headerPosition?: Animated.Value<number>;
    /**
     * Defines how violently sheet has to stopped while overdragging. 0 means no overdrag. Defaults to 0.
     */
    overdragResistanceFactor: number;
    /**
     * Array of Refs passed to gesture handlers for simultaneous event handling
     */
    simultaneousHandlers?: Array<React.RefObject<any>> | React.RefObject<any>;
    /**
     * Overrides config for spring animation
     */
    springConfig: {
        damping?: number;
        mass?: number;
        stiffness?: number;
        restSpeedThreshold?: number;
        restDisplacementThreshold?: number;
        toss?: number;
    };
    /**
     * Refs for gesture handlers used for building bottomsheet
     */
    innerGestureHandlerRefs: [React.RefObject<PanGestureHandler>, React.RefObject<PanGestureHandler>, React.RefObject<TapGestureHandler>];
    enabledImperativeSnapping?: boolean;
    onOpenStart?: () => void;
    onOpenEnd?: () => void;
    onCloseStart?: () => void;
    onCloseEnd?: () => void;
    callbackThreshold?: number;
    borderRadius?: number;
    overflow?: 'visible' | 'hidden';
};
declare type State = {
    snapPoints: Animated.Value<number>[];
    init: any;
    initSnap: number;
    propsToNewIndices: {
        [key: string]: number;
    };
    heightOfContent: Animated.Value<number>;
    heightOfHeader: number;
    heightOfHeaderAnimated: Animated.Value<number>;
};
export default class BottomSheetBehavior extends React.Component<Props, State> {
    static defaultProps: {
        overdragResistanceFactor: number;
        initialSnap: number;
        enabledImperativeSnapping: boolean;
        enabledGestureInteraction: boolean;
        enabledBottomClamp: boolean;
        enabledBottomInitialAnimation: boolean;
        enabledHeaderGestureInteraction: boolean;
        enabledContentGestureInteraction: boolean;
        enabledContentTapInteraction: boolean;
        enabledInnerScrolling: boolean;
        springConfig: {};
        innerGestureHandlerRefs: React.RefObject<{}>[];
        callbackThreshold: number;
    };
    private decayClock;
    private panState;
    private tapState;
    private velocity;
    private panMasterState;
    private masterVelocity;
    private isManuallySetValue;
    private manuallySetValue;
    private masterClockForOverscroll;
    private preventDecaying;
    private dragMasterY;
    private dragY;
    private translateMaster;
    private panRef;
    private master;
    private tapRef;
    private snapPoint;
    private Y;
    private clampingValue;
    private onOpenStartValue;
    private onOpenEndValue;
    private onCloseStartValue;
    private onCloseEndValue;
    constructor(props: Props);
    componentDidUpdate(_prevProps: Props, prevState: State): void;
    private runSpring;
    private handleMasterPan;
    private handlePan;
    private handleTap;
    private withEnhancedLimits;
    snapTo: (index: number) => void;
    private height;
    private handleLayoutHeader;
    private handleFullHeader;
    private handleLayoutContent;
    static renumber: (str: string) => number;
    static getDerivedStateFromProps(props: Props, state: State | undefined): State;
    render(): JSX.Element;
}
export {};