Sha256: c98c16089bd092bc1118e0acac281eb3be0452082206599032a7bae83eb118d6
Contents?: true
Size: 1.61 KB
Versions: 29
Compression:
Stored size: 1.61 KB
Contents
# frozen_string_literal: true
module Primer
module Alpha
CheckBoxGroup = Primer::FormComponents.from_input(Primer::Forms::Dsl::CheckBoxGroupInput)
# Check box groups consist of one or more related check boxes.
#
# @form_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
class CheckBoxGroup < Primer::Component
status :alpha
# @!method initialize
#
# @param 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 <%= link_to_component(Primer::Alpha::CheckBox) %> for more information.
# @param label [String] Label text displayed above the input.
# @param hidden [Boolean] When set to `true`, visually hides the group.
# @param caption [String] A string describing the field and what sorts of input it expects. Displayed below the group.
# @param 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.
# @!method check_box
#
# Adds a check box to the group.
#
# @param system_arguments [Hash] The arguments accepted by <%= link_to_component(Primer::Alpha::CheckBox) %>.
# @param block [Proc] The block accepted by <%= link_to_component(Primer::Alpha::CheckBox) %>.
end
end
end
Version data entries
29 entries across 29 versions & 2 rubygems