Class Drawer

Hierarchy

GridLayout
- Drawer

Indexable

[key: symbol]: (value: any) => void

Index

Constructors

constructor

Constructors

constructor

new Drawer(): Drawer
Returns Drawer
Overrides GridLayout.constructor
- Defined in index.d.ts:99

Properties

`Optional`animationFunction

animationFunction?: AnimationFunctionType

backDrop

backDrop: View

backdropColor

backdropColor: Color

backDropEnabled

backDropEnabled: boolean

backdropProperties

backdropProperties: {}

backdropTapGestureEnabled

backdropTapGestureEnabled: boolean

bottomClosedDrawerAllowDraging

bottomClosedDrawerAllowDraging: boolean

`Optional`bottomDrawer

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

`Optional`leftDrawer

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

`Optional`rightDrawer

rightDrawer?: View

rightDrawerMode

rightDrawerMode: any

rightOpenedDrawerAllowDraging

rightOpenedDrawerAllowDraging: boolean

rightSwipeDistance

rightSwipeDistance: number

`Optional`shouldPan

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

`Optional`shouldStartSheetDragging

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

simultaneousHandlers

simultaneousHandlers: any[]

startingSide

startingSide: Side | VerticalSide

topClosedDrawerAllowDraging

topClosedDrawerAllowDraging: boolean

`Optional`topDrawer

topDrawer?: View

topDrawerMode

topDrawerMode: any

topOpenedDrawerAllowDraging

topOpenedDrawerAllowDraging: boolean

topSwipeDistance

topSwipeDistance: number

`Optional`translationFunction

translationFunction?: TranslationFunctionType

waitFor

waitFor: any[]

Methods

_onBackDropEnabledValueChanged

_onBackDropEnabledValueChanged(): void
Returns void
- Defined in index.d.ts:100

_onDrawerContentChanged

_onDrawerContentChanged(
    side: Side | VerticalSide,
    oldValue: View,
    newValue: View,
): void
Parameters
- side: Side | VerticalSide
- oldValue: View
- newValue: View
Returns void
- Defined in index.d.ts:120

_onMainContentChanged

_onMainContentChanged(oldValue: View, newValue: View): void
Parameters
- oldValue: View
- newValue: View
Returns void
- Defined in index.d.ts:114

addChild

addChild(child: any): void
Adds the view to children array.
Parameters
- child: any
Returns void
Overrides GridLayout.addChild
- Defined in index.d.ts:119

animateToPosition

animateToPosition(
    side: Side | VerticalSide,
    position: any,
    duration?: number,
): Promise<void>
Parameters
- side: Side | VerticalSide
- position: any
- Optionalduration: number
Returns Promise<void>
- Defined in index.d.ts:187

applyTrData

applyTrData(trData: { [k: string]: any }, side: Side | VerticalSide): void
Parameters
- trData: { [k: string]: any }
- side: Side | VerticalSide
Returns void
- Defined in index.d.ts:182

bottomLayoutChanged

bottomLayoutChanged(event: EventData): void
Parameters
- event: EventData
Returns void
- Defined in index.d.ts:118

close

close(side?: Side | VerticalSide, duration?: number): Promise<void>
Parameters
- Optionalside: Side | VerticalSide
- Optionalduration: number
Returns Promise<void>
- Defined in index.d.ts:193

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 };
    }
- Defined in index.d.ts:122

constrainX

constrainX(side: any, x: any): any
Parameters
- side: any
- x: any
Returns any
- Defined in index.d.ts:185

constrainY

constrainY(side: any, y: any): any
Parameters
- side: any
- y: any
Returns any
- Defined in index.d.ts:186

disposeNativeView

disposeNativeView(): void
Clean up references to the native view.

Returns void
Overrides GridLayout.disposeNativeView
- Defined in index.d.ts:106

forceEnsureSize

forceEnsureSize(side: Side | VerticalSide): void
Parameters
- side: Side | VerticalSide
Returns void
- Defined in index.d.ts:178

getActualSide

getActualSide(side: Side | VerticalSide): Side | VerticalSide
Parameters
- side: Side | VerticalSide
Returns Side | VerticalSide
- Defined in index.d.ts:101

getDefaultSide

getDefaultSide(): "left" | "right" | "bottom" | "top"
Returns "left" | "right" | "bottom" | "top"
- Defined in index.d.ts:190

getDrawerToOpen

getDrawerToOpen(extraData: any): "left" | "right" | "bottom" | "top"
Parameters
- extraData: any
Returns "left" | "right" | "bottom" | "top"
- Defined in index.d.ts:109

initGestures

initGestures(): void
Returns void
- Defined in index.d.ts:104

initNativeView

initNativeView(): void
Initializes properties/listeners of the native view.

Returns void
Overrides GridLayout.initNativeView
- Defined in index.d.ts:105

isOpened

isOpened(side?: Side | VerticalSide): boolean
Parameters
- Optionalside: Side | VerticalSide
Returns boolean
- Defined in index.d.ts:189

