Skip to content

Latest commit

 

History

History

README.md

Ripple UI Documentation

Welcome to the @ripple-ui/svelte documentation. Ripple is a Svelte 5 component library that renders interactive UIs from declarative JSON specifications — designed for AI-generated interfaces.

Table of Contents

  1. Getting Started — Installation, basic usage, and your first spec
  2. Architecture — How Ripple works under the hood
  3. UISpec Reference (v1.0) — Low-level widget tree specification
  4. UniversalSpec Reference (v2.0) — High-level intent-based specification
  5. Widgets — Reference for the 150+ built-in widgets (layout, display, input, data, overlay, composite, research, vertical, control)
  6. Expressions — Binding syntax, operators, and template strings
  7. State Management — Reactive state with dot-notation paths
  8. Event Handling — Actions, chaining, and the event system
  9. Intent System — Layout engine, pattern detection, and chaining
  10. Theming — Color tokens, dark mode, and theme overrides
  11. Custom Widgets — Extending Ripple with your own widgets
  12. API Reference — All exports, types, and functions

Manifest as source of truth. Every widget's prop schema and runnable example is shipped in dist/manifest.json (also served at /manifest.json in dev). When the docs and the manifest disagree, the manifest is canonical — it's generated from the same TypeScript declarations the runtime consumes.