Axon 911 Frontend DocsAxon 911 Frontend Docs
Axon 911 Frontend Docs
    Loading navigation…
U
User
Switch to light mode
  1. Blocks
  2. Settings Section
  3. API and Development

Settings Section

API and Development

View SourceOpens in a new tabSubmit IssueOpens in a new tab
Import SettingsSection, SettingsRow, and the exported enums from @prepared911/ui/blocks/settings-section. The declaration in packages/ui/src/blocks/settings-section/schema.ts is the contract for inputs, slots, composed components, and variants. Prop types and TSDoc are in packages/ui/src/blocks/settings-section/props.ts. Row copy defaults live in packages/ui/src/utils/settings-declaration/default-settings-section-copy-catalog.ts (settingsSection.* keys).
Props
NameTypeDefaultDescription
titleLocalizedMessage—Section title; rendered as a heading at level.
audienceSettingsRowAudienceSettingsRowAudience.CustomerFacingWho may see the section.
canViewboolean—When false, the section renders null (section-level view permission).
childrenReactNode—SettingsRow children.
classNamestring——
copyOverridesSettingsSectionCopyOverrides—Partial overrides for generated settings section copy.
descriptionLocalizedMessage—Supporting copy under the title. Required when kind is danger.
emptyStateSettingsSectionEmptyState—Shown inside the card when the section has no row children but remains on the page.
idstring——
infoContentLocalizedMessage—Body of the optional info popover beside the title.
infoLabelLocalizedMessage—Accessible name of the optional info popover trigger beside the title.
kindSettingsSectionKindSettingsSectionKind.DefaultVisual intent of the section.
levelSettingsSectionLevelSettingsSectionLevel.TwoHeading level of the title.
localestring—BCP 47 locale override for generated row copy and toasts; otherwise uses the nearest LocaleProvider.
refRef<HTMLDivElement>——
viewerIsStaffboolean—When false, rows with audience: internal render null.
Storybook
Interactive examples and edge cases for this component are in Storybook.
DefaultOpens in a new tab
Previous
Settings Section / Usage
Next
Settings Section / Accessibility
On this page
Props
Storybook