For AI agents: the complete documentation index is available at /next/llms.txt, the full documentation bundle is available at /next/llms-full.txt, and this page is available as Markdown at /next/api/genui/openui/core/interfaces/OpenUIContextValue.md.
Lynx
  • English
  • 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

    ParameterType
    formNamestring | undefined
    namestring

    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

    ParameterType
    valueunknown

    Returns

    ReactNode


    reportError?

    optional reportError?: (error: OpenUIError) => void

    Report a structured error (used internally by error boundary).

    Parameters

    ParameterType
    errorOpenUIError

    Returns

    void


    setFieldValue

    setFieldValue: (formName: string | undefined, componentType: string | undefined, name: string, value: unknown, shouldTriggerSaveCallback?: boolean) => void

    Set a form field value.

    Parameters

    ParameterTypeDescription
    formNamestring | undefinedThe form's name prop.
    componentTypestring | undefinedThe component type (e.g. "Input", "Select").
    namestringThe field's name prop.
    valueunknownThe new value.
    shouldTriggerSaveCallback?booleanWhen true, persists state via onStateUpdate. Text inputs should pass false on change and true on blur. Discrete inputs (Select, RadioGroup, etc.) should always pass true.

    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

    ParameterType
    userMessagestring
    formName?string
    action?ActionPlan | { context?: string; params?: Record<string, any>; type?: string; url?: string; }

    Returns

    void | Promise<void>

    Except as otherwise noted, this work is licensed under a Creative Commons Attribution 4.0 International License, and code samples are licensed under the Apache License 2.0.