Skip to content

Latest commit

 

History

History
 
 

checkbox

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
src
src
 
 
stories
stories
 
 
CHANGELOG.md
CHANGELOG.md
 
 
README.md
README.md
 
 
index.js
index.js
 
 
lion-checkbox.js
lion-checkbox.js
 
 
package.json
package.json
 
 

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 the checked state (boolean) - checked boolean attribute
  • Pre-select an option by setting the checked boolean attribute
  • Get or set the value of the choice - choiceValue()

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.