Class Drawer

Hierarchy

  • GridLayout
    • Drawer

Constructors

constructor

Properties

animationFunction? backDrop backdropColor backDropEnabled backdropProperties backdropTapGestureEnabled bottomClosedDrawerAllowDraging bottomDrawer? bottomDrawerMode bottomOpenedDrawerAllowDraging bottomSwipeDistance closeAnimationDuration gestureEnabled gestureHandlerOptions gestureMinDist gestureTag leftClosedDrawerAllowDraging leftDrawer? leftDrawerMode leftOpenedDrawerAllowDraging leftSwipeDistance mainContent mViewByIdCache openAnimationDuration panGestureHandler rightClosedDrawerAllowDraging rightDrawer? rightDrawerMode rightOpenedDrawerAllowDraging rightSwipeDistance shouldPan? shouldStartSheetDragging? simultaneousHandlers startingSide topClosedDrawerAllowDraging topDrawer? topDrawerMode topOpenedDrawerAllowDraging topSwipeDistance translationFunction? waitFor

Methods

_onBackDropEnabledValueChanged _onDrawerContentChanged _onMainContentChanged addChild animateToPosition applyTrData bottomLayoutChanged close computeTranslationData constrainX constrainY disposeNativeView forceEnsureSize getActualSide getDefaultSide getDrawerToOpen initGestures initNativeView isOpened isSideOpened isSideVisible leftLayoutChanged onBackdropTap onGestureState onGestureTouch onLayoutChange onSideModeChanged onTapGestureState open rightLayoutChanged shouldStartGesture shouldStartSheetDraggingInternal toggle topLayoutChanged updateIsPanning updateStartingSide

Constructors

constructor

  • new Drawer(): Drawer

  • Returns Drawer

Properties

OptionalanimationFunction

animationFunction?: AnimationFunctionType

backDrop

backDrop: View

backdropColor

backdropColor: Color

backDropEnabled

backDropEnabled: boolean

backdropProperties

backdropProperties: {}

backdropTapGestureEnabled

backdropTapGestureEnabled: boolean

bottomClosedDrawerAllowDraging

bottomClosedDrawerAllowDraging: boolean

OptionalbottomDrawer

bottomDrawer?: View

bottomDrawerMode

bottomDrawerMode: any

bottomOpenedDrawerAllowDraging

bottomOpenedDrawerAllowDraging: boolean

bottomSwipeDistance

bottomSwipeDistance: number

closeAnimationDuration

closeAnimationDuration: number

gestureEnabled

gestureEnabled: boolean

gestureHandlerOptions

gestureHandlerOptions: any

gestureMinDist

gestureMinDist: number

gestureTag

gestureTag: number

leftClosedDrawerAllowDraging

leftClosedDrawerAllowDraging: boolean

OptionalleftDrawer

leftDrawer?: View

leftDrawerMode

leftDrawerMode: any

leftOpenedDrawerAllowDraging

leftOpenedDrawerAllowDraging: boolean

leftSwipeDistance

leftSwipeDistance: number

mainContent

mainContent: View

mViewByIdCache

mViewByIdCache: {}

openAnimationDuration

openAnimationDuration: number

panGestureHandler

panGestureHandler: PanGestureHandler

rightClosedDrawerAllowDraging

rightClosedDrawerAllowDraging: boolean

OptionalrightDrawer

rightDrawer?: View

rightDrawerMode

rightDrawerMode: any

rightOpenedDrawerAllowDraging

rightOpenedDrawerAllowDraging: boolean

rightSwipeDistance

rightSwipeDistance: number

OptionalshouldPan

shouldPan?: (side: Side | VerticalSide) => boolean

OptionalshouldStartSheetDragging

shouldStartSheetDragging?: (side: Side | VerticalSide) => boolean

simultaneousHandlers

simultaneousHandlers: any[]

startingSide

startingSide: Side | VerticalSide

topClosedDrawerAllowDraging

topClosedDrawerAllowDraging: boolean

OptionaltopDrawer

topDrawer?: View

topDrawerMode

topDrawerMode: any

topOpenedDrawerAllowDraging

topOpenedDrawerAllowDraging: boolean

topSwipeDistance

topSwipeDistance: number

OptionaltranslationFunction

translationFunction?: TranslationFunctionType

waitFor

waitFor: any[]

Methods

_onBackDropEnabledValueChanged

  • _onBackDropEnabledValueChanged(): void

  • Returns void

_onDrawerContentChanged

  • _onDrawerContentChanged(
        side: Side | VerticalSide,
        oldValue: View,
        newValue: View,
    ): void

  • Parameters

    Returns void

_onMainContentChanged

  • _onMainContentChanged(oldValue: View, newValue: View): void

  • Parameters

    • oldValue: View
    • newValue: View

    Returns void

addChild

  • addChild(child: any): void

  • Adds the view to children array.

    Parameters

    • child: any

    Returns void

