Getting started
What AsheeUI is, and the smallest application that renders something real.
AsheeUI is a React component framework for Tailwind CSS v4. It ships the components a product is made of, not a button and a card, but the page compositions, the field family, the four states every region can be in, and the two tables, behind one configuration cascade and one theme controller. The same descriptions render on the web and on React Native.
The shortest path
npm install asheeui
Then two imports and a provider:
// src/index.css
@import "tailwindcss";
@import "@asheeui/web/styles";
// src/main.tsx
import { AsheeUIProvider } from "@asheeui/web";
createRoot(root).render(
<AsheeUIProvider>
<App />
</AsheeUIProvider>,
);
That is the whole setup: no bundler plugin, no generated file, no configuration file. Every page in this documentation builds on it.
Where to go next
| If you want to… | Read |
|---|---|
| Add it to an existing application, in order | Installation |
| Render your first component | First component |
| Understand the configuration | Configuration |
| Change the colours, or add a theme | Theming |
| Find a component | Components |
| Build a whole page | Page compositions |
| Run it on a device | React Native |
| Scaffold and check a setup from the terminal | CLI |
What it is not
It is not a design system you restyle: the tokens are the framework's, and an application overrides the ones it disagrees with. It is not a CSS framework: it is Tailwind's, already configured. And it is not a page builder, though it can sit behind one, see Puck.