Astro Guide

Install and Configure Tailus UI React with Astro

1. Create a new Astro project

First, create a new Astro project by running the following command:

npm create astro@latest astrolus
cd astrolus

2. Add React and Tailwind CSS

Next, add React and Tailwind CSS to your project by running the following command:

npx astro add tailwind react

3. Install Tailus UI Themer

Next, install Tailus UI Themer by running the following command:

npm install @tailus/themer tailwind-merge lucide-react

4. Update your Tailwind CSS configuration

Add the components path to your content array

module.exports = {
    content: [
        './index.html',
        './src/**/*.{js,ts,jsx,tsx}',
        './node_modules/@tailus/themer/dist/components/**/*.{js,ts}',
    ],
    theme: {
        extend: {},
    }
};

5. Add cloneElement utility

Create a file called utils.ts in your /lib directory and copy-paste the following code

mkdir src/lib && touch src/lib/utils.ts

import { twMerge } from "tailwind-merge";
import React from "react";

/**
 * Clone React element.
 * The function clones React element and adds Tailwind CSS classnames to the cloned element
 * @param element the React element to clone
 * @param classNames Tailwind CSS classnames
 * @returns { React.ReactElement } - Cloned React element
 */
export function cloneElement(element: React.ReactElement, classNames: string) {
    return React.cloneElement(element, {
        className: twMerge(element.props.className, classNames)
    });
}

6. Add paths

Add paths to your tsconfig.json file to make the import of the components easier.

{
    "compilerOptions": {
        /* Paths */
        "baseUrl": "./src",
        "paths": {
            "@tailus-ui/*": ["/components/tailus-ui/*"],
            "@lib/*": ["/lib/*"],
        }
    },
}

What’s next?

Great job! You’ve successfully installed Tailus UI React in your project. Next, let’s learn how to configure your theme.