FixtureEditor

API reference and demos for FixtureEditor.

Source

Import

import { FixtureEditor } from "@flanksource/clicky-ui/data";

Demos

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.

Props

Prop	Type	Default	Description
allowedFences	readonly FixtureFenceOption[]	—	Optional allow-list/order for the add-fence menu. Defaults to schema keys.
className	string	—	Classes applied to the component root.
frontmatterEditor	boolean | FixtureFrontmatterEditorOptions	—	Enables a dialog for top-level fixture frontmatter. The dialog edits Gavel `ai:` runtime options and fixture `env:` while preserving unrelated keys.
onChange*	(…) => void	—	Called with the serialized fixture markdown after an edit.
placeholder	string	Write fixture markdown...	Text shown in the empty markdown editor.
readOnly	boolean	false	Disables all editing controls while preserving the markdown rendering.
schemas	FixtureFenceSchemas	{}	Host-provided runner schemas keyed by logical fixture kind ("test", "lint") or full fence info string ("yaml test", "yaml lint"). AI/reviewer instructions are markdown/source content, not fence schemas.
size	enum	md	Form/input density forwarded to nested editors.
value*	string	—	Controlled fixture markdown source.