<!DOCTYPE html>
<html lang="en-US">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>Usage | v-toggle-switch</title>
<meta name="generator" content="VuePress 1.8.0">
<meta name="description" content="Simple, yet configurable toggle switch component with accessibility out of the box!">
<meta name="theme-color" content="#3eaf7c">
<meta name="apple-mobile-web-app-capable" content="yes">
<meta name="apple-mobile-web-app-status-bar-style" content="black">
<link rel="preload" href="/assets/css/0.styles.cfca41b8.css" as="style"><link rel="preload" href="/assets/js/app.b297c1fe.js" as="script"><link rel="preload" href="/assets/js/2.812d8c3e.js" as="script"><link rel="preload" href="/assets/js/15.ca491376.js" as="script"><link rel="preload" href="/assets/js/3.bf7e24a9.js" as="script"><link rel="preload" href="/assets/js/7.0576a861.js" as="script"><link rel="prefetch" href="/assets/js/10.f6f0015e.js"><link rel="prefetch" href="/assets/js/11.601dd9db.js"><link rel="prefetch" href="/assets/js/12.351b1666.js"><link rel="prefetch" href="/assets/js/13.f771dbb7.js"><link rel="prefetch" href="/assets/js/14.e1252d4d.js"><link rel="prefetch" href="/assets/js/16.a791a7aa.js"><link rel="prefetch" href="/assets/js/4.60026e53.js"><link rel="prefetch" href="/assets/js/5.de78bb05.js"><link rel="prefetch" href="/assets/js/6.d43349ca.js"><link rel="prefetch" href="/assets/js/8.2f8b26e5.js"><link rel="prefetch" href="/assets/js/9.3a1b03c0.js">
<link rel="stylesheet" href="/assets/css/0.styles.cfca41b8.css">
</head>
<body>
<div id="app" data-server-rendered="true"><div class="theme-container"><header class="navbar"><div class="sidebar-button"><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" role="img" viewBox="0 0 448 512" class="icon"><path fill="currentColor" d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z"></path></svg></div> <a href="/" class="home-link router-link-active"><!----> <span class="site-name">v-toggle-switch</span></a> <div class="links"><div class="search-box"><input aria-label="Search" autocomplete="off" spellcheck="false" value=""> <!----></div> <nav class="nav-links can-hide"><div class="nav-item"><a href="/guide/" class="nav-link router-link-active">
Guide
</a></div><div class="nav-item"><a href="/examples/" class="nav-link">
Examples
</a></div> <a href="https://github.com/mattzahel/v-toggle-switch" target="_blank" rel="noopener noreferrer" class="repo-link">
GitHub
<span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a></nav></div></header> <div class="sidebar-mask"></div> <aside class="sidebar"><nav class="nav-links"><div class="nav-item"><a href="/guide/" class="nav-link router-link-active">
Guide
</a></div><div class="nav-item"><a href="/examples/" class="nav-link">
Examples
</a></div> <a href="https://github.com/mattzahel/v-toggle-switch" target="_blank" rel="noopener noreferrer" class="repo-link">
GitHub
<span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a></nav> <ul class="sidebar-links"><li><section class="sidebar-group depth-0"><p class="sidebar-heading open"><span>Guide</span> <!----></p> <ul class="sidebar-links sidebar-group-items"><li><a href="/guide/installation.html" class="sidebar-link">Installation</a></li><li><a href="/guide/usage.html" class="active sidebar-link">Usage</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/guide/usage.html#simple-use" class="sidebar-link">Simple use</a></li><li class="sidebar-sub-header"><a href="/guide/usage.html#passing-the-value-and-binding-event" class="sidebar-link">Passing the value and binding event</a></li><li class="sidebar-sub-header"><a href="/guide/usage.html#using-slots-for-labels" class="sidebar-link">Using slots for labels</a></li></ul></li><li><a href="/guide/customization.html" class="sidebar-link">Customization</a></li></ul></section></li><li><section class="sidebar-group depth-0"><p class="sidebar-heading"><span>Examples</span> <!----></p> <ul class="sidebar-links sidebar-group-items"><li><a href="/examples/" class="sidebar-link">Examples</a></li></ul></section></li></ul> </aside> <main class="page"> <div class="theme-default-content content__default"><h1 id="usage"><a href="#usage" class="header-anchor">#</a> Usage</h1> <h2 id="simple-use"><a href="#simple-use" class="header-anchor">#</a> Simple use</h2> <div class="language- extra-class"><pre class="language-text"><code><toggle-switch />
</code></pre></div><div class="basic" data-v-1fbbaa2e><label id="toggle-switch-label-9" for="toggle-switch-9" tabindex="-1" class="toggle-switch" data-v-f446f5ce data-v-1fbbaa2e><button id="toggle-switch-9" tabindex="0" type="button" role="switch" aria-checked="false" aria-labelledby="toggle-switch-label-9" class="toggle-switch__button" style="--color-on:#0178D6;--color-off:#C4C4C4;--color-text:#FFF;--width:50px;--height:24px;--padding:6px;--distance:26px;--speed:200ms;" data-v-f446f5ce><div class="toggle-switch__labels" data-v-f446f5ce><!----> <span data-v-f446f5ce></span></div> <span class="toggle-switch__toggle" data-v-f446f5ce></span></button> <span class="toggle-switch__label" data-v-f446f5ce></span></label> <!----></div> <h2 id="passing-the-value-and-binding-event"><a href="#passing-the-value-and-binding-event" class="header-anchor">#</a> Passing the value and binding event</h2> <div class="language- extra-class"><pre class="language-text"><code><toggle-switch :value="myValue" @toggle="onToggle" />
</code></pre></div><div class="basic" data-v-1fbbaa2e><label id="toggle-switch-label-10" for="toggle-switch-10" tabindex="-1" class="toggle-switch" data-v-f446f5ce data-v-1fbbaa2e><button id="toggle-switch-10" tabindex="0" type="button" role="switch" aria-checked="false" aria-labelledby="toggle-switch-label-10" class="toggle-switch__button" style="--color-on:#0178D6;--color-off:#C4C4C4;--color-text:#FFF;--width:50px;--height:24px;--padding:6px;--distance:26px;--speed:200ms;" data-v-f446f5ce><div class="toggle-switch__labels" data-v-f446f5ce><!----> <span data-v-f446f5ce></span></div> <span class="toggle-switch__toggle" data-v-f446f5ce></span></button> <span class="toggle-switch__label" data-v-f446f5ce></span></label> <span data-v-1fbbaa2e>State: false</span></div> <h2 id="using-slots-for-labels"><a href="#using-slots-for-labels" class="header-anchor">#</a> Using slots for labels</h2> <div class="language- extra-class"><pre class="language-text"><code><toggle-switch>
<template v-slot:label-off>Off</template>
<template v-slot:label-on>On</template>
This is an example main label
</toggle-switch>
</code></pre></div><div><label id="toggle-switch-label-11" for="toggle-switch-11" tabindex="-1" class="toggle-switch" data-v-f446f5ce><button id="toggle-switch-11" tabindex="0" type="button" role="switch" aria-checked="false" aria-labelledby="toggle-switch-label-11" class="toggle-switch__button" style="--color-on:#0178D6;--color-off:#C4C4C4;--color-text:#FFF;--width:64px;--height:28px;--padding:7px;--distance:36px;--speed:200ms;" data-v-f446f5ce><div class="toggle-switch__labels" data-v-f446f5ce><!----> <span data-v-f446f5ce>Off</span></div> <span class="toggle-switch__toggle" data-v-f446f5ce></span></button> <span class="toggle-switch__label" data-v-f446f5ce>
This is an example main label
</span></label></div></div> <footer class="page-edit"><!----> <!----></footer> <!----> </main></div><div class="global-ui"></div></div>
<script src="/assets/js/app.b297c1fe.js" defer></script><script src="/assets/js/2.812d8c3e.js" defer></script><script src="/assets/js/15.ca491376.js" defer></script><script src="/assets/js/3.bf7e24a9.js" defer></script><script src="/assets/js/7.0576a861.js" defer></script>
</body>
</html>