SlideOutView

The widget that allows you to slide-out the current view to reveal a custom menu.

This widget is similar to the dxSlideOut widget. In its simplest form, it consists of a panel that slides out to reveal a menu. However, unlike the dxSlideOut widget, dxSlideOutView does not hold items. It contains only content and menu panels, which enable you to use any collection widget as a menu.

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

  • jQuery
    Use the dxSlideOut jQuery plug-in.

    HTML
    <div id="slideOutView"></div>
    JavaScript
    $("#slideOut").dxSlideOutView({
        contentTemplate: function(contentElement){
            contentElement.append("<p>Here is the widget content</p>")
        },
        menuTemplate: function(menuElement){
            menuElement.css("height", "100%");
            var menuList = $("<div>").dxList(listOptions);
            menuElement.append(menuList);
        }
    });
  • Knockout
    Add a div element and apply the dxSlideOutView binding to this element.

    HTML
    <div data-bind="dxSlideOutView: {
        contentTemplate: 'myContent',
        menuTemplate: 'myMenu'
    }">
        <div data-options="dxTemplate: { name: 'myContent' }">
            <p>Here is the widget content</p>
        </div>
        <div data-options="dxTemplate: { name: 'myMenu' }" style="height: 100%;">
            <div data-bind="dxList: listOptions"></div>
        </div>
    </div>
  • Angular
    Add a div element and apply the dx-slide-out-view directive to this element.

    HTML
    <div dx-slide-out-view="{
        contentTemplate: 'myContent',
        menuTemplate: 'myMenu'
    }">
        <div data-options="dxTemplate: { name: 'myContent' }">
            <p>Here is the widget content</p>
        </div>
        <div data-options="dxTemplate: { name: 'myMenu' }" style="height: 100%;">
            <div dx-list="listOptions"></div>
        </div>
    }"></div>

Note that DevExtreme widgets require you to link the jQuery and Globalize libraries to your application. If you use the Knockout or Angular approach, the Knockout or Angular library is also required.

See Also

You can find the detailed information on principles of working with the widget in the dxSlideOutView section of the Individual Widgets article.

Configuration

An object defining configuration options for the 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.

disabled

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

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.

menuTemplate

A template to be used for rendering menu panel content.

menuVisible

Specifies whether or not the menu panel is visible.

onDisposing

A handler for the disposing event.

onInitialized

A handler for the initialized event.

onOptionChanged

A handler for the optionChanged event.

rtlEnabled

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

swipeEnabled

Specifies whether or not the menu is shown when a user swipes the widget content.

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.

content()

Returns an HTML element of the widget content block.

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.

hideMenu()

Hides the widget's menu block.

instance()

Returns an instance of this component class.

menuContent()

Returns an HTML element of the widget menu block.

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 menu block.

toggleMenuVisibility()

Toggles the visibility of the widget's menu block.

Events

This section describes events exposed by this widget.

Name Description
disposing

Fires when the widget is being removed.

initialized

Fires when the widget is initialized.

optionChanged

Fires after an option of the component is changed.