smrt
Open the smrt source on GitHub Switch to dark color scheme
← All UI components

Svelte · Workspace

ShellNavToggle

Header nav toggle for tablet/desktop: a chevron that points left while the nav is open (collapse) and right while it is collapsed (expand), with an accessible label and `aria-expanded`. Pair it with `ShellTitle` in AdminShell's `header` snippet; phones use the bottom bar's Menu item instead.

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.62.10

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