Home Manual Reference Source

Typedef

Static Public Summary
public

Drawer object.

public

Overlay object.

Static Public

public Drawer: Object source

Drawer object.

Properties:

NameTypeAttributeDescription
element Object
  • nullable: false

HTML DOM Element.

direction string
  • optional
  • default: "right"

Drawer placement direction.

size string | number
  • optional
  • default: "80%"

Drawer size. In the case of character strings, the units are '%' and 'px' are supported.

maxSize string | number
  • optional
  • default: -1

Drawer max size. In the case of character strings, the units are '%' and 'px' are supported.

swipeable boolean
  • optional
  • default: true

Enable opening and closing of the drawer with a swipe gesture.

swipeArea string | number
  • optional
  • default: 20

Swipeable area. In the case of character strings, the units are '%' and 'px' are supported.

duration number
  • optional
  • default: 400

Drawer moving time.

zIndex number
  • optional
  • default: 9999

Drawer stacking order.

style Object
  • optional
  • default: {}

Drawer's css style.

initCreate boolean
  • optional
  • default: true

Create a drawer at initialization.

enabledMaxWidth number
  • optional
  • default: -1

Maximum screen width with drawer enabled. Always valid when -1.

history boolean
  • optional
  • default: true

Activate if history is supported.

overlay Overlay
  • optional
  • default: null

Overlay object. If not specified, it will be created automatically. Specify false if it is unnecessary.

onCreate function
  • optional
  • default: null

Called when a drawer is created.

onDestroy function
  • optional
  • default: null

Called when a drawer is destroyed.

onOpen function
  • optional
  • default: null

Called when a drawer is opened.

onClose function
  • optional
  • default: null

Called when a drawer is closed.

onChangeState function
  • optional
  • default: null

Called when the opening / closing state is changed.

onResize function
  • optional
  • default: null

Called when the size of the drawer has changed.

onTouchStart function
  • optional
  • default: null

Called when the drawer starts moving with a swipe gesture.

onTouchMove function
  • optional
  • default: null

Called when the drawer is moving with a swipe gesture.

onTouchFinish function
  • optional
  • default: null

Called when the drawer has finished moving with a swipe gesture.

onError function
  • optional
  • default: null

Called when there is an error in processing within the object.

public Overlay: Object source

Overlay object.

Properties:

NameTypeAttributeDescription
element Object

HTML DOM Element.

opacity number
  • optional
  • default: 0.6

Overlay object transparency.

zIndex number
  • optional
  • default: -1

Overlay stacking order. If -1, zIndex - 1 of the drawer is specified automatically.