Tool

API and Development

View SourceOpens in a new tab Submit IssueOpens in a new tab

Import Tool, ToolState from @prepared911/ui/tool.

Tool

Prop	Type	Default	Notes
`name`	`string`	required	Tool identifier, rendered as code.
`state`	`ToolState \| ToolStateValue`	required	Picks the badge intent and label.
`statusLabels`	`Record<ToolStateValue, LocalizedMessage>`	required	Badge label for every state.
`input`	`unknown`		Printed as JSON unless `null` or `undefined`.
`inputLabel`	`LocalizedMessage`	required	Heading above the input.
`output`	`unknown`		Printed as JSON unless `null` or `undefined`.
`outputLabel`	`LocalizedMessage`	required	Heading above the output.
`errorText`	`LocalizedMessage \| DisplayValue`		Failure text.
`open`	`boolean`		Controlled open state.
`defaultOpen`	`boolean`	`false`	Initial open state when uncontrolled.
`onOpenChange`	`(open: boolean, details: ChangeDetails) => void`		Reason is `trigger-press`.
`className`	`string`		Appended to the root.

ToolState

InputStreaming (input-streaming, informative badge), InputAvailable (input-available, neutral), OutputAvailable (output-available, success) and OutputError (output-error, destructive).

Props

Name	Type	Default	Description
`inputLabel`	`LocalizedMessage`	—	Heading above the input JSON, for example "Input".
`name`	`string`	—	The tool's identifier, for example `queryAnalytics`. It is data, not copy, and reads left to right.
`outputLabel`	`LocalizedMessage`	—	Heading above the output JSON, for example "Output".
`state`	`"input-streaming" \| "input-available" \| "output-available" \| "output-error"`	—	Lifecycle state. It picks the status badge's intent and its label from `statusLabels`. A `ToolState` member or its string, so the `state` of a streamed tool part is accepted as it arrives.
`statusLabels`	`Readonly<Record<"input-streaming" \| "input-available" \| "output-available" \| "output-error", LocalizedMessage>>`	—	The badge label for every state, for example "Running" for `ToolState.InputStreaming`.
`className`	`string`	—	Classes appended to the root.
`defaultOpen`	`boolean`	`false`	Initial open state when uncontrolled.
`errorText`	`LocalizedMessage \| DisplayValue`	—	Failure text, shown in the destructive color. It is runtime data, so a {@link DisplayValue} is accepted.
`input`	`unknown`	—	Tool input, shown as formatted JSON when it is not `null` or `undefined`.
`onOpenChange`	`ToolOpenChangeHandler`	—	Fires when the trigger requests a change.
`open`	`boolean`	—	Controlled open state.
`output`	`unknown`	—	Tool output, shown as formatted JSON when it is not `null` or `undefined`.

Storybook

Interactive examples and edge cases for this component are in Storybook.

DefaultOpens in a new tab

On this page

Tool

API and Development

View SourceOpens in a new tab Submit IssueOpens in a new tab

Import Tool, ToolState from @prepared911/ui/tool.

Tool

Prop	Type	Default	Notes
`name`	`string`	required	Tool identifier, rendered as code.
`state`	`ToolState \| ToolStateValue`	required	Picks the badge intent and label.
`statusLabels`	`Record<ToolStateValue, LocalizedMessage>`	required	Badge label for every state.
`input`	`unknown`		Printed as JSON unless `null` or `undefined`.
`inputLabel`	`LocalizedMessage`	required	Heading above the input.
`output`	`unknown`		Printed as JSON unless `null` or `undefined`.
`outputLabel`	`LocalizedMessage`	required	Heading above the output.
`errorText`	`LocalizedMessage \| DisplayValue`		Failure text.
`open`	`boolean`		Controlled open state.
`defaultOpen`	`boolean`	`false`	Initial open state when uncontrolled.
`onOpenChange`	`(open: boolean, details: ChangeDetails) => void`		Reason is `trigger-press`.
`className`	`string`		Appended to the root.

ToolState

Props

Name	Type	Default	Description
`inputLabel`	`LocalizedMessage`	—	Heading above the input JSON, for example "Input".
`name`	`string`	—	The tool's identifier, for example `queryAnalytics`. It is data, not copy, and reads left to right.
`outputLabel`	`LocalizedMessage`	—	Heading above the output JSON, for example "Output".
`state`	`"input-streaming" \| "input-available" \| "output-available" \| "output-error"`	—	Lifecycle state. It picks the status badge's intent and its label from `statusLabels`. A `ToolState` member or its string, so the `state` of a streamed tool part is accepted as it arrives.
`statusLabels`	`Readonly<Record<"input-streaming" \| "input-available" \| "output-available" \| "output-error", LocalizedMessage>>`	—	The badge label for every state, for example "Running" for `ToolState.InputStreaming`.
`className`	`string`	—	Classes appended to the root.
`defaultOpen`	`boolean`	`false`	Initial open state when uncontrolled.
`errorText`	`LocalizedMessage \| DisplayValue`	—	Failure text, shown in the destructive color. It is runtime data, so a {@link DisplayValue} is accepted.
`input`	`unknown`	—	Tool input, shown as formatted JSON when it is not `null` or `undefined`.
`onOpenChange`	`ToolOpenChangeHandler`	—	Fires when the trigger requests a change.
`open`	`boolean`	—	Controlled open state.
`output`	`unknown`	—	Tool output, shown as formatted JSON when it is not `null` or `undefined`.

Storybook

Interactive examples and edge cases for this component are in Storybook.

DefaultOpens in a new tab

On this page