Lynx

genui / openui

openui

索引

接口

Interface描述
ComponentRenderPropsProps passed to an OpenUI ReactLynx component renderer.
CreateOpenUiLibraryOptionsOptions for creating the default 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.

类型别名

变量

函数

Function描述
createOpenUiLibraryCreate a ReactLynx OpenUI library with the built-in components plus any caller-provided extensions.
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.

参考

ActionEvent

重命名并重新导出 ACTION_STEPS


ActionPlan

重命名并重新导出 ACTION_STEPS


ActionStep

重命名并重新导出 ACTION_STEPS


BuiltinActionType

重命名并重新导出 ACTION_STEPS


builtInValidators

重命名并重新导出 ACTION_STEPS


ComponentGroup

重命名并重新导出 ACTION_STEPS


ComponentPromptSpec

重命名并重新导出 ACTION_STEPS


createParser

重命名并重新导出 ACTION_STEPS


createStreamingParser

重命名并重新导出 ACTION_STEPS


ElementNode

重命名并重新导出 ACTION_STEPS


EvaluationContext

重命名并重新导出 ACTION_STEPS


extractToolResult

重命名并重新导出 ACTION_STEPS


generatePrompt

重命名并重新导出 ACTION_STEPS


isReactiveAssign

重命名并重新导出 ACTION_STEPS


isReactiveSchema

重命名并重新导出 ACTION_STEPS


LibraryJSONSchema

重命名并重新导出 ACTION_STEPS


McpClientLike

重命名并重新导出 ACTION_STEPS


mergeStatements

重命名并重新导出 ACTION_STEPS


OpenUIError

重命名并重新导出 ACTION_STEPS


ParsedRule

重命名并重新导出 ACTION_STEPS


ParseResult

重命名并重新导出 ACTION_STEPS


parseRules

重命名并重新导出 ACTION_STEPS


parseStructuredRules

重命名并重新导出 ACTION_STEPS


PromptOptions

重命名并重新导出 ACTION_STEPS


PromptSpec

重命名并重新导出 ACTION_STEPS


ReactiveAssign

重命名并重新导出 ACTION_STEPS


StateField

重命名并重新导出 ACTION_STEPS


StreamParser

重命名并重新导出 ACTION_STEPS


SubComponentOf

重命名并重新导出 ACTION_STEPS


tagSchemaId

重命名并重新导出 ACTION_STEPS


ToolDescriptor

重命名并重新导出 ACTION_STEPS


ToolNotFoundError

重命名并重新导出 ACTION_STEPS


ToolProvider

重命名并重新导出 ACTION_STEPS


ToolSpec

重命名并重新导出 ACTION_STEPS


validate

重命名并重新导出 ACTION_STEPS


ValidatorFn

重命名并重新导出 ACTION_STEPS

除非另有说明,本项目采用知识共享署名 4.0 国际许可协议进行许可,代码示例采用 Apache License 2.0 许可协议进行许可。