s-m-r-t
Open the s-m-r-t source on GitHub Switch to dark color scheme
← All UI components

Svelte · Workspace

ShellNavToggle

No summary has been written for ShellNavToggle. Everything below is generated from the declaration shipped in 0.57.40 and describes the real contract.

Public export

typescript
import { ShellNavToggle } from '@happyvertical/smrt-svelte/workspace';
Import path
@happyvertical/smrt-svelte/workspace
Props
4
Props described
4 of 4
Bindable state
0
Callback events
1
Verified release
0.57.40

Props

NameTypeRequiredDescription
expandedbooleanYesWhether the nav is open.
onclick() => voidYesToggle the nav (e.g. `() => shell.togglePanel('left')`).
controlsstringNoid of the nav panel (default AdminShell's left panel).
labelstringNoWhat is toggled, for the accessible name ("Collapse site navigation").

Bindable state

This component has no bindable public state.

Callback events

  • onclick() => void

Examples and explanation