Vue toggle

A toggle button for simple state management

Version: 1.0.1 Updated: 08/19/2016

By: vue-comps License: MIT

Downloads Last 30 Days: 149

Install

npm i vue-toggle
yarn add vue-toggle

Repository: https://github.com/vue-comps/vue-toggle

CDNs

bundle.run: https://bundle.run/vue-toggle

jsDelivr: https://cdn.jsdelivr.net/npm/vue-toggle

unpkg: https://unpkg.com/vue-toggle

vue-toggle

A toggle button for simple state management.

Demo

Install

npm install --save-dev vue-toggle

or include build/bundle.js.

Usage

# in your component
components:
  "toggle": require("vue-toggle")
# or, when using bundle.js
components:
  "toggle": window.vueComps.toggle
<toggle>
  click to switch
  <span slot="on"> off</span>
  <span slot="off"> on</span>
</toggle>

For examples see dev/.

Props

Name type default description
is-on Boolean false (two-way) toggle state
on-class String "on" class of button when on
off-class String "off" class of button when off
disabled Boolean false is disabled

Events

| Name | description | | ---:| --- | ---| --- | | off | will be emitted on click when state was on | | on | will be emitted on click when state was off | | toggle | will be emitted on click |

Development

Clone repository.

npm install
npm run dev

Browse to http://localhost:8080/.

License

Copyright (c) 2016 Paul Pflugradt Licensed under the MIT license.

Categories: Vue js