LLM index: /llms.txt
Nexus UI components are designed for React projects using Tailwind CSS v4 and TypeScript. Follow the steps below to get set up.
Prerequisites
Make sure your project has the following:
- React 19 or later
- Tailwind CSS v4
- TypeScript
Nexus UI also depends on shared utilities from shadcn/ui. If you don't have shadcn set up yet, initialize it first:
Add registry
Add the Nexus UI registry to your components.json (skip if using Option 1):
Add components
Option 1: shadcn CLI (recommended)
Nexus UI is in the shadcn directory. No config needed—add components directly:
Option 2: Direct URL
Add components by passing the registry URL directly:
Option 3: Nexus UI CLI
Install components using the Nexus UI CLI:
Install all components: npx nexus-ui-cli@latest
Manual installation
If you prefer to install manually, copy the component source from the docs page directly into your project.
Each component page includes the full source code. Copy it into your components/nexus-ui directory and install the required dependencies:
Project structure
After adding components, your project will look something like this:
Components in nexus-ui/ are Nexus UI primitives. Components in ui/ are shared shadcn/ui primitives that Nexus UI components may depend on.
Usage
Import and compose components directly:
See individual component pages for detailed usage and examples.