https://github.com/getrailsui/railsui-tailwind-presets

Tailwind CSS presets for Rails UI.
https://github.com/getrailsui/railsui-tailwind-presets

preset rails tailwind tailwindcss ui

Last synced: 18 days ago
JSON representation

Tailwind CSS presets for Rails UI.

• Host: GitHub
• URL: https://github.com/getrailsui/railsui-tailwind-presets
• Owner: getrailsui
• Created: 2024-07-15T12:22:38.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-10-20T17:32:06.000Z (about 1 month ago)
• Last Synced: 2024-10-20T21:15:50.094Z (about 1 month ago)
• Topics: preset, rails, tailwind, tailwindcss, ui
• Language: JavaScript
• Homepage: https://railsui.com
• Size: 43 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Rails UI Tailwind CSS Presets

Tailwind CSS presets for [Rails UI](https://github.com/getrailsui/railsui). These presets are designed to work with the [Tailwind CSS](https://tailwindcss.com/) framework.

## Installation

To install the presets, run the following command in your terminal:

```bash

npm install railsui-tailwind-presets

```

## Usage

Once installed, you can import the presets into your Tailwind CSS configuration file (e.g., `tailwind.config.js`) and use them in your project. Bear in mind, these are designed for exclusive use with [Rails UI](https://railsui.com). Here's an example:

```javascript

// tailwind.config.js

const presets = require("railsui-tailwind-presets")

module.exports = {

  presets: [presets.hound],

  content: ["./app/**/*.html.erb"],

}

```

Or just import one preset:

```javascript

// tailwind.config.js

const { hound } = require("railsui-tailwind-presets")

module.exports = {

  presets: [hound],

  // Other Tailwind CSS configuration options...

}

```

In this example, we're using the `hound` preset, which includes the Rails UI styles and a custom primary and secondary color palette. You can choose from the following presets (more coming soon):

- `hound`

- `shepherd`

- `retriever`

- `setter`

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more information.