JavaScript/jQuery Drawer Options

See Also

The UI component switches to the active state when users press down the primary mouse button. When this property is set to true, the CSS rules for the active state apply. You can change these rules to customize the component.

Use this property when you display the component on a platform whose guidelines include the active state change for UI components.

See Also

• animationDuration

The function passed to this property enables you to specify a custom condition for UI component closing. For instance, you can prevent closing until a user clicks a specific element on the view:

$(function() {
    $("#drawerContainer").dxDrawer({
        // ...
        closeOnOutsideClick: function(e) {
            return e.target === $("#someElement").get()[0];
        }
    });
});

import { DxDrawerModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
    closeOnOutsideClick(e) {
        return e.target === document.getElementById("someElement");
    }
}
@NgModule({
     imports: [
         // ...
         DxDrawerModule
     ],
     // ...
 })

<dx-drawer ...
    [closeOnOutsideClick]="closeOnOutsideClick">
</dx-drawer>

<template>
    <DxDrawer ....
        :close-on-outside-click="closeOnOutsideClick">
    </DxDrawer>
</template>

<script>
import 'devextreme/dist/css/dx.light.css';

import DxDrawer from 'devextreme-vue/drawer';

export default {
    components: {
        DxDrawer
    },
    methods: {
        closeOnOutsideClick (e) {
            return e.target === document.getElementById("someElement");
        }
    }
}
</script>

import React from 'react';
import 'devextreme/dist/css/dx.light.css';

import Drawer from 'devextreme-react/drawer';

const closeOnOutsideClick = (e) => {
    return e.target === document.getElementById("someElement");
};

export default function App() {
    return (
        <Drawer ...
            closeOnOutsideClick={closeOnOutsideClick}>
        </Drawer>
    );
}

This property accepts a value of one of the following types:

• Number
  The height in pixels.

• String
  A CSS-accepted measurement of height. For example, "55px", "20vh", "inherit". If you want to specify a relative height, use vh height measurements.

• Function (deprecated since v21.2)
  Refer to the W0017 warning description for information on how to migrate to viewport units.

See Also

• openedStateMode

See Also

• maxSize

See Also

The following example shows how to subscribe to component property changes:

$(function() {
    $("#drawerContainer").dxDrawer({
        // ...
        onOptionChanged: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    });
});

<dx-drawer ...
    (onOptionChanged)="handlePropertyChange($event)"> 
</dx-drawer>

import { Component } from '@angular/core'; 

@Component({ 
    selector: 'app-root', 
    templateUrl: './app.component.html', 
    styleUrls: ['./app.component.css'] 
}) 

export class AppComponent { 
    // ...
    handlePropertyChange(e) {
        if(e.name === "changedProperty") { 
            // handle the property change here
        }
    }
}

import { BrowserModule } from '@angular/platform-browser'; 
import { NgModule } from '@angular/core'; 
import { AppComponent } from './app.component'; 
import { DxDrawerModule } from 'devextreme-angular'; 

@NgModule({ 
    declarations: [ 
        AppComponent 
    ], 
    imports: [ 
        BrowserModule, 
        DxDrawerModule 
    ], 
    providers: [ ], 
    bootstrap: [AppComponent] 
}) 

export class AppModule { }  

<template> 
    <DxDrawer ...
        @option-changed="handlePropertyChange"
    />            
</template> 

<script>  
import 'devextreme/dist/css/dx.light.css'; 
import DxDrawer from 'devextreme-vue/drawer'; 

export default { 
    components: { 
        DxDrawer
    }, 
    // ...
    methods: { 
        handlePropertyChange: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    } 
} 
</script> 

import React from 'react';  
import 'devextreme/dist/css/dx.light.css'; 

import Drawer from 'devextreme-react/drawer'; 

const handlePropertyChange = (e) => {
    if(e.name === "changedProperty") {
        // handle the property change here
    }
}

export default function App() { 
    return ( 
        <Drawer ...
            onOptionChanged={handlePropertyChange}
        />        
    ); 
} 

See Also

• openedStateMode
• revealMode

The following modes are available:

