Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • DrawerProperties

Indexable

[key: string]: any

key for others property.

Index

Properties

Optional anchor

anchor: "left" | "right" | "top" | "bottom"

anchor of drawer.

Optional children

children: ReactNode

Children of List.

closeDrawer

closeDrawer: function

Closes the drawer

Type declaration

    • (): void
    • Returns void

Optional drawerBackgroundColor

drawerBackgroundColor: ColorProperties

Specifies the background color of the drawer. The default value is white. If you want to set the opacity of the drawer, use rgba. Example

Optional drawerLockMode

drawerLockMode: "unlocked" | "locked-closed" | "locked-open"

Specifies the lock mode of the drawer. The drawer can be locked in 3 states: 'unlocked'|'locked-closed'|'locked-open'

Optional drawerPosition

drawerPosition: "left" | "right"

Specifies the side of the screen from which the drawer will slide in.

Optional drawerWidth

drawerWidth: undefined | number

Specifies the width of the drawer, more precisely the width of the view that be pulled in from the edge of the window.

Optional keyboardDismissMode

keyboardDismissMode: "none" | "on-drag"

Determines whether the keyboard gets dismissed in response to a drag 'none' (the default), drags do not dismiss the keyboard. 'on-drag', the keyboard is dismissed when a drag begins.

Optional onDrawerClose

onDrawerClose: undefined | function

Function called whenever the navigation view has been closed.

Optional onDrawerOpen

onDrawerOpen: undefined | function

Function called whenever the navigation view has been opened.

onDrawerSlide

onDrawerSlide: function

Function called whenever there is an interaction with the navigation view.

Type declaration

    • (): void
    • Returns void

Optional onDrawerStateChanged

onDrawerStateChanged: undefined | function

Function called when the drawer state has changed. The drawer can be in 3 states: idle, meaning there is no interaction with the navigation view happening at the time dragging, meaning there is currently an interaction with the navigation view settling, meaning that there was an interaction with the navigation view, and the navigation view is now finishing its closing or opening animation

Optional onStateChanged

onStateChanged: undefined | function

onClose: callback called when drawer is closed

Optional open

open: undefined | true | false

if true, drawer is open

openDrawer

openDrawer: function

Opens the drawer.

Type declaration

    • (): void
    • Returns void

renderNavigationView

renderNavigationView: function

The navigation view that will be rendered to the side of the screen and can be pulled in.

Type declaration

    • (): void
    • Returns void

Optional statusBarBackgroundColor

statusBarBackgroundColor: ColorProperties

Make the drawer take the entire screen and draw the background of the status bar to allow it to open over the status bar

Optional style

style: undefined | object

Style object for List.

Optional type

type: "temporary" | "persistent" | "permanent" | "overlay" | "static" | "displace"

type of drawer

Optional width

width: undefined | number

width of drawer.

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc