.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "HTML::FormFu::Role::Element::Group 3pm"
.TH HTML::FormFu::Role::Element::Group 3pm 2024-04-10 "perl v5.38.2" "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::Role::Element::Group \- Role for grouped form fields
.SH VERSION
.IX Header "VERSION"
version 2.07
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Base class for HTML::FormFu::Element::Checkboxgroup,
HTML::FormFu::Element::Radiogroup, and
HTML::FormFu::Element::Select fields.
.SH METHODS
.IX Header "METHODS"
.SS options
.IX Subsection "options"
Arguments: none
.PP
Arguments: \e@options
.PP
.Vb 12
\&    \-\-\-
\&    elements:
\&      \- type: Select
\&        name: foo
\&        options:
\&          \- [ 01, January ]
\&          \- [ 02, February ]
\&          \- value: 03
\&            label: March
\&            attributes:
\&              style: highlighted
\&          \- [ 04, April ]
.Ve
.PP
If passed no arguments, it returns an arrayref of the currently set options.
.PP
Use to set the list of items in the select menu / radiogroup.
.PP
Its arguments must be an array-ref of items. Each item may be an array ref
of the form \f(CW\*(C`[ $value, $label ]\*(C'\fR or a hash-ref of the form
\&\f(CW\*(C`{ value => $value, label => $label }\*(C'\fR. Each hash-ref may also have an
\&\f(CW\*(C`attributes\*(C'\fR key.
.PP
Passing an item containing a \f(CW\*(C`group\*(C'\fR key will, for
Select fields, create an optgroup. And for
Radiogroup fields or
Checkboxgroup fields, create a
sub-group of radiobuttons or checkboxes with a new \f(CW\*(C`span\*(C'\fR block, with the
classname \f(CW\*(C`subgroup\*(C'\fR.
.PP
An example of Select optgroups:
.PP
.Vb 10
\&    \-\-\-
\&    elements:
\&      \- type: Select
\&        name: foo
\&        options:
\&          \- label: "group 1"
\&            group:
\&              \- [1a, \*(Aqitem 1a\*(Aq]
\&              \- [1b, \*(Aqitem 1b\*(Aq]
\&          \- label: "group 2"
\&            group:
\&              \- [2a, \*(Aqitem 2a\*(Aq]
\&              \- [2b, \*(Aqitem 2b\*(Aq]
.Ve
.PP
When using the hash-ref construct, the \f(CW\*(C`label_xml\*(C'\fR and \f(CW\*(C`label_loc\*(C'\fR
variants of \f(CW\*(C`label\*(C'\fR are supported, as are the \f(CW\*(C`value_xml\*(C'\fR and \f(CW\*(C`value_loc\*(C'\fR
variants of \f(CW\*(C`value\*(C'\fR, the \f(CW\*(C`attributes_xml\*(C'\fR variant of \f(CW\*(C`attributes\*(C'\fR and the
\&\f(CW\*(C`label_attributes_xml\*(C'\fR variant of \f(CW\*(C`label_attributes\*(C'\fR.
.PP
\&\f(CW\*(C`container_attributes\*(C'\fR or \f(CW\*(C`container_attributes_xml\*(C'\fR is used by
HTML::FormFu::Element::Checkboxgroup and
HTML::FormFu::Element::Radiogroup for the c<span> surrounding each
item's input and label. It is ignored by HTML::FormFu::Element::Select
elements.
.PP
\&\f(CW\*(C`label_attributes\*(C'\fR / \f(CW\*(C`label_attributes_xml\*(C'\fR is used by
HTML::FormFu::Element::Checkboxgroup and
HTML::FormFu::Element::Radiogroup for the c<label> tag of each item.
It is ignored by HTML::FormFu::Element::Select elements.
.SS values
.IX Subsection "values"
Arguments: \e@values
.PP
.Vb 9
\&    \-\-\-
\&    elements:
\&      \- type: Radiogroup
\&        name: foo
\&        values:
\&          \- jan
\&          \- feb
\&          \- mar
\&          \- apr
.Ve
.PP
A more concise alternative to "options". Use to set the list of values in
the select menu / radiogroup.
.PP
Its arguments must be an array-ref of values. The labels used are the
result of \f(CWucfirst($value)\fR.
.SS value_range
.IX Subsection "value_range"
Arguments: \e@values
.PP
.Vb 8
\&    \-\-\-
\&    elements:
\&      \- type: Select
\&        name: foo
\&        value_range:
\&          \- ""
\&          \- 1
\&          \- 12
.Ve
.PP
Similar to "values", but the last 2 values are expanded to a range. Any
preceding values are used literally, allowing the common empty first item
in select menus.
.SS empty_first
.IX Subsection "empty_first"
If true, then a blank option will be inserted at the start of the option list
(regardless of whether "options", "values" or "value_range" was used to
populate the options).  See also "empty_first_label".
.SS empty_first_label
.IX Subsection "empty_first_label"
.SS empty_first_label_xml
.IX Subsection "empty_first_label_xml"
.SS empty_first_label_loc
.IX Subsection "empty_first_label_loc"
If "empty_first" is true, and "empty_first_label" is set, this value will
be used as the label for the first option \- so only the first option's value
will be empty.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Is a sub-class of, and inherits methods from
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.
.SH AUTHOR
.IX Header "AUTHOR"
Carl Franks <cpan@fireartist.com>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2018 by Carl Franks.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.