• "overlap"
  The drawer overlaps the view. If you assign "overlap" to the openedStateMode property, the Drawer uses the Popup component to render a side menu. A z-index of all overlay UI components (Popup, Popover, etc.) on a page is calculated when a component is created and it takes into account the z-indexes of existing overlays. As a result, a newly opened Popup (the Drawer's panel) is displayed at the top. If you need to display a different window at the top, call the focus() method for the Popup after the openedStateMode property is changed.

• "shrink"
  The view's width decreases to accommodate the drawer.

• "push"
  The drawer partially displaces the view.

Note that if the value of this property changes, the Drawer template is re-rendered.

View Demo

See Also

• revealMode

Use "before" and "after" if the Drawer should be positioned differently in right-to-left and regular representations. The following table shows the dependency between the rtlEnabled value and "before" and "after" positions:

Top or Bottom Position Demo Left or Right Position Demo

The following modes are available:

• "slide"
  The drawer slides in. The drawer and its content are animated.

• "expand"
  The drawer expands from the closed position. The drawer's width is animated; its content is not.

When you change the Drawer's reveal mode, the component needs to perform recalculations for animation. As a result, the template is rerendered which can increase loading time.

View Demo

See Also

• openedStateMode

When this property is set to true, the UI component text flows from right to left, and the layout of elements is reversed. To switch the entire application/site to the right-to-left representation, assign true to the rtlEnabled field of the object passed to the DevExpress.config(config) method.

DevExpress.config({
    rtlEnabled: true
});

DataGrid Demo Navigation UI Demo Editors Demo

See Also

• openedStateMode

This property accepts one of the following values:

• A CSS selector, or a jQuery selector if you use jQuery

  jQuery

  index.js

  $(function(){
      $("#drawerContainer").dxDrawer({
          // ...
          target: '#targetElement'
      });
  });

  Angular

  app.component.html

  <dx-drawer ... 
      target="#targetElement"
  >
  </dx-drawer>

  Vue

  App.vue

  <template>
      <DxDrawer ... 
          target="#targetElement"
      >
      </DxDrawer>
  </template>
  <script>
  import { DxDrawer } from 'devextreme-vue/drawer';
  
  export default {
      components: {
          DxDrawer
      }
  };
  </script>

  React

  App.js

  import Drawer from 'devextreme-react/drawer';
  // ...
  function App() {
      return (
          <Drawer ... 
              target="#targetElement"
          >
          </Drawer>
      );
  }

• A jQuery wrapper

  jQuery

  index.js

  $(function(){
      $("#drawerContainer").dxDrawer({
          // ...
          target: $('#targetElement')
      });
  });

• A DOM element

  jQuery

  index.js

  $(function(){
      $("#drawerContainer").dxDrawer({
          // ...
          target: document.getElementById('#targetElement')
      });
  });

  Angular

  app.component.html

  app.component.ts

  <dx-drawer ... 
      [target]="targetElement"
  >
  </dx-drawer>

  // ...
  export class AppComponent {
      targetElement: Element;
      constructor() {
          this.targetElement = document.getElementById('#targetElement') as Element;
      }
  }

  Vue

  App.vue

  <template>
      <DxDrawer ... 
          :target="targetElement"
      >
      </DxDrawer>
  </template>
  <script>
  import { DxDrawer } from 'devextreme-vue/drawer';
  
  export default {
      components: {
          DxDrawer
      },
      data() {
          return {
              targetElement: null
          }
      },
      mounted() {
          this.targetElement = document.getElementById('targetElement');
      }
  };
  </script>

  React

  App.js

  import React, { useEffect, useState } from 'react';
  import Drawer from 'devextreme-react/drawer';
  // ...
  function App() {
      const [targetElement, setTargetElement] = useState(null);
      useEffect(() => {
          setTargetElement(document.getElementById('targetElement'));
      }, []);
      return (
          <Drawer ... 
              target={targetElement}
          >
          </Drawer>
      );
  }

See Also

• position

This property specifies the drawer's content. To specify the view's content, nest it inside the Drawer's markup element as shown in the code below.

$(function() {
    $("#drawerContainer").dxDrawer({
        template: function() {
            const $drawerContent = $("<div>").width(200);
            // ...
            // Specify the drawer's content here
            // ...
            return $drawerContent;
        }
    });
});

<div id="drawerContainer">
    <!-- Declare the view's content here -->
</div>

<dx-drawer
    template="drawer-content">
    <div *dxTemplate="let data of 'drawer-content'" style="width:200px;">
        <!-- Declare the drawer's content here -->
    </div>
    <!-- Declare the view's content here -->
</dx-drawer>

<template>
    <DxDrawer
        template="drawer-content">
        <template #drawer-content="{ data }" style="width:200px;">
            <!-- Declare the drawer's content here -->
        </template>
        <!-- Declare the view's content here -->
    </DxDrawer>
</template>

<script>
import 'devextreme/dist/css/dx.light.css';

import DxDrawer from 'devextreme-vue/drawer';

export default {
    components: {
        DxDrawer
    }
}
</script>

import React from 'react';

import 'devextreme/dist/css/dx.light.css';

import Drawer from 'devextreme-react/drawer';

function DrawerContent() {
    return (
        <div style={{ width: 200 }}>
            {/* Declare the drawer's content here */}
        </div>
    )
}

export default function App() {
    return (
        <Drawer
            render={DrawerContent}>
            {/* Declare the view's content here */}
        </Drawer>
    );
}

View Demo

See Also

• Custom Templates

This property accepts a value of one of the following types:

• Number
  The width in pixels.

• String
  A CSS-accepted measurement of width. For example, "55px", "20vw", "auto", "inherit". If you want to specify relative width, use the vw width measurements.

• Function (deprecated since v21.2)
  Refer to the W0017 warning description for information on how you can migrate to viewport units.