genui / openui / UseOpenUIStateOptions

#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.

Defined in

@lynx-js/genui/openui/src/core/hooks/useOpenUIState.ts:105

#initialState?

optional initialState: Record<string, unknown>;

Defined in

@lynx-js/genui/openui/src/core/hooks/useOpenUIState.ts:99

#isStreaming

isStreaming: boolean;

Defined in

@lynx-js/genui/openui/src/core/hooks/useOpenUIState.ts:96

#library

library: CoreLibrary<ComponentRenderer<any>>;

Defined in

@lynx-js/genui/openui/src/core/hooks/useOpenUIState.ts:95

#onAction()?

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

Parameters

Returns

void

Defined in

@lynx-js/genui/openui/src/core/hooks/useOpenUIState.ts:97

#onError()?

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

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

Parameters

Returns

void

Defined in

@lynx-js/genui/openui/src/core/hooks/useOpenUIState.ts:109

#onStateUpdate()?

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

Parameters

Returns

void

Defined in

@lynx-js/genui/openui/src/core/hooks/useOpenUIState.ts:98

#response

response: null | string;

Defined in

@lynx-js/genui/openui/src/core/hooks/useOpenUIState.ts:94

#toolProvider?

optional toolProvider: any;

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

Defined in

@lynx-js/genui/openui/src/core/hooks/useOpenUIState.ts:107