Put checkbox label and hint definition in builder

chaimann · chaimann · commit 32c2509bcf8a · 2025-06-30T20:51:55.000+02:00
diff --git a/admin/app/components/solidus_admin/adjustment_reasons/edit/component.html.erb b/admin/app/components/solidus_admin/adjustment_reasons/edit/component.html.erb
@@ -4,10 +4,7 @@
       <div class="flex flex-col gap-6 pb-4">
         <%= f.text_field(:name, class: "required") %>
         <%= f.text_field(:code, class: "required") %>
-        <%= f.checkbox(:active) do |checkbox| %>
-          <%= checkbox.with_label(text: Spree::AdjustmentReason.human_attribute_name(:active), weight: :semibold, size: :xs, classes: 'ml-2') %>
-          <%= checkbox.with_hint(text: t(".hints.active")) %>
-        <% end %>
+        <%= f.checkbox(:active, hint: t(".hints.active")) %>
       </div>
       <% modal.with_actions do %>
         <form method="dialog">
diff --git a/admin/app/components/solidus_admin/adjustment_reasons/new/component.html.erb b/admin/app/components/solidus_admin/adjustment_reasons/new/component.html.erb
@@ -4,10 +4,7 @@
       <div class="flex flex-col gap-6 pb-4">
         <%= f.text_field(:name, class: "required") %>
         <%= f.text_field(:code, class: "required") %>
-        <%= f.checkbox(:active) do |checkbox| %>
-          <%= checkbox.with_label(text: Spree::AdjustmentReason.human_attribute_name(:active), weight: :semibold, size: :xs, classes: 'ml-2') %>
-          <%= checkbox.with_hint(text: t(".hints.active")) %>
-        <% end %>
+        <%= f.checkbox(:active, hint: t(".hints.active")) %>
       </div>
       <% modal.with_actions do %>
         <form method="dialog">
diff --git a/admin/app/components/solidus_admin/orders/show/address/component.html.erb b/admin/app/components/solidus_admin/orders/show/address/component.html.erb
@@ -33,10 +33,10 @@
           </div>
 
           <%= form.checkbox(use_attribute,
-            checked: @address == (@type == 'ship' ? @order.bill_address : @order.ship_address)
-          ) do |checkbox| %>
-            <%= checkbox.with_label(text: t(".use_this_address.#{@type}"), size: :xs) %>
-          <% end %>
+            checked: @address == (@type == 'ship' ? @order.bill_address : @order.ship_address),
+            label: t(".use_this_address.#{@type}"),
+            label_options: { size: :xs })
+          %>
         </div>
       <% end %>
 
diff --git a/admin/app/components/solidus_admin/products/show/component.html.erb b/admin/app/components/solidus_admin/products/show/component.html.erb
@@ -102,10 +102,7 @@
             type: :date,
             value: f.object.discontinue_on&.to_date
           ) %>
-          <%= f.checkbox(:promotionable) do |checkbox| %>
-            <%= checkbox.with_label(text: Spree::Product.human_attribute_name(:promotionable), size: :xs) %>
-            <%= checkbox.with_hint(text: t(".hints.promotionable_html")) %>
-          <% end %>
+          <%= f.checkbox(:promotionable, hint: t(".hints.promotionable_html")) %>
         <% end %>
 
         <%= render component("ui/panel").new(title: t(".product_organization")) do %>
diff --git a/admin/app/components/solidus_admin/refund_reasons/edit/component.html.erb b/admin/app/components/solidus_admin/refund_reasons/edit/component.html.erb
@@ -4,10 +4,7 @@
       <div class="flex flex-col gap-6 pb-4">
         <%= f.text_field(:name, class: "required") %>
         <%= f.text_field(:code, class: "required") %>
-        <%= f.checkbox(:active) do |checkbox| %>
-          <%= checkbox.with_label(text: Spree::RefundReason.human_attribute_name(:active), weight: :semibold, size: :xs, classes: 'ml-2') %>
-          <%= checkbox.with_hint(text: t(".hints.active")) %>
-        <% end %>
+        <%= f.checkbox(:active, hint: t(".hints.active")) %>
       </div>
       <% modal.with_actions do %>
         <form method="dialog">
