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/index.md.
Lynx
  • English

      • genui / openui

      openui

      Index

      Interfaces

      InterfaceDescription
      ComponentRenderPropsProps passed to an OpenUI ReactLynx component renderer.
      CreateOpenUiLibraryOptionsOptions for creating a ReactLynx OpenUI component library.
      FormValidationContextValueValidation state and helpers for OpenUI form fields.
      OpenUIContextValueRuntime context shared by OpenUI renderers, hooks, actions, and form fields.
      OpenUiRendererParsedPropsProps for rendering an already parsed OpenUI result.
      OpenUiRendererRuntimePropsProps for rendering raw OpenUI response text with parsing, runtime state, actions, and query execution.
      OpenUIStateDerived OpenUI renderer state returned by useOpenUIState.
      UseOpenUIStateOptionsInputs used to parse OpenUI text and build renderer state.

      Type Aliases

      Type aliasDescription
      ComponentRenderer-
      DefinedComponent-
      InitialQueryResultsPrefetched Query results keyed by Query assignment name (statement ID).
      Library-
      LibraryDefinition-
      OpenUiRendererProps-
      ToolProviderInput-

      Variables

      VariableDescription
      ACTION_STEPS-
      FormNameContext-
      FormValidationContext-

      Functions

      FunctionDescription
      createOpenUiLibraryCreate a ReactLynx OpenUI library with caller-provided components and, unless disabled, the built-in components.
      defineComponentDefine a ReactLynx component renderer and its OpenUI schema metadata.
      OpenUiRendererRender OpenUI language output using a ReactLynx component library.
      reactiveMark a schema prop as reactive so runtime evaluation can preserve $bindings.
      useCreateFormValidationCreate form validation state and callbacks for an OpenUI form boundary.
      useFormValidationRead the nearest OpenUI form validation context, if one exists.
      useGetFieldValueGet a form field value from the form state context.
      useIsQueryLoadingWhether any Query is currently fetching data.
      useIsStreamingWhether the LLM is currently streaming content.
      useOpenUIAccess the full OpenUI context. Throws if used outside an OpenUiRenderer tree.
      useOpenUIStateCore state hook — extracts all form state, action handling, parser management, and context assembly out of the Renderer component.
      useRenderNodeGet the renderNode function for rendering nested component values.
      useSetDefaultValuePersists a component's default/initial value into form state once streaming finishes — but only if the user hasn't already set a value.
      useSetFieldValueGet the setFieldValue function for updating form field values.
      useStateFieldResolve a named OpenUI state field against form state and reactive bindings.
      useTriggerActionGet the triggerAction function for firing structured action events.

      References

      ActionEvent

      Renames and re-exports ACTION_STEPS

      ActionPlan

      Renames and re-exports ACTION_STEPS

      ActionStep

      Renames and re-exports ACTION_STEPS

      BuiltinActionType

      Renames and re-exports ACTION_STEPS

      builtInValidators

      Renames and re-exports ACTION_STEPS

      ComponentGroup

      Renames and re-exports ACTION_STEPS

      ComponentPromptSpec

      Renames and re-exports ACTION_STEPS

      createParser

      Renames and re-exports ACTION_STEPS

      createStreamingParser

      Renames and re-exports ACTION_STEPS

      ElementNode

      Renames and re-exports ACTION_STEPS

      EvaluationContext

      Renames and re-exports ACTION_STEPS

      extractToolResult

      Renames and re-exports ACTION_STEPS

      generatePrompt

      Renames and re-exports ACTION_STEPS

      isReactiveAssign

      Renames and re-exports ACTION_STEPS

      isReactiveSchema

      Renames and re-exports ACTION_STEPS

      LibraryJSONSchema

      Renames and re-exports ACTION_STEPS

      McpClientLike

      Renames and re-exports ACTION_STEPS

      mergeStatements

      Renames and re-exports ACTION_STEPS

      OpenUIError

      Renames and re-exports ACTION_STEPS

      ParsedRule

      Renames and re-exports ACTION_STEPS

      ParseResult

      Renames and re-exports ACTION_STEPS

      parseRules

      Renames and re-exports ACTION_STEPS

      parseStructuredRules

      Renames and re-exports ACTION_STEPS

      PromptOptions

      Renames and re-exports ACTION_STEPS

      PromptSpec

      Renames and re-exports ACTION_STEPS

      ReactiveAssign

      Renames and re-exports ACTION_STEPS

      StateField

      Renames and re-exports ACTION_STEPS

      StreamParser

      Renames and re-exports ACTION_STEPS

      SubComponentOf

      Renames and re-exports ACTION_STEPS

      tagSchemaId

      Renames and re-exports ACTION_STEPS

      ToolDescriptor

      Renames and re-exports ACTION_STEPS

      ToolNotFoundError

      Renames and re-exports ACTION_STEPS

      ToolProvider

      Renames and re-exports ACTION_STEPS

      ToolSpec

      Renames and re-exports ACTION_STEPS

      validate

      Renames and re-exports ACTION_STEPS

      ValidatorFn

      Renames and re-exports ACTION_STEPS

      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.