Skip to content

Sidebar Navigation Item ​

SCASidebarNavigationItem is one row of the sidebar tree: an optional expander, an icon, a label that gets a tooltip when truncated, and an actions menu that appears on hover. Nested items go in the default slot. Icon names are typed (IconName); see Icons.

Props ​

PropTypeDefaultDescription
labelstring | HighlightedText—Row text; HighlightedText (from @scayla/core) marks search matches. Required.
iconIconName—Icon before the label (20 px).
levelnumber0Nesting depth; indents the row.
expandablebooleanfalseShow the expander caret and toggle the children.
expandedbooleanfalseChildren visible. Two-way via v-model:expanded.
selectedbooleanfalseSelected row.
isActivebooleanfalseHighlights the icon and the caret (the route is inside this item); on touch devices it also keeps the actions menu available.
disabledbooleanfalseDisabled row; no hover actions.
isMinibooleanfalseCompact layout (24 px rows, smaller indent).
asstring | Component'button'Element or component of the row, e.g. RouterLink. Attributes and listeners (@click, to, …) go to it.
favoritebooleanfalseDeclared but not used by the row.

Slots ​

SlotDescription
defaultChild items; shown while expanded.
actionsContent of the actions dropdown (dots-three button) shown on hover. Without it the row has no menu.

Emits ​

EventPayloadWhen
update:expandedbooleanThe expander is clicked.

Actions ​

Nesting ​

States and icons ​