headmin 0.3.2 → 0.4.0

data/app/views/headmin/forms/_label.html.erb

@@ -5,26 +5,18 @@
   # * +form+ - Form object
   # * +attribute+ - Name of the attribute of the form model
   #
-  # ==== Options
-  # * +class+ - Optional HTML class attribute
-  # * +for+ - Set reference to the input id
-  # * +required+ - Set to true if you want to highlight the requirement
+  # ==== Optional parameters
   # * +text+ - Custom label to be used instead of the attribute
   #
   # ==== References
+  # https://headmin.dev/docs/forms/label
   # https://developer.mozilla.org/en-US/docs/Web/HTML/Element/label
-  # https://apidock.com/rails/v5.2.3/ActionView/Helpers/FormHelper/label
+  # https://apidock.com/rails/ActionView/Helpers/FormHelper/label
   #
   # ==== Examples
   #   Basic version
   #   <%= render 'headmin/forms/label', form: form, attribute: :image %#>
-
-  text = local_assigns[:text]
-  default_options = {
-    class: ['form-label', local_assigns[:class]].join(' '),
-    form: form.options[:id],
-  }
-  options = default_options.merge(local_assigns.slice(*%i(for required)).compact)
 %>
 
-<%= form.label attribute, text, options %>
+<% label = Headmin::Form::LabelView.new(local_assigns) %>
+<%= form.label label.attribute, label.text, label.options %>

data/app/views/headmin/forms/_number.html.erb

@@ -2,52 +2,40 @@
   # headmin/forms/number
   #
   # ==== Required parameters
-  # * +form+ - Form object
   # * +attribute+ - Name of the attribute of the form model
+  # * +form+ - Form object
   #
   # ==== Optional parameters
-  # * +aria+ - Provide a hash to define all aria attributes
-  # * +autocomplete+ - Value to be autofilled by the browser
-  # * +autofocus+ - Set to true to focus on this field when the page renders
-  # * +data+ - Provide a hash to define all data attributes
-  # * +disabled+ - Sets the placeholder of the field
-  # * +id+ - Input identifier
-  # * +in+ -  Range specifying the +min+ and +max+ values
-  # * +list+ - Add array of options to show in a data list
-  # * +max+ - The maximum acceptable value
-  # * +min+ - The minimum acceptable value
-  # * +placeholder+ - Sets the placeholder of the field
-  # * +readonly+ - Sets the placeholder of the field
-  # * +required+ - Set to true to mark as required
-  # * +step+ - The acceptable value granularity
-  # * +value+ - Overrides the value of the form
-  # * +within+ - Same as +in+
-  #
-  # ==== Extra parameters
-  # Listed in 'headmin/forms/base'
+  # * +append+ - Display as input group with text on the right-hand side
+  # * +float+ - Use floating labels. Defaults to false
+  # * +hint+ - Informative text to assist with data input. HTML markup is allowed.
+  # * +label+ - Text to display inside label tag. Defaults to the attribute name. Set to false if you don"t want to show a label.
+  # * +list+ - Options are passed through options_for_select
+  # * +plaintext+ - Render input as plain text.
+  # * +prepend+ - Display as input group with text on the left-hand side
+  # * +wrapper+ - Hash with all options for the surrounding html tag
   #
   # ==== References
+  # https://headmin.dev/docs/forms/number
   # https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/number
   # https://apidock.com/rails/ActionView/Helpers/FormHelper/number_field
   #
   # ==== Examples
   #   Basic version
-  #   <%= render 'headmin/forms/number', form: form, attribute: :amount %#>
-  #
-  #   With data-list
-  #   <%= render 'headmin/forms/number', form: form, attribute: :amount, list: [2,4,6,8,10] %#>
-
-  placeholder = local_assigns[:float] ? local_assigns[:placeholder] || attribute : local_assigns[:placeholder]
+  #   <%= form_with do |form| %#>
+  #     <%= render "headmin/forms/number", form: form, attribute: :number %#>
+  #   <% end %#>
 
-  option_keys = %i(aria autocomplete autofocus data disabled id in list max min placeholder readonly required step value within)
-  options = local_assigns.slice(*option_keys).merge(
-    aria: { describedby: form_field_validation_id(form, attribute) },
-    class: ['form-control', form_field_validation_class(form, attribute)].join(' '),
-    list: local_assigns[:list] ? "#{attribute}_list" : nil,
-    placeholder: placeholder
-  )
+  number = Headmin::Form::NumberView.new(local_assigns)
 %>
 
