lion/packages/checkbox/README.md
Thomas Allmer ec8da8f12c feat: release inital public lion version
Co-authored-by: Mikhail Bashkirov <mikhail.bashkirov@ing.com>
Co-authored-by: Thijs Louisse <thijs.louisse@ing.com>
Co-authored-by: Joren Broekema <joren.broekema@ing.com>
Co-authored-by: Gerjan van Geest <gerjan.van.geest@ing.com>
Co-authored-by: Erik Kroes <erik.kroes@ing.com>
Co-authored-by: Lars den Bakker <lars.den.bakker@ing.com>
2019-04-26 10:37:57 +02:00

1.1 KiB

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.