JavaScript/jQuery Drawer API
The Drawer is a dismissible or permanently visible panel used for navigation in responsive web application layouts.
See Also
- Set Up DevExtreme: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- Configure a Widget: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
Configuration
This section describes options that configure the Drawer widget's contents, behavior and appearance.
| Name | Description |
|---|---|
| activeStateEnabled |
Specifies whether or not the widget 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 widget responds to user interaction. |
| elementAttr |
Specifies the attributes to be attached to the widget's root element. |
| height |
Specifies the view's height. |
| hint |
Specifies text for a hint that appears when a user pauses on the widget. |
| hoverStateEnabled |
Specifies whether the widget 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 widget is disposed of. |
| onInitialized |
A function used in JavaScript frameworks to save the widget instance. |
| onOptionChanged |
A function that is executed after a widget option 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 widget to a right-to-left representation. |
| shading |
Specifies whether to shade the view when the drawer is opened. |
| target |
Specifies a CSS selector for the element in which the drawer should be rendered. Applies only when the openedStateMode is "overlap". |
| template |
Specifies the drawer's content. |
| visible |
Specifies whether the Drawer widget (including the view) is visible. |
| width |
Specifies the view's width. |
See Also
- Configure a Widget: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
Methods
| Name | Description |
|---|---|
| beginUpdate() |
Prevents the widget from refreshing until the endUpdate() method is called. |
| content() |
Gets the drawer's content. |
| defaultOptions(rule) |
Specifies the device-dependent default configuration options for this component. |
| dispose() |
Disposes of all the resources allocated to the Drawer instance. |
| element() |
Gets the root widget element. |
| endUpdate() |
Refreshes the widget after a call of the beginUpdate() method. |
| getInstance(element) |
Gets the instance of a widget found using its DOM node. |
| hide() |
Closes the drawer. |
| instance() |
Gets the widget's instance. Use it to access other methods of the widget. |
| 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 widget options. |
| option(optionName) |
Gets the value of a single option. |
| option(optionName, optionValue) |
Updates the value of a single option. |
| option(options) |
Updates the values of several options. |
| repaint() |
Repaints the widget without reloading data. Call it to update the widget's markup. |
| resetOption(optionName) |
Resets an option to its default value. |
| show() |
Opens the drawer. |
| toggle() |
Opens or closes the drawer, reversing the current state. |
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
Events
| Name | Description |
|---|---|
| disposing |
Raised before the widget is disposed of. |
| initialized |
Raised only once, after the widget is initialized. |
| optionChanged |
Raised after a widget option is changed. |
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core