Angular SlideOut API Deprecated

Use the dxDrawer instead.

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

import { DxSlideOutModule } from "devextreme-angular"
Type: DxSlideOutTypes.default

View Demo

See Also

Properties

An object defining configuration properties for the SlideOut UI component.

Name Description
activeStateEnabled

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

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

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

Specifies a custom template for the UI component content. Rendered only once - when the UI component is created.
dataSource

Binds the UI component to data.
disabled

Specifies whether the UI component responds to user interaction.
elementAttr

Specifies the global attributes to be attached to the UI component's container element.
height

Specifies the UI component's height.
hint

Specifies text for a hint that appears when a user pauses on the UI component.
hoverStateEnabled

Specifies whether the UI component changes its state when a user pauses on it.
itemComponent

An alias for the itemTemplate property 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 property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.
items

An array of items displayed by the UI component.
itemTemplate

Specifies a custom template for items.
menuGroupComponent

An alias for the menuGroupTemplate property 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 property 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 property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.
menuItemRender

An alias for the menuItemTemplate property 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

Specifies the text or HTML markup displayed by the UI component if the item collection is empty.
onContentReady

A function that is executed when the UI component's content is ready and each time the content is changed.
onDisposing

A function that is executed before the UI component is disposed of.
onInitialized

A function used in JavaScript frameworks to save the UI component 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 UI component property is changed.
onSelectionChanged

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

Switches the UI component 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 UI component's main panel.
visible

Specifies whether the UI component is visible.
width

Specifies the UI component's width.

See Also

Methods

This section describes members used to manipulate the UI component.

Name Description
beginUpdate()

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

Specifies the device-dependent default configuration properties for this component.
dispose()

Disposes of all the resources allocated to the SlideOut instance.
element()

Gets the root UI component element.
endUpdate()

Refreshes the UI component after a call of the beginUpdate() method.
getDataSource()

Gets the DataSource instance.
getInstance(element)

Gets the instance of a UI component found using its DOM node.
hideMenu()

Hides the UI component's slide-out menu.
instance()

Gets the UI component's instance. Use it to access other methods of the UI component.
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 UI component properties.
option(optionName)

Gets the value of a single property.
option(optionName, optionValue)

Updates the value of a single property.
option(options)

Updates the values of several properties.
repaint()

Repaints the UI component without reloading data. Call it to update the UI component's markup.
resetOption(optionName)

Resets a property to its default value.
showMenu()

Displays the UI component'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 UI component.

Name Description
contentReady

Raised when the UI component's content is ready.
disposing

Raised before the UI component is disposed of.
initialized

Raised only once, after the UI component 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 UI component property is changed.
selectionChanged

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

See Also