Skip to content

Relix UI is an open-source set of prebuilt UI components based on the utility-first Tailwind CSS framework.

License

Notifications You must be signed in to change notification settings

ilsyaa/tw-relix

Repository files navigation

Relix UI is an open-source set of prebuilt UI components based on the utility-first Tailwind CSS framework.

License: MIT

Why use Relix UI?

Based on the Tailwind CSS utility classes, Relix UI's prebuilt components and UI elements help you quickly design and customize responsive mobile-first websites with the components a website needs, including buttons, dropdowns, navigation bars, modals, and more.

What's in the box?

Components are grouped by visual usability criteria (components, navigation, forms, etc.) and styled directly on top of Tailwind CSS, making them easy to extend and customize. This is a lifesaver for developers looking to create a unique and eye-catching design system without the hassle of creating each component by hand.

Getting Started

Quick Setup

This guide will help you get started with Relix UI, including how to run, customize, update, and integrate your project!

First, you need to make sure that you have a working Tailwind CSS project installed and that you also have Node and NPM installed on your machine.

Require via NPM

  1. Install relix via npm
npm i tw-relix
  1. Include Relix UI as a plugin in the tailwind.config.js file
module.exports = {
  content: [
    'node_modules/tw-relix/dist/*.js'
  ],
  plugins: [
    require('tw-relix/plugin')
  ],
}
  1. Include the JavaScript <script> that powers the interactive elements near the end of your <body> tag:
<script src="./node_modules/tw-relix/dist/relix.js"></script>
<!-- or  -->
<script type="module">
  import 'tw-relix'
</script>

About

Relix UI is an open-source set of prebuilt UI components based on the utility-first Tailwind CSS framework.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published