LycanUI
LycanUI

Getting Started

Introduction Installation Forms

Components

Accordion Alert Avatar Badge Button
Calendar - Soon TM
Checkbox
Date Field - Soon TM
Collapsible Dialog Dropdown Input Popover Radio Select Switch Textarea
Toaster - Soon TM

Installation

Installation is super straightforward.

Add the gem to the development group in your Gemfile,

        group :development do 
  gem 'lycan_ui', require: false
end

Run bundle install and then setup with,

        rails generate lycan_ui:setup

Follow the prompts in your terminal and then.. you're done!

So.. what'd that do?

Installing does a number of things

  • Installs the icon package Lycan UI uses - lucide-rails
  • Installs the class merging utility Lycan UI uses - tailwind_merge
  • Sets up your tailwind config
  • Copies over the ui helper
  • Installs the Ruby files for any components you picked during setup into the app/components directory
  • Installs the Javascript files for any components you picked during setup into the app/javascript/controllers directory