lion/packages/checkbox-group

Checkbox Group

lion-checkbox-group component is webcomponent that enhances the functionality of the native <input type="checkbox"> element. Its purpose is to provide a way for users to check multiple options amongst a set of choices, or to function as a single toggle.

You should use lion-checkbox's inside this element.

Features

Since it extends from lion-fieldset, it has all the features a fieldset has.

How to use

Installation

npm i --save @lion/checkbox @lion/checkbox-group

import '@lion/checkbox/lion-checkbox.js';
import '@lion/checkbox-group/lion-checkbox-group.js';
// validator import example
import { Required } from '@lion/validate';

Example

<lion-form><form>
  <lion-checkbox-group
    name="scientistsGroup"
    label="Favorite scientists"
    .validators=${[new Required()]}
  >
    <lion-checkbox name="scientists[]" label="Archimedes" .choiceValue=${'Archimedes'}></lion-checkbox>
    <lion-checkbox name="scientists[]" label="Francis Bacon" .choiceValue=${'Francis Bacon'}></lion-checkbox>
    <lion-checkbox name="scientists[]" label="Marie Curie" .choiceValue=${'Marie Curie'}></lion-checkbox>
  </lion-checkbox-group>
</form></lion-form>

• Make sure that it has a name attribute, this is necessary for the lion-form's serialization result.