Skip to content

ctx.registerSettingsPage

Add a page to the Settings dialog. The host draws the left rail entry and the pane title from SettingsPage.title — your component is the body only (no <h2>).

ts
ctx.registerSettingsPage(page: SettingsPage): Disposable

Example

tsx
ctx.registerSettingsPage({
  id: "acme",
  title: "Acme",
  component: AcmeSettings, // body only — no page title
});

Pass badge to render a small indicator after the title in the rail (e.g. an update count) — its own component, so it can subscribe to reactive state and update independently of the page's own render:

tsx
ctx.registerSettingsPage({
  id: "acme",
  title: "Acme",
  component: AcmeSettings,
  badge: AcmeUpdateBadge, // e.g. renders a pill when updates are pending
});

Types

Pass SettingsPage.

See also

Other Registration members on ctx.