React Drawer Methods
beginUpdate()
Postpones rendering that can negatively affect performance until the endUpdate() method is called.
The beginUpdate() and endUpdate() methods reduce the number of renders in cases where extra rendering can negatively affect performance.
See Also
content()
The drawer's content. It is an HTML Element or a jQuery Element when you use jQuery.
defaultOptions(rule)
Name | Type | Description |
---|---|---|
device | | |
Device parameters. |
options |
Options to be applied. |
defaultOptions is a static method that the UI component class supports. The following code demonstrates how to specify default properties for all instances of the Drawer UI component in an application executed on the desktop.
jQuery
DevExpress.ui.dxDrawer.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the Drawer properties } });
Angular
import Drawer, { Properties } from "devextreme/ui/drawer"; // ... export class AppComponent { constructor () { Drawer.defaultOptions<Properties>({ device: { deviceType: "desktop" }, options: { // Here go the Drawer properties } }); } }
Vue
<template> <div> <DxDrawer id="drawer1" /> <DxDrawer id="drawer2" /> </div> </template> <script> import DxDrawer from "devextreme-vue/drawer"; import Drawer from "devextreme/ui/drawer"; Drawer.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the Drawer properties } }); export default { components: { DxDrawer } } </script>
React
import dxDrawer from "devextreme/ui/drawer"; import Drawer from "devextreme-react/drawer"; dxDrawer.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the Drawer properties } }); export default function App() { return ( <div> <Drawer id="drawer1" /> <Drawer id="drawer2" /> </div> ) }
You can also set rules for multiple device types:
jQuery
const devicesConfig = [ { deviceType: 'desktop' }, { deviceType: 'tablet' }, { deviceType: 'phone' }, ]; devicesConfig.forEach(deviceConfig => { DevExpress.ui.dxDrawer.defaultOptions({ device: deviceConfig, options: { // Here go the Drawer properties } }); });
Angular
import Drawer, { Properties } from "devextreme/ui/drawer"; // ... export class AppComponent { constructor () { const devicesConfig = [ { deviceType: 'desktop' }, { deviceType: 'tablet' }, { deviceType: 'phone' }, ]; devicesConfig.forEach(deviceConfig => { Drawer.defaultOptions<Properties>({ device: deviceConfig, options: { // Here go the Drawer properties } }); }); } }
Vue
<template> <div> <DxDrawer /> </div> </template> <script> import DxDrawer from "devextreme-vue/drawer"; import Drawer from "devextreme/ui/drawer"; const devicesConfig = [ { deviceType: 'desktop' }, { deviceType: 'tablet' }, { deviceType: 'phone' }, ]; devicesConfig.forEach(deviceConfig => { Drawer.defaultOptions({ device: deviceConfig, options: { // Here go the Drawer properties } }); }); export default { components: { DxDrawer } } </script>
React
import dxDrawer from "devextreme/ui/drawer"; import Drawer from "devextreme-react/drawer"; const devicesConfig = [ { deviceType: 'desktop' }, { deviceType: 'tablet' }, { deviceType: 'phone' }, ]; devicesConfig.forEach(deviceConfig => { dxDrawer.defaultOptions({ device: deviceConfig, options: { // Here go the Drawer properties } }); }); export default function App() { return ( <div> <Drawer /> </div> ) }
dispose()
jQuery
After calling this method, remove the DOM element associated with the UI component:
$("#myDrawer").dxDrawer("dispose"); $("#myDrawer").remove();
Angular
Use conditional rendering instead of this method:
<dx-drawer ... *ngIf="condition"> </dx-drawer>
Vue
Use conditional rendering instead of this method:
<template> <DxDrawer ... v-if="condition"> </DxDrawer> </template> <script> import DxDrawer from 'devextreme-vue/drawer'; export default { components: { DxDrawer } } </script>
React
Use conditional rendering instead of this method:
import React from 'react'; import Drawer from 'devextreme-react/drawer'; function DxDrawer(props) { if (!props.shouldRender) { return null; } return ( <Drawer ... > </Drawer> ); } class App extends React.Component { render() { return ( <DxDrawer shouldRender="condition" /> ); } } export default App;
endUpdate()
Refreshes the UI component after a call of the beginUpdate() method.
The beginUpdate() and endUpdate() methods reduce the number of renders in cases where extra rendering can negatively affect performance.
See Also
getInstance(element)
getInstance is a static method that the UI component class supports. The following code demonstrates how to get the Drawer instance found in an element with the myDrawer
ID:
// Modular approach import Drawer from "devextreme/ui/drawer"; ... let element = document.getElementById("myDrawer"); let instance = Drawer.getInstance(element) as Drawer; // Non-modular approach let element = document.getElementById("myDrawer"); let instance = DevExpress.ui.dxDrawer.getInstance(element);
See Also
hide()
A Promise that is resolved after the drawer is closed. It is a native Promise or a jQuery.Promise when you use jQuery.
on(eventName, eventHandler)
Use this method to subscribe to one of the events listed in the Events section.
See Also
on(events)
Use this method to subscribe to several events with one method call. Available events are listed in the Events section.
See Also
repaint()
Renders the component again without reloading data. Use the method to update the component's markup and appearance dynamically.
The repaint()
method re-initializes the component with new settings, resetting its state and history.
See Also
- reload() in DataSource | List
- refresh() in DataGrid | TreeList
show()
A Promise that is resolved after the drawer is opened. It is a native Promise or a jQuery.Promise when you use jQuery.
toggle()
A Promise that is resolved after the drawer is opened or closed. It is a native Promise or a jQuery.Promise when you use jQuery.
If you have technical questions, please create a support ticket in the DevExpress Support Center.