Settings

Settings sidebar

The left-rail navigation for the BTS space-settings modal, showing the space identity above a menu of setting panes.

Available

Ports as-is

Examples

Rendered live from the maintained Storybook story. Lantern stores only the story id and embeds Storybook rather than duplicating the component or its demo.

Settings sidebar

Rendered live from Storybook

Open

Storybook must be running for this to load — bun run start:storybook from the monorepo root, or set NEXT_PUBLIC_STORYBOOK_URL to a deployed instance.

Props

The component's public API, read from its TypeScript source. Descriptions come from TSDoc on the prop, so this table cannot drift from the component.

Prop	Type	Default	Description
`activeTab`*	`SettingsSidebarTabId`	—	Currently selected pane.
`onTabChange`*	`(tab: SettingsSidebarTabId) => void`	—	Undocumented — add TSDoc to the prop in the library.
`spaceName`*	`string`	—	Space name shown in the identity tile above the menu.
`spaceIconSrc`	`string`	`PLACEHOLDER_SPACE_ICON`	Space avatar. Defaults to the shared inline placeholder — never a network fetch.
`items`	`SettingsSidebarItem[]`	`SETTINGS_SIDEBAR_ITEMS`	Menu contents. Defaults to `SETTINGS_SIDEBAR_ITEMS`.
`className`	`string`	—	Undocumented — add TSDoc to the prop in the library.

Reference

Transcribed from the component audit. If this disagrees with the source, the source is right.

Source: src/components/settings/SettingsSidebar.tsx
Portability: Copies across unchanged — only the utils import path moves.
Notes: Use to switch between settings panes such as Details, Access, Roles, and Billing; pass a filtered item list to drop panes a space doesn't have enabled, such as payouts on a space without commerce.