isSideOpened

isSideOpened(): boolean
Returns boolean
- Defined in index.d.ts:188

isSideReady

isSideReady(side: Side | VerticalSide): boolean
Parameters
- side: Side | VerticalSide
Returns boolean
- Defined in index.d.ts:112

isSideVisible

isSideVisible(side: Side | VerticalSide): number
Parameters
- side: Side | VerticalSide
Returns number
- Defined in index.d.ts:111

leftLayoutChanged

leftLayoutChanged(event: EventData): void
Parameters
- event: EventData
Returns void
- Defined in index.d.ts:115

onBackdropTap

onBackdropTap(): void
Returns void
- Defined in index.d.ts:103

onGestureState

onGestureState(args: GestureStateEventData): void
Parameters
- args: GestureStateEventData
Returns void
- Defined in index.d.ts:110

onGestureTouch

onGestureTouch(args: GestureTouchEventData): void
Parameters
- args: GestureTouchEventData
Returns void
- Defined in index.d.ts:113

onLayoutChange

onLayoutChange(side: Side | VerticalSide, event: EventData): void
Parameters
- side: Side | VerticalSide
- event: EventData
Returns void
- Defined in index.d.ts:177

onSideModeChanged

onSideModeChanged(side: Side | VerticalSide, mode: Mode, oldMode?: Mode): void
Parameters
- side: Side | VerticalSide
- mode: Mode
- OptionaloldMode: Mode
Returns void
- Defined in index.d.ts:121

onTapGestureState

onTapGestureState(args: GestureStateEventData): void
Parameters
- args: GestureStateEventData
Returns void
- Defined in index.d.ts:179

open

open(side?: Side | VerticalSide, duration?: number): Promise<void>
Parameters
- Optionalside: Side | VerticalSide
- Optionalduration: number
Returns Promise<void>
- Defined in index.d.ts:192

rightLayoutChanged

rightLayoutChanged(event: EventData): void
Parameters
- event: EventData
Returns void
- Defined in index.d.ts:116

shouldStartGesture

shouldStartGesture(data: any): any
Parameters
- data: any
Returns any
- Defined in index.d.ts:108

shouldStartSheetDraggingInternal

shouldStartSheetDraggingInternal(side: Side | VerticalSide): any
Parameters
- side: Side | VerticalSide
Returns any
- Defined in index.d.ts:107

toggle

toggle(side?: Side | VerticalSide): Promise<void>
Parameters
- Optionalside: Side | VerticalSide
Returns Promise<void>
- Defined in index.d.ts:191

topLayoutChanged

topLayoutChanged(event: EventData): void
Parameters
- event: EventData
Returns void
- Defined in index.d.ts:117

updateIsPanning

updateIsPanning(state: GestureState): void
Parameters
- state: GestureState
Returns void
- Defined in index.d.ts:180

updateStartingSide

updateStartingSide(side: any): void
Parameters
- side: any
Returns void
- Defined in index.d.ts:102

Class Drawer

Hierarchy

Indexable

Index

Constructors

Properties

Methods

Constructors

constructor

Returns Drawer

Properties

OptionalanimationFunction

backDrop

backdropColor

backDropEnabled

backdropProperties

backdropTapGestureEnabled

bottomClosedDrawerAllowDraging

OptionalbottomDrawer

bottomDrawerMode

bottomOpenedDrawerAllowDraging

bottomSwipeDistance

closeAnimationDuration

gestureEnabled

gestureHandlerOptions

gestureMinDist

gestureTag

leftClosedDrawerAllowDraging

OptionalleftDrawer

leftDrawerMode

leftOpenedDrawerAllowDraging

leftSwipeDistance

mainContent

mViewByIdCache

openAnimationDuration

panGestureHandler

rightClosedDrawerAllowDraging

OptionalrightDrawer

rightDrawerMode

rightOpenedDrawerAllowDraging

rightSwipeDistance

OptionalshouldPan

OptionalshouldStartSheetDragging

simultaneousHandlers

startingSide

topClosedDrawerAllowDraging

OptionaltopDrawer

topDrawerMode

topOpenedDrawerAllowDraging

topSwipeDistance

OptionaltranslationFunction

waitFor

Methods

_onBackDropEnabledValueChanged

Returns void

_onDrawerContentChanged

Parameters

Returns void

_onMainContentChanged

Parameters

Returns void

addChild

Parameters

Returns void

animateToPosition

Parameters

Returns Promise<void>

applyTrData

Parameters

Returns void

bottomLayoutChanged

Parameters

Returns void

close

Parameters

Returns Promise<void>

computeTranslationData

Parameters

constrainX

Parameters

`Optional`animationFunction

`Optional`bottomDrawer

`Optional`leftDrawer

`Optional`rightDrawer

`Optional`shouldPan

`Optional`shouldStartSheetDragging

`Optional`topDrawer

`Optional`translationFunction