/vue-js-toggle-button

:white_circle: Vue.js 2 toggle / switch button - simple, pretty, customizable. Demo: http://vue-js-toggle-button.yev.io/

Primary LanguageVueMIT LicenseMIT

Vue.js 2.0+ toggle / switch button - simple, pretty, customizable.

npm version

Imgur

Feel free to ask questions or propose features in the "Issues" section

Live demo here

Install:

npm install vue-js-toggle-button --save

Import:

import ToggleButton from 'vue-js-toggle-button'
Vue.use(ToggleButton)

Use:

<toggle-button @change="onChangeEventHandler"/>
<toggle-button :value="false" :color="#82C7EB" :sync="true" :labels="true"/>
<toggle-button :value="true" :labels="{checked: 'Foo', unchecked: 'Bar'}"/>

Properties

Name Type Default Description
value Boolean false Initial state of the toggle button
sync Boolean false If set to true, will be watching changes in value property and overwrite the current state of the button whenever value prop. changes
disabled Boolean false Button does not react on mouse events
color [String, Object] #75C791 if String - color of the button when checked
If Object - colors for the button when checked/uncheked
Example: {checked: '#00FF00', unchecked: '#FF0000'}
labels [Boolean, Object] false If Boolean - shows/hides default labels ("on" and "off")
If Object - sets custom labels for both states.
Example: {checked: 'Foo', unchecked: 'Bar'}
width Number 50 Width of the button, default is 50

Events

Name Description
change Triggered whenever state of the component changes.
Contains:
value - state of the object
srcEvent - source click event