Primer ViewComponents v0.35.1

Previews

No matching results.

Check Box Group

Check box groups consist of one or more related check boxes.

Usage

class ExampleForm < ApplicationForm
  form do |example_form|
    example_form.check_box_group(attributes) do |group|
      group.check_box(check_box_attributes)
    end
  end
end

Common arguments

Name Type Description
name String Value for the HTML name attribute. When provided, the check box values will be submitted in to the server in :array mode. See the CheckBox for more information.
label String Label text displayed above the input.
hidden Boolean When set to true, visually hides the group.
caption String A string describing the field and what sorts of input it expects. Displayed below the group.
invalid Boolean If set to true, the input will be marked as invalid. Implied if validation_message is truthy. This option is set to true automatically if the model object associated with the form reports that the input is invalid via Rails validations. It is provided for cases where the form does not have an associated model. If the input is invalid as determined by Rails validations, setting invalid to false will have no effect.
validation_message String A string displayed between the caption and the input indicating the input's contents are invalid. This option is, by default, set to the first Rails validation message for the input (assuming the form is associated with a model object). Use validation_message to override the default or to provide a validation message in case there is no associated model object.
label_arguments Hash Attributes that will be passed to Rails' builder.label method. These can be HTML attributes or any of the other label options Rails supports. They will appear as HTML attributes on the <label> tag.

Methods

#check_box

Adds a check box to the group.

Name Type Description
system_arguments Hash The arguments accepted by CheckBox.
block Proc The block accepted by CheckBox.

Examples