-<%= render 'headmin/forms/base', local_assigns do |form| %>
-  <%= form.number_field(attribute, options) %>
+<%= render "headmin/forms/wrapper", number.wrapper_options do %>
+  <%= render "headmin/forms/label", number.label_options if number.prepend_label? %>
+  <%= render "headmin/forms/input_group", number.input_group_options do %>
+    <%= form.number_field(number.attribute, number.input_options) %>
+    <%= render "headmin/forms/datalist", number.datalist_options if number.datalist? %>
+  <% end %>
+  <%= render "headmin/forms/validation", number.validation_options if number.validate? %>
+  <%= render "headmin/forms/hint", number.hint_options if number.hint? %>
+  <%= render "headmin/forms/label", number.label_options if number.append_label? %>
 <% end %>

data/app/views/headmin/forms/_password.html.erb

@@ -2,47 +2,38 @@
   # headmin/forms/password
   #
   # ==== Required parameters
-  # * +form+ - Form object
   # * +attribute+ - Name of the attribute of the form model
+  # * +form+ - Form object
   #
   # ==== Optional parameters
-  # * +aria+ - Provide a hash to define all aria attributes
-  # * +autocomplete+ - Value to be autofilled by the browser
-  # * +autofocus+ - Set to true to focus on this field when the page renders
-  # * +data+ - Provide a hash to define all data attributes
-  # * +disabled+ - Sets the placeholder of the field
-  # * +id+ - Input identifier
-  # * +list+ - Add array of options to show in a data list
-  # * +maxlength+ - The maximum number of characters that the browser will allow the user to enter.
-  # * +minlength+ - The minimum number of characters that the browser will allow the user to enter.
-  # * +placeholder+ - Sets the placeholder of the field
-  # * +readonly+ - Sets the placeholder of the field
-  # * +required+ - Set to true to mark as required
-  # * +size+ - The number of visible characters that will fit in the input
-  # * +value+ - Overrides the value of the form
-  #
-  # ==== Extra parameters
-  # Listed in 'headmin/forms/base'
+  # * +append+ - Display as input group with text on the right-hand side
+  # * +float+ - Use floating labels. Defaults to false
+  # * +hint+ - Informative text to assist with data input. HTML markup is allowed.
+  # * +label+ - Text to display inside label tag. Defaults to the attribute name. Set to false if you don"t want to show a label.
+  # * +plaintext+ - Render input as plain text.
+  # * +prepend+ - Display as input group with text on the left-hand side
+  # * +wrapper+ - Hash with all options for the surrounding html tag
   #
   # ==== References
+  # https://headmin.dev/docs/forms/password
   # https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/password
   # https://apidock.com/rails/ActionView/Helpers/FormHelper/password_field
   #
   # ==== Examples
   #   Basic version
-  #   <%= render 'headmin/forms/password', form: form, attribute: :password %#>
-
-  placeholder = local_assigns[:float] ? local_assigns[:placeholder] || attribute : local_assigns[:placeholder]
+  #   <%= form_with do |form| %#>
+  #     <%= render "headmin/forms/password", form: form, attribute: :password %#>
+  #   <% end %#>
 
-  option_keys = %i(aria autocomplete autofocus data disabled id list maxlength minlength placeholder readonly required size value)
-  options = local_assigns.slice(*option_keys).merge(
-    autocomplete: true,
-    aria: { describedby: form_field_validation_id(form, attribute) },
-    class: ['form-control', form_field_validation_class(form, attribute)].join(' '),
-    placeholder: placeholder
-  )
+  password = Headmin::Form::PasswordView.new(local_assigns)
 %>
 
-<%= render 'headmin/forms/base', local_assigns do |form| %>
-  <%= form.password_field(attribute, options) %>
+<%= render "headmin/forms/wrapper", password.wrapper_options do %>
+  <%= render "headmin/forms/label", password.label_options if password.prepend_label? %>
+  <%= render "headmin/forms/input_group", password.input_group_options do %>
+    <%= form.password_field(password.attribute, password.input_options) %>
+  <% end %>
+  <%= render "headmin/forms/validation", password.validation_options if password.validate? %>
+  <%= render "headmin/forms/hint", password.hint_options if password.hint? %>
+  <%= render "headmin/forms/label", password.label_options if password.append_label? %>
 <% end %>

data/app/views/headmin/forms/_redactorx.html.erb

@@ -1,50 +1,31 @@
 <%
   # headmin/forms/redactorx
   #
