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/OpenUiRendererRuntimeProps.md.
Lynx
  • English
  • genui / openui / OpenUiRendererRuntimeProps

    OpenUiRendererRuntimeProps

    Props for rendering raw OpenUI response text with parsing, runtime state, actions, and query execution.

    Properties

    initialQueryResults?

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

    Prefetched Query results keyed by Query assignment name (statement ID). Results render synchronously, then an optional toolProvider revalidates.

    Defined in

    @lynx-js/genui/openui/src/core/renderer.tsx:70


    initialState?

    optional initialState: Record<string, unknown>;

    Initial persisted state. $-prefixed keys hydrate reactive bindings.

    Defined in

    @lynx-js/genui/openui/src/core/renderer.tsx:65


    isStreaming?

    optional isStreaming: boolean;

    Whether the LLM is still streaming; disables interactions while true.

    Defined in

    @lynx-js/genui/openui/src/core/renderer.tsx:59


    library

    library: CoreLibrary<ComponentRenderer<any>>;

    Component library from createOpenUiLibrary().

    Defined in

    @lynx-js/genui/openui/src/core/renderer.tsx:57


    onAction()?

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

    Callback when a component triggers a host action.

    Parameters

    ParameterType
    eventActionEvent

    Returns

    void

    Defined in

    @lynx-js/genui/openui/src/core/renderer.tsx:61


    onError()?

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

    Structured parser/runtime/query errors for correction loops.

    Parameters

    ParameterType
    errorsOpenUIError[]

    Returns

    void

    Defined in

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


    onParseResult()?

    optional onParseResult: (result: any) => void;

    Called whenever the raw parse result changes.

    Parameters

    ParameterType
    resultany

    Returns

    void

    Defined in

    @lynx-js/genui/openui/src/core/renderer.tsx:72


    onStateUpdate()?

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

    Called whenever $variables or form state changes.

    Parameters

    ParameterType
    stateRecord<string, unknown>

    Returns

    void

    Defined in

    @lynx-js/genui/openui/src/core/renderer.tsx:63


    queryLoader?

    optional queryLoader: ReactNode;

    Custom loading node shown while Query() calls are in flight.

    Defined in

    @lynx-js/genui/openui/src/core/renderer.tsx:76


    response

    response: null | string;

    Raw openui-lang response text. This enables v0.5 runtime features.

    Defined in

    @lynx-js/genui/openui/src/core/renderer.tsx:55


    toolProvider?

    optional toolProvider: any;

    Tool provider for Query()/Mutation(): function map or MCP client.

    Defined in

    @lynx-js/genui/openui/src/core/renderer.tsx:74

    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.