ayo/lion

History

Thijs Louisse d3642221df chore: exposed '/docs' and '/translations' for all packages		2019-05-16 14:47:27 +02:00
..
src	feat: release inital public lion version	2019-04-26 10:37:57 +02:00
CHANGELOG.md	chore: release new versions	2019-05-16 09:09:11 +00:00
index.js	feat: release inital public lion version	2019-04-26 10:37:57 +02:00
lion-checkbox.js	feat: release inital public lion version	2019-04-26 10:37:57 +02:00
package.json	chore: exposed '/docs' and '/translations' for all packages	2019-05-16 14:47:27 +02:00
README.md	feat: release inital public lion version	2019-04-26 10:37:57 +02:00

README.md

Checkbox

lion-checkbox component is a sub-element to be used in lion-checkbox-group elements. 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.

Features

Get or set the checked state (boolean) - choiceChecked()
Get or set the value of the choice - choiceValue()
Pre-select an option by setting the checked boolean attribute

How to use

Installation

npm i --save @lion/checkbox;

import '@lion/checkbox/lion-checkbox.js';

Example

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

Use this component inside a lion-checkbox-group
Make sure that it has a name attribute with appended [] for multiple choices.