JavaScript/jQuery SlideOutView Options
An object defining configuration options for the widget.
See Also
- Configure a Widget: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
activeStateEnabled
Specifies whether or not the widget changes its state when interacting with a user.
This option is used when the widget is displayed on a platform whose guidelines include the active state change for widgets.
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 attributes to be attached to the widget's root 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
Specifies the widget's height.
This option 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; }
hint
Specifies text for a hint that appears when a user pauses on the widget.
hoverStateEnabled
Specifies whether the widget changes its state when a user pauses on it.
menuComponent
An alias for the menuTemplate property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.
menuPosition
Specifies the current menu position.
Normally, the menu is located at the left side of the screen. Assign "inverted" to this option to display the menu at the opposite side.
Use the SlideOutMenuPosition
enum to specify this option when the widget 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 widget is disposed of.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget'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
A function used in JavaScript frameworks to save the widget instance.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
onOptionChanged
A function that is executed after a widget option is changed.
Information about the event.
Name | Type | Description |
---|---|---|
model |
Model data. Available only if you use Knockout. |
|
fullName |
The path to the modified option that includes all parent options. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The widget's instance. |
|
name |
The modified option if it belongs to the first level. Otherwise, the first-level option it is nested into. |
|
value | any |
The modified option's new value. |
rtlEnabled
Switches the widget to a right-to-left representation.
When this option is set to true, the widget 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
swipeEnabled
Specifies whether or not the menu is shown when a user swipes the widget content.
If the option value is false, the menu can be shown only programmatically.
width
Specifies the widget's width.
This option 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; }
If you have technical questions, please create a support ticket in the DevExpress Support Center.