-  # ==== Options
-  # * +form+ - Form object
+  # ==== Required parameters
   # * +attribute+ - Name of the attribute of the form model
-  # * +label+ - Text to show as label. Label will be hidden if value is false
-  # * +addbar+ - Items to show in the addbar
-  # * +topbar+ - Items to show in the topbar
-  # * +plugins+ - Plugin items to work with
+  # * +form+ - Form object
+  #
+  # ==== Optional parameters
+  # * +append+ - Display as input group with text on the right-hand side
+  # * +hint+ - Informative text to assist with data input. HTML markup is allowed.
+  # * +hybrid+ - Enables hybrid mode when set to true (default = false)
+  # * +label+ - Text to display inside label tag. Defaults to the attribute name. Set to false if you don"t want to show a label.
+  # * +prepend+ - Display as input group with text on the left-hand side
+  # * +redactor+ - Hash with all options you can pass to redactor JS config
+  # * +wrapper+ - Hash with all options for the surrounding html tag
+  #
+  # ==== References
+  # https://headmin.dev/docs/forms/redactorx
+  # https://developer.mozilla.org/en-US/docs/Web/HTML/Element/textarea
+  # https://apidock.com/rails/ActionView/Helpers/FormHelper/text_area
   #
   # ==== Examples
   #   Basic version
-  #   <%= render 'headmin/forms/redactorx', form: form, attribute: :title %#>
-
-  class_names = local_assigns.has_key?(:class) ? local_assigns[:class] : false
-  data = local_assigns.has_key?(:data) ? data : {}
-  disabled = local_assigns.has_key?(:disabled) ? disabled : false
-  label = local_assigns.has_key?(:label) ? label : nil
-  readonly = local_assigns.has_key?(:readonly) ? readonly : false
-  required = local_assigns.has_key?(:required) ? required : false
-  addbar = local_assigns.has_key?(:addbar) ? addbar : ['paragraph', 'image', 'embed', 'table', 'quote', 'pre', 'line']
-  plugins = local_assigns.has_key?(:plugins) ? plugins : ['shortcut']
-  topbar = local_assigns.has_key?(:topbar) ? topbar : []
-
-  data = data.merge(
-    controller: 'redactorx',
-    'redactor-options': {
-      buttons: {
-        addbar: addbar,
-        plugins: plugins,
-        topbar: topbar,
-      }
-    }
-  )
+  #   <%= form_with do |form| %#>
+  #     <%= render "headmin/forms/redactorx", form: form, attribute: :text %#>
+  #   <% end %#>
 
-  options = {
-    'aria-describedby': form_field_validation_id(form, attribute),
-    class: "form-control redactorx #{form_field_validation_class(form, attribute)} #{class_names}",
-    data: data,
-    disabled: disabled,
-    placeholder: attribute,
-    readonly: readonly,
-    required: required,
-  }
+  redactor = Headmin::Form::RedactorxView.new(local_assigns)
 %>
 
-<%= render 'headmin/forms/base', form: form, attribute: attribute, label: label, required: required do |form| %>
-  <%= form.text_area(attribute, options) %>
-<% end %>
+<%= render "headmin/forms/textarea", redactor.options %>

data/app/views/headmin/forms/_repeater.html.erb

@@ -26,7 +26,7 @@
   #   <% end %#>
   #
   #   # Allow more than one type of fields to be inserted. You must specify the templates as an array of view paths
-  #   <% templates = ['admin/questions/fields/_type_1.html.erb', 'admin/questions/fields/_type_2.html.erb'] %#>
+  #   <% templates = ['admin/questions/fields/type_1', 'admin/questions/fields/type_2'] %#>
   #   <% render 'headmin/forms/repeater', form: form, attribute: :questions, templates: templates do |question| %#>
   #     <% render 'admin/questions/fields, form: :question' %#>
   #   <% end %#>
@@ -50,80 +50,75 @@
   show_label = label != false
 %>
 
-<div class="repeater" data-controller="repeater" data-repeater-id-value="<%= repeater_id %>">
+<!-- Label -->
+<% if show_label %>
+  <%= render 'headmin/forms/label', form: form, attribute: attribute, text: label, required: required %>
+<% end %>
 
