Interface: SettingsPage
Defined in: packages/sdk/src/types.ts:852
A page in the Settings dialog, listed in the left rail.
Properties
id
id: string;Defined in: packages/sdk/src/types.ts:854
Unique id for this settings page.
title
title: string;Defined in: packages/sdk/src/types.ts:859
Label shown in the Settings left rail and as the host-owned page title in the pane. Do not render your own <h2> — the host draws this.
group?
optional group?: string;Defined in: packages/sdk/src/types.ts:866
Optional grouping key for the left rail (groups sorted lexically, separated by a divider). Honored only for core.* pages; a page contributed by any non-core extension is always grouped under Extensions, so group is ignored for those.
order?
optional order?: number;Defined in: packages/sdk/src/types.ts:868
Sort order within the group. Lower sorts first. Defaults to 0.
component
component: ComponentType;Defined in: packages/sdk/src/types.ts:870
Renders the right-hand pane when this page is selected.
badge?
optional badge?: ComponentType<{
}>;Defined in: packages/sdk/src/types.ts:877
Optional small indicator rendered after the title in the left rail (e.g. an update-available count). Rendered as its own component — separate from SettingsPage.component — so it can subscribe to reactive state and update independently of whether the page itself is the active one.