s-m-r-t
Open the s-m-r-t source on GitHub Switch to dark color scheme
← All UI components

Svelte · Workspace

WorkspaceAccountMenu

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

Public export

typescript
import { WorkspaceAccountMenu } from '@happyvertical/smrt-svelte/workspace';
Import path
@happyvertical/smrt-svelte/workspace
Props
16
Props described
16 of 16
Bindable state
0
Callback events
2
Verified release
0.57.40

Props

NameTypeRequiredDescription
userNamestringYesUsername or identifier displayed in the account menu.
density'comfortable' | 'touch'NoTarget density; omit to inherit the theme density.
compactbooleanNoShow only the avatar while preserving the full accessible account name.
userLabelstringNoCustom display name for the user, falls back to userName.
emailstringNoEmail shown under the name at the top of the open menu.
avatarUrlstringNoURL for the user's avatar image.
tenantLabelstringNoCustom display name for the current tenant.
roleLabelstringNoUser's role or permission level.
tenantsWorkspaceAccountTenant[]NoList of available tenants to switch between.
currentTenantIdstring | nullNoID of the currently selected tenant.
placementDropdownPlacement | 'inline-end'NoWhere the menu appears relative to the trigger. `inline-end` opens beside the trigger, bottom-aligned (a compact trigger in a narrow rail).
disabledbooleanNoDisables the account menu button.
settingsHrefstringNoAdds a Settings link to the menu.
signOutHrefstringNoAdds a Sign out link (a GET navigation) to the menu. Never point it at a POST-only route such as the runtime's `/sign-out`; use `onSignOut` for those. Use `onSignOut` for a callback.
onTenantSelect(tenantId: string) => voidNoCalled when the user selects a different tenant.
onSignOut() => unknownNoCalled when the user clicks sign out. May return a promise: the item shows a busy state (`aria-busy`, disabled against double submit) while it is pending, the menu closes on success, and stays open with an inline error when it rejects.

Bindable state

This component has no bindable public state.

Callback events

  • onTenantSelect(tenantId: string) => void
  • onSignOut() => unknown

Examples and explanation