-  <!-- Label -->
-  <% if show_label %>
-    <%= render 'headmin/forms/label', form: form, attribute: attribute, name: label, required: required %>
-  <% end %>
-
-  <ul class="list-group <%= 'list-group-flush' if flush %>" data-repeater-target="list">
+<ul class="repeater list-group <%= 'list-group-flush' if flush %>" data-controller="repeater" data-repeater-target="list" data-repeater-id-value="<%= repeater_id %>">
 
-    <!-- Header -->
-    <% if header %>
-      <li class="list-group-item">
-        <%= render header %>
-      </li>
-    <% end %>
+  <!-- Header -->
+  <% if header %>
+    <li class="list-group-item">
+      <%= render header %>
+    </li>
+  <% end %>
 
-    <!-- Rows -->
-    <%= form.fields_for attribute, associations do |ff| %>
-      <%= render 'headmin/forms/repeater/row', pass_thru: pass_thru, form: ff, repeater_id: repeater_id do %>
-        <%= yield(ff) %>
-      <% end %>
+  <!-- Rows -->
+  <%= form.fields_for attribute, associations do |ff| %>
+    <%= render 'headmin/forms/repeater/row', pass_thru: pass_thru, form: ff, repeater_id: repeater_id do %>
+      <%= yield(ff) %>
     <% end %>
+  <% end %>
 
-    <!-- Footer -->
-    <li class="list-group-item d-flex justify-content-between align-items-center" data-repeater-target="footer">
+  <!-- Footer -->
+  <li class="list-group-item d-flex justify-content-between align-items-center" data-repeater-target="footer">
 
-      <!-- Empty notice -->
-      <div class="text-secondary invisible" data-repeater-target="empty">
-        <%= t('.empty') %>
-      </div>
+    <!-- Empty notice -->
+    <div class="text-secondary invisible" data-repeater-target="empty">
+      <%= t('.empty') %>
+    </div>
 
-      <!-- Button -->
-      <a href="#"
-         class="btn btn-sm h-btn-outline-light"
-         data-repeater-target="addButton"
-         data-popup-target="button"
-         data-popup-id="<%= "repeater-buttons-#{repeater_id}" %>"
-         data-popup-pass-thru="<%= pass_thru %>"
-         data-action="click->repeater#resetButtonIndices click->popup#open"
-      >
-        <%= bootstrap_icon('plus') %>
-        <%= t('.add', name: association_model.model_name.human) %>
-      </a>
+    <!-- Button -->
+    <div
+       class="btn btn-sm h-btn-outline-light"
+       data-repeater-target="addButton"
+       data-popup-target="button"
+       data-popup-id="<%= "repeater-buttons-#{repeater_id}" %>"
+       data-popup-pass-thru="<%= pass_thru %>"
+       data-action="click->repeater#resetButtonIndices click->popup#open"
+    >
+      <%= bootstrap_icon('plus') %>
+      <%= t('.add', name: association_model.model_name.human) %>
+    </div>
 
-      <!-- Popup  -->
-      <%= render 'headmin/popup', id: "repeater-buttons-#{repeater_id}" do %>
-        <div class="d-grid gap-2">
-          <% template_names.each do |name| %>
-            <a href="#"
-               class="btn btn-sm h-btn-outline-light"
-               data-popup-target="button"
-               data-popup-id="<%= "repeater-buttons-#{repeater_id}" %>"
-               data-action="click->repeater#addRow click->popup#close"
-               data-row-index=""
-               data-template-name="<%= name %>"
-            >
-              <%= name.humanize %>
-            </a>
-          <% end %>
-        </div>
-      <% end %>
-    </li>
+    <!-- Popup  -->
+    <%= render 'headmin/popup', id: "repeater-buttons-#{repeater_id}" do %>
+      <div class="d-grid gap-2">
+        <% template_names.each do |name| %>
+          <div
+             class="btn btn-sm h-btn-outline-light"
+             data-popup-target="button"
+             data-popup-id="<%= "repeater-buttons-#{repeater_id}" %>"
+             data-action="click->repeater#addRow click->popup#close"
+             data-row-index=""
+             data-template-name="<%= name %>"
+          >
+            <%= t("blocks.#{name}", default: name).humanize %>
+          </div>
+        <% end %>
+      </div>
+    <% end %>
 
     <!-- Templates -->
     <% template_names.each do |name| %>
       <template data-repeater-target="template" data-template-name="<%= name %>" data-template-id-regex="<%= association_object.object_id %>">
         <%= form.fields_for attribute, association_object, child_index: association_object.object_id do |ff| %>
           <%= render 'headmin/forms/repeater/row', form: ff, pass_thru: pass_thru, repeater_id: repeater_id do %>
