js-toggle-switch

    1.0.1 • Public • Published

    js-toggle-switch

    Build Status Coverage Status

    A toggle switch on native Javascript.

    DEMO

    Install

    Via NPM:

    $ npm install js-toggle-switch

    Usage

    Include:

    // include style and script
    <link href="dist/toggle-switch.min.css" rel="stylesheet">
    <script type="text/javascript" src="dist/toggle-switch.min.js"></script>

    Add checkbox:

    <input type="checkbox" name="some_chekbox_name">

    Initialize toggle switch:

    <script type="text/javascript">
    var toggleSwitch = new ToggleSwitch('input[name="some_chekbox_name"]');
    </script> 

    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.

    new ToggleSwitch('.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.

    Install

    npm i js-toggle-switch

    DownloadsWeekly Downloads

    20

    Version

    1.0.1

    License

    BSD-3-Clause

    Unpacked Size

    43.1 kB

    Total Files

    32

    Last publish

    Collaborators

    • bupy7