Skip to the content

Documentation

Introduction

What Rivier UI is and what makes it different.

Rivier UI is a library of React components that you copy into a project and own. It is written so that an assistant can find the right component, use it correctly, and restyle a whole product from one place. It is in prelaunch: changes are dated, and version numbers start at launch.

What makes it different

  • Copied in, not installed. rivier-ui add dialog puts the source in your project. You can read it and change it, and nothing breaks on an upgrade you did not ask for.
  • One theme, three switches. Light or dark, square to round, any highlight colour: three attributes on <html>. Every component draws only from the theme's variables, so the switches reach everything, charts and 3D included.
  • Written to be read by an assistant. Every file starts with what it is, when to use it and when not to, and an example that works. From those headers the library generates llms.txt, a registry that shadcn-compatible tools can read, and the pages of this site.
  • Past the flat page. Bento grids, motion and page transitions, 3D scenes and charts are part of the same library and the same theme, not separate products with separate looks.
  • Checked in a real browser. Each component's keyboard pattern is driven key by key at desktop and phone widths, left-to-right and right-to-left, with an accessibility scan. See Accessibility.

What is in it

141 items today, in six groups.

  • Controls and surfaces (94). Buttons, fields, menus, dialogs, dates, lists, conversation parts, players and records.
  • Layout (9). Containers, sections, a bento grid, a marquee and frames.
  • Motion (15). Reveals, scroll scenes, pointer effects and page transitions, from the theme's durations.
  • 3D (7). Scenes that take their colours from the theme and fall back to a still.
  • Charts (8). SVG charts and sparklines in the theme's series colours, each with a text alternative.
  • Helpers (8). Class names, motion tokens, reading direction, announcements and controllable state.

What it is built on

Radix for behaviour and accessibility, Tailwind CSS for styling, Motion for animation, three.js for 3D, d3 for the maths of charts, cmdk for the command palette and Sonner for toasts. Where Radix has no primitive (a calendar, a sortable list, a bottom sheet, media players, a carousel, a windowed list) the component is written here to the WAI-ARIA pattern for its kind, so no package is added for one component. Every dependency is MIT or Apache 2.0, and nothing is hosted. The names of the theme's variables follow the shadcn convention, so components written for it take this theme as they are.

Where to go next

  • Installation: put the first components in a project.
  • Theming: try the three switches on this page, live.
  • Components: every item, with its example, its source and a working demonstration.