Zerotul2015/vue-toggle-button

Vue Toggle Button Component

Vue Toggle Button

Table of contents

• Getting started
• Usage
• Available Properties

Getting started

npm install

Compiles and hot-reloads for development

npm run serve

Usage

<template>
    <div>
        <ToggleButton id="switch" />
    </div>
</template>

<script>
import ToggleButton from './components/ToggleButton.vue'

export default {
    components: {
        ToggleButton
    }
}
</script>

Get Toggle State with Custom Event Handler

<template>
    <div>
        <ToggleButton 
            id="switch"
            v-on:change="eventHandler"
        />
    </div>
</template>

<script>
import ToggleButton from './components/ToggleButton.vue'

export default {
    components: {
        ToggleButton
    },

    methods: {
        eventHandler(value) {
            console.log(value);
        }
    }
}
</script>

Available Properties

List of available properties to use in this component:

Prop	Data Type	Default	Description
id	String	primary	Element Id
default-state	Boolean	false	Toggle State (true
disabled	Boolean	false	Disable the toggle button
label-enable-text	String	On	Active Label
label-disable-text	String	Off	In-Active Label