ActionView::Helpers::FormTagHelper

checkbox_tag

API docs (Rails 8.1.4.1) ↗

Alias: check_box_tag

def checkbox_tag(name, value = "1", checked = false, options = {})

Description

Creates an <input> with type="checkbox" that is not tied to a model.

Arguments

Changing a value updates the ERB and HTML.

Used as the name and id attributes of the <input>. In the id, [, spaces and similar characters become _, and ] is removed.
= "1"
Sets the value attribute. nil omits it.
= false 
true
Any value other than false and nil adds the checked attribute (even "0" adds it).
options= {}
"other"
Sets the value attribute, overriding the value argument. nil omits value.
Common options

Rails handles these options the same way in every helper. Options the HTML spec does not allow on the <input>, and ones this site considers rarely used, are not listed here.

Shared by form helpers

"q"
Replaces the generated name with the given value. nil omits name.
nil
Replaces the generated id with the given value. nil omits id.

Shared by all helpers

true adds disabled="disabled"; false omits it. The same goes for every HTML attribute in Rails' list (BOOLEAN_ATTRIBUTES), such as readonly, required and autofocus: any value other than false or nil adds it as attr="attr".
{active: true, hidden: false}
A hash gives the keys whose values are not false or nil, joined with spaces. An array gives its elements joined with spaces, after removing nil, false and empty strings (including whitespace-only strings).
{controller: "tags", tags_suggestions_value: ["ruby", "rails"]}
A hash adds data-* attributes, with _ in the keys converted to -. Array and hash values are converted to JSON strings.
{describedby: ["name_help", "name_error"], invalid: false}
Like :data, adds aria-* attributes. Array values are joined with spaces, leaving out nil and empty strings (nothing is added if none remain). For a hash value, the keys whose values are not false or nil are joined with spaces.
Any other options become HTML attributes of the <input>; those with a nil value are left out.

ERB

Changes from the previous output: Added Removed Changed


          

        


        

          

            
HTML

          

          

            
            

          

        


        

          

            
Preview

            

              
              
                
Interacting with the preview updates the form submission.


            

          


          

            
Form submission

            

              
Form data

              

                
namevalue

                
              

              

                Request body
                
Content-Type: 

                

              

              

                
params