zidane-ui/ settings
import { … } from 'zidane-ui/settings'ui/src/settings/index.ts
Components#
AgentDefaultsRowsComponent#
The agent, model and effort rows of new sessions' defaults.
AppearanceSectionComponent#
Renders the appearance preferences of the nearest AppearanceProvider. Outside one the controls show the
defaults and change nothing.
ApprovalModeRowComponent#
Tool approvals: ask, Model decision or off, in a menu. Model decision is offered only when a decision model resolves; otherwise its option is disabled and its tooltip says why.
ChoiceRowComponent#
A catalog choice as a row: a press opens a menu of its options.
ClaudeImportDialogComponent#
The Claude Code import dialog. Renders nothing when the host can't import.
CompactionModelRowComponent#
The model that writes compaction summaries.
ConversationPresetsRowComponent#
The sample conversation with a tab for your settings and one per preset (Focused, Balanced, Detailed). A tab only previews; "Use" sets every setting of the preset.
CreateExtensionDialogComponent#
The create-extension dialog. Renders nothing when the host can't scaffold.
DecisionModelRowComponent#
The model that answers decisions from hooks and extensions. Only models the credentials can send decisions to are pickable; when none can, the row says why. Renders nothing when the host lists no decision models.
EditorSectionComponent#
Renders the Files & editor preferences. Editing, Diagnostics and Language servers need the files host's
editorPrefs; the tree side needs an appearance host.
EnabledListSectionComponent#
Renders one enabled list of the nearest SettingsProvider's settings. The entries toggle through
update; without it (or a connection that may not write) they are read-only.
EnvironmentsSectionComponent#
Renders the environment kinds of the nearest SettingsProvider's host. Without the host's
update every control is read-only; without verify there is no connection test.
ExtensionActionRowComponent#
One action row: label and description, a live status line, and a Run button.
ExtensionActionsComponent#
An extension row's controls: Edit, Update, Remove (asks first), then its folder. With
onChangeOrigin, a right click on Update or the arrow beside it opens "Update from <origin>"
and "Change origin…".
ExtensionConfigRowComponent#
One setting's row, by its type.
ExtensionListComponent#
The extensions with their boxes (enabledExtensions): a native one's mark, where it comes from, what it
adds. One that failed to load stays unchecked. This computer's Extensions and a server's draw it.
ExtensionOptionsSectionComponent#
The enabled extensions' options and action rows for cwd (an
ExtensionsSection's children), or why there are none.
ExtensionSourceBrowserComponent#
Renders the extension source browser, open on the default source.
ExtensionsSectionComponent#
Renders the extensions of the nearest SettingsProvider's host for cwd.
HostCatalogSectionComponent#
Renders one catalog of the nearest SettingsProvider's host, as the host reports it.
InstructionsSectionComponent#
Renders what the session's agent is loaded with, from the nearest SettingsProvider's host.
KeybindingsSectionComponent#
Renders every binding of the nearest KeybindingsProvider's host (the defaults outside one). Edit in file
needs the host's openInEditor, Reload a host.
LogsSectionComponent#
Renders the log records of the nearest SettingsProvider's host, filtered by level and text. A connection
that may not write gets no logs (reading them is admin-only too): the frame shows, restricted and empty.
McpSectionComponent#
Renders the MCP servers of the nearest SettingsProvider's host (mcp). Without it the section shows
nothing to do; each action needs its host member, the switches need update, and a connection that may
not write (writable) sees the list and Add server restricted ("Admin only").
ModelListPickerComponent#
The popover, portaled under anchor with the menu motion. The list mounts
fresh on every open (search, cursor and the selected-first order reset).
The forwarded ref is the surface, for the caller's outside-press check.
ModelPickFieldComponent#
A row that picks one model, with its Test and clear button.
ModelTestButtonComponent#
A model row's Test button.
ModelTestLineComponent#
How the last Test went, in one line under the row: the time, provider and model as badges.
PerformanceHudComponent#
Renders the overlay card.
PerformanceSectionComponent#
Renders the nearest SettingsProvider's host's performance figures.
PerfSparklineComponent#
Draws the series. Decorative: the figure it trends sits next to it.
PluginListComponent#
The plugins with their boxes (enabledPlugins): where each comes from, what enabling it brings in, and its
folder. This computer's Plugins and a server's draw it.
PluginsSectionComponent#
Renders the plugins of the nearest SettingsProvider's host for cwd.
ProvidersSectionComponent#
Renders the providers of the nearest SettingsProvider's host (providers). Without it the list is
empty; without an action, its control is hidden; a connection that may not write (writable) sees
the list restricted ("Admin only").
SelectRowComponent#
A row whose value chip opens a menu of options: the current one checked, each with its icon, description and why it may be disabled.
ServerProvidersSectionComponent#
Renders the providers of the nearest SettingsProvider's host (providers) as a server's cards: Set API
key needs setApiKey, Sign in signIn, Remove remove; a connection that may not write (writable)
sees the cards restricted ("Admin only").
ServerSignInComponent#
Renders a server sign-in from start to end.
SettingFocusComponent#
A row a deep link or search can land on: the shell scrolls
[data-setting-focus] into view and the row stays highlighted until the
user presses inside it.
SettingsFrameComponent#
The default frame: the nav column (a back button when the settings can be left, the search, the nav, the footer) beside the open section under its title. Below 640px the columns stack.
SettingsHeadingTextComponent#
Heading text that crossfades on change.
SettingsHostSwitcherComponent#
The settings screen's host switcher: a menu of the hosts, hidden with one.
SettingsNavComponent#
The section nav: a vertical tablist.
SettingsPanelComponent#
A section body's full-height flex column, hosting one SettingsPanelBody (plus any fixed rows above it).
SettingsPanelActionsComponent#
A kept-mounted section's header actions, portaled into the shell's header (shown while the section is open). Renders nothing without actions or a slot (a section that isn't kept mounted has none).
SettingsPanelBodyComponent#
A section body's only scrolling region, on the screen's reading column.
SettingsProviderComponent#
Provides a SettingsHost and optional label overrides to the settings components below it.
SettingsRowsPageComponent#
A layout page of settings rows over the settings host.
SettingsShellComponent#
The settings screen: nav, search and the open section.
SettingsTutorialComponent#
Renders the tutorial of a settings page.
SkillsSectionComponent#
Renders the skills of the nearest SettingsProvider's host for cwd.
SpacesDefaultsSectionComponent#
The Spaces sections of the General page: the switch, then the list with each space's defaults while it is on.
TextModelRowComponent#
The model that writes session titles and suggestions; automatic is the session provider's smallest.
ToggleRowComponent#
A catalog toggle as a row: label, description (or why it is inert) and a switch.
ValueChipComponent#
The value of a row that picks one (a choice, a model, an agent): the caret says it opens a menu. Muted while it names a default or an unavailable setting.
Functions#
agentDefaultsOfFunction#
The host's defaults for new sessions (Settings › Agent › Defaults), as the rows edit them.
agentDefaultsPatchFunction#
The settings patch that stores value as the host's defaults.
appearanceSettingsSectionFunction#
The Appearance section, over the nearest AppearanceProvider.
automaticTextModelFunction#
The automatic text model for main's provider; the main model when the catalog offers nothing smaller.
editorSettingsSectionFunction#
The Files & editor section, over the nearest FilesProvider (editor preferences) and AppearanceProvider.
enabledListSettingsSectionFunction#
A host's enabled list (for a host that can't list its catalog) in its page's place.
environmentsSettingsSectionFunction#
The Environments section, over the settings host's environments group.
extensionConfigValueFunction#
The value a row shows for what is stored — mirrors the core resolver's
default-first checks (type, number range, string pattern, enum membership)
so the row never shows a value the agent would actually ignore. The author
validate can't cross the IPC boundary, so it's the one check not mirrored
here; the authoritative default-first read still happens agent-side via the
core resolver.
extensionPickOfFunction#
The pick of a listed extension. undefined for one with no way to install.
extensionsSettingsSectionFunction#
The Extensions section, over the settings host's extensions group.
filterModelListFunction#
The entries whose search text holds every word of query.
hostCatalogSettingsSectionFunction#
A host's own catalog (a server's Skills, Extensions or Plugins) in that page's place,
over the settings host's hostCatalog group.
instructionsSettingsSectionFunction#
The Instructions section, over the settings host's instructions group.
keybindingsSettingsSectionFunction#
The Keybindings section, over the nearest KeybindingsProvider.
logsSettingsSectionFunction#
The Logs section, over the settings host's logs group.
mcpSettingsSectionFunction#
MCP servers, over the settings host's mcp group and its settings document.
modelPickLabelFunction#
"Opus 4.6 on Anthropic (Work)" for a stored pick, from the catalog when it lists it.
navOrderFunction#
The nav's rows in order: each top-level section, then the sections grouped under it, each followed by the ones grouped under it in turn.
performanceSettingsSectionFunction#
The Performance section, over the settings host's performance member. Kept mounted, it
watches only while open.
pluginsSettingsSectionFunction#
The Plugins section, over the settings host's plugins group.
providersSettingsSectionFunction#
Accounts (providers and keys), over the settings host's providers group.
serverProvidersSettingsSectionFunction#
A server's Accounts as cards, over the settings host's providers group (that server's).
skillsSettingsSectionFunction#
The Skills section, over the settings host's skills group.
spaceDefaultsFunction#
A space's defaults for new sessions, as the rows edit them.
useAccountsSectionLabelsFunction#
The Accounts sections' strings, overridable through LabelsProvider.
useAppearanceSectionLabelsFunction#
The Appearance section's strings, overridable through LabelsProvider.
useClaudeImportAvailableFunction#
Whether the provided settings host has a Claude Code setup to import.
useClaudeImportLabelsFunction#
The Claude Code import dialog's strings, overridable through LabelsProvider.
useCreateExtensionLabelsFunction#
The create-extension dialog's strings, overridable through LabelsProvider.
useEditorSectionLabelsFunction#
The Files & editor section's strings, overridable through LabelsProvider.
useEnabledListSectionLabelsFunction#
The enabled list section's strings, overridable through LabelsProvider.
useEnvironmentsSectionLabelsFunction#
The Environments section's strings, overridable through LabelsProvider.
useExtensionOptionsLabelsFunction#
The extension options' strings, overridable through LabelsProvider.
useExtensionOptionsSearchFunction#
The extension options and actions of a folder as search hits on the
Extensions section (SettingsShell's extraSearch).
useExtensionsSectionLabelsFunction#
The Extensions section's strings, overridable through LabelsProvider.
useHostCatalogLabelsFunction#
The host catalog section's strings, overridable through LabelsProvider.
useInstructionsSectionLabelsFunction#
The Instructions section's strings, overridable through LabelsProvider.
useKeybindingsSectionLabelsFunction#
The Keybindings section's strings, overridable through LabelsProvider.
useLogsSectionLabelsFunction#
The Logs section's strings, overridable through LabelsProvider.
useMcpSectionLabelsFunction#
The MCP servers section's strings, overridable through LabelsProvider.
useModelRowsLabelsFunction#
The model rows' strings, overridable through LabelsProvider.
useModelTestFunction#
The Test of the model key names: run sends the probe. A result belongs
to the key it was run for: another pick shows none until tested.
usePerformanceSectionLabelsFunction#
The Performance section's strings, overridable through LabelsProvider.
usePluginsSectionLabelsFunction#
The Plugins section's strings, overridable through LabelsProvider.
useSettingsFunction#
The nearest provider's settings and their writers, re-rendering when the document changes. Reads the provider's one subscription.
useSettingsDocumentFunction#
The settings document, re-rendering when it changes.
useSettingsHostFunction#
The provided SettingsHost (an empty one outside a provider).
useSettingsHostNameFunction#
The server whose settings the nearest provider holds, by name (undefined: this computer's).
useSettingsLabelsFunction#
Returns the settings components' strings: the defaults merged with any overrides.
useSettingsSectionFunction#
The section a body renders in: its id, whether it is open, and how to open another.
useSettingsWritableFunction#
Whether the settings can be written here: the host offers update and this connection may write.
useSkillsSectionLabelsFunction#
The Skills section's strings, overridable through LabelsProvider.
withSpaceDefaultsFunction#
space with next's defaults. Its fallback chain stays with a model:
kept when the model changes (without the new model itself), gone with it.
Constants#
DEFAULT_ACCOUNTS_SECTION_LABELSConstant#
The default English strings of the Accounts sections.
DEFAULT_APPEARANCE_SECTION_LABELSConstant#
The default English strings of the Appearance section.
DEFAULT_CATALOG_SHARED_LABELSConstant#
The default English strings shared by the catalog sections.
DEFAULT_CLAUDE_IMPORT_LABELSConstant#
The default English strings of the Claude Code import dialog.
DEFAULT_CREATE_EXTENSION_LABELSConstant#
The default English strings of the create-extension dialog.
DEFAULT_EDITOR_SECTION_LABELSConstant#
The default English strings of the Files & editor section.
DEFAULT_ENABLED_LIST_SECTION_LABELSConstant#
The default English strings of the enabled list section.
DEFAULT_ENVIRONMENTS_SECTION_LABELSConstant#
The default English strings of the Environments section.
DEFAULT_EXTENSION_OPTIONS_LABELSConstant#
The default English strings of the extension options.
DEFAULT_EXTENSIONS_SECTION_LABELSConstant#
The default English strings of the Extensions section.
DEFAULT_HOST_CATALOG_LABELSConstant#
The default English strings of the host catalog section.
DEFAULT_INSTRUCTIONS_SECTION_LABELSConstant#
The default English strings of the Instructions section.
DEFAULT_KEYBINDINGS_SECTION_LABELSConstant#
The default English strings of the Keybindings section.
DEFAULT_LOGS_SECTION_LABELSConstant#
The default English strings of the Logs section.
DEFAULT_MCP_SECTION_LABELSConstant#
The default English strings of the MCP servers section.
DEFAULT_MODEL_ROWS_LABELSConstant#
The default English strings of the model rows.
DEFAULT_PERFORMANCE_SECTION_LABELSConstant#
The default English strings of the Performance section and overlay.
DEFAULT_PLUGINS_SECTION_LABELSConstant#
The default English strings of the Plugins section.
DEFAULT_SKILLS_SECTION_LABELSConstant#
The default English strings of the Skills section.
KEYBINDING_ROW_COUNTConstant#
How many rows KEYBINDING_SECTIONS lists (a page's search count).
KEYBINDING_SECTIONSConstant#
The groups Settings › Keybindings shows, in order. Every catalog action has a row.
Interfaces#
AgentDefaultsRowsPropsInterface#
Props for AgentDefaultsRows.
AgentDefaultsValueInterface#
The defaults the rows edit.
AppearanceSectionPropsInterface#
Props for AppearanceSection.
ApprovalModeRowPropsInterface#
Props for ApprovalModeRow.
ChoiceRowPropsInterface#
Props for ChoiceRow.
ClaudeImportDialogPropsInterface#
Props for ClaudeImportDialog.
CompactionModelRowPropsInterface#
Props for CompactionModelRow.
ConversationPresetsRowPropsInterface#
Props for ConversationPresetsRow.
CreateExtensionDialogPropsInterface#
Props for CreateExtensionDialog.
DecisionModelRowPropsInterface#
Props for DecisionModelRow.
EditorDiagnosticsToolInterface#
One project tool the diagnostics run, as found in a folder.
EditorLanguageServerInterface#
One language server, as found for a folder.
EditorSectionPropsInterface#
Props for EditorSection.
EnabledListSectionPropsInterface#
Props for EnabledListSection.
EnvironmentsSectionPropsInterface#
Props for EnvironmentsSection.
ExtensionActionRowPropsInterface#
Props for ExtensionActionRow.
ExtensionConfigRowPropsInterface#
Props for ExtensionConfigRow.
ExtensionOptionsSectionPropsInterface#
Props for ExtensionOptionsSection.
ExtensionPickInterface#
An extension picked in the browser: what installs it.
ExtensionSourceBrowserPropsInterface#
Props of ExtensionSourceBrowser.
ExtensionsSectionPropsInterface#
Props for ExtensionsSection.
HostCatalogSectionPropsInterface#
Props for HostCatalogSection.
InstructionsSectionPropsInterface#
Props for InstructionsSection.
KeybindingGroupInterface#
One group of rows under a title.
KeybindingRowInterface#
One row: a catalog action (its bound keys come from the merged map) or a literal spec.
KeybindingsSectionPropsInterface#
Props for KeybindingsSection.
LogsSectionPropsInterface#
Props for LogsSection.
McpSectionPropsInterface#
Props for McpSection.
ModelListEntryInterface#
A model the list offers.
ModelListPickerPropsInterface#
Props for ModelListPicker.
ModelPickFieldPropsInterface#
Props for ModelPickField.
ModelTestButtonPropsInterface#
Props for ModelTestButton.
ModelTestLinePropsInterface#
Props for ModelTestLine.
PerformanceHudPropsInterface#
Props for PerformanceHud.
PerformanceSectionPropsInterface#
Props for PerformanceSection.
PerfSparklinePropsInterface#
Props for PerfSparkline.
PluginsSectionPropsInterface#
Props for PluginsSection.
PreferenceSectionOverridesInterface#
What a preference section's descriptor may change from the layout's.
ProvidersSectionPropsInterface#
Props for ProvidersSection.
SelectRowOptionInterface#
One option of a SelectRow.
SelectRowPropsInterface#
Props for SelectRow.
ServerProvidersSectionPropsInterface#
Props for ServerProvidersSection.
ServerSignInPropsInterface#
Props for ServerSignIn.
SettingFocusPropsInterface#
Props for SettingFocus.
SettingsFramePropsInterface#
What the frame around the settings draws.
SettingsHeadingTextPropsInterface#
Props for SettingsHeadingText.
SettingsHostSwitcherPropsInterface#
Props for SettingsHostSwitcher.
SettingsNavPropsInterface#
Props for SettingsNav.
SettingsPanelActionsPropsInterface#
Props for SettingsPanelActions.
SettingsPanelBodyPropsInterface#
Props for SettingsPanelBody.
SettingsPanelPropsInterface#
Props for SettingsPanel.
SettingsProviderPropsInterface#
Props for SettingsProvider.
SettingsRowsPagePropsInterface#
Props for SettingsRowsPage.
SettingsSectionStateInterface#
What useSettingsSection returns.
SettingsShellPropsInterface#
Props for SettingsShell.
SettingsTutorialPropsInterface#
Props for SettingsTutorial.
SettingsValuesInterface#
The settings as useSettings hands them, with their writers.
SkillsSectionPropsInterface#
Props for SkillsSection.
SpacesDefaultsSectionPropsInterface#
Props for SpacesDefaultsSection.
TextModelRowPropsInterface#
Props for TextModelRow.
ToggleRowPropsInterface#
Props for ToggleRow.
ValueChipPropsInterface#
Props for ValueChip.
Types#
AccountsConfirmType#
Asks the user to confirm; resolves with the answer.
AccountsSectionLabelsType#
The shape of the Accounts sections' label dictionary.
AppearanceSectionLabelsType#
The shape of the Appearance section's label dictionary.
CatalogSharedLabelsType#
The shape of the shared catalog label dictionary.
ClaudeImportLabelsType#
The shape of the Claude Code import dialog's label dictionary.
CreateExtensionLabelsType#
The shape of the create-extension dialog's label dictionary.
EditorOpenInType#
Where a clicked file, folder or diff opens.
EditorSectionLabelsType#
The shape of the Files & editor section's label dictionary.
EnabledListSectionLabelsType#
The shape of the enabled list section's label dictionary.
EnvironmentsSectionLabelsType#
The shape of the Environments section's label dictionary.
ExtensionConfigValueType#
A setting's value as a row shows and writes it.
ExtensionOptionsLabelsType#
The shape of the extension options' label dictionary.
ExtensionsSectionLabelsType#
The shape of the Extensions section's label dictionary.
HostCatalogLabelsType#
The shape of the host catalog section's label dictionary.
HostCatalogSectionKindType#
The catalogs HostCatalogSection draws.
InstructionsSectionLabelsType#
The shape of the Instructions section's label dictionary.
KeybindingsSectionLabelKeyType#
A key of KeybindingsSectionLabels that names a string (a row or a group).
KeybindingsSectionLabelsType#
The shape of the Keybindings section's label dictionary.
LogsSectionLabelsType#
The shape of the Logs section's label dictionary.
McpSectionLabelsType#
The shape of the MCP servers section's label dictionary.
ModelRowsLabelsType#
The shape of the model rows' label dictionary.
ModelTestStateType#
A Test's state: running, or how it went.
PerformanceSectionLabelsType#
The shape of the Performance section's label dictionary.
PluginsSectionLabelsType#
The shape of the Plugins section's label dictionary.
SkillsSectionLabelsType#
The shape of the Skills section's label dictionary.
Re-exports#
These names are documented on the entry point that owns them.