Skip to content

ToolCallProps

Defined in: react/components/agent/tool-call.tsx:22

Props shared by every ztui React component (plus each component’s own props).

optional accent?: Partial<MessageAccent>

Defined in: react/components/agent/tool-call.tsx:37

Optional one-sided accent bar around the whole card (colour = which tool / source, like a chat bubble). Omit for a plain card. Defaults the side/weight when only a colour is given.


optional args?: string

Defined in: react/components/agent/tool-call.tsx:31

One-line argument preview, dimmed after the name (e.g. the file path).


optional children?: ReactNode

Defined in: react/components/agent/tool-call.tsx:52

The result body, revealed when expanded — a diff, syntax block, text, …

ComponentProps.children


optional className?: string

Defined in: react/components/types.ts:24

Space-separated class names (currently advisory; no CSS cascade).

ComponentProps.className


optional defaultOpen?: boolean

Defined in: react/components/agent/tool-call.tsx:48

Initial open state when uncontrolled. Defaults to false.


optional disabled?: boolean

Defined in: react/components/types.ts:52

Marks the widget (and its descendants) as inert: not focusable, ignores key/mouse input, and interactive controls render in a muted style. A disabled container propagates to every control inside it.

ComponentProps.disabled


optional focusable?: boolean

Defined in: react/components/types.ts:40

Allow this widget to take keyboard focus.

ComponentProps.focusable


optional focusOnClick?: boolean

Defined in: react/components/types.ts:46

When a click lands on this container (its padding, border, or a non-focusable child), move focus to its first focusable descendant — so clicking a Form/Panel/Box hands focus to its first field. Off by default.

ComponentProps.focusOnClick


optional hoverInterest?: boolean

Defined in: react/components/types.ts:66

Opt-in hint that this widget cares about passive hover movement.

ComponentProps.hoverInterest


optional icon?: ReactNode

Defined in: react/components/agent/tool-call.tsx:29

Optional leading icon for the tool — any node (a HeroIcon, FileIcon, an emoji Label, …). Sits between the status badge and the name. Omit for none.


optional id?: string

Defined in: react/components/types.ts:22

Stable identifier, handy for tests and lookups.

ComponentProps.id


optional label?: string

Defined in: react/components/types.ts:36

Structural/accessible label (also the tab title inside TabContainer).

ComponentProps.label


name: string

Defined in: react/components/agent/tool-call.tsx:24

Tool name shown in the header, e.g. "Read" or "Bash".


optional onClick?: (ev) => void

Defined in: react/components/types.ts:54

Pointer click.

any

void

ComponentProps.onClick


optional onDragEnd?: (x, y, moved) => void

Defined in: react/components/types.ts:72

Drag released; moved is false for a tap with no movement.

number

number

boolean

void

ComponentProps.onDragEnd


optional onDragMove?: (x, y) => void

Defined in: react/components/types.ts:70

Pointer moved while dragging from this widget.

number

number

void

ComponentProps.onDragMove


optional onDragStart?: (x, y) => void

Defined in: react/components/types.ts:68

Pointer-drag lifecycle; moved is false for a tap with no movement.

number

number

void

ComponentProps.onDragStart


optional onKey?: (ev) => void

Defined in: react/components/types.ts:58

Key event while focused; set ev.handled to consume it.

any

void

ComponentProps.onKey


optional onMouseDown?: (ev) => void

Defined in: react/components/types.ts:56

Pointer pressed (any button); the event carries button and x/y.

any

void

ComponentProps.onMouseDown


optional onMouseEnter?: (ev) => void

Defined in: react/components/types.ts:62

Pointer entered this widget’s region.

any

void

ComponentProps.onMouseEnter


optional onMouseLeave?: (ev) => void

Defined in: react/components/types.ts:64

Pointer left this widget’s region.

any

void

ComponentProps.onMouseLeave


optional onScroll?: (ev) => void

Defined in: react/components/types.ts:60

Wheel / scroll event.

any

void

ComponentProps.onScroll


optional onToggle?: (open) => void

Defined in: react/components/agent/tool-call.tsx:50

Fired with the next open state when the user toggles the header.

boolean

void


optional open?: boolean

Defined in: react/components/agent/tool-call.tsx:46

Controlled open state. Omit to let the component manage it internally.


optional ref?: Ref<Widget>

Defined in: react/components/types.ts:30

Captures the underlying widget instance (React 19 ref-as-prop). Defaults to the base Widget; narrow it with a cast when you need a subclass field, e.g. ref={inputRef as React.Ref<InputWidget>}.

ComponentProps.ref


optional status?: ToolCallStatus

Defined in: react/components/agent/tool-call.tsx:39

Execution status; drives the badge glyph and colour. Defaults to "success".


optional style?: WidgetStyles

Defined in: react/components/types.ts:32

Inline styles for this widget — see the Styling guide.

ComponentProps.style


optional summary?: string

Defined in: react/components/agent/tool-call.tsx:44

One-line result preview shown in the header while collapsed (e.g. "42 lines" or "exit 0"), so the call reads at a glance without expanding.


optional theme?: string

Defined in: react/components/types.ts:34

Re-theme this subtree; descendants resolve $tokens against it.

ComponentProps.theme