Skip to main content
RUIRenderer accepts the accumulated source string as children, checks it against an approved component list, and resolves only React components supplied by the application.

Source lifecycle

  1. Complete physical statements are parsed as characters arrive.
  2. Valid statements may form a limited streaming preview.
  3. Invalid lines or nodes are skipped with bounded diagnostics.
  4. complete validates the complete tree and creates the final UI.
  5. Effectful controls, fields, and custom components remain disabled until the final UI; reversible local controls such as tabs can work in the preview.
Use streamStatus with streaming, complete, cancelled, or failed. isStreaming remains available as a simpler boolean, but streamStatus carries the full terminal state. retryKey resets compilation for a new attempt; replacing the source with a non-prefix value also resets it.

Host inputs and events

data, context, and draft are read-only host inputs. Events are frozen objects and can be observed through onAction, onNavigate, onRender, onError, or the combined onEvent. onStateChange exposes source, diagnostics, catalog, stream state, and the current snapshot for tools such as Devtools. For every prop, see the @rixx-ui/react API.