JavaScript/jQuery SlideOutView Options
See Also
- Configure a Widget: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
contentComponent
An alias for the contentTemplate property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.
contentRender
An alias for the contentTemplate property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.
elementAttr
Specifies the global attributes to be attached to the UI component's container element.
jQuery
$(function(){ $("#slideOutViewContainer").dxSlideOutView({ // ... elementAttr: { id: "elementId", class: "class-name" } }); });
Angular
<dx-slide-out-view ... [elementAttr]="{ id: 'elementId', class: 'class-name' }"> </dx-slide-out-view>
import { DxSlideOutViewModule } from "devextreme-angular"; // ... export class AppComponent { // ... } @NgModule({ imports: [ // ... DxSlideOutViewModule ], // ... })
Vue
<template> <DxSlideOutView ... :element-attr="slideOutViewAttributes"> </DxSlideOutView> </template> <script> import DxSlideOutView from 'devextreme-vue/slide-out-view'; export default { components: { DxSlideOutView }, data() { return { slideOutViewAttributes: { id: 'elementId', class: 'class-name' } } } } </script>
React
import React from 'react'; import SlideOutView from 'devextreme-react/slide-out-view'; class App extends React.Component { slideOutViewAttributes = { id: 'elementId', class: 'class-name' } render() { return ( <SlideOutView ... elementAttr={this.slideOutViewAttributes}> </SlideOutView> ); } } export default App;
height
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"
,"80%"
,"inherit"
.Function
A function returning either of the above. For example:JavaScriptheight: function() { return window.innerHeight / 1.5; }
menuComponent
An alias for the menuTemplate property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.
menuPosition
Normally, the menu is located at the left side of the screen. Assign "inverted" to this property to display the menu at the opposite side.
Use the SlideOutMenuPosition
enum to specify this property when the UI component is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: Normal
and Inverted
.
menuRender
An alias for the menuTemplate property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.
onDisposing
A function that is executed before the UI component is disposed of.
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
Model data. Available only if you use Knockout. |
onInitialized
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
onOptionChanged
Name | Type | Description |
---|---|---|
model |
Model data. Available only if you use Knockout. |
|
fullName |
The path to the modified property that includes all parent properties. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
|
name |
The modified property if it belongs to the first level. Otherwise, the first-level property it is nested into. |
|
value | any |
The modified property's new value. |
The following example shows how to subscribe to component property changes:
jQuery
$(function() { $("#slideOutViewContainer").dxSlideOutView({ // ... onOptionChanged: function(e) { if(e.name === "changedProperty") { // handle the property change here } } }); });
Angular
<dx-slide-out-view ... (onOptionChanged)="handlePropertyChange($event)"> </dx-slide-out-view>
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 { DxSlideOutViewModule } from 'devextreme-angular'; @NgModule({ declarations: [ AppComponent ], imports: [ BrowserModule, DxSlideOutViewModule ], providers: [ ], bootstrap: [AppComponent] }) export class AppModule { }
Vue
<template> <DxSlideOutView ... @option-changed="handlePropertyChange" /> </template> <script> import 'devextreme/dist/css/dx.common.css'; import 'devextreme/dist/css/dx.light.css'; import DxSlideOutView from 'devextreme-vue/slide-out-view'; export default { components: { DxSlideOutView }, // ... methods: { handlePropertyChange: function(e) { if(e.name === "changedProperty") { // handle the property change here } } } } </script>
React
import React from 'react'; import 'devextreme/dist/css/dx.common.css'; import 'devextreme/dist/css/dx.light.css'; import SlideOutView from 'devextreme-react/slide-out-view'; const handlePropertyChange = (e) => { if(e.name === "changedProperty") { // handle the property change here } } export default function App() { return ( <SlideOutView ... onOptionChanged={handlePropertyChange} /> ); }
rtlEnabled
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 });
See Also
- Right-to-Left Support Demo: DataGrid | Navigation Widgets | Editors
width
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"
,"80%"
,"auto"
,"inherit"
.Function
A function returning either of the above. For example:JavaScriptwidth: function() { return window.innerWidth / 1.5; }