Skip to content

rhinobase/raftyui

Repository files navigation

Welcome to rafty/ui

React + Accessible + Tailwind CSS Dynamic Component Library

  • Works out of the box. Rafty UI contains a set of polished React components that work out of the box.

  • Flexible & composable. Rafty UI components are built on top of a Radix UI Primitive and Tailwind CSS for endless composability.

  • SSR. Rafty UI components support React SSR functionality.

  • Dark Mode 😍: All components are dark mode compatible.

Looking for the documentation?

Check it out at rafty.rhinobase.io

Quick start

Rafty UI is made up of multiple components and tools that you can import one by one.

Installing Rafty UI

To use Rafty UI in your project, run one of the following commands in your terminal:

npm i @rafty/ui
# or
yarn add @rafty/ui
# or
pnpm i @rafty/ui

Setup

For the styling to work in @rafty/ui, you need to make few changes in your tailwind.config.js file.

First, install the @rafty/plugin package as devDependencies

npm i -D @rafty/plugin

And in your tailwind.config.js file

module.exports = {
  content: [
    ...,
    "./node_modules/@rafty/ui/**/*.{js,cjs}",
  ],
  theme: {
    extend: {
        ...,
        // (Optional)
        // Extend the default configuration of @rafty/ui
        colors: {
            primary: colors.purple,
            ...,
        }
    },
  },
  plugins: [
    ...,
    require("@rafty/plugin")
  ],
};

Connect with us

Whether you're a beginner or advanced Rafty UI user, joining our community is the best way to connect with like-minded people who build great products with the library.

Contributing

Feel like contributing? That's awesome! We have a contributing guide to help guide you.

Join the community

Connect with a vibrant community of developers, and designers on Discord at discord.gg/rhinobase. Share your experiences, exchange insights, and shape the evolution of @rafty/ui.

Follow us on twitter for the latest news @rhinobaseio