ayo/lion

History

CircleCI bf32e05833 chore: release new versions - @lion/checkbox-group@0.6.3 - @lion/form-system@0.4.3 - @lion/radio-group@0.6.2		2020-02-10 18:19:14 +00:00
..
src	fix: move documentation from readme to mdx	2020-02-10 19:16:33 +01:00
stories	fix: move documentation from readme to mdx	2020-02-10 19:16:33 +01:00
test	fix(checkbox-group): throw if name does not contain []	2020-02-10 18:26:10 +01:00
CHANGELOG.md	chore: release new versions	2020-02-10 18:19:14 +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-02-10 18:19:14 +00:00
README.md	fix: move documentation from readme to mdx	2020-02-10 19:16:33 +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="scientists[]"
  label="Favorite scientists"
>
  <lion-checkbox label="Archimedes" .choiceValue=${'Archimedes'}></lion-checkbox>
  <lion-checkbox label="Francis Bacon" .choiceValue=${'Francis Bacon'}></lion-checkbox>
  <lion-checkbox label="Marie Curie" .choiceValue=${'Marie Curie'}></lion-checkbox>
</lion-checkbox-group>