JavaScript/jQuery SlideOutView API
Use the dxDrawer instead.
The SlideOutView UI component is a classic slide-out menu paired with a view. This UI component is very similar to the SlideOut with only one difference - the SlideOut always contains the List in the slide-out menu, while the SlideOutView can hold any collection there.
Options
An object defining configuration properties for the UI component.
| Name | Description |
|---|---|
| activeStateEnabled | Specifies 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. |
| 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. |
| menuComponent | An alias for the menuTemplate property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information. |
| menuPosition | Specifies the current menu position. |
| menuRender | An alias for the menuTemplate property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information. |
| menuTemplate | Specifies a custom template for the menu content. |
| menuVisible | Specifies whether or not the menu panel is visible. |
| 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. |
| onOptionChanged | A function that is executed after a UI component property is changed. |
| rtlEnabled | Switches the UI component to a right-to-left representation. |
| swipeEnabled | Specifies whether or not the menu is shown when a user swipes the UI component content. |
| visible | Specifies whether the UI component is visible. |
| width | Specifies the UI component's width. |
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. |
| content() | Gets the UI component's content. |
| defaultOptions(rule) | Specifies the device-dependent default configuration properties for this component. |
| dispose() | Disposes of all the resources allocated to the SlideOutView instance. |
| element() | Gets the root UI component element. |
| endUpdate() | Refreshes the UI component after a call of the beginUpdate() method. |
| 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. |
| menuContent() | Gets the slide-out menu's content. |
| 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() | Shows the slide-out menu. |
| toggleMenuVisibility(showing) | Shows or hides the slide-out menu depending on the argument. |
Events
This section describes events that this UI component raises.
| Name | Description |
|---|---|
| disposing | Raised before the UI component is disposed of. |
| initialized | Raised only once, after the UI component is initialized. |
| optionChanged | Raised after a UI component property is changed. |