Switch

The switch' fancy cousin

Includes a Ruby component and corresponding Rails helper

Ruby

Includes a Stimulus controller

Stimulus

Example

<%= nk_switch %>

Install

Set up Nitro Kit then

bin/rails generate nitro_kit:add switch

Files generated

Form use

To use in forms, it's easiest to use the Form Builder.

f.switch tries to match Rails' own API.

For extra convenience use the f.field method.

<%= nk_form_with model: @session do |f| %>
  <%= f.field :remember_me,
    as: :switch,
    label: "Remember me",
    description: "At least for a little bit" %>
<% end %>

With a label

To add a label, use the label: argument.

<%= nk_switch label: "Accept your fate" %>

Sizes

:sm

:md

<div class="flex gap-4 items-center text-xs text-center">
  <div class="flex flex-col gap-4">
    <%= nk_switch label: "Small", size: :sm %>
    <code>:sm</code>
  </div>
  <div class="flex flex-col gap-4">
    <%= nk_switch label: "Medium", size: :md %>
    <code>:md</code>
  </div>
</div>

Usage

`nk_switch(size: :md, **attrs)`
Property	Default	Description
`size`	`:md`	One of `:sm` / `:md`
`**attrs`		HTML attributes for `<button>` element