Rails - JS Bundler
How to install RubyUI within a Rails app that employs JS bundling.
RubyUI
To take full advantage of RubyUI, the application is expected to be using TailwindCSS 4 and Stimulus
Using RubyUI CLI
We provide a Ruby gem with useful generators to help you to setup RubyUI components in your apps.
1
Add RubyUI gem to your Gemfile
bundle add ruby_ui --group development --require false
2
Run the install command
rails g ruby_ui:install
Manual
You can install the dependencies manually if you prefer
1
Add Phlex Rails to your app
bundle add phlex-rails
Phlex compatibility
Note that RubyUI components target Phlex 2.x most recent version
2
Install Phlex Rails
bin/rails g phlex:install
3
Install tailwind_merge
RubyUI components use tailwind_merge to avoid conflicts between TailwindCSS classes
bundle add tailwind_merge
4
Create RubyUI initializer
Add this code to config/initializers/ruby_ui.rb
module RubyUI
extend Phlex::Kit
end
# Allow using RubyUI instead RubyUi
Rails.autoloaders.main.inflector.inflect(
"ruby_ui" => "RubyUI"
)
# Allow using RubyUI::ComponentName instead Components::RubyUI::ComponentName
Rails.autoloaders.main.push_dir(
"#{Rails.root}/app/components/ruby_ui", namespace: RubyUI
)
# Allow using RubyUI::ComponentName instead RubyUI::ComponentName::ComponentName
Rails.autoloaders.main.collapse(Rails.root.join("app/components/ruby_ui/*"))
5
Include RubyUI kit in your base component
Include RubyUI module in app/components/base.rb
module Components
class Base < Phlex::HTML
include Components
include RubyUI
...
6
Create the RubyUI base component
Every RubyUI component inherit from RubyUI::Base
Copy and paste the code snippet below into the app/components/ruby_ui/base.rb file.
require "tailwind_merge"
module RubyUI
class Base < Phlex::HTML
TAILWIND_MERGER = ::TailwindMerge::Merger.new.freeze unless defined?(TAILWIND_MERGER)
attr_reader :attrs
def initialize(**user_attrs)
@attrs = mix(default_attrs, user_attrs)
@attrs[:class] = TAILWIND_MERGER.merge(@attrs[:class]) if @attrs[:class]
end
private
def default_attrs
{}
end
end
end
7
Include RubyUI configuration & styles in your CSS
Include RubyUI styles in app/assets/stylesheets/application.tailwind.css
Your CSS file will look like this:
@import "tailwindcss";
@plugin "@tailwindcss/forms";
@plugin "@tailwindcss/typography";
@import "tw-animate-css";
@custom-variant dark (&:is(.dark *));
:root {
--background: oklch(1 0 0);
--foreground: oklch(0.145 0 0);
--card: oklch(1 0 0);
--card-foreground: oklch(0.145 0 0);
--popover: oklch(1 0 0);
--popover-foreground: oklch(0.145 0 0);
--primary: oklch(0.205 0 0);
--primary-foreground: oklch(0.985 0 0);
--secondary: oklch(0.97 0 0);
--secondary-foreground: oklch(0.205 0 0);
--muted: oklch(0.97 0 0);
--muted-foreground: oklch(0.556 0 0);
--accent: oklch(0.97 0 0);
--accent-foreground: oklch(0.205 0 0);
--destructive: oklch(0.577 0.245 27.325);
--destructive-foreground: oklch(0.577 0.245 27.325);
--border: oklch(0.922 0 0);
--input: oklch(0.922 0 0);
--ring: oklch(0.708 0 0);
--chart-1: oklch(0.87 0 0);
--chart-2: oklch(0.556 0 0);
--chart-3: oklch(0.439 0 0);
--chart-4: oklch(0.371 0 0);
--chart-5: oklch(0.269 0 0);
--radius: 0.625rem;
--sidebar: oklch(0.985 0 0);
--sidebar-foreground: oklch(0.145 0 0);
--sidebar-primary: oklch(0.205 0 0);
--sidebar-primary-foreground: oklch(0.985 0 0);
--sidebar-accent: oklch(0.97 0 0);
--sidebar-accent-foreground: oklch(0.205 0 0);
--sidebar-border: oklch(0.922 0 0);
--sidebar-ring: oklch(0.708 0 0);
}
.dark {
--background: oklch(0.145 0 0);
--foreground: oklch(0.985 0 0);
--card: oklch(0.145 0 0);
--card-foreground: oklch(0.985 0 0);
--popover: oklch(0.145 0 0);
--popover-foreground: oklch(0.985 0 0);
--primary: oklch(0.985 0 0);
--primary-foreground: oklch(0.205 0 0);
--secondary: oklch(0.269 0 0);
--secondary-foreground: oklch(0.985 0 0);
--muted: oklch(0.269 0 0);
--muted-foreground: oklch(0.708 0 0);
--accent: oklch(0.269 0 0);
--accent-foreground: oklch(0.985 0 0);
--destructive: oklch(0.396 0.141 25.723);
--destructive-foreground: oklch(0.637 0.237 25.331);
--border: oklch(0.269 0 0);
--input: oklch(0.269 0 0);
--ring: oklch(0.439 0 0);
--chart-1: oklch(0.87 0 0);
--chart-2: oklch(0.556 0 0);
--chart-3: oklch(0.439 0 0);
--chart-4: oklch(0.371 0 0);
--chart-5: oklch(0.269 0 0);
--sidebar: oklch(0.205 0 0);
--sidebar-foreground: oklch(0.985 0 0);
--sidebar-primary: oklch(0.488 0.243 264.376);
--sidebar-primary-foreground: oklch(0.985 0 0);
--sidebar-accent: oklch(0.269 0 0);
--sidebar-accent-foreground: oklch(0.985 0 0);
--sidebar-border: oklch(0.269 0 0);
--sidebar-ring: oklch(0.439 0 0);
}
@theme inline {
--color-background: var(--background);
--color-foreground: var(--foreground);
--color-card: var(--card);
--color-card-foreground: var(--card-foreground);
--color-popover: var(--popover);
--color-popover-foreground: var(--popover-foreground);
--color-primary: var(--primary);
--color-primary-foreground: var(--primary-foreground);
--color-secondary: var(--secondary);
--color-secondary-foreground: var(--secondary-foreground);
--color-muted: var(--muted);
--color-muted-foreground: var(--muted-foreground);
--color-accent: var(--accent);
--color-accent-foreground: var(--accent-foreground);
--color-destructive: var(--destructive);
--color-destructive-foreground: var(--destructive-foreground);
--color-border: var(--border);
--color-input: var(--input);
--color-ring: var(--ring);
--color-chart-1: var(--chart-1);
--color-chart-2: var(--chart-2);
--color-chart-3: var(--chart-3);
--color-chart-4: var(--chart-4);
--color-chart-5: var(--chart-5);
--radius-sm: calc(var(--radius) - 4px);
--radius-md: calc(var(--radius) - 2px);
--radius-lg: var(--radius);
--radius-xl: calc(var(--radius) + 4px);
--color-sidebar: var(--sidebar);
--color-sidebar-foreground: var(--sidebar-foreground);
--color-sidebar-primary: var(--sidebar-primary);
--color-sidebar-primary-foreground: var(--sidebar-primary-foreground);
--color-sidebar-accent: var(--sidebar-accent);
--color-sidebar-accent-foreground: var(--sidebar-accent-foreground);
--color-sidebar-border: var(--sidebar-border);
--color-sidebar-ring: var(--sidebar-ring);
}
/* Container settings */
@utility container {
margin-inline: auto;
padding-inline: 2rem;
max-width: 1400px;
}
/* Scroll fade (MessageScroller): fades the bottom edge while there is content
below, from shadcn's scroll-fade-b (MIT). */
@property --scroll-fade-b {
syntax: "<length-percentage>";
inherits: false;
initial-value: 0px;
}
@keyframes scroll-fade-reveal-b {
from {
--scroll-fade-b: var(--_scroll-fade-size-b);
}
to {
--scroll-fade-b: 0px;
}
}
@utility scroll-fade-b {
--_scroll-fade-size-b: var(--scroll-fade-b-size, min(12%, calc(var(--spacing) * 10)));
mask-image: linear-gradient(to bottom, #000 0, #000 calc(100% - var(--scroll-fade-b, 0px)), transparent 100%);
mask-repeat: no-repeat;
@supports (animation-timeline: scroll()) {
animation: scroll-fade-reveal-b 1ms ease-in-out both;
animation-timeline: scroll(self y);
animation-range: calc(100% - calc(var(--spacing) * 24)) 100%;
}
@supports not (animation-timeline: scroll()) {
--scroll-fade-b: var(--_scroll-fade-size-b);
}
}
@layer base {
* {
@apply border-border outline-ring/50;
}
body {
@apply bg-background text-foreground;
}
}
8
Install tw-animate-css plugin
Some RubyUI components utilize CSS animations to create smooth transitions.
yarn add tw-animate-css