Remix Guide

Install and Configure Tailus UI React with Remix

1. Create a new Remix project

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

npx create-remix@latest remus
cd remus

2. Install Tailwind CSS

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

npm install -D tailwindcss postcss autoprefixer
npx tailwindcss init --ts -p

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: [
    theme: {
        extend: {},

5. Add css directives

Add the following tailwind css directives to your tailwind.css file and import it in your root.tsx file

// tailwind.css

@tailwind base;
@tailwind components;
@tailwind utilities;
// root.tsx

import type { LinksFunction } from "@remix-run/node"; // or cloudflare/deno

// ...

import styles from "./tailwind.css?url";

export const links: LinksFunction = () => [
  { rel: "stylesheet", href: styles },

6. Add cloneElement utility

Create a file called utils.ts in your /app/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)

7. Add paths

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

    "compilerOptions": {
        /* Paths */
        "baseUrl": "./app",
        "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.