BnToggle ​

BnToggle is a component that can be used as a UI switch or checkbox.

The only required prop for BnToggle is name. The name prop is used to identify the input in the context of a Form or an useForm, or when submitting a form in the traditional way.

Basic Usage ​

<bn-toggle v-model="checked" name="exampleToggle" />

Colors ​

You can change the color accent of the toggle using the color prop.

<bn-toggle name="selected" color="lime" v-model="selected">
    Color Toggle
  </bn-toggle>

Slots ​

BnToggle provides a slot for adding labels or any custom content to the toggle.

<bn-toggle v-model="checked" name="exampleToggle">
  Toggle me
</bn-toggle>

Vee-Validate ​

BnToggle works with vee-validate out of the box.

<script setup lang="ts">
import { Form, ErrorMessage } from 'vee-validate';
import isRequired from '../rules';

const validationSchema = {
  terms: isRequired,
};
</script>

<template>
  <Form :validation-schema="validationSchema">
    <bn-toggle name="toggleMe">
      You accept our terms and conditions
    </bn-toggle>
  </Form>
</template>

Rules ​

If you want to validate a field without being in the context of a Form or an useForm, you can use the rules prop.

<script setup lang="ts">
import isRequired from '../rules';
</script>

<template>
  <bn-toggle
    v-model="validate"
    name="validate"
    :rules="isRequired"
  >
    You accept our terms and conditions
  </bn-toggle>
</template>

Customization ​

There are two ways to customize the appearance of the BnToggle component:

classes prop ​

Every component has a classes prop that will accept an object where each key corresponds to an internal element of the component. The value of each key will be the classes that will be applied to that element. For the values, you can use strings, objects or arrays, the same way it works with Vue's class binding.

<bn-toggle
  name="toggle"
  v-model="selected"
  :value="true"
  :classes="{
    ball: ['rounded-none', { 'bg-yellow-500': selected }],
    track: ['rounded-none', { 'bg-purple-200': selected }]
  }"
>
  This is a toggle
</bn-toggle>

Default styles will still be applied, but the classes you provide will take precedence, so you can use this to override any existing style.

The available keys for this component are:

• ball: The ball of the toggle
• track: The track of the toggle

Theming ​

You can change the default appearance or even add variants by editing the configuration of the TailwindCSS plugin.

plugins: [
    require('@tailwindcss/forms'),
    require('@headlessui/tailwindcss'),
    banano.tailwindPlugin({
      theme: {
        BnToggle: {
          '.bn-toggle__track--focus-visible': {
            '@apply ring-green-600': {},
          }
        }
      }
    }),
  ],

You can find more information about customizing the library in Theme Customization.

API Reference ​

Props ​

type ValueTypes = undefined | boolean | string | number | Record<string, unknown>;

Events ​

This component does not emit any events, but it emits all the events from the underlying <input> element.

Slots ​