ayo/lion

History

Thomas Allmer 5f5d5bb30c chore: move all devDependencies to the root		2020-04-02 16:25:41 +02:00
..
src	chore: move radio, checkbox and option	2020-03-04 17:33:09 +01:00
stories	fix(overlays): support backdrop with local overlay	2020-03-20 16:32:19 +01:00
test	chore: move radio, checkbox and option	2020-03-04 17:33:09 +01:00
CHANGELOG.md	chore: release new versions	2020-03-25 16:05:28 +00:00
index.js	chore: move radio, checkbox and option	2020-03-04 17:33:09 +01:00
lion-checkbox-group.js	feat: release inital public lion version	2019-04-26 10:37:57 +02:00
lion-checkbox.js	chore: move radio, checkbox and option	2020-03-04 17:33:09 +01:00
package.json	chore: move all devDependencies to the root	2020-04-02 16:25:41 +02:00
README.md	chore: move radio, checkbox and option	2020-03-04 17:33:09 +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 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-group

import '@lion/checkbox-group/lion-checkbox-group.js';
import '@lion/checkbox-group/lion-checkbox.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>