ayo/lion

History

Thomas Allmer 0c53b1d4bb fix: update links in stories		2020-01-23 18:24:38 +01:00
..
src	feat: finalize validation and adopt it everywhere	2019-11-18 15:30:08 +01:00
stories	fix: update links in stories	2020-01-23 18:24:38 +01:00
test	feat: integrate and pass automated a11y testing	2019-12-03 15:15:01 +01:00
CHANGELOG.md	chore: release new versions	2020-01-23 10:32:07 +00:00
index.js	feat: release inital public lion version	2019-04-26 10:37:57 +02:00
lion-checkbox-group.js	feat: release inital public lion version	2019-04-26 10:37:57 +02:00
package.json	chore: release new versions	2020-01-23 10:32:07 +00:00
README.md	fix: update links in stories	2020-01-23 18:24:38 +01:00

README.md

Checkbox Group

lion-checkbox-group component 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.

Live Demo/Documentation

See our storybook for a live demo and API documentation

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';

Example

<lion-checkbox-group
  name="scientistsGroup"
  label="Favorite scientists"
>
  <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>