29 lines
554 B
Markdown
29 lines
554 B
Markdown
# Switch
|
|
|
|
[//]: # 'AUTO INSERT HEADER PREPUBLISH'
|
|
|
|
`lion-switch` is a component that is used to toggle a property or feature on or off.
|
|
|
|
## 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
|
|
|
|
```sh
|
|
npm i --save @lion/switch
|
|
```
|
|
|
|
```js
|
|
import '@lion/swith/lion-switch.js';
|
|
```
|
|
|
|
### Example
|
|
|
|
```html
|
|
<lion-switch name="airplaneMode" label="Airplane mode" checked></lion-switch>
|
|
```
|