.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "HTML::FormFu::Element::Checkboxgroup 3pm"
.TH HTML::FormFu::Element::Checkboxgroup 3pm "2016-10-29" "perl v5.24.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
HTML::FormFu::Element::Checkboxgroup \- Group of checkbox form fields
.SH "VERSION"
.IX Header "VERSION"
version 2.05
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\s-1YAML\s0 config:
.PP
.Vb 8
\&    \-\-\-
\&    elements:
\&      \- type: Checkboxgroup
\&        name: subjects
\&        options:
\&          \- [ \*(AqMath\*(Aq ]
\&          \- [ \*(AqScience\*(Aq ]
\&          \- [ \*(AqEnglish\*(Aq ]
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Convenient to use group of checkbox fields.
.PP
Use the same syntax as you would to create a Select element optgroup to
create Checkboxgroup sub-groups, see \*(L"options\*(R" in HTML::FormFu::Role::Element::Group
for details.
.SH "METHODS"
.IX Header "METHODS"
.SS "options"
.IX Subsection "options"
See \*(L"options\*(R" in HTML::FormFu::Role::Element::Group.
.SS "values"
.IX Subsection "values"
See \*(L"values\*(R" in HTML::FormFu::Role::Element::Group.
.SS "value_range"
.IX Subsection "value_range"
See \*(L"value_range\*(R" in HTML::FormFu::Role::Element::Group.
.SS "auto_id"
.IX Subsection "auto_id"
In addition to the substitutions documented by \*(L"auto_id\*(R" in HTML::FormFu,
\&\f(CW%c\fR will be replaced by an incremented integer, to ensure there are
no duplicated \s-1ID\s0's, and \f(CW%v\fR will be replaced by the item's value to
allow multiple elements with the same name to coexist, and their labels
to correctly select the appropriate item.
.PP
.Vb 5
\&    \-\-\-
\&    elements:
\&      type: Checkboxgroup
\&      name: foo
\&      auto_id: "%n_%c"
.Ve
.SS "reverse_group"
.IX Subsection "reverse_group"
If true, then the label for each checkbox in the checkbox group should
be rendered to the right of the field control.  Otherwise, the label
is rendered to the left of the field control.
.PP
The default value is \f(CW\*(C`true\*(C'\fR, causing each label to be rendered to the
right of its field control (or to be explicit: the markup for the
label comes after the field control in the source).
.PP
Default Value: \f(CW\*(C`true\*(C'\fR
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Is a sub-class of, and inherits methods from
HTML::FormFu::Role::Element::Group,
HTML::FormFu::Role::Element::Field,
HTML::FormFu::Element
.PP
HTML::FormFu
.SH "AUTHOR"
.IX Header "AUTHOR"
Carl Franks, \f(CW\*(C`cfranks@cpan.org\*(C'\fR
.SH "LICENSE"
.IX Header "LICENSE"
This library is free software, you can redistribute it and/or modify it under
the same terms as Perl itself.