JSPM

  • Created
  • Published
  • Downloads 147
  • Score
    100M100P100Q66503F
  • License MIT

React + A11y + Tailwind CSS Dynamic Component Library

Package Exports

  • @rafty/ui

Readme

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?

rafty-ui.rhinobase.io (Under Development)

Installing Rafty UI

Rafty UI is made up of multiple components and tools that you can import one by one. All you need to do is install the @rafty/ui package:

yarn add @rafty/ui

# or

npm 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")
  ],
};

Get Started

import { Button } from "@rafty/ui";