JavaScript/jQuery Drawer API

The Drawer is a dismissible or permanently visible panel used for navigation in responsive web application layouts.

import Drawer from "devextreme/ui/drawer"
Type:

Object

NOTE
The Drawer UI component is not designed to contain another Drawer. Do not use nested Drawers to avoid possible issues in your application.

Start Tutorial View Demo

See Also

Options

This section describes properties that configure the Drawer UI component's contents, behavior and appearance.

Name Description
activeStateEnabled

Specifies whether or not the UI component changes its state when interacting with a user.
animationDuration

Specifies the duration of the drawer's opening and closing animation (in milliseconds). Applies only if animationEnabled is true.
animationEnabled

Specifies whether to use an opening and closing animation.
closeOnOutsideClick

Specifies whether to close the drawer if a user clicks or taps the view area.
component

An alias for the template property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.
disabled

Specifies whether the UI component responds to user interaction.
elementAttr

Specifies the global attributes to be attached to the UI component's container element.
height

Specifies the view's height.
hint

Specifies text for a hint that appears when a user pauses on the UI component.
hoverStateEnabled

Specifies whether the UI component changes its state when a user pauses on it.
maxSize

Specifies the drawer's width or height (depending on the drawer's position) in the opened state.
minSize

Specifies the drawer's width or height (depending on the drawer's position) in the closed state.
onDisposing

A function that is executed before the UI component is disposed of.
onInitialized

A function used in JavaScript frameworks to save the UI component instance.
onOptionChanged

A function that is executed after a UI component property is changed.
opened

Specifies whether the drawer is opened.
openedStateMode

Specifies how the drawer interacts with the view in the opened state.
position

Specifies the drawer's position in relation to the view.
render

An alias for the template property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.
revealMode

Specifies the drawer's reveal mode.
rtlEnabled

Switches the UI component to a right-to-left representation.
shading

Specifies whether to shade the view when the drawer is opened.
template

Specifies the drawer's content.
visible

Specifies whether the Drawer UI component (including the view) is visible.
width

Specifies the view's width.

See Also

Methods

This section describes the methods that control the Drawer UI component.

Name Description
beginUpdate()

Prevents the UI component from refreshing until the endUpdate() method is called.
content()

Gets the drawer's content.
defaultOptions(rule)

Specifies the device-dependent default configuration properties for this component.
dispose()

Disposes of all the resources allocated to the Drawer instance.
element()

Gets the root UI component element.
endUpdate()

Refreshes the UI component after a call of the beginUpdate() method.
getInstance(element)

Gets the instance of a UI component found using its DOM node.
hide()

Closes the drawer.
instance()

Gets the UI component's instance. Use it to access other methods of the UI component.
off(eventName)

Detaches all event handlers from a single event.
off(eventName, eventHandler)

Detaches a particular event handler from a single event.
on(eventName, eventHandler)

Subscribes to an event.
on(events)

Subscribes to events.
option()

Gets all UI component properties.
option(optionName)

Gets the value of a single property.
option(optionName, optionValue)

Updates the value of a single property.
option(options)

Updates the values of several properties.
repaint()

Repaints the UI component without reloading data. Call it to update the UI component's markup.
resetOption(optionName)

Resets an property to its default value.
show()

Opens the drawer.
toggle()

Opens or closes the drawer, reversing the current state.

See Also

Events

This section describes events that the Drawer UI component raises.

Name Description
disposing

Raised before the UI component is disposed of.
initialized

Raised only once, after the UI component is initialized.
optionChanged

Raised after a UI component property is changed.

See Also