vue-onoff-toggle

A smart, lightweight and easy-to-use on/off toggle component for Vue.js with multiple themes.
5,422 15
Install
npm install vue-onoff-toggle
Latest Version:1.1.1
Vue:2
License:MIT
Last Updated:Dec 30, 2020
Links: GitHub  ·  npm
Maintainer: devwiz1028

Vue OnOff Toggle

A simple, lightweight on/off toggle component made with Vue.js. Provides multiple themes with default configurations. You can also customize size, color and borders.

Live Demo

Installation

npm install vue-onoff-toggle --save

or with yarn,

yarn add vue-onoff-toggle

Import in Vue.js

In your main.js file:

import Vue from 'vue'
import OnoffToggle from 'vue-onoff-toggle'

Vue.use(OnoffToggle)

Import in Nuxt.js

Create a new plugin in plugins/vue-onoff-toggle.js:

import Vue from 'vue'
import OnoffToggle from 'vue-onoff-toggle'

Vue.use(OnoffToggle)

Add this new plugin to nuxt.config.js

module.exports = {
  // ...
  plugins: [
    // ...
    '~plugins/vue-onoff-toggle'
  ]
}

How to use

After importing the library, use onoff-toggle tag inside your vue template:

<onoff-toggle v-model="checked" />

<onoff-toggle v-model="checked" theme="ios" />

<onoff-toggle v-model="checked" theme="material" />

<onoff-toggle
  v-model="checked"
  onColor="#008F13"
  :shadow="false"
/>

<onoff-toggle
  v-model="checked"
  theme="ios"
  onColor="#008F13"
/>

<onoff-toggle
  v-model="checked"
  theme="material"
  thumbColor="#008F13"
/>

Props

Prop Description
theme Theme to use. "default", "ios" and "material" are available.
name Name to attach to checkbox input. Useful when the toggle is used inside a form.
disabled Toggle is disabled
onColor Background color of checked toggle
offColor Background color of unchecked toggle
thumbColor Background color of the thumb. For "material" theme, if you don't specify onColor, it will be thumbColor with opacity 0.5 by default
borderColor Color of the thumb's border. Only available for "ios" theme.
width Width of the toggle
height Height of the toggle
margin Space around the thumb
shadow Only works on default theme. When set to true, a glow effect will be added around the toggle.

Browser Compatibility

  • Chrome: 40+
  • Firefox: 25+
  • IE: 11+

Related Packages

vue-js-toggle-button

A toggle button component for Vue.js 2+

1,383,442 921
vuejs-toggle-switch

A toggle switch component for Vue.js

93,443 34
vue-switch

a beautiful switch component for vue

4,692 33
vue-libs-simple-toggle

Simple and very light vue.js (v2) toggle component

1,356 1
g123

水务项目demo

1,879 1

Version History

Version Released Vue License
1.1.1 ^2.6.11 MIT
1.1.0 ^2.6.11 MIT
1.0.5 ^2.6.11 MIT
1.0.4 ^2.6.11 MIT
1.0.3 ^2.6.11 MIT