Interface: OpenUIContextValue
Runtime context shared by OpenUI renderers, hooks, actions, and form fields.
Properties
evaluationContext
evaluationContext:
EvaluationContext
AST evaluation context used by runtime expression evaluation.
getFieldValue
getFieldValue: (
formName:string|undefined,name:string) =>any
Get a field value. Top-level for $bindings, nested under formName for form fields.
Parameters
Returns
any
isQueryLoading
isQueryLoading:
boolean
Whether any Query is currently fetching data.
isStreaming
isStreaming:
boolean
Whether the LLM is currently streaming content.
library
library:
Library
The active component library (schema + renderers).
renderNode
renderNode: (
value:unknown) =>ReactNode
Render any value (element, array, primitive) into React nodes.
Parameters
Returns
ReactNode
reportError?
optionalreportError?: (error:OpenUIError) =>void
Report a structured error (used internally by error boundary).
Parameters
Returns
void
setFieldValue
setFieldValue: (
formName:string|undefined,componentType:string|undefined,name:string,value:unknown,shouldTriggerSaveCallback?:boolean) =>void
Set a form field value.
Parameters
Returns
void
store
store:
Store
Reactive binding store for $variables and form data.
triggerAction
triggerAction: (
userMessage:string,formName?:string,action?:ActionPlan| {context?:string;params?:Record<string,any>;type?:string;url?:string; }) =>void|Promise<void>
Trigger an action. Accepts either:
- ActionPlan (v0.5): runs steps sequentially (Run, Set, ToAssistant, OpenUrl)
- Legacy action config (v0.1): object with optional type and params.
- Nothing: fires ContinueConversation with the label
Parameters
Returns
void | Promise<void>