genui / openui

openui

Index

Interfaces

Interface	Description
ComponentRenderProps	Props passed to an OpenUI ReactLynx component renderer.
CreateOpenUiLibraryOptions	Options for creating the default ReactLynx OpenUI component library.
FormValidationContextValue	Validation state and helpers for OpenUI form fields.
OpenUIContextValue	Runtime context shared by OpenUI renderers, hooks, actions, and form fields.
OpenUiRendererParsedProps	Props for rendering an already parsed OpenUI result.
OpenUiRendererRuntimeProps	Props for rendering raw OpenUI response text with parsing, runtime state, actions, and query execution.
OpenUIState	Derived OpenUI renderer state returned by `useOpenUIState`.
UseOpenUIStateOptions	Inputs used to parse OpenUI text and build renderer state.

Type Aliases

Type alias	Description
ComponentRenderer	-
DefinedComponent	-
Library	-
LibraryDefinition	-
OpenUiRendererProps	-
ToolProviderInput	-

Variables

Variable	Description
ACTION_STEPS	-
FormNameContext	-
FormValidationContext	-

Functions

Function	Description
createOpenUiLibrary	Create a ReactLynx OpenUI library with the built-in components plus any caller-provided extensions.
defineComponent	Define a ReactLynx component renderer and its OpenUI schema metadata.
OpenUiRenderer	Render OpenUI language output using a ReactLynx component library.
reactive	Mark a schema prop as reactive so runtime evaluation can preserve $bindings.
useCreateFormValidation	Create form validation state and callbacks for an OpenUI form boundary.
useFormValidation	Read the nearest OpenUI form validation context, if one exists.
useGetFieldValue	Get a form field value from the form state context.
useIsQueryLoading	Whether any Query is currently fetching data.
useIsStreaming	Whether the LLM is currently streaming content.
useOpenUI	Access the full OpenUI context. Throws if used outside an `OpenUiRenderer` tree.
useOpenUIState	Core state hook — extracts all form state, action handling, parser management, and context assembly out of the Renderer component.
useRenderNode	Get the renderNode function for rendering nested component values.
useSetDefaultValue	Persists a component's default/initial value into form state once streaming finishes — but only if the user hasn't already set a value.
useSetFieldValue	Get the setFieldValue function for updating form field values.
useStateField	Resolve a named OpenUI state field against form state and reactive bindings.
useTriggerAction	Get 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

#openui

#Index

#Interfaces

#Type Aliases

#Variables

#Functions

#References

#ActionEvent

#ActionPlan

#ActionStep

#BuiltinActionType

#builtInValidators

#ComponentGroup

#ComponentPromptSpec

#createParser

#createStreamingParser

#ElementNode

#EvaluationContext

#extractToolResult

#generatePrompt

#isReactiveAssign

#isReactiveSchema

#LibraryJSONSchema

#McpClientLike

#mergeStatements

#OpenUIError

#ParsedRule

#ParseResult

#parseRules

#parseStructuredRules

#PromptOptions

#PromptSpec

#ReactiveAssign

#StateField

#StreamParser

#SubComponentOf

#tagSchemaId

#ToolDescriptor

#ToolNotFoundError

#ToolProvider

#ToolSpec

#validate

#ValidatorFn

openui

Index

Interfaces

Type Aliases

Variables

Functions

References

ActionEvent

ActionPlan

ActionStep

BuiltinActionType

builtInValidators

ComponentGroup

ComponentPromptSpec

createParser

createStreamingParser

ElementNode

EvaluationContext

extractToolResult

generatePrompt

isReactiveAssign

isReactiveSchema

LibraryJSONSchema

McpClientLike

mergeStatements

OpenUIError

ParsedRule

ParseResult

parseRules

parseStructuredRules

PromptOptions

PromptSpec

ReactiveAssign

StateField

StreamParser

SubComponentOf

tagSchemaId

ToolDescriptor

ToolNotFoundError

ToolProvider

ToolSpec

validate

ValidatorFn