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.

contentReadyAction

An action performed when widget content is ready.

Type: String|function(e)
Function parameters:
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.
Default Value: null

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

Alternatively, you can assign a URL to which the browser will navigate when widget content is ready.

If data displayed by the widget is specified using a DataSource instance, the contentReadyAction is executed each time the load() method of the DataSource instance is called as well as when widget content is ready. In this case, when you create the widget, the contentReadyAction is executed twice: when widget content is ready (at this moment, the widget does not display items) and when the DataSource is loaded (the widget displays the loaded items).

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.

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. For details refer to the Customize Widget Item Appearance topic.

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.

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

    JavaScript
    height: function () { 
        return baseHeight - 10 + "%";
    }

hoverStateEnabled

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

Type: Boolean
Default Value: true

itemClickAction

An action performed when a collection item is clicked.

Type: String|function(e)
Function parameters:
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.
itemData: Object
The data that is bound to the clicked item.
itemElement: jQuery
An HTML element of the item.
Default Value: null

Assign a function to perform a custom action when the widget's collection item is clicked.

Alternatively, you can assign a URL to which the browser will navigate when the item is clicked.

itemHoldAction

An action performed when an item is being held for a specified time period.

Type: String|function(e)
Function parameters:
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.
itemData: Object
The data that is bound to the item being held.
itemElement: jQuery
An HTML element of the item.
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).

Alternatively, you can assign a URL to which the browser will navigate when item content is being held for a specified time period.

itemHoldTimeout

The time period in milliseconds before itemHoldAction execution.

Type: Number
Default Value: 750

itemRender

A function used to render collection items.

Type: function
Function parameters:
itemData: Object
An object representing the item to be rendered.
itemIndex: Number
The index of the item to be rendered.
itemElement: jQuery
An HTML element containing the item to be rendered.
Return Value: String|DOM Node|jQuery
An HTML string, Element, or jQuery object representing the rendered item.
Default Value: null

As in all container widgets in DevExtreme, items of this widget are displayed by a default HTML template. This template is based on certain fields of the data source. You can define a custom item template that will use specific fields of the data source. To learn more about item templates, refer to the Customize Widget Item Appearance topic.

Implement the itemRender function to provide a custom item template for a given collection item. This function is called each time a collection item of the widget is rendered.

Return an HTML string, Element, or jQuery object representing the rendered item.

Alternatively, you can define the dxTemplate markup component within the widget element and set its name option to item. In this case, the markup enclosed into the dxTemplate component will be automatically applied as an item template. In addition, you may need to define several item templates and apply each of them when required. In this instance, use the itemTemplate option to set the required template.

Refer to the Customize Widget Item Appearance topic to learn more about ways to render collection items.

itemRenderedAction

An action performed after a collection item is rendered.

Type: String|function(e)
Function parameters:
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.
itemData: Object
The data that is bound to the rendered item.
itemElement: jQuery
An HTML element of the item.
Default Value: null

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

Alternatively, you can assign a URL to which the browser will navigate after a collection item is rendered.

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.

itemSelectAction

An action performed when a widget item is selected.

Type: String|function(e)
Function parameters:
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.
itemData: Object
The data that is bound to the selected item.
itemElement: jQuery
An HTML element of the item.
selectedIndex: Object
Specifies the index of the just selected item.
previousIndex: Object
Specifies the index of the previously selected item.
Default Value: null

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

Alternatively, you can assign a URL to which the browser will navigate when a widget item is selected.

itemTemplate

The template to be used for rendering items.

Type: String|function|DOM Node|jQuery
Return Value: String|jQuery
A template name or a template container.
Default Value: "item"

As in all container widgets in DevExtreme, items of this widget are displayed by a default HTML template. This template is based on specific data source fields. You can define a custom item template that will use specific fields of the data source. To learn more about item templates, refer to the Customize Widget Item Appearance topic.

In a simple case, you can define a single custom template for widget items using the dxTemplate markup component within the widget's container. Set the name option of this component to 'item'. In this instance, this template will automatically be used as an item template, and you don't have to specify the itemTemplate option.

However, in some cases you may need to have several custom item templates defined within the widget's container and apply each of them in different scenarios. In this instance, use one of the following ways of setting the required template to the itemTemplate option.

  • Assign a string representing the name of the required template.
  • Assign a function that returns the name of the template as a result of a certain logic.

When you have several collection widgets, you may need to define a common template for them. For this purpose, factor out a template into 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 collection item template, assign one of the following values to the itemTemplate option.

  • Assign a jQuery object representing the template's container
  • Assign a DOM Node representing the template's container
  • Assign a function that returns the jQuery object or a DOM Node representing the template's container

You can use a custom template engine. For this purpose, call the DevExpress.ui.setTemplateEngine(name) method passing the name of one of the supported template engine. You can see a demo where a custom template engine is used: Data Grid - Row Underscore Template.

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.

menuGroupRender

A function rendering a menu group header.

Type: function
Function parameters:
groupData: Object
An object representing the group to be rendered.
groupIndex: Number
The index of the group to be rendered.
groupElement: Object
An HTML element containing the group to be rendered.
Return Value: String|DOM Node|jQuery
An HTML string, Element, or jQuery object representing the rendered group caption.
Default Value: null

menuGroupTemplate

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

Type: String|function|DOM Node|jQuery
Return Value: String|jQuery
A template name or a template container.
Default Value: "group"

menuItemRender

A function used to render items of the slide-out menu.

Type: function
Function parameters:
itemData: Object
The data that is bound to the rendered item.
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
An HTML string, Element, or jQuery object representing the rendered item.
Default Value: null

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

Implement the menuItemRender function to provide a custom item template for a given menu item. This function is called each time a menu item is rendered. The following data is passed as the function's parameters.

  1. itemData - An object representing the rendered item.
  2. itemIndex - An index of the rendered item.
  3. itemElement - A container element containing the rendered item.

Return an HTML string, an Element, or a jQuery object representing the rendered item.

Alternatively, you can factor out a template into a separate HTML element and assign it to the menuItemTemplate option.

To learn more about item templates, refer to the Customize Widget Item Appearance topic.

menuItemTemplate

The template used to render menu items.

Type: String|function|DOM Node|jQuery
Return Value: String|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>

To learn more about item templates, refer to the Customize Widget Item Appearance topic.

If you have several menu item templates specified within the widget, assign the name of a particular 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 this template as a menu item template, assign one of the following values to the menuItemTemplate option:

  • Assign a jQuery object representing the template's container;
  • Assign a DOM Node representing the template's container;
  • Assign a function that returns the jQuery object or a DOM Node representing the template's container.

Alternatively, implement a function that returns a menu item template. For this purpose, use the menuItemRender option.

menuVisible

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

Type: Boolean
Default Value: false

noDataText

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

Type: String
Default Value: "No data to display"

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

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 + "%";
    }