Caprice LogoCaprice UI
Installation

Astro

PreviousNext

Install and configure Caprice UI for Astro.

Create project

Start by creating a new Astro project:

npx create-astro@latest astro-app  --template with-tailwindcss --install --add react --git

Edit tsconfig.json file

Add the following code to the tsconfig.json file to resolve paths:

tsconfig.json
{
  "compilerOptions": {
    // ...
    "baseUrl": ".",
    "paths": {
      "@/*": [
        "./src/*"
      ]
    }
    // ...
  }
}

Run the CLI

Run the shadcn init command to setup your project:

npx shadcn@latest init https://caprice-ui.com/r/init.json

Add Caprice UI Registry to your components.json

components.json
{
  "registries": {
    "@caprice": "https://caprice-ui.com/r/{name}.json"
  }
}

Add Components

You can now start adding components to your project.

npx shadcn@latest add @caprice/button

The command above will add the Button component to your project. You can then import it like this:

src/pages/index.astro
---
import { Button } from "@/components/caprice-ui/button"
---

<html lang="en">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width" />
    <link rel="icon" type="image/svg+xml" href="/favicon.svg" />
    <meta name="generator" content={Astro.generator} />
    <title>Astro + TailwindCSS</title>
  </head>

  <body>
    <div className="grid place-items-center h-screen content-center">
      <Button>Button</Button>
    </div>
  </body>
</html>

Add all components at once

You can install all Caprice UI components at once with a single command:

npx shadcn@latest add @caprice/ui

The command above will add all caprice ui components to your project.

On this page

Create project
Edit tsconfig.json file
Run the CLI
Add Caprice UI Registry to your components.json
Add Components
Add all components at once
Create project
Install Caprice UI dependencies
Configure styles
Import components

Contribute