Merge pull request heartcombo#1784 from paulcc/revise-unchecked-docs

Revise unchecked docs
Sgtpluck · Jul 12, 2022 · cf743e7 · cf743e7
2 parents 3978722 + 4338d45
commit cf743e7
Showing 1 changed file with 12 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -257,7 +257,18 @@ the wrapper as well:
   <%= f.input :date_of_birth, as: :date, start_year: Date.today.year - 90,
                               end_year: Date.today.year - 12, discard_day: true,
                               order: [:month, :year] %>
-  <%= f.input :accepts, as: :boolean, checked_value: true, unchecked_value: false %>
+  <%= f.input :accepts, as: :boolean, checked_value: 'positive', unchecked_value: 'negative' %>
+  <%= f.button :submit %>
+<% end %>
+```
+
+By default, **Simple Form** generates a hidden field to handle the un-checked case for boolean fields. 
+Passing `unchecked_value: false` in the options for boolean fields will cause this hidden field to be omitted,
+following the convention in Rails. You can also specify `include_hidden: false` to skip the hidden field:
+
+```erb
+<%= simple_form_for @user do |f| %>
+  <%= f.input :just_the_checked_case, as: :boolean, include_hidden: false %>
   <%= f.button :submit %>
 <% end %>
 ```