#Interface: UseOpenUIStateOptions

Inputs used to parse OpenUI text and build renderer state.

#Properties

#initialQueryResults?

optional initialQueryResults?: Readonly<Record<string, unknown>>

Prefetched Query results keyed by the Query assignment name (statement ID). They are available during the initial render and act as fallbacks while an optional tool provider revalidates them after commit.

---

#initialState?

optional initialState?: Record<string, unknown>

---

#isStreaming

isStreaming: boolean

---

#library

library: Library

---

#onAction?

optional onAction?: (event: ActionEvent) => void

#Parameters

#Returns

void

---

#onError?

optional onError?: (errors: OpenUIError[]) => void

Callback for structured, LLM-friendly errors. See OpenUIError type.

#Parameters

#Returns

void

---

#onStateUpdate?

optional onStateUpdate?: (state: Record<string, unknown>) => void

#Parameters

#Returns

void

---

#response

response: string | null

---

#toolProvider?

optional toolProvider?: ToolProvider | null

ToolProvider for Query data fetching — MCP, REST, GraphQL, or any backend.