Vue SlideOut Props

Template Data: undefined

Default Name: 'content'

Use to manage the content regardless of which view is selected. You can use the onSelectionChanged option to manually update the content when a title is clicked.

If this option is defined, the itemTemplate option is ignored.

dataSource

A data source used to fetch data to be displayed by the widget.

Type:

|

Array<String | template>

|

DataSource

|

DataSource Configuration

Default Value: null

This option accepts one of the following.

Array of objects
A simple JavaScript array containing a collection of plain objects.
URL
The URL of a JSON file or service that returns JSON data.
DataSource or its configuration object
A DataSource is an object that provides a handy API for data processing. A DataSource is a stateful object, which means that it saves data processing settings and applies them each time data is loaded. All underlying data access logic of a DataSource is isolated in a Store. A Store provides an API for reading and modifying data. Unlike the DataSource, a Store is a stateless object.

NOTE

Data field names should not contain the following characters: ., ,, :, [, and ]. Their presence may cause issues in the widget's operation.

If the data source is specified using the dataSource option, use the items option only for reading. Updating data items using the items option may cause unexpected results.

To display widget items, a default template can be used. This template is based on the data source fields that are listed in the Default Item Template section of the widget's API.

disabled

Specifies whether the widget responds to user interaction.

Type:

Default Value: false

elementAttr

Specifies the attributes to be attached to the widget's root element.

Type:

Default Value: {}

jQuery

$(function(){
    $("#slideOutContainer").dxSlideOut({
        // ...
        elementAttr: {
            id: "elementId",
            class: "class-name"
        }
    });
});

Angular

HTML

TypeScript

<dx-slide-out ...
    [elementAttr]="{ id: 'elementId', class: 'class-name' }">
</dx-slide-out>

import { DxSlideOutModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxSlideOutModule
    ],
    // ...
})

ASP.NET MVC Control

Razor C#

Razor VB

@(Html.DevExtreme().SlideOut()
    .ElementAttr("class", "class-name")
    // ===== or =====
    .ElementAttr(new {
        @id = "elementId",
        @class = "class-name"
    })
    // ===== or =====
    .ElementAttr(new Dictionary<string, object>() {
        { "id", "elementId" },
        { "class", "class-name" }
    })

)

@(Html.DevExtreme().SlideOut() _
    .ElementAttr("class", "class-name")
    ' ===== or =====
    .ElementAttr(New With {
        .id = "elementId",
        .class = "class-name"
    })
    ' ===== or =====
    .ElementAttr(New Dictionary(Of String, Object) From {
        { "id", "elementId" },
        { "class", "class-name" }
    })
)

height

Specifies the widget's height.

Type:

|

|

Return Value:

|

The widget's height.

Default Value: undefined

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%", "auto", "inherit".
Function
A function returning either of the above. For example:
JavaScript
```
height: function() {
    return window.innerHeight / 1.5;
}
```

hint

Specifies text for a hint that appears when a user pauses on the widget.

Type:

Default Value: undefined

hoverStateEnabled

Specifies whether the widget changes its state when a user pauses on it.

Type:

Default Value: false

itemHoldTimeout

The time period in milliseconds before the onItemHold event is raised.

Type:

Number

Default Value: 750

items

An array of items displayed by the widget.

Type:

Array<String | Object>

Raised Events: onOptionChanged

You can use the dataSource option instead. Unlike the items option, the dataSource option can take on the DataSource configuration object as well as a simple array.

NOTE

If you need to modify the data source specified using the items option at runtime, do it only with the help of the items option. Updating data items using the dataSource option may cause unexpected results.

To display widget items, a default template can be used. This template is based on the data source fields that are listed in the Default Item Template section of the widget's API.

itemTemplate

Specifies a custom template for items.

Type:

Template Data:

The item object to be rendered.

Default Name: 'item'

menuGrouped

A Boolean value specifying whether or not to display a grouped menu.

Type:

Default Value: false

If this option is set to true, the object assigned to the items option should include the key and items properties. The key property specifies the group caption in the menu. The items property represents an array listing group items.

menuGroupTemplate

Specifies a custom template for group captions.

Type:

Template Data:

The current group's data.

Default Name: 'menuGroup'

menuItemTemplate

Specifies a custom template for menu items.

Type:

Template Data:

The current menu item's data.

Default Name: 'menuItem'

menuPosition

Specifies the current menu position.

Type:

Default Value: 'normal'

Accepted Values: 'inverted' | 'normal'

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 Control. This enum accepts the following values: Normal and Inverted.

menuVisible

Specifies whether or not the slide-out menu is displayed.

Type:

Default Value: false

noDataText

The text or HTML markup displayed by the widget if the item collection is empty.

Type:

Default Value: 'No data to display'

onContentReady

A function that is executed when the widget's content is ready and each time the content is changed.

Type:

Function parameters:

e:

Information about the event.

Object structure:

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

The model data. Available only when using Knockout.

Default Value: null

onDisposing

A function that is executed before the widget is disposed of.

Type:

Function parameters:

e:

Information about the event.

Object structure:

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

The model data. Available only if you use Knockout.

Default Value: null

onInitialized

A function that is executed only once, after the widget is initialized.

Type:

Function parameters:

e:

Information about the event.

Object structure:

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.

Default Value: null

You cannot access widget elements in this function because it is executed before they are ready. Use the onContentReady function instead.

onItemClick

A function that is executed when a collection item is clicked or tapped.

Type:

|

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	SlideOut	The widget's instance.
element	HTMLElement \| jQuery	The widget's container.
model	Object	The model data. Available only if you use Knockout.
itemData	Object	The clicked item's data.
itemElement	HTMLElement \| jQuery	The item's container. It is an HTML Element or a jQuery Element when you use jQuery.
itemIndex	Number	The clicked item's index.
jQueryEvent	jQuery.Event	Use 'event' instead. The jQuery event that caused the handler execution. Deprecated in favor of the event field.
event	Event (jQuery or EventObject)	The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.

Default Value: null

onItemContextMenu

A function that is executed when a collection item is right-clicked or pressed.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	SlideOut	The widget's instance.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
model	Object	The model data. Available only if you use Knockout.
itemData	Object	The item's data.
itemElement	HTMLElement \| jQuery	The item's container. It is an HTML Element or a jQuery Element when you use jQuery.
itemIndex	Number	The item's index.
jQueryEvent	jQuery.Event	Use 'event' instead. The jQuery event that caused the handler execution. Deprecated in favor of the event field.
event	Event (jQuery or EventObject)	The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.

Default Value: null

onItemHold

A function that is executed when a collection item has been held for a specified period.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	SlideOut	The widget's instance.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
model	Object	The model data. Available only if you use Knockout.
itemData	Object	The data of the item being held.
itemElement	HTMLElement \| jQuery	The item's container. It is an HTML Element or a jQuery Element when you use jQuery.
itemIndex	Number	The item's index.
event	Event (jQuery or EventObject)	The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.

Default Value: null

onItemRendered

A function that is executed after a collection item is rendered.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	SlideOut	The widget's instance.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
model	Object	The model data. Available only if you use Knockout.
itemData	Object	The current item's data.
itemElement	HTMLElement \| jQuery	The item's container. It is an HTML Element or a jQuery Element when you use jQuery.
itemIndex	Number	The current item's index.

Default Value: null

onMenuGroupRendered

A function that is executed when a group menu item is rendered.

Type:

Function parameters:

e:

Information about the event.

Object structure:

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

The model data. Available only if Knockout is used.

Default Value: null

onMenuItemRendered

A function that is executed when a regular menu item is rendered.

Type:

Function parameters:

e:

Information about the event.

Object structure:

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

The model data. Available only if Knockout is used.

Default Value: null

onOptionChanged

A function that is executed after a widget option is changed.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
name	String	The option's short name.
model	Object	The model data. Available only if you use Knockout.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
component	SlideOut	The widget's instance.
fullName	String	The option's full name.
value	any	The option's new value.

Default Value: null

onSelectionChanged

A function that is executed when a collection item is selected or the selection is canceled.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	SlideOut	The widget's instance.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
model	Object	The model data. Available only if you use Knockout.
addedItems	Array<any>	The data of the items that have been selected.
removedItems	Array<any>	The data of the items whose selection has been canceled.

Default Value: null

rtlEnabled

Switches the widget to a right-to-left representation.

Type:

Default Value: false

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.

JavaScript

DevExpress.config({
    rtlEnabled: true
});

selectedIndex

The index number of the currently selected item.

Type:

Number

Default Value: 0

Raised Events: onSelectionChanged

selectedItem

The selected item object.

Type:

Default Value: null

Raised Events: onSelectionChanged

swipeEnabled

Indicates whether the menu can be shown/hidden by swiping the widget's main panel.

Type:

Default Value: true

When this option is set to false, ensure that you have elements in the widget that call the widget's show() and hide() methods.

visible

Specifies whether the widget is visible.

Type: