CheckBoxGroup

readyNot reviewed for a11y

This page may be removed. Primer plans to move all Rails component documentation to Lookbook.

The CheckBoxGroup component is part of the Primer ViewComponents forms framework. If you are building a form, please consider using the framework instead of this standalone component.

Description

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

Arguments

Name	Required	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 `Primer::Alpha::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(system_arguments: Hash, block: Proc)`

Adds a check box to the group.

Parameters

Name	Required	Description
system_arguments		`Hash` The arguments accepted by `Primer::Alpha::CheckBox`.
block		`Proc` The block accepted by `Primer::Alpha::CheckBox`.