Carl Franks > HTML-FormFu-2.01 > HTML::FormFu::Element::Checkboxgroup

Download:
HTML-FormFu-2.01.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  12
Open  4
Stalled  1
View/Report Bugs
Module Version: 2.01   Source  

NAME ^

HTML::FormFu::Element::Checkboxgroup - Group of checkbox form fields

SYNOPSIS ^

YAML config:

    ---
    elements:
      - type: Checkboxgroup
        name: subjects
        options:
          - [ 'Math' ]
          - [ 'Science' ]
          - [ 'English' ]

DESCRIPTION ^

Convenient to use group of checkbox fields.

Use the same syntax as you would to create a Select element optgroup to create Checkboxgroup sub-groups, see "options" in HTML::FormFu::Role::Element::Group for details.

METHODS ^

options

See "options" in HTML::FormFu::Role::Element::Group.

values

See "values" in HTML::FormFu::Role::Element::Group.

value_range

See "value_range" in HTML::FormFu::Role::Element::Group.

auto_id

In addition to the substitutions documented by "auto_id" in HTML::FormFu, %c will be replaced by an incremented integer, to ensure there are no duplicated ID's, and %v 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.

    ---
    elements:
      type: Checkboxgroup
      name: foo
      auto_id: "%n_%c"

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.

The default value is true, 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).

Default Value: true

SEE ALSO ^

Is a sub-class of, and inherits methods from HTML::FormFu::Role::Element::Group, HTML::FormFu::Role::Element::Field, HTML::FormFu::Element

HTML::FormFu

AUTHOR ^

Carl Franks, cfranks@cpan.org

LICENSE ^

This library is free software, you can redistribute it and/or modify it under the same terms as Perl itself.

syntax highlighting: