Configuration

An object defining configuration options for the dxSlideOut widget.

activeStateEnabled

A Boolean value specifying whether or not the widget changes its state when interacting with a user.

Type:

Boolean

Default Value: false

This option is used when the widget is displayed on a platform whose guidelines include the active state change for widgets.

contentTemplate

A template to be used for rendering widget content.

Function parameters:
container:

jQuery

The jQuery object of the widget content element.

Return Value:

String

|

DOM Node

|

jQuery

A template name or a template container.

Default Value: 'content'

If the contentTemplate is defined, the widget does not render selected items. It renders only the content template when the widget is created. You can use the onItemClick option to manually update the content when a menu item is clicked.

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

Show Example:
AngularJS
Knockout
jQuery

dataSource

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

Default Value: null

You can assign an array directly to this option as well as use the Data Source provided by the DevExtreme library.

NOTE
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. Alternatively, you can implement a custom item template.

See Also

disabled

A Boolean value specifying whether or not the widget can respond to user interaction.

Type:

Boolean

Default Value: false

Create an observable variable and assign it to this option to specify the availability of the widget at runtime.

height

Specifies the height of the widget.

Type:

Number

|

String

|

function

Return Value:

Number

|

String

The widget height.

Default Value: undefined

The option can hold a value of the following types.

  • number
    The height of the widget in pixels

  • string
    A CSS measurement of the widget height (e.g., "55px", "80%", "auto" and "inherit")

  • function
    A function returning the widget height (e.g., height:function(){ return baseHeight - 10 + "%"; })

hint

Specifies the text of the hint displayed for the widget.

Type:

String

Default Value: undefined

hoverStateEnabled

A Boolean value specifying whether or not the widget changes its state when being hovered by an end user.

Type:

Boolean

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

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. Alternatively, you can implement a custom item template.

See Also

itemTemplate

The template to be used for rendering items.

Function parameters:
itemData:

Object

The item object to be rendered.

itemIndex:

Number

The index of the item to be rendered.

itemElement:

jQuery

An HTML element of the item to be rendered.

Return Value:

String

|

DOM Node

|

jQuery

A template name or a template container.

Default Value: 'item'
NOTE
A binding context of an item template is the data source object that corresponds to the currently rendered item. So, you can bind template elements to the item object's fields directly (see the code above). To access another binding context within an item template, use Knockout/AngularJS binding variables.
See Also

menuGrouped

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

Type:

Boolean

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

The name of the template used to display a group header.

Function parameters:
groupData:

Object

The group object to be rendered.

groupIndex:

Number

The index of the group to be rendered.

groupElement:

Object

An HTML element of the group to be rendered.

Return Value:

String

|

DOM Node

|

jQuery

A template name or a template container.

Default Value: 'menuGroup'
NOTE
A binding context of a group template is the data source object that corresponds to the currently rendered group. So, you can bind template elements to the group object's fields directly (see the code above). To access another binding context within a group template, use the Knockout/AngularJS binding variables.

menuItemTemplate

The template used to render menu items.

Function parameters:
itemData:

Object

The menu item object to be rendered.

itemIndex:

Number

The index of the menu item to be rendered.

itemElement:

jQuery

An HTML element of the menu item to be rendered.

Return Value:

String

|

DOM Node

|

jQuery

A template name or a template container.

Default Value: 'menuItem'

As in all container widgets in DevExtreme, slide-out menu items are displayed by a default HTML template. This template is based on certain fields of the data source. You can define a custom menu item template that will use specific fields of the data source.

HTML
<div id="slideOut" data-bind="dxSlideOut:{dataSource: items, selectedIndex: selectedIndex}">
    <div data-options="dxTemplate : { name: 'menuItem' } ">
        This is <div data-bind="text: text"></div>
    </div>
</div>
NOTE
A binding context of a menu item template is the data source object that corresponds to the currently rendered item. So, you can bind template elements to the item object's fields directly (see the code above). To access another binding context within a menu item template, use the Knockout/AngularJS binding variables.
See Also

If you have several menu item templates specified within the widget, assign the name of a specific template to the widget's menuItemTemplate option.

You can define the markup for a menu item template as a separate element, as demonstrated below.

HTML
<script type="text/html" id="person-template">
    <h3 data-bind="text: name"></h3>
    <p>Address: <span data-bind="text: address"></span></p>
</script>

To set the common template as a menu item template, pass the template container element to the menuItemTemplate option. The option accepts a jQuery object, a DOM node, or a function that returns a jQuery object or a DOM node.

menuPosition

Specifies the current menu position.

Type:

String

Default Value: 'normal'
Accepted Values: 'normal' | 'inverted'

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.

Show Example:
AngularJS
Knockout
jQuery

menuVisible

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

Type:

Boolean

Default Value: false

noDataText

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

Type:

String

Default Value: 'No data to display'

onContentReady

A handler for the contentReady event.

Type:

function

Function parameters:
e:

Object

Provides function parameters.

Object structure:
component:

Object

Provides access to the widget instance.

element:

jQuery

An HTML element of the widget.

model:

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout and AngularJS approaches.

Default Value: null

Assign a function to perform a custom action when widget content is ready.

onDisposing

A handler for the disposing event.

Type:

function

Function parameters:
e:

Object

Provides function parameters.

Object structure:
component:

Object

Provides access to the widget instance.

element:

jQuery

An HTML element of the widget.

model:

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout and AngularJS approaches.

Default Value: null

Assign a function to perform a custom action when the widget is being removed.

NOTE
The function assigned to this option is executed only if the widget is removed using the remove(), empty(), or html() jQuery methods.

onInitialized

A handler for the initialized event.

Type:

function

Function parameters:
e:

Object

