@lion/checkbox

Checkbox

🛠 Status: Pilot Phase

Lion Web Components are still in an early alpha stage; they should not be considered production ready yet.

The goal of our pilot phase is to gather feedback from a private group of users. Therefore, during this phase, we kindly ask you to:

• not publicly promote or link us yet: (no tweets, blog posts or other forms of communication about Lion Web Components)
• not publicly promote or link products derived from/based on Lion Web Components

As soon as Pilot Phase ends we will let you know (feel free to subscribe to this issue https://github.com/ing-bank/lion/issues/1)

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.