Svelte · Workspace

TenantNav

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

Public export

typescript

import { TenantNav } from '@happyvertical/smrt-svelte/workspace';

Import path: @happyvertical/smrt-svelte/workspace
Props: 10
Props described: 10 of 10
Bindable state: 0
Callback events: 1
Verified release: 0.57.40

Props

NameTypeRequiredDescription

itemsShellNavItem[]NoNavigation items with href, label, icon, and optional children.

groupsShellNavGroup[]NoLabelled, collapsible navigation groups, rendered after flat items.

aria-labelstringNoAccessible name for this navigation landmark.

density'comfortable' | 'touch'NoTarget density; omit to inherit the theme density.

currentHrefstringNoCurrent URL to highlight the active navigation link.

iconComponentComponent<{ name: string; size?: number; }>NoComponent used to render icon names as SVG or custom icons.

collapsedbooleanNoHide labels and show only icons in a compact layout.

onNavigate() => voidNoCalled when the user clicks a navigation link.

navMode'items' | 'sections' | 'sections-with-items'No`'items'` (default) lists every group's entries. `'sections'` shows only the sections. `'sections-with-items'` also shows entries when expanded. Section links go to the section's own page (`ShellNavGroup.href`, else `sectionHref(id)`, else its first entry).

sectionHref(sectionId: string) => string | undefinedNoSection page for groups without an `href` (e.g. user-created ones).

Public export

Props

Bindable state

Callback events

Examples and explanation