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

Svelte · App

ShellSettingsPage

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

Public export

typescript
import { ShellSettingsPage } from '@happyvertical/smrt-svelte/app';
Import path
@happyvertical/smrt-svelte/app
Props
7
Props described
7 of 7
Bindable state
0
Callback events
1
Verified release
0.62.10

Props

NameTypeRequiredDescription
signOutHrefstringNoWhere the Account section's sign-out link goes; shown only when given. A link is a GET: never point it at the runtime's POST-only `/sign-out`; use `onSignOut` for that.
onSignOut() => unknownNoCalled by the sign-out control instead of following `signOutHref`; may be async (busy while pending, inline error on rejection).
basePathstringNoTurns on the section menu: the settings route (e.g. `/settings`). Without a `section` the page lists the sections, each linking to `${basePath}/${id}`; with one it renders only that section and links back. Omit for the one-page mode that shows every section.
sectionShellSettingsSectionNoBuilt-in section to render on its own page (needs `basePath` for the back link).
extraSectionsShellSettingsMenuItem[]NoHost sections listed after the built-in ones in the menu.
titlestringNoHeading of a host section page (`children` without a built-in `section`).
childrenSnippetNoHost section content, rendered instead of the built-in panel.

Bindable state

This component has no bindable public state.

Callback events

  • onSignOut() => unknown

Examples and explanation