js-toggle-switch
A toggle switch on native Javascript.
Install
Via NPM:
$ npm install js-toggle-switch
Usage
Include:
// include style and script
Add checkbox:
Initialize toggle switch:
Build
Using Docker
Run dev environment:
$ docker-compose up
Login, install packages and build:
$ docker-compose run ext bash
$ npm install
$ npm run build
Using locale dev environment
$ npm install$ npm run build
Options
The options inject to the second argument of ToggleSwitch
. Options is object
.
'.some-checkbox' onLabel: 'Yes' // [string] - Label for `true` value of checkbox. offLabel: 'No' // [string] - Label for `false` value of checkbox.
ToggleSwitch.defaultOptions
[object] - Default options for everything new instances.- onLabel [string]
- offLabel [string]
Methods
- getValue() [string] - Returns current value of the checkbox.
- turnOn() - Set to "true" the checkbox value.
- turnOff() - Set to "false" the checkbox value.
- toggle() - Set to "false"/"true" the checkbox value.
- destroy() - Destroy the toggle switch and restore the orginal checkbox.
Run tests
Using Docker
$ docker-compose run --rm ext npm run test:run-without-coverage
Using locale dev environment
$ npm run test:run-without-coverage
License
js-toggle-switch is released under the BSD-3-Clause License.