For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt, and this page is available as Markdown at /api/genui/openui/interfaces/OpenUIContextValue.md.
Lynx
  • English
  • genui / openui / OpenUIContextValue

    OpenUIContextValue

    Runtime context shared by OpenUI renderers, hooks, actions, and form fields.

    Properties

    evaluationContext

    evaluationContext: EvaluationContext;

    AST evaluation context used by runtime expression evaluation.

    Defined in

    @lynx-js/genui/openui/src/core/context.tsx:78


    getFieldValue()

    getFieldValue: (formName: undefined | string, name: string) => any;

    Get a field value. Top-level for $bindings, nested under formName for form fields.

    Parameters

    ParameterType
    formNameundefined | string
    namestring

    Returns

    any

    Defined in

    @lynx-js/genui/openui/src/core/context.tsx:53


    isQueryLoading

    isQueryLoading: boolean;

    Whether any Query is currently fetching data.

    Defined in

    @lynx-js/genui/openui/src/core/context.tsx:49


    isStreaming

    isStreaming: boolean;

    Whether the LLM is currently streaming content.

    Defined in

    @lynx-js/genui/openui/src/core/context.tsx:46


    library

    library: Library;

    The active component library (schema + renderers).

    Defined in

    @lynx-js/genui/openui/src/core/context.tsx:20


    renderNode()

    renderNode: (value: unknown) => ReactNode;

    Render any value (element, array, primitive) into React nodes.

    Parameters

    ParameterType
    valueunknown

    Returns

    ReactNode

    Defined in

    @lynx-js/genui/openui/src/core/context.tsx:25


    reportError()?

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

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

    Parameters

    ParameterType
    errorOpenUIError

    Returns

    void

    Defined in

    @lynx-js/genui/openui/src/core/context.tsx:81


    setFieldValue()

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

    Set a form field value.

    Parameters

    ParameterTypeDescription
    formNameundefined | stringThe form's name prop.
    componentTypeundefined | stringThe 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

    Defined in

    @lynx-js/genui/openui/src/core/context.tsx:66


    store

    store: Store;

    Reactive binding store for $variables and form data.

    Defined in

    @lynx-js/genui/openui/src/core/context.tsx:75


    triggerAction()

    triggerAction: (userMessage: string, formName?: string, action?: any) => 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?any

    Returns

    void | Promise<void>

    Defined in

    @lynx-js/genui/openui/src/core/context.tsx:33

    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.