React Drawer Methods

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

beginUpdate()

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

The beginUpdate() and endUpdate() methods prevent the UI component from excessive updates when you are changing multiple UI component settings at once. After the beginUpdate() method is called, the UI component does not update its UI until the endUpdate() method is called.

jQuery

Call Methods

Angular

Call Methods

Vue

Call Methods

React

Call Methods

content()

Gets the drawer's content.

Return Value:

HTMLElement | jQuery

The drawer's content. It is an HTML Element or a jQuery Element when you use jQuery.

defaultOptions(rule)

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

Parameters:

rule:

Object

The component's default device properties.

Object structure:

Name	Type	Description
device	Device \| Array<Device> \| Function	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	Object	Options to be applied.

Name

Type

Description

device

Device

|

Array<Device>

|

Function

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

Object

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

JavaScript

DevExpress.ui.dxDrawer.defaultOptions({ 
    device: { deviceType: "desktop" },
    options: {
        // Here go the Drawer properties
    }
});

Angular

TypeScript

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>
    )
}

dispose()

Disposes of all the resources allocated to the Drawer instance.

jQuery

After calling this method, remove the DOM element associated with the UI component:

JavaScript

$("#myDrawer").dxDrawer("dispose");
$("#myDrawer").remove();

Angular

Use conditional rendering instead of this method:

app.component.html

<dx-drawer ...
    *ngIf="condition">
</dx-drawer>

Vue

Use conditional rendering instead of this method:

App.vue

<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:

App.js

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;

element()

Gets the root UI component element.

Return Value:

HTMLElement | jQuery

An HTML element or a jQuery element when you use jQuery.

jQuery

Call Methods

Angular

Call Methods

Vue

Call Methods

React

Call Methods

endUpdate()

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

Main article: beginUpdate()

jQuery

Call Methods

Angular

Call Methods

Vue

Call Methods

React

Call Methods

getInstance(element)

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

Parameters:

element:

Element

|

jQuery

The UI component's container.

Return Value:

Object

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);