HTML::...xgroup(3pm)

✨ HTML::FormFu::Element::Checkboxgroup — the manual page, bestie edition ✨

okay so real quick: this is the page for HTML::...xgroup(3pm) — which is the manpage for HTML::FormFu::Element::Checkboxgroup, from the User Contributed Perl Documentation section. yes the header truncates the name, no we're not gonna be weird about it. let's GO 💅

---

🌸 NAME 🌸

HTML::FormFu::Element::Checkboxgroup — a whole group of checkbox form fields, living together, thriving 💖

---

🎀 VERSION 🎀

version 2.07 ✨

---

🦋 SYNOPSIS 🦋

YAML config, babes:

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

look at her. three little checkboxes. so cute. so functional. 🍓

---

👑 DESCRIPTION 👑

Convenient to use group of checkbox fields. that's the whole vibe, honestly — it's a handy little container so you're not hand-rolling a pile of checkboxes like some kind of gremlin.

wanna make Checkboxgroup sub-groups? then you use the exact same syntax you'd use to create an optgroup for a Select element. details are over in "options" in HTML::FormFu::Role::Element::Group — go peek, iykyk 🔥

---

💜 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

okay so this one is the same as the substitutions documented by "auto_id" in HTML::FormFu, plus two extra little treats:

• %c gets replaced by an incremented integer — this is the whole point, it makes sure there are no duplicated ID's, periodt 💅
• %v gets replaced by the item's value — so multiple elements with the same name can coexist peacefully, and their labels correctly select the appropriate item 🫶

like so:

---
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). icon behaviour fr fr 🌈

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 — she's got family, she's got lineage, main character energy inherited from all of them 💖

HTML::FormFu — the mothership. go say hi.

---

🫶 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. slay, honestly.

---

🫶 AUTHOR 🫶

Carl Franks <cpan@fireartist.com> — yes, again, because the original page says it twice and we do NOT skip details in this house 💅

---

💖 COPYRIGHT AND LICENSE 💖

This software is copyright (c) 2018 by Carl Franks.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

---

ok that's the whole page, bestie, you ate that 💀✨

and that's a wrap! this little beauty is perl v5.28.1, dated 2019-01-12, and it's the HTML::...xgroup(3pm) page — mwah, go build some checkboxes 💅🎀🦋