raft-ui
Version:
React UI components for Raft.
36 lines (25 loc) • 2.15 kB
Markdown
name: overview
description: "What rUI is and where to start."
# Overview
## Build something bold with rUI
rUI is a UI system with expressive visuals and playful interactions, shaped by Raft and made for whatever you build next. The `raft-ui` package includes CSS foundations, composable React components, and Brutal and Elegant themes.
## Start with your agent
Copy this prompt and add your task:
```text
Use rUI (raft-ui) for this project: expressive visuals and playful interactions, shaped by Raft and made for whatever we build next. Use its shared tokens and components where they fit the project. Plain HTML can use foundation.css without React or Tailwind.
Read https://rui.botiverse.build/guides/overview and follow the guides relevant to the task. Match the existing project setup. For version-specific APIs, use node_modules/raft-ui/dist/index.d.mts; matching guides are in node_modules/raft-ui/skills/raft-ui-guide/rules/.
Skills are optional. Only install them when requested.
```
## Guides
| Task | Guide |
| ------------------------------------ | --------------------------------------------------------------------- |
| Adopting rUI in an existing project | [Adoption](./adoption.md) |
| Technical foundations | [Technical overview](./technical-overview.md) |
| Compose or adapt UI | [Composition](./composition.md), [Styling](./styling.md) |
| Chat and collaboration | [Conversation](./conversation.md) |
| Dashboards and workspaces | [Layout](./layout.md), [Forms](./forms.md), [Feedback](./feedback.md) |
| Dialogs, menus, and tooltips | [Overlays](./overlays.md) |
| Typography, avatars, code, and files | [Display](./display.md) |
| Exact component APIs | [API lookup](./lookup.md) |