This section describes the methods that control the Drawer UI component.
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 AlsoGets the drawer's content.
Specifies the device-dependent default configuration properties for this component.
Parameters:The component's default device properties.
Object structure:
Name Type Description device |Device parameters.
When you specify a function, get information about the current device from the argument. Return true if the properties should be applied to the device.
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.
jQueryDevExpress.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:
jQueryconst 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> ) }
Disposes of all the resources allocated to the Drawer instance.
jQueryAfter 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;
Gets the root UI component element.
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 AlsoGets the instance of a UI component found using its DOM node.
Parameters:The UI component's container.
The UI component's instance.
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
Gets the UI component's instance. Use it to access other methods of the UI component.
This UI component's instance.
Detaches all event handlers from a single event.
The object for which this method is called.
Detaches a particular event handler from a single event.
Parameters:The event's name.
The event's handler.
The object for which this method is called.
Subscribes to an event.
Parameters:The event's name.
The event's handler.
The object for which this method is called.
Use this method to subscribe to one of the events listed in the Events section.
See AlsoSubscribes to events.
Parameters:Events with their handlers: { "eventName1": handler1, "eventName2": handler2, ...}
The object for which this method is called.
Use this method to subscribe to several events with one method call. Available events are listed in the Events section.
See AlsoGets the value of a single property.
Parameters:The property's name or full path.
Return Value: any
This property's value.
Updates the value of a single property.
Parameters:The property's name or full path.
optionValue: any
This property's new value.
Updates the values of several properties.
Parameters:Options with their new values.
Renders the component again without reloading data. Use the method to update the component's markup and appearance dynamically.
Resets a property to its default value.
Opens or closes the drawer, reversing the current state.
Feel free to share topic-related thoughts here.RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4