Skip to content

k0va1/lightning_ui_kit

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

144 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

LightningUiKit

UI components for fast prototyping in Rails applications.

Preview is available at ui.k0va1.dev

Installation

Add this line to your application's Gemfile:

gem "propshaft"
gem "lightning_ui_kit"

And then execute:

$ bundle

Add the following lines to your application.html.erb file:

<%= stylesheet_link_tag "lightning_ui_kit" %>
<%= javascript_include_tag "lightning_ui_kit" %>

Usage

Use the lui helper to render components:

<%= lui.button { "Click me" } %>
<%= lui.button(style: :outline) { "Cancel" } %>
<%= lui.button(style: :destructive, size: :small) { "Delete" } %>

Form Components

<%= lui.input(name: :email, type: :email, label: "Email") %>
<%= lui.textarea(name: :bio, label: "Biography", rows: 4) %>
<%= lui.select(name: :country, label: "Country", options: [["US", "us"], ["UK", "uk"]]) %>
<%= lui.checkbox(name: :terms, label: "Accept terms") %>
<%= lui.switch(name: :notifications, label: "Enable notifications") %>

With Rails Form Builder

<%= form_with model: @user do |form| %>
  <%= lui.input(name: :email, type: :email, label: "Email", form: form) %>
  <%= lui.textarea(name: :bio, label: "Biography", form: form) %>
  <%= lui.button(type: :submit) { "Save" } %>
<% end %>

Components with Slots

<%= lui.modal(id: "confirm", title: "Confirm Action") do |modal| %>
  <% modal.with_body do %>
    <p>Are you sure you want to proceed?</p>
  <% end %>
  <% modal.with_action do %>
    <%= lui.button(style: :outline) { "Cancel" } %>
  <% end %>
  <% modal.with_action do %>
    <%= lui.button { "Confirm" } %>
  <% end %>
<% end %>

<%= lui.table(data: @users) do |table| %>
  <% table.with_column("Name") { |user| user.name } %>
  <% table.with_column("Email") { |user| user.email } %>
  <% table.with_action { |user| link_to "Edit", edit_user_path(user) } %>
<% end %>

Available Components

Form: button, input, textarea, select, checkbox, switch, radio_group, combobox, file_input, dropzone

Display: text, badge, avatar, alert, banner, toast, skeleton, spinner

Structure: card, tabs, accordion, table, pagination, description_list, dropdown, modal, tooltip, layout (frosted glass sidebar with backdrop blur), sidebar, sidebar_section, sidebar_link, link

Alternative Syntax

You can also use the standard ViewComponent render syntax:

<%= render LightningUiKit::ButtonComponent.new { "Click me" } %>

Theming

LightningUiKit supports theming via CSS custom properties. All components use semantic design tokens instead of hardcoded colors.

Built-in Themes

  • Light (default) — applied automatically
  • Dark — add class="lui-theme-dark" to a container element
<body class="lui-theme-dark">
  <%= lui.button { "Dark themed" } %>
</body>

Custom Themes

Override --lui-theme-* CSS variables to create your own theme:

.my-brand-theme {
  --lui-theme-surface: oklch(0.98 0.01 250);
  --lui-theme-foreground: oklch(0.2 0.02 250);
  --lui-theme-interactive: oklch(0.6 0.2 250);
  /* See themes.css for all available tokens */
}

Full token definitions are in app/assets/stylesheets/lightning_ui_kit/themes.css.

Contributing

Bug reports and pull requests are welcome

License

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

About

Resources

License

Stars

Watchers

Forks

Sponsor this project

 

Packages

 
 
 

Contributors