# Rixx UI

> Rixx UI is a streaming generative UI renderer for React, from Markdown to charts, forms, and application-owned components.

## Docs

- [ADR 0001: Separate language, protocol, and runtime](https://docs.rixxui.com/adr/0001-language-protocol-runtime.md): Why Rixx UI separates model-facing source, canonical protocol records, and the rendering runtime.
- [Actions, approval, and idempotency](https://docs.rixxui.com/configuration/actions.md): Validate generated action requests while keeping authorization, confirmation, execution, and deduplication in the host.
- [Approve components for generation](https://docs.rixxui.com/configuration/catalog-and-registry.md): Choose which components and properties a model may request, then connect those contracts to your React implementations.
- [Custom components](https://docs.rixxui.com/configuration/custom-components.md): Build typed host components that receive validated props, resolved options, and mediated capabilities.
- [Images, links, and resource policies](https://docs.rixxui.com/configuration/resource-policies.md): Control navigation and image fetching independently with safe defaults and host narrowing policies.
- [Forms, charts, media, math, and Mermaid](https://docs.rixxui.com/configuration/rich-components.md): Use constrained first-party rich components without allowing generated executable behavior.
- [Themes, localization, and RTL](https://docs.rixxui.com/configuration/themes-localization.md): Configure deterministic themes, locale-aware formatting, time zones, currency, and text direction.
- [Update UI with application data](https://docs.rixxui.com/configuration/trusted-data.md): Pass read-only application data separately from model output and update the rendered UI without generating a new component tree.
- [Installation](https://docs.rixxui.com/getting-started/installation.md): Current npm publication status, planned package names, React compatibility, and repository development requirements.
- [Evaluate Rixx UI locally](https://docs.rixxui.com/getting-started/quickstart.md): Run the local React playground and evaluate Markdown, structured UI, streaming recovery, themes, and Devtools before npm publication.
- [Rixx UI](https://docs.rixxui.com/index.md): A streaming generative UI renderer for React, from Markdown to charts, forms, and application-owned components.
- [Devtools](https://docs.rixxui.com/integrations/devtools.md): Inspect RUI source, diagnostics, snapshots, catalog definitions, and renderer events during development.
- [Next.js](https://docs.rixxui.com/integrations/nextjs.md): Place Rixx UI client renderers and server-safe helpers correctly in the Next.js App Router.
- [React 18 and React 19](https://docs.rixxui.com/integrations/react-compatibility.md): Supported React versions, rendering behavior, Strict Mode, SSR, and hydration guidance.
- [Local playground](https://docs.rixxui.com/integrations/static-playground.md): Run the backend-free local RUI source, streaming, theme, and Devtools playground.
- [Troubleshooting](https://docs.rixxui.com/integrations/troubleshooting.md): Diagnose missing styles, rejected source, stalled previews, policy denials, SSR issues, and action failures.
- [Vite](https://docs.rixxui.com/integrations/vite.md): Use Rixx UI in a Vite React application with client rendering and optional server-side bundling.
- [Renderer contract 0.1](https://docs.rixxui.com/product/renderer-contract.md): The pre-alpha consumer boundary for rendering, streaming, resources, actions, and presentation.
- [Changelog](https://docs.rixxui.com/project/changelog.md): Release history and notable documentation status for Rixx UI packages.
- [Contributing](https://docs.rixxui.com/project/contributing.md): Set up the workspace, run required checks, add Changesets, and follow project security and DCO policies.
- [Release status](https://docs.rixxui.com/project/release-status.md): Current package publication, versioning, stability, and production-readiness status.
- [Core components](https://docs.rixxui.com/reference/core-components.md): Reference for the first-party rixx.core@0.1 component catalog.
- [@rixx-ui/react/markdown API](https://docs.rixxui.com/reference/markdown.md): Minimal client entry point for safe streaming Markdown rendering and resource policy types.
- [@rixx-ui/react API](https://docs.rixxui.com/reference/react.md): Complete value and type export reference for the main Rixx UI React package entry point.
- [@rixx-ui/react-devtools API](https://docs.rixxui.com/reference/react-devtools.md): Complete component, hook, prop, binding, option, and tab exports for Rixx UI Devtools.
- [@rixx-ui/react/server API](https://docs.rixxui.com/reference/server.md): Server-safe catalog, generation instruction, and Markdown conversion exports.
- [Streaming Markdown renderer for React](https://docs.rixxui.com/renderers/markdown-renderer.md): Render streaming CommonMark and GFM in React with incomplete-syntax repair, highlighted code, link review, and managed images.
- [Structured generative UI renderer for React](https://docs.rixxui.com/renderers/rui-renderer.md): Render streaming structured AI responses with approved React components, application data, recovery, and action requests.
- [Security overview](https://docs.rixxui.com/security/overview.md): Understand Rixx UI trust boundaries, declarative rendering guarantees, and host security responsibilities.
- [Threat model](https://docs.rixxui.com/security/threat-model.md): Trust boundaries, security objectives, controls, failure behavior, and deferred risks for Rixx UI.
- [Rixx UI Language 0.1](https://docs.rixxui.com/spec/language.md): Experimental syntax, streaming semantics, bindings, and validation rules for RUI source.
- [Rixx UI Protocol 0.1](https://docs.rixxui.com/spec/protocol.md): Experimental framed protocol, transaction invariants, graph validation, and recovery behavior.
- [Accumulated streaming](https://docs.rixxui.com/streaming/accumulated-streaming.md): Feed cumulative provider output to Rixx UI while preserving safe provisional and committed states.
- [Recover from malformed AI output](https://docs.rixxui.com/streaming/tolerant-recovery.md): Skip malformed lines without weakening validation or discarding later valid content from the same streaming response.