NavPanelCollapseButton

NavPanelCollapseButton toggles the sidebar (NavPanel) collapse state when used in a vertical app layout. Place it in the NavPanel footer (e.g. next to ToneChangerButton) for a Nextra-like sidebar toggle.

Behaviors

This component supports the following behaviors:

Behavior	Properties
Animation	`animation`, `animationOptions`
Bookmark	`bookmark`, `bookmarkLevel`, `bookmarkTitle`, `bookmarkOmitFromToc`
Component Label	`label`, `labelPosition`, `labelWidth`, `labelBreak`, `required`, `enabled`, `shrinkToLabel`, `style`, `readOnly`
Publish/Subscribe	`subscribeToTopic`
Tooltip	`tooltip`, `tooltipMarkdown`, `tooltipOptions`
Styling Variant	`variant`

Properties

`aria-label`

Accessible label for the button when expanded.

`aria-labelCollapsed`

Accessible label for the button when collapsed.

`icon`

default: "sidebar-collapse"

Icon name for the button when the panel is expanded (collapse action).

`iconCollapsed`

default: "sidebar-collapse"

Icon name for the button when the panel is collapsed (expand action).

Events

This component does not have any events.

Exposed Methods

This component does not expose any methods.

Styling

This component does not have any styles.