assistant-ui logo/Docs/API Reference
Primitives

QueueItemPrimitive

Queue item primitives for rendering pending assistant-ui thread operations, optimistic work, and runtime queue state.

API Reference

Text

Renders the prompt text of a queue item.

This primitive renders a <span> element unless asChild is set.

<QueueItemPrimitive.Text />
QueueItemPrimitiveTextProps
asChild : boolean = false

Change the default rendered element for the one passed as a child, merging their props and behavior.

Read the Composition guide for more details.

render ?: ReactElement

$$typeof ?: symbol | string

Steer

A button that steers the current run to process this queue item immediately.

This primitive renders a <button> element unless asChild is set.

<QueueItemPrimitive.Steer>Run Now</QueueItemPrimitive.Steer>
QueueItemPrimitiveSteerProps
asChild : boolean = false

Change the default rendered element for the one passed as a child, merging their props and behavior.

Read the Composition guide for more details.

render ?: ReactElement

$$typeof ?: symbol | string

Remove

A button that removes this item from the queue.

This primitive renders a <button> element unless asChild is set.

<QueueItemPrimitive.Remove>×</QueueItemPrimitive.Remove>
QueueItemPrimitiveRemoveProps
asChild : boolean = false

Change the default rendered element for the one passed as a child, merging their props and behavior.

Read the Composition guide for more details.

render ?: ReactElement

$$typeof ?: symbol | string