A toggle button for simple state management
Package: vue-toggle
Created by: vue-comps
Last modified: Tue, 28 Jun 2022 20:35:11 GMT
Version: 1.0.1
License: MIT
Downloads: 39
Repository: https://github.com/vue-comps/vue-toggle
Install
npm install vue-toggle
yarn add 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.
Dependencies
Dependencies
chai: ^3.5.0chai-spies: ^0.7.1coffee-loader: ^0.7.2coffee-script: ^1.10.0css-loader: ^0.23.1gh-pages: ^0.11.0karma: ^1.2.0karma-chai: ^0.1.0karma-chai-dom: ^1.1.0karma-chai-spies: ^0.1.4karma-chrome-launcher: ^2.0.0karma-firefox-launcher: ^1.0.0karma-mocha: ^1.1.1karma-sourcemap-loader: ^0.3.7karma-spec-reporter: ^0.0.26karma-vue-component: ^0.1.0karma-webpack: ^1.8.0mocha: ^3.0.2pug: ^2.0.0-beta5script-runner: ^0.1.5vue: ^1.0.26vue-compiler: ^0.3.0vue-dev-server: ^0.2.10vue-html-loader: ^1.2.3vue-loader: ^8.5.3webpack: ^1.13.2
