Skip to content

SpecRuntimeEditor

API reference and demos for SpecRuntimeEditor.

Source

import { SpecRuntimeEditor } from "@flanksource/clicky-ui/ai";

No dedicated Storybook demo is available for this component yet.

The props table documents the component-specific surface. Standard DOM attributes inherited from React, such as className, event handlers, and accessibility attributes, may also be accepted when the component’s prop type extends a native element.

Prop Type Default Description
activeTab string — Controlled active tab id; falls back to the first visible tab when filtered out.
beforeSections ReactNode — Content rendered before the first section inside the editor column.
className string — —
cliOptions SpecRuntimeCLIOptions — Schema for the runtime's extra CLI args; enables the CLI flags section.
defaultCollapsedSections readonly SpecSectionId[] — Sections that should start collapsed in embedded contexts.
effectiveMode string — Resolved mode used to validate posture when this editable layer inherits it.
effectiveModel string — Resolved model used to identify the inherited provider family.
eyebrow ReactNode Agent configuration —
families SpecRuntimeFamily[] — Runtime catalog used to determine which detailed fields are supported.
fixtureSchemas FixtureFenceSchemas — Runner schemas keyed by fixture kind or fence info, used by the verification editor.
footerStatus ReactNode Ready to run —
inheritedCommits AISpecRuntimeCommit[] — Commit stanza(s) inherited from a lower spec layer (e.g. the lifecycle step's own workflow). Determines whether commit message details apply while the editable layer has no explicit policy.
models ChatModel[] [] —
onActiveTabChange (…) => … — —
onCancel (…) => … — Renders the sticky footer's cancel action when set.
onChange* (…) => void — —
onSave (…) => … — Renders the sticky footer's save action when set.
permissionCatalog AISpecRuntimePermissionCatalog — —
promptVariant enum runtime `document` presents prompt.user as a complete .prompt body; `system` omits prompt.user for hosts that edit it in their own composer.
readOnly boolean false Disables value controls while preserving section navigation and disclosures.
sandboxCatalog SpecRuntimeSandboxCatalog — Sandbox adapter catalog; enables the Sandbox section.
sandboxCreate SpecRuntimeSandboxCreateConfig — Host-owned sandbox creation and credential-reference adapter.
saveLabel string Save & run —
secretSelector SpecRuntimeSecretSelectorConfig — —
sections readonly SpecSectionId[] — Optional ordered section selection for embedded editors that only need part of the runtime spec.
showHeader boolean true Hide the editor rail when a host modal already supplies the context.
tabs readonly SpecRuntimeTab[] — Groups sections behind a tab strip instead of stacking them; exclusive with `sections`.
title ReactNode Runtime Spec —
tools ToolMeta[] [] —
value* AISpecRuntimeSpec — —
variant enum run Restrict task-owned fields when editing a reusable preset fragment.