Class Drawer

Hierarchy

GridLayout
- Drawer

Index

Constructors

Properties

Constructors

constructor

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

Properties

`Optional` animationFunction

animationFunction?: AnimationFunctionType

backDrop

backDrop: View

backDropEnabled

backDropEnabled: boolean

backdropColor

backdropColor: Color

backdropProperties

backdropProperties: {}

Type declaration

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

`Private` mIsAnimating

mIsAnimating: any

`Private` mIsPanning

mIsPanning: any

`Private` mModes

mModes: any

`Private` mPrevDeltaX

mPrevDeltaX: any

`Private` mPrevDeltaY

mPrevDeltaY: any

`Private` mShowingSide

mShowingSide: any

`Private` mTranslationX

mTranslationX: any

`Private` mTranslationY

mTranslationY: any

mViewByIdCache

mViewByIdCache: {}

Type declaration

`Private` mViewHeight

mViewHeight: any

`Private` mViewWidth

mViewWidth: any

mainContent

mainContent: View

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) => boolean)

Type declaration

- (side): boolean
- Parameters
  - side: Side | VerticalSide
  Returns boolean

`Optional` shouldStartSheetDragging

shouldStartSheetDragging?: ((side) => boolean)

Type declaration

- (side): boolean
- Parameters
  - side: Side | VerticalSide
  Returns 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:90

_onDrawerContentChanged

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

_onMainContentChanged

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

addChild

addChild(child): void
Parameters
- child: any
Returns void
Overrides GridLayout.addChild
- Defined in index.d.ts:108

animateToPosition

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

applyTrData

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

bottomLayoutChanged

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

close

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

computeTranslationData

computeTranslationData(side, value): 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:111

constrainX

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

constrainY

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

disposeNativeView

disposeNativeView(): void
Returns void
Overrides GridLayout.disposeNativeView
- Defined in index.d.ts:96

forceEnsureSize

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

getActualSide

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

getDefaultSide

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

getDrawerToOpen

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

initGestures

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

initNativeView

initNativeView(): void
Returns void
Overrides GridLayout.initNativeView
- Defined in index.d.ts:95

isOpened

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

isSideOpened

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

isSideVisible

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

leftLayoutChanged

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

onBackdropTap

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

onGestureState

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

onGestureTouch

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

onLayoutChange

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

onSideModeChanged

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

onTapGestureState

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

open

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

rightLayoutChanged

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

shouldStartGesture

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

shouldStartSheetDraggingInternal

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

toggle

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

topLayoutChanged

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

updateIsPanning

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

updateStartingSide

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

Class Drawer

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns Drawer

Properties

Optional animationFunction

backDrop

backDropEnabled

backdropColor

backdropProperties

Type declaration

backdropTapGestureEnabled

bottomClosedDrawerAllowDraging

Optional bottomDrawer

bottomDrawerMode

bottomOpenedDrawerAllowDraging

bottomSwipeDistance

closeAnimationDuration

gestureEnabled

gestureHandlerOptions

gestureMinDist

gestureTag

leftClosedDrawerAllowDraging

Optional leftDrawer

leftDrawerMode

leftOpenedDrawerAllowDraging

leftSwipeDistance

Private mIsAnimating

Private mIsPanning

Private mModes

Private mPrevDeltaX

Private mPrevDeltaY

Private mShowingSide

Private mTranslationX

Private mTranslationY

mViewByIdCache

Type declaration

Private mViewHeight

Private mViewWidth

mainContent

openAnimationDuration

panGestureHandler

rightClosedDrawerAllowDraging

Optional rightDrawer

rightDrawerMode

rightOpenedDrawerAllowDraging

rightSwipeDistance

Optional shouldPan

Type declaration

Parameters

Returns boolean

Optional shouldStartSheetDragging

Type declaration

Parameters

Returns boolean

simultaneousHandlers

startingSide

topClosedDrawerAllowDraging

Optional topDrawer

topDrawerMode

topOpenedDrawerAllowDraging

topSwipeDistance

Optional translationFunction

waitFor

Methods

_onBackDropEnabledValueChanged

Returns void

_onDrawerContentChanged

Parameters

Returns void

_onMainContentChanged

Parameters

Returns void

addChild

Parameters

`Optional` animationFunction

`Optional` bottomDrawer

`Optional` leftDrawer

`Private` mIsAnimating

`Private` mIsPanning

`Private` mModes

`Private` mPrevDeltaX

`Private` mPrevDeltaY

`Private` mShowingSide

`Private` mTranslationX

`Private` mTranslationY

`Private` mViewHeight

`Private` mViewWidth

`Optional` rightDrawer

`Optional` shouldPan

`Optional` shouldStartSheetDragging

`Optional` topDrawer

`Optional` translationFunction