diff --git a/admin/app/components/solidus_admin/refund_reasons/new/component.html.erb b/admin/app/components/solidus_admin/refund_reasons/new/component.html.erb
@@ -4,10 +4,7 @@
       <div class="flex flex-col gap-6 pb-4">
         <%= f.text_field(:name, class: "required") %>
         <%= f.text_field(:code, class: "required") %>
-        <%= f.checkbox(:active) do |checkbox| %>
-          <%= checkbox.with_label(text: Spree::RefundReason.human_attribute_name(:active), weight: :semibold, size: :xs, classes: 'ml-2') %>
-          <%= checkbox.with_hint(text: t(".hints.active")) %>
-        <% end %>
+        <%= f.checkbox(:active, hint: t(".hints.active")) %>
       </div>
       <% modal.with_actions do %>
         <form method="dialog">
diff --git a/admin/app/components/solidus_admin/return_reasons/edit/component.html.erb b/admin/app/components/solidus_admin/return_reasons/edit/component.html.erb
@@ -3,10 +3,7 @@
     <%= solidus_form_for @return_reason, url: form_url, html: { id: form_id } do |f| %>
       <div class="flex flex-col gap-6 pb-4">
         <%= f.text_field(:name, class: "required") %>
-        <%= f.checkbox(:active) do |checkbox| %>
-          <%= checkbox.with_label(text: Spree::ReturnReason.human_attribute_name(:active), weight: :semibold, size: :xs, classes: 'ml-2') %>
-          <%= checkbox.with_hint(text: t(".hints.active")) %>
-        <% end %>
+        <%= f.checkbox(:active, hint: t(".hints.active")) %>
       </div>
       <% modal.with_actions do %>
         <form method="dialog">
diff --git a/admin/app/components/solidus_admin/return_reasons/new/component.html.erb b/admin/app/components/solidus_admin/return_reasons/new/component.html.erb
@@ -3,10 +3,7 @@
     <%= solidus_form_for @return_reason, url: form_url, html: { id: form_id } do |f| %>
       <div class="flex flex-col gap-6 pb-4">
         <%= f.text_field(:name, class: "required") %>
-        <%= f.checkbox(:active) do |checkbox| %>
-          <%= checkbox.with_label(text: Spree::ReturnReason.human_attribute_name(:active), weight: :semibold, size: :xs, classes: 'ml-2') %>
-          <%= checkbox.with_hint(text: t(".hints.active")) %>
-        <% end %>
+        <%= f.checkbox(:active, hint: t(".hints.active")) %>
       </div>
       <% modal.with_actions do %>
         <form method="dialog">
diff --git a/admin/app/components/solidus_admin/store_credit_reasons/edit/component.html.erb b/admin/app/components/solidus_admin/store_credit_reasons/edit/component.html.erb
@@ -3,10 +3,7 @@
     <%= solidus_form_for @store_credit_reason, url: form_url, html: { id: form_id } do |f| %>
       <div class="flex flex-col gap-6 pb-4">
         <%= f.text_field(:name, class: "required") %>
-        <%= f.checkbox(:active) do |checkbox| %>
-          <%= checkbox.with_label(text: Spree::StoreCreditReason.human_attribute_name(:active), weight: :semibold, size: :xs, classes: 'ml-2') %>
-          <%= checkbox.with_hint(text: t(".hints.active")) %>
-        <% end %>
+        <%= f.checkbox(:active, hint: t(".hints.active")) %>
       </div>
       <% modal.with_actions do %>
         <form method="dialog">
diff --git a/admin/app/components/solidus_admin/store_credit_reasons/new/component.html.erb b/admin/app/components/solidus_admin/store_credit_reasons/new/component.html.erb
@@ -3,10 +3,7 @@
     <%= solidus_form_for @store_credit_reason, url: form_url, html: { id: form_id } do |f| %>
       <div class="flex flex-col gap-6 pb-4">
         <%= f.text_field(:name, class: "required") %>
