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.all.js
Module: ui/slide_out
Export: default
Type:

Object

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.

contentComponent

An alias for the contentTemplate option specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.

contentRender

An alias for the contentTemplate option specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.

contentTemplate

Specifies a custom template for the widget content. Rendered only once - when the widget is created.

dataSource

Binds the widget to data.

disabled

Specifies whether the widget responds to user interaction.

elementAttr

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

height

Specifies the widget's height.

hint

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

hoverStateEnabled

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

itemComponent

An alias for the itemTemplate option specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.

itemHoldTimeout

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

itemRender

An alias for the itemTemplate option specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.

items

An array of items displayed by the widget.

itemTemplate

Specifies a custom template for items.

menuGroupComponent

An alias for the menuGroupTemplate option specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.

menuGrouped

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

menuGroupRender

An alias for the menuGroupTemplate option specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.

menuGroupTemplate

Specifies a custom template for group captions.

menuItemComponent

An alias for the menuItemTemplate option specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.

menuItemRender

An alias for the menuItemTemplate option specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.

menuItemTemplate

Specifies a custom template for 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 function that is executed when the widget's content is ready and each time the content is changed.

onDisposing

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

onInitialized

A function used in JavaScript frameworks to save the widget instance.

onItemClick

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

onItemContextMenu

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

onItemHold

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

onItemRendered

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

onMenuGroupRendered

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

onMenuItemRendered

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

onOptionChanged

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

onSelectionChanged

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

rtlEnabled

Switches the widget to 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

Specifies whether the widget is visible.

width

Specifies the widget's width.

See Also

Methods

This section describes members used to manipulate the widget.

Name Description
beginUpdate()

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

defaultOptions(rule)

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

dispose()

Disposes of all the resources allocated to the SlideOut instance.

element()

Gets the root widget element.

endUpdate()

Refreshes the widget after a call of the beginUpdate() method.

getDataSource()

Gets the DataSource instance.

getInstance(element)

Gets the instance of a widget found using its DOM node.

hideMenu()

Hides the widget's slide-out menu.

instance()

Gets the widget's instance. Use it to access other methods of the widget.

off(eventName)

Detaches all event handlers from a single event.

off(eventName, eventHandler)

Detaches a particular event handler from a single event.

on(eventName, eventHandler)

Subscribes to an event.

on(events)

Subscribes to events.

option()

Gets all widget options.

option(optionName)

Gets the value of a single option.

option(optionName, optionValue)

Updates the value of a single option.

option(options)

Updates the values of several options.

repaint()

Repaints the widget without reloading data. Call it to update the widget's markup.

resetOption(optionName)

Resets an option to its default value.

showMenu()

Displays the widget's slide-out menu.

toggleMenuVisibility(showing)

Shows or hides the slide-out menu depending on the argument.

See Also

Events

This section describes events fired by this widget.

Name Description
contentReady

Raised when the widget's content is ready.

disposing

Raised before the widget is disposed of.

initialized

Raised only once, after the widget is initialized.

itemClick

Raised when a collection item is clicked or tapped.

itemContextMenu

Raised when a collection item is right-clicked or pressed.

itemHold

Raised when a collection item has been held for a specified period.

itemRendered

Raised after a collection item is rendered.

menuGroupRendered

Raised when a group is rendered in the slide-out menu.

menuItemRendered

Raised when a regular menu item is rendered.

optionChanged

Raised after a widget option is changed.

selectionChanged

Raised when a collection item is selected or selection is canceled.

See Also