Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

History

15 Commits

Repository files navigation

toggle

A toggle UI element.

onoff

Installation

$ component install segmentio/toggle

Example

varToggle=require('toggle');vartoggle=newToggle();document.body.appendChild(toggle.el);toggle.value();// falsetoggle.value(true);toggle.value();// truetoggle.toggle();toggle.value();// false

API

Toggle(value, el)

Create a new toggle with an optional starting value and optional el to use instead of creating one.

#el

The toggle's DOM element.

<divclass="toggle"><labelclass="toggle-on-label"></label><divclass="toggle-switch"><inputclass="toggle-checkbox" type="checkbox"></div><labelclass="toggle-off-label"></label></div>

#value(val)

Get or set the value of the toggle.

#name(name)

Set the toggle's internal checkbox's name, so forms can be submitted properly.

#toggle()

Toggle the value of the toggle.

#label(on, off)

Set the on and off labels's HTML.

#addClass(name)

Add a class to the toggle's element.

#removeClass(name)

Remove a class from the toggle's element.

License

MIT

About

A toggle UI element.

Resources

Stars

38 stars

Watchers

36 watching

Forks

Releases

Packages

Contributors

Languages