-        <%= f.checkbox(:active) do |checkbox| %>
-          <%= checkbox.with_label(text: Spree::StoreCreditReason.human_attribute_name(:active), weight: :semibold, size: :xs, classes: 'ml-2') %>
-          <%= checkbox.with_hint(text: t(".hints.active")) %>
-        <% end %>
+        <%= f.checkbox(:active, hint: t(".hints.active")) %>
       </div>
       <% modal.with_actions do %>
         <form method="dialog">
diff --git a/admin/app/components/solidus_admin/tax_categories/edit/component.html.erb b/admin/app/components/solidus_admin/tax_categories/edit/component.html.erb
@@ -5,10 +5,7 @@
         <%= f.text_field(:name) %>
         <%= f.text_field(:tax_code) %>
         <%= f.text_field(:description) %>
-        <%= f.checkbox(:is_default) do |checkbox| %>
-          <%= checkbox.with_label(text: Spree::TaxCategory.human_attribute_name(:is_default), weight: :semibold, size: :xs, classes: 'ml-2') %>
-          <%= checkbox.with_hint(text: t(".hints.is_default")) %>
-        <% end %>
+        <%= f.checkbox(:is_default, hint: t(".hints.is_default")) %>
       </div>
       <% modal.with_actions do %>
         <form method="dialog">
diff --git a/admin/app/components/solidus_admin/tax_categories/new/component.html.erb b/admin/app/components/solidus_admin/tax_categories/new/component.html.erb
@@ -5,10 +5,7 @@
         <%= f.text_field(:name) %>
         <%= f.text_field(:tax_code) %>
         <%= f.text_field(:description) %>
-        <%= f.checkbox(:is_default) do |checkbox| %>
-          <%= checkbox.with_label(text: Spree::TaxCategory.human_attribute_name(:is_default), weight: :semibold, size: :xs, classes: 'ml-2') %>
-          <%= checkbox.with_hint(text: t(".hints.is_default")) %>
-        <% end %>
+        <%= f.checkbox(:is_default, hint: t(".hints.is_default")) %>
       </div>
       <% modal.with_actions do %>
         <form method="dialog">
diff --git a/admin/app/lib/solidus_admin/form_builder.rb b/admin/app/lib/solidus_admin/form_builder.rb
@@ -17,10 +17,17 @@ def select(method, choices, **options)
     render component("ui/forms/field").select(self, method, choices, **options)
   end
 
-  def checkbox(method, checked: nil, **options, &block)
+  def checkbox(method, label: nil, checked: nil, hint: nil, **options)
+    label = @object.class.human_attribute_name(method) if label.nil?
+    label_options = options.delete(:label_options) || {}
     checked = @object.public_send(method) if checked.nil?
+    hint_options = options.delete(:hint_options) || {}
+
     component_instance = component("ui/forms/checkbox").new(object_name: @object_name, checked:, method:, **options)
-    render component_instance, &block
+    render component_instance do |checkbox|
+      checkbox.with_label(text: label, **label_options)
+      checkbox.with_hint(text: hint, **hint_options) if hint
+    end
   end
 
   def checkbox_row(method, options:, row_title:, **attrs)
diff --git a/admin/spec/solidus_admin/form_builder_spec.rb b/admin/spec/solidus_admin/form_builder_spec.rb
@@ -44,6 +44,18 @@
         expect(builder.checkbox(:promotionable)).to include("checked=\"checked\"")
       end
     end
+
+    context "with custom label" do
+      it "renders with custom label" do
+        expect(builder.checkbox(:promotionable, label: "Promo-able")).to include("Promo-able")
+      end
+    end
+
+    context "with hint" do
+      it "renders with hint" do
+        expect(builder.checkbox(:promotionable, hint: "Helpful info")).to include("Helpful info")
+      end
+    end
   end
 
   describe "#checkbox_row" do
