SlideOut

The SlideOut widget is a classic slide-out menu paired with a view. An end user opens the menu by swiping away the view.

Included in: dx.mobile.js, dx.all.js
Module: ui/slide_out
Export: default

You can create the widget using one of the following approaches.

  • jQuery

    HTML
    CSS
    JavaScript
    <div id="slideOut"></div>
    #slideOut {
        height: auto;
        position: absolute;
        top: 0;
        bottom: 0;
        width: 100%;
    }
    $(function () {
        $("#slideOut").dxSlideOut({
            dataSource: ['SuperLCD 42', 'SuperLED 42', 'SuperLED 50',
                        'SuperLCD 55', 'SuperLCD 70', 'DesktopLCD 19',
                        'DesktopLCD 21', 'DesktopLED 21'],
            onItemClick: function (e) {
                e.component.hideMenu();
            }
        });
    });
  • Angular

    HTML
    JavaScript
    <dx-slide-out
        [dataSource]="displays"
        (onItemClick)="closeSlideOut($event)">
    </dx-slide-out>
    export class AppComponent {
        displays = [
            // ...
        ];
        closeSlideOut = function (e) {
            e.component.hideMenu();
        }
    }
  • AngularJS

    HTML
    JavaScript
    <div id="slideOut" dx-slide-out="{
        dataSource: displays,
        onItemClick: closeSlideOut
    }"></div>
    angular.module('DemoApp', ['dx'])
        .controller("DemoController", function ($scope) {
            $scope.displays = [
                // ...   
            ];
            $scope.closeSlideOut = function (e) {
                e.component.hideMenu();
            }
        });
  • Knockout

    HTML
    <div id="slideOut" data-bind="dxSlideOut: {
        dataSource: [
            // ...
        ],
        onItemClick: function (e) {
            e.component.hideMenu();
        }
    }"></div>
  • ASP.NET MVC Wrappers

    Razor C#
    Razor VB
    @(Html.DevExtreme().SlideOut()
        .ID("slideOut")
        .DataSource(new [] {
            "SuperLCD 42", "SuperLED 42", "SuperLED 50",
            "SuperLCD 55", "SuperLCD 70", "DesktopLCD 19",
            "DesktopLCD 21", "DesktopLED 21"
        })
        .OnItemClick(@<text>
            function (e) {
                e.component.hideMenu();
            }
        </text>)
    )
    @(Html.DevExtreme().SlideOut() _
        .ID("slideOut") _
        .DataSource({
            "SuperLCD 42", "SuperLED 42", "SuperLED 50",
            "SuperLCD 55", "SuperLCD 70", "DesktopLCD 19",
            "DesktopLCD 21", "DesktopLED 21"
        }) _
        .OnItemClick("slideOut_itemClick")
    )
    <script>
        function slideOut_itemClick(e) {
            e.component.hideMenu();
        }
    </script>

Note that DevExtreme widgets require you to link the jQuery library to your application. If you use the Knockout or AngularJS approach, the Knockout or AngularJS library is also required. For detailed information on linking these libraries to your project, refer to the topics in the Installation section.

View Demo

See Also

Configuration

An object defining configuration options for the SlideOut widget.

Name Description
activeStateEnabled

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

contentTemplate

A template to be used for rendering widget content.

dataSource

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

disabled

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

elementAttr

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

height

Specifies the height of the widget.

hint

Specifies the text of the hint displayed for the widget.

hoverStateEnabled

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

itemHoldTimeout

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

items

An array of items displayed by the widget.

itemTemplate

The template to be used for rendering items.

menuGrouped

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

menuGroupTemplate

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

menuItemTemplate

The template used to render menu items.

menuPosition

Specifies the current menu position.

menuVisible

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

noDataText

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

onContentReady

A handler for the contentReady event. Executed when the widget's content is ready. This handler may be executed multiple times during the widget's lifetime depending on the number of times its content changes.

onDisposing

A handler for the disposing event.

onInitialized

A handler for the initialized event. Executed only once, after the widget is initialized.

onItemClick

A handler for the itemClick event.

onItemContextMenu

A handler for the itemContextMenu event.

onItemHold

A handler for the itemHold event.

onItemRendered

A handler for the itemRendered event.

onMenuGroupRendered

A handler for the menuGroupRendered event.

onMenuItemRendered

A handler for the menuItemRendered event.

onOptionChanged

A handler for the optionChanged event.

onSelectionChanged

A handler for the selectionChanged event.

rtlEnabled

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

selectedIndex

The index number of the currently selected item.

selectedItem

The selected item object.

swipeEnabled

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

visible

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

width

Specifies the width of the widget.

Methods

This section describes members used to manipulate the widget.

Name Description
beginUpdate()

Prevents the component from refreshing until the endUpdate() method is called.

defaultOptions(rule)

Specifies the device-dependent default configuration options for this component.

element()

Returns the root HTML element of the widget.

endUpdate()

Enables the component to refresh after the beginUpdate() method call.

getDataSource()

Allows you to get the DataSource instance.

hideMenu()

Hides the widget's slide-out menu.

instance()

Returns an instance of this component class.

off(eventName)

Detaches all event handlers from the specified event.

off(eventName, eventHandler)

Detaches a particular event handler from the specified event.

on(eventName, eventHandler)

Subscribes to a specified event.

on(events)

Subscribes to the specified events.

option()

Returns the configuration options of this component.

option(optionName)

Gets the value of the specified configuration option of this component.

option(optionName, optionValue)

Sets a value to the specified configuration option of this component.

option(options)

Sets one or more options of this component.

repaint()

Redraws the widget.

showMenu()

Displays the widget's slide-out menu.

toggleMenuVisibility(showing)

Toggles the visibility of the widget's slide-out menu.

Events

This section describes events fired by this widget.

Name Description
contentReady

Raised when the widget's content is ready.

disposing

Fires when the widget is being removed.

initialized

Raised only once, after the widget is initialized.

itemClick

Fires when a widget item is clicked.

itemContextMenu

Fires 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.

itemHold

Fires when the widget's collection item is being held for the time period specified by the itemHoldTimeout option.

itemRendered

Fires after a collection item is rendered.

menuGroupRendered

Fires after a menu item group element is rendered.

menuItemRendered

Fires after a menu item is rendered.

optionChanged

Fires after an option of the component is changed.

selectionChanged

Fires after a collection item is selected or unselected.

Default Item Template

This section lists the data source fields that are used in a default template for SlideOut items.

By default, a predefined item template is applied to display the items of this widget. This template is based on certain fields of the data source provided for this widget. Below is the list of these fields. If the default item template is not appropriate for your task, implement a custom item template based on these or other fields of your data source.

See Also