-            <% template = templates.detect { |t| t.include?("/#{name}.") } %>
-            <% yield(ff, template&.gsub('/_', '/')) %>
+            <% yield(ff, name) %>
           <% end %>
         <% end %>
       </template>
     <% end %>
-
-  </ul>
-</div>
+  </li>
+</ul>

data/app/views/headmin/forms/_search.html.erb

@@ -0,0 +1,43 @@
+<%
+  # headmin/forms/search
+  #
+  # ==== Required parameters
+  # * +attribute+ - Name of the attribute of the form model
+  # * +form+ - Form object
+  #
+  # ==== Optional parameters
+  # * +append+ - Display as input group with text on the right-hand side
+  # * +collection+ - Values to be suggested while typing. Can be an collection array or a remote URL.
+  # * +float+ - Use floating labels. Defaults to false
+  # * +hint+ - Informative text to assist with data input. HTML markup is allowed.
+  # * +label+ - Text to display inside label tag. Defaults to the attribute name. Set to false if you don"t want to show a label.
+  # * +list+ - Options are passed through options_for_select
+  # * +plaintext+ - Render input as plain text.
+  # * +prepend+ - Display as input group with text on the left-hand side
+  # * +wrapper+ - Hash with all options for the surrounding html tag
+  #
+  # ==== Documentation
+  # https://headmin.dev/docs/forms/search
+  # https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/search
+  # https://apidock.com/rails/ActionView/Helpers/FormHelper/search_field
+  #
+  # ==== Examples
+  #   Basic version
+  #   <%= form_with do |form| %#>
+  #     <%= render "headmin/forms/search", form: form, attribute: "basic_example" %#>
+  #   <% end %#>
+
+  search = Headmin::Form::SearchView.new(local_assigns)
+%>
+
+<%= render "headmin/forms/wrapper", search.wrapper_options do %>
+  <%= render "headmin/forms/label", search.label_options if search.prepend_label? %>
+  <%= render "headmin/forms/input_group", search.input_group_options do %>
+    <%= form.search_field(search.attribute, search.input_options) %>
+    <%= render "headmin/forms/datalist", search.datalist_options if search.datalist? %>
+    <%= render "headmin/forms/autocomplete", search.autocomplete_options if search.autocomplete? %>
+  <% end %>
+  <%= render "headmin/forms/validation", search.validation_options if search.validate? %>
+  <%= render "headmin/forms/hint", search.hint_options if search.hint? %>
+  <%= render "headmin/forms/label", search.label_options if search.append_label? %>
+<% end %>

data/app/views/headmin/forms/_select.html.erb

@@ -2,67 +2,42 @@
   # headmin/forms/select
   #
   # ==== Required parameters
-  # * +form+ - Form object
   # * +attribute+ - Name of the attribute of the form model
+  # * +form+ - Form object
   # * +collection+ - Values to create option tags for
   #
   # ==== Optional parameters
-  # * +aria+ - Provide a hash to define all aria attributes
-  # * +autocomplete+ - Value to be autofilled by the browser
-  # * +autofocus+ - Set to true to focus on this field when the page renders
-  # * +data+ - Optional HTML data attributes
-  # * +disabled+ - One or more values to be disabled in the option tags
-  # * +include_blank+ - Set to true or prompt string if the first option tag is a blank
-  # * +multiple+ - Set to true if multiple selections are allowed
-  # * +required+ - Set to true to mark as required
-  # * +selected+ - Value to be marked as "selected"
-  # * +size+ - The number of visible rows in a multiple select field
-  # * +tags+ - Set to true if new options are allowed to be created
-  #
-  # ==== Extra parameters
-  # Listed in 'headmin/forms/base'
+  # * +append+ - Display as input group with text on the right-hand side
+  # * +float+ - Use floating labels. Defaults to false
+  # * +hint+ - Informative text to assist with data input. HTML markup is allowed.
+  # * +label+ - Text to display inside label tag. Defaults to the attribute name. Set to false if you don"t want to show a label.
+  # * +list+ - Options are passed through options_for_select
+  # * +plaintext+ - Render input as plain text.
+  # * +prepend+ - Display as input group with text on the left-hand side
+  # * +tags+ - Allow options to be created dynamically. This will set the multiple attribute to true
+  # * +wrapper+ - Hash with all options for the surrounding html tag
   #
   # ==== References