animateToPosition

  • animateToPosition(
        side: Side | VerticalSide,
        position: any,
        duration?: number,
    ): Promise<void>

  • Parameters

    Returns Promise<void>

applyTrData

  • applyTrData(trData: { [k: string]: any }, side: Side | VerticalSide): void

  • Parameters

    Returns void

bottomLayoutChanged

  • bottomLayoutChanged(event: EventData): void

  • Parameters

    • event: EventData

    Returns void

close

  • close(side?: Side | VerticalSide, duration?: number): Promise<void>

  • Parameters

    Returns Promise<void>

computeTranslationData

  • computeTranslationData(
        side: any,
        value: any,
    ):
        | TrData
        | {
            backDrop: {
                opacity: number;
                translateX: number;
                translateY?: undefined;
            };
            mainContent: { translateX: number; translateY?: undefined };
            [x: string]:
                | { opacity?: undefined; translateX: number }
                | { opacity: number; translateX: number };
        }
        | {
            backDrop: {
                opacity: number;
                translateX?: undefined;
                translateY?: undefined;
            };
            mainContent: { translateX?: undefined; translateY?: undefined };
            [x: string]:
                | { opacity?: undefined; translateX?: undefined }
                | { opacity?: undefined; translateX: any }
                | { opacity: number; translateX?: undefined };
        }
        | {
            backDrop: {
                opacity: number;
                translateX?: undefined;
                translateY: number;
            };
            mainContent: { translateX?: undefined; translateY: number };
            [x: string]:
                | { opacity?: undefined; translateY: any }
                | { opacity: number; translateY: number };
        }

  • Parameters

    • side: any
    • value: any

    Returns
        | TrData
        | {
            backDrop: {
                opacity: number;
                translateX: number;
                translateY?: undefined;
            };
            mainContent: { translateX: number; translateY?: undefined };
            [x: string]:
                | { opacity?: undefined; translateX: number }
                | { opacity: number; translateX: number };
        }
        | {
            backDrop: {
                opacity: number;
                translateX?: undefined;
                translateY?: undefined;
            };
            mainContent: { translateX?: undefined; translateY?: undefined };
            [x: string]:
                | { opacity?: undefined; translateX?: undefined }
                | { opacity?: undefined; translateX: any }
                | { opacity: number; translateX?: undefined };
        }
        | {
            backDrop: {
                opacity: number;
                translateX?: undefined;
                translateY: number;
            };
            mainContent: { translateX?: undefined; translateY: number };
            [x: string]:
                | { opacity?: undefined; translateY: any }
                | { opacity: number; translateY: number };
        }

constrainX

  • constrainX(side: any, x: any): any

  • Parameters

    • side: any
    • x: any

    Returns any

constrainY

  • constrainY(side: any, y: any): any

  • Parameters

    • side: any
    • y: any

    Returns any

disposeNativeView

  • disposeNativeView(): void

  • Clean up references to the native view.

    Returns void

forceEnsureSize

getActualSide

getDefaultSide

  • getDefaultSide(): "left" | "right" | "bottom" | "top"

  • Returns "left" | "right" | "bottom" | "top"

getDrawerToOpen

  • getDrawerToOpen(extraData: any): "left" | "right" | "bottom" | "top"

  • Parameters

    • extraData: any

    Returns "left" | "right" | "bottom" | "top"

initGestures

  • initGestures(): void

  • Returns void

initNativeView

  • initNativeView(): void

  • Initializes properties/listeners of the native view.

    Returns void

isOpened

isSideOpened

  • isSideOpened(): boolean

  • Returns boolean

isSideVisible

leftLayoutChanged

  • leftLayoutChanged(event: EventData): void

  • Parameters

    • event: EventData

    Returns void

onBackdropTap

  • onBackdropTap(): void

  • Returns void

onGestureState

  • onGestureState(args: GestureStateEventData): void

  • Parameters

    • args: GestureStateEventData

    Returns void

onGestureTouch

  • onGestureTouch(args: GestureTouchEventData): void

  • Parameters

    • args: GestureTouchEventData

    Returns void

onLayoutChange

onSideModeChanged

onTapGestureState

  • onTapGestureState(args: GestureStateEventData): void

  • Parameters

    • args: GestureStateEventData

    Returns void

open

  • open(side?: Side | VerticalSide, duration?: number): Promise<void>

  • Parameters

    Returns Promise<void>

rightLayoutChanged

  • rightLayoutChanged(event: EventData): void

  • Parameters

    • event: EventData

    Returns void

shouldStartGesture

  • shouldStartGesture(data: any): any

  • Parameters

    • data: any

    Returns any

shouldStartSheetDraggingInternal

toggle

topLayoutChanged

  • topLayoutChanged(event: EventData): void

  • Parameters

    • event: EventData

    Returns void

updateIsPanning

  • updateIsPanning(state: GestureState): void

  • Parameters

    • state: GestureState

    Returns void

updateStartingSide

  • updateStartingSide(side: any): void

  • Parameters

    • side: any

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods