Project

vitrail

0.0
The project is in a healthy, maintained state
Kuartz design system view components
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies
 Project Readme

Vitrail

Kuartz's Design system view components.

Prerequisites

  • Ruby v3
  • Rails v7
  • ViewComponent v3
  • tailwindcss-rails (the gem) v2

Installation

In your Gemfile, add this line:

gem "vitrail", "~> 1.0"

Then, run bundle install.

Finally, run the following command to install Vitrail's assets and configuration files in your project:

rails vitrail:install

This will:

  • Add default styles to the available Vitrail classes in lib/assets/stylesheets/vitrail
  • Add the Tailwind preset file in lib/assets/vitrail_preset.js
  • Load the Vitrail styles in your application.tailwind.css file
  • Add config to your tailwind.config.js file

License

The gem is available as open source under the terms of the MIT License.