+  # https://headmin.dev/docs/forms/select
   # https://developer.mozilla.org/en-US/docs/Web/HTML/Element/select
   # https://apidock.com/rails/ActionView/Helpers/FormOptionsHelper/select
   #
   # ==== Examples
   #   Basic version
-  #   <%= render 'headmin/forms/select', form: form, attribute: :color, collection: ['red', 'green', 'blue'] %#>
-  #
-  #   Disabled
-  #   <%= render 'headmin/forms/select', form: form, attribute: :color, collection: ['red', 'green', 'blue'], disabled: true %#>
-  #
-  #   Disable specific options
-  #   <%= render 'headmin/forms/select', form: form, attribute: :color, collection: ['red', 'green', 'blue'], disabled: ['red'] %#>
-  #
-  #   Show blank option
-  #   <%= render 'headmin/forms/select', form: form, attribute: :color, collection: ['red', 'green', 'blue'], include_blank: 'Pick a color' %#>
-  #
-  #   Select a default option
-  #   <%= render 'headmin/forms/select', form: form, attribute: :color, collection: ['red', 'green', 'blue'], selected: 'green' %#>
-  #
-  #   Allow multiple options to be selected
-  #   <%= render 'headmin/forms/select', form: form, attribute: :color, collection: ['red', 'green', 'blue'], multiple: true %#>
-  #
-  #   Allow multiple options to be selected and new options to be created
-  #   <%= render 'headmin/forms/select', form: form, attribute: :color, collection: ['red', 'green', 'blue'], tags: true %#>
-
-  options_keys = %i(include_blank selected disabled)
-  options = local_assigns.slice(*options_keys).merge(
-    selected: form.object&.send(attribute),
-  )
+  #   <%= form_with do |form| %#>
+  #     <%= render "headmin/forms/select", form: form, attribute: :color, collection: %w[red green blue] %#>
+  #   <% end %#>
 
-  html_option_keys = %i(aria autocomplete autofocus data disabled id multiple required size)
-  html_options = local_assigns.slice(*html_option_keys).merge(
-    aria: { describedby: form_field_validation_id(form, attribute) },
-    class: ['form-select', form_field_validation_class(form, attribute)].join(' '),
-    data: { tags: local_assigns[:tags], controller: 'select'},
-    disabled: local_assigns[:disabled] == true,
-    multiple: local_assigns[:multiple] || local_assigns[:tags],
-  )
+  select = Headmin::Form::SelectView.new(local_assigns)
 %>
 
-<%= render 'headmin/forms/base', local_assigns do |form| %>
-  <%= form.select(attribute, collection, options, html_options) %>
+<%= render "headmin/forms/wrapper", select.wrapper_options do %>
+  <%= render "headmin/forms/label", select.label_options if select.prepend_label? %>
+  <%= render "headmin/forms/input_group", select.input_group_options do %>
+    <%= form.select(select.attribute, select.collection, select.select_options, select.input_options) %>
+  <% end %>
+  <%= render "headmin/forms/validation", select.validation_options if select.validate? %>
+  <%= render "headmin/forms/hint", select.hint_options if select.hint? %>
+  <%= render "headmin/forms/datalist", select.datalist_options if select.datalist? %>
+  <%= render "headmin/forms/label", select.label_options if select.append_label? %>
 <% end %>

data/app/views/headmin/forms/_switch.html.erb

@@ -0,0 +1,29 @@
+<%
+  # headmin/forms/switch
+  #
+  # ==== Required parameters
+  # * +attribute+ - Name of the attribute of the form model
+  # * +form+ - Form object
+  #
+  # ==== Optional parameters
+  # * +checked_value+ - Value for checked state
+  # * +hint+ - Informative text to assist with data input. HTML markup is allowed.
+  # * +label+ - Text to display inside label tag. Defaults to the attribute name. Set to false if you don"t want to show a label.
+  # * +unchecked_value+ - Value for unchecked state
+  # * +wrapper+ - Hash with all options for the surrounding html tag
+  #
+  # ==== References
+  # https://headmin.dev/docs/forms/switch
+  # https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/checkbox
+  # https://apidock.com/rails/ActionView/Helpers/FormHelper/check_box
+  #
+  # ==== Examples
+  #   Basic version
+  #   <%= form_with do |form| %#>
+  #     <%= render "headmin/forms/switch", form: form, attribute: :active %#>
+  #   <% end %#>
+
+  switch = Headmin::Form::SwitchView.new(local_assigns)
+%>
+
+<%= render "headmin/forms/checkbox", switch.options %>