Provides function parameters.

Object structure:
component:

Object

Provides access to the widget instance.

element:

jQuery

An HTML element of the widget.

Default Value: null

Assign a function to perform a custom action when the widget is initialized.

onItemClick

A handler for the itemClick event.

Type:

function

|

String

Function parameters:
e:

Object

Provides function parameters.

Object structure:
component:

Object

Provides access to the widget instance.

element:

jQuery

An HTML element of the widget.

model:

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout and AngularJS approaches.

itemData:

Object

The data that is bound to the clicked item.

itemElement:

jQuery

An HTML element of the item.

itemIndex:

Number

Specifies the index of the clicked item.

jQueryEvent:

jQuery.Event

Specifies the jQuery event that caused action execution.

Default Value: null

Assign a function to perform a custom action when a widget item is clicked.

To navigate to a specific URL when the itemClick event fires, assign that URL or the anchor part (#) of that URL directly to this option as a string.

onItemContextMenu

A handler for the itemContextMenu event.

Type:

function

Function parameters:
e:

Object

Provides function parameters.

Object structure:
component:

Object

Provides access to the widget instance.

element:

jQuery

An HTML element of the widget.

model:

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout and AngularJS approaches.

itemData:

Object

The data that is bound to the item.

itemElement:

jQuery

An HTML element of the item.

itemIndex:

Number

Specifies the index of the item.

jQueryEvent:

jQuery.Event

Specifies the jQuery event that caused action execution.

Default Value: null

Assign a function to perform a custom action when the right mouse button is clicked when the pointer is over a widget item, or when the "sustained" (also known as a long press) touch action is performed.

onItemHold

A handler for the itemHold event.

Type:

function

Function parameters:
e:

Object

Provides function parameters.

Object structure:
component:

Object

Provides access to the widget instance.

element:

jQuery

An HTML element of the widget.

model:

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout and AngularJS approaches.

itemData:

Object

The data that is bound to the item being held.

itemElement:

jQuery

An HTML element of the item.

itemIndex:

Number

Specifies the index of the item being held.

Default Value: null

Assign a function to perform a custom action when the widget's collection item is being held for a specified time period (see the itemHoldTimeout option).

onItemRendered

A handler for the itemRendered event.

Type:

function

Function parameters:
e:

Object

Provides function parameters.

Object structure:
component:

Object

Provides access to the widget instance.

element:

jQuery

An HTML element of the widget.

model:

Object

Provides access to the data available for binding against the element. Available only in the Knockout and AngularJS approaches.

itemData:

Object

The data that is bound to the item to be rendered.

itemElement:

jQuery

An HTML element of the item.

itemIndex:

Number

Specifies the index of the rendered item.

Default Value: null

Assign a function to perform a custom action after a collection item is rendered.

onMenuGroupRendered

A handler for the menuGroupRendered event.

Type:

function

Function parameters:
e:

Object

Provides function parameters.

Object structure:
component:

Object

Provides access to the widget instance.

element:

jQuery

An HTML element of the widget.

model:

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout and AngularJS approaches.

Default Value: null

Assign a function to perform a custom action after a menu item group element is rendered.

onMenuItemRendered

A handler for the menuItemRendered event.

Type:

function

Function parameters:
e:

Object

Provides function parameters.

Object structure:
component:

Object

Provides access to the widget instance.

element:

jQuery

An HTML element of the widget.

model:

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout and AngularJS approaches.

Default Value: null

Assign a function to perform a custom action after a menu item is rendered.

onOptionChanged

A handler for the optionChanged event.

Type:

function

Function parameters:
e:

Object

Provides function parameters.

Object structure:
component:

Object

Provides access to the widget instance.

name:

String

Specifies the name of the option whose value is changed.

fullName:

String

Specifies a full name of the option whose value is changed. The full name is formed by concatenating the names of the options that are presented in the hierarchy of the given option. The names are delimited by commas.

value: any

Specifies a new value for the option.

element:

jQuery

An HTML element of the widget.

model:

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout and AngularJS approaches.

Default Value: null

Assign a function to perform a custom action after an option of the component is changed.

onSelectionChanged

A handler for the selectionChanged event.

Type:

function

Function parameters:
e:

Object

Provides function parameters.

Object structure:
component:

Object

Provides access to the widget instance.

element:

jQuery

An HTML element of the widget.

model:

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout and AngularJS approaches.

addedItems:

Array

An array of items added to selection.

removedItems:

Array

An array of items removed from selection.

Default Value: null

Assign a function to perform a custom action after a collection item is selected or unselected.

rtlEnabled

Specifies whether or not the current component supports a right-to-left representation.

Type:

Boolean

Default Value: false

If you need to switch the display of this DevExtreme component to right-to-left, enable a specifically designed configuration option - rtlEnabled. When this option is set to true, the text flows from right to left, and the layout the component's elements is reversed. To switch the entire application/site to a right-to-left representation, use the static DevExpress.rtlEnabled field.

selectedIndex

The index of the currently selected widget item.

Type:

Number

Default Value: -1

selectedItem

The selected item object.

Type:

Object

Default Value: null

swipeEnabled

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

Type:

Boolean

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

A Boolean value specifying whether or not the widget is visible.

Type:

Boolean

Default Value: true

width

Specifies the width of the widget.

Type:

Number

|

String

|

function

Return Value:

Number

|

String

The widget width.

Default Value: undefined

The option can hold a value of the following types.

  • numeric
    The widget width in pixels.
  • string
    A CSS measurement of the widget width (e.g., "55px", "80%", "auto" and "inherit").
  • function
    The function returning the widget width. For example, see the following code.

    JavaScript
    width: function () { 
        return baseWidth - 10 + "%";
    }