AppSidePane (Client API reference)
[This topic is pre-release documentation and is subject to change.]
Provides methods for managing a single side pane.
Important
- This is a preview feature, and isn't available in all regions.
- Preview features aren’t meant for production use and may have restricted functionality. These features are available before an official release so that customers can get early access and provide feedback.
Methods
| Methods | Description |
|---|---|
| close | Closes the side pane and removes it from the side bar. |
| select | Specify whether the pane should be selected or expanded. |
| navigate | Opens a page within the selected pane. This is similar to the navigateTo method. |
Parameters
| Parameter Name | Type | Required | Description |
|---|---|---|---|
| title | string | No | The title of the pane. Used in pane header and for tooltip. |
| panelId | string | No | The ID of the new pane. If the value is not passed, the ID value is auto-generated. |
| canClose | Boolean | No | Whether the pane header will show a close button or not. |
| imageSrc | string | No | The path of the icon to show in the panel switcher control. |
| width | Number | No | The width of the pane in pixels. |
| hidden | Boolean | No | Hides the pane and tab. |
| alwaysRender | Boolean | No | Prevents the pane from unmounting when it is hidden. |
| keepBadgeOnSelect | Boolean | No | Prevents the badge from getting cleared when the pane becomes selected. |