@rixx-ui/react/server when React components are not
needed.
Value exports
| Export | Purpose |
|---|---|
RUIRenderer | Compile accumulated RUI source and render safe surface state |
MarkdownRenderer | Render safe CommonMark/GFM; also available from /markdown |
Renderer | Advanced renderer for an existing normalized snapshot |
StoreRenderer | Advanced renderer subscribed to an existing SurfaceStore |
defineCatalog | Create framework-neutral catalog and instruction contracts |
defineComponent | Define one typed, closed-schema component contract |
defineAction | Define one typed action contract |
defineRegistry | Bind a defined catalog to trusted React implementations |
defineRUI | Combine the same catalog and registry into renderer config |
coreRUIConfig | Ready-to-use first-party catalog, instructions, and registry |
coreRegistry | First-party React component registry |
fromMarkdown | Convert Markdown into a RUI source fragment |
Renderer, StoreRenderer, normalized snapshots, and stores are advanced
surfaces without pre-alpha stability guarantees. Prefer RUIRenderer.
Configuration types
| Export | Purpose |
|---|---|
ActionApproval | none, confirm, or strong |
CatalogActionMap | Defined action map |
CatalogComponentMap | Defined component map |
DefineActionOptions | Options accepted by defineAction |
DefineCatalogOptions | Options accepted by defineCatalog |
DefineComponentOptions | Options accepted by defineComponent |
DefineRUIOptions | Catalog and registry accepted by defineRUI |
DefinedCatalog | Result of defineCatalog |
DefinedCatalogAction | Typed action definition |
DefinedCatalogComponent | Typed component definition |
DefinedRegistry | Result of defineRegistry |
RegistryImplementations | Catalog-keyed React implementation map |
RUIConfig | Combined catalog, registry, actions, and instructions |
RUIConfiguredActionEvent | Config-derived action event union |
TypedRenderComponentProps | Typed props for a custom implementation |
Renderer types
| Export | Purpose |
|---|---|
RUIRendererProps | Props for RUIRenderer |
MarkdownRendererProps | Props for MarkdownRenderer |
RendererProps | Props for low-level Renderer |
ComponentRegistry | Component name to React implementation map |
RenderComponentProps | Untyped implementation capability props |
RendererOptions | Optional theme, locale, direction, and resource settings |
ResolvedRendererOptions | Validated, complete, frozen renderer settings |
RendererTheme | light, dark, or system |
RendererDirection | ltr, rtl, or auto |
RendererExternalLinkBehavior | confirm or direct |
RendererResourceTiming | progressive, committed, or manual |
RUIStreamStatus | streaming, complete, cancelled, or failed |
RUIRendererState | Observable source, diagnostics, catalog, and snapshot |
RUIFallbackEvent | Frozen pending/rejected fallback context |
RUIFallbackRenderer | Functional fallback type |
Event and policy types
| Export | Purpose |
|---|---|
RUIEvent | Union of action, navigation, render, and error events |
RUIActionEvent | Validated action request |
RUINavigationEvent | Host-mediated navigation request |
RUIRenderEvent | Successful surface render event |
RUIErrorEvent | Source, component, or action error union |
RUISourceErrorEvent | Compiler/source diagnostic event |
RUIComponentErrorEvent | Trusted component render error |
RUIActionErrorEvent | Action validation error |
RUISurfaceEventContext | Shared committed/provisional surface metadata |
RUISurfaceStatus | committed or provisional |
RUIImagePolicy | Host image-request predicate |
RUIImageRequest | Image URL, origin, node, alt, and title context |
@rixx-ui/react/styles.css.