'%20d='M64%205c-3%2018-15%2026-13%2043-9-5-13-13-13-22C20%2043%2015%2062%2022%2082c7%2022%2023%2037%2042%2041%2022-4%2039-21%2043-43%203-17-3-32-18-45%202%2011%200%2018-6%2025C84%2036%2075%2019%2064%205Z'%20/%3e%3cpath%20fill='url(%23heat)'%20d='M64%2045c-2%2015-14%2022-13%2038-5-4-8-9-9-15-7%2010-8%2020-4%2030%205%2012%2014%2020%2026%2023%2013-3%2023-12%2027-25%203-11%200-20-8-29%200%207-2%2012-6%2016%201-16-5-27-13-38Z'%20/%3e%3c!--%20The%20glasses%20render%20as%20two%20stacked%20stroke%20groups:%20a%20pale%20warm%20casing%20under%20a%20dark%20warm-charcoal%20stroke.%20The%20casing%20keeps%20the%20dark%20strokes%20legible%20where%20they%20leave%20the%20flame%20body%20(temple%20tips,%20lower%20rims)%20on%20dark%20backgrounds,%20and%20reads%20as%20a%20rim%20light%20against%20the%20flame%20on%20light%20ones.%20--%3e%3cg%20fill='none'%20stroke='%23ffe3ae'%20stroke-opacity='0.85'%20stroke-linecap='round'%20stroke-linejoin='round'%3e%3cpath%20stroke-width='14'%20d='M7%2063c12-4%2027-5%2043-1M78%2062c16-4%2031-3%2043%201'/%3e%3crect%20x='12'%20y='58'%20width='46'%20height='35'%20rx='13'%20stroke-width='14'/%3e%3crect%20x='70'%20y='58'%20width='46'%20height='35'%20rx='13'%20stroke-width='14'/%3e%3cpath%20stroke-width='13'%20d='M57%2066c5-4%209-4%2014%200'/%3e%3c/g%3e%3cg%20fill='none'%20stroke='%2333221b'%20stroke-linecap='round'%20stroke-linejoin='round'%3e%3cpath%20stroke-width='8'%20d='M7%2063c12-4%2027-5%2043-1M78%2062c16-4%2031-3%2043%201'/%3e%3crect%20x='12'%20y='58'%20width='46'%20height='35'%20rx='13'%20stroke-width='8'/%3e%3crect%20x='70'%20y='58'%20width='46'%20height='35'%20rx='13'%20stroke-width='8'/%3e%3cpath%20stroke-width='7'%20d='M57%2066c5-4%209-4%2014%200'/%3e%3c/g%3e%3c/svg%3e){kind=small}
Svelte · Workspace
AdminShell
No summary has been written for AdminShell. Everything below is generated from the declaration shipped in 0.57.40 and describes the real contract.Public export
typescript
import { AdminShell } from '@happyvertical/smrt-svelte/workspace';- Import path
@happyvertical/smrt-svelte/workspace- Props
- 45
- Props described
- 37 of 45
- Bindable state
- 0
- Callback events
- 0
- Verified release
- 0.57.40
Props
NameTypeRequiredDescription
titlestringNoNot describedhomeHrefstringNoOptional destination for the default brand and compact rail mark.edgeTogglesboolean | Partial<Record<PanelEdge, boolean>>NoShow the edge toggle buttons (and their hotkey hints) that open and close the drop-down edge panels: `true` for all four edges, or a per-edge map. Default `false`: no toggles, no hotkeys, and each region is laid out inline (its slots and content visible) instead of a collapsed bar that expands as a drop-down. Visibility then comes from the layout (`ShellLayout.panels`). Existing apps keep the old behaviour with `true`. A phone still gets the Menu opener and drawer for the left sidebar.hotkeysbooleanNoKeyboard shortcuts (WASD, `?`). Default: active only for edges that have toggles. `true` enables them for every edge (the panels then behave as drop-downs without a button); `false` disables them.brandInSlotbooleanNoThe brand is rendered by the host as a slot item (`AppShell` supplies `item:brand` in `header.start`), so the top band does not draw its own.showTenantTogglebooleanNoNot describedlogoSrcstringNoOptional brand logo URL.logoAltstringNoAlternative text for the logo (decorative by default).brandSnippet<[{ compact: boolean; }]>NoCustom brand content, receiving whether it is in the compact rail.subtitlestringNoNot describedconfigShellPanelDefaultsNoNot describedsettingsShellSettingsDeltaNoNot describedsettingsAdapterShellSettingsAdapterNoNot describedstorageKeystringNoNot describedstateShellStateNoPre-configured shell state. Creates one from config if omitted.appBarSnippetNoContent for the top app bar.accountSnippetNoAccount content kept in the app bar in every left-panel state.appPanelSnippetNoContent for the main app panel.tenantRailSnippetNoContent for the left tenant rail.tenantRailFooterSnippetNoContent pinned below the collapsed tenant rail.tenantUtilitiesSnippetNoIcon controls in the left sidebar's utility row: with the collapse chevron at the end of the nav region, above the sidebar footer, in the expanded sidebar (start of the row; the chevron keeps the inner edge) and in the collapsed rail (stacked above the chevron). Desktop only; `AppShell` puts its color-scheme item here.tenantPanelSnippetNoContent for the left tenant panel.slotsPartial<Record<ShellSlot, Snippet>>NoHost content for the region slots (`header.start|center|end`, `footer.start|center|end`, `leftSidebar.header|footer`, `rightSidebar.header|footer`). A slot whose region is not visible moves along its documented fallback chain (see `slotFallbackChain`).layoutEditShellLayoutEditSurfaceNoIn-place layout editing (`AppShell` supplies it): while `active`, slots render as drop zones and hidden regions as strips.rootElementHTMLElementNoThe shell's root element (bindable), e.g. to confine drag hit-testing.floatingReserve{ inline?: string; block?: string; main?: string; }NoRoom kept clear for a floating control (AppShell's floating layout toggle): CSS lengths for the header's end, the right sidebar's top and main's top. Part of the root's style so re-renders never drop it.tenantFooterSnippetNoContent for the tenant panel footer.focusRailSnippetNoContent for the right focus rail.focusPanelSnippet<[{ tool: ShellFocusTool | null; }]>NoContent for the right focus panel, receives the active tool.systemBarSnippetNoContent for the system bar. When supplied without a `systemPanel` it owns the bottom band: there is nothing to open, so no bottom toggle is drawn.systemPanelSnippetNoContent for the system panel.topLeftCornerSnippetNoContent for the top-left corner.topRightCornerSnippetNoContent for the top-right corner.bottomLeftCornerSnippetNoContent for the bottom-left corner.bottomRightCornerSnippetNoContent for the bottom-right corner.shortcutsOverlaySnippetNoContent for the keyboard shortcuts overlay.headerSnippet<[{ viewport: ShellViewport; }]>NoA full-width header row above every edge (`#smrt-admin-shell-header`, 3.5rem; override `--smrt-admin-shell-header-size`). Shown at every width except on phones when `phoneTopBar` is given.phoneTopBarSnippet<[{ hidden: boolean; }]>NoPhone-only context bar over the top of the main region. Hides while scrolling down and returns on the first scroll up (see `phone.hideOnScroll`); pinned while `pinChrome` or a drawer is open. Mark an actual replacement title with `data-shell-page-title-replacement` to visually hide the corresponding PageHeader title. Action-only or workspace-name bars leave the page heading visible. Mark replacement back navigation with `data-shell-page-navigation-replacement` to hide PageHeader breadcrumbs; a title alone does not replace navigation.phoneBottomBarSnippetNoPhone-only bottom bar row. Replaced by a form's action bar (`[data-form-action-bar]` inside main) and hidden while the on-screen keyboard is open.overlaysSnippet<[{ viewport: ShellViewport; bottomBar: BottomBarMode; }]>NoHost surfaces laid over the shell above the phone bottom bar (phone sheets, status strips). The layer ignores pointer events; its direct children receive them.phoneAdminShellPhoneOptionsNoPhone behavior switches (scrim and swipe to close default on; hide on scroll).phoneDockOpenerbooleanNoShow the built-in "Tools" opener on phones while the right edge has focus tools (default true). `AppShell` turns it off when dock toggles already open the dock from the header.pinChromebooleanNoKeep the phone top bar shown (e.g. while a banner is visible).pathstringNoCurrent location. When it changes on a phone, open side drawers and sheets close and the phone top bar comes back.childrenSnippetYesNot describedBindable state
This component has no bindable public state.
Callback events
This component declares no callback event props.