vue-boolean v0.0.11

Vue-Boolean

Vue-Boolean it is a renderer for child component

Only for Vue 3

Setup

npm i vue-boolean

Demo

Demo at codesandbox.io

Usage

Composition API

<script setup>
import { VueBoolean } from 'vue-boolean'
import { ref } from 'vue'

const booleanModel = ref(false)
</script>

<template>
  <vue-boolean v-model="booleanModel">
    <button>Press to true</button>
  </vue-boolean>
</template>

Options API

<script>
import { VueBoolean } from 'vue-boolean'

export default {
  components: {
    VueBoolean
  },
  data() {
    return {
      booleanModel: false
    }
  }
}
</script>

<template>
  <vue-boolean v-model="booleanModel">
    <button>Press to true</button>
  </vue-boolean>
</template>

With Nuxt 3

// plugins/vue-boolean.ts

import { defineNuxtPlugin } from 'nuxt/app'
import VueBoolean from 'vue-boolean'
export default defineNuxtPlugin((nuxtApp) => {
    nuxtApp.vueApp.use(VueBoolean)

})

Behaivor

when state set to true, slot class will be set to "checked" with model

props:

@change - fires on state change
:checked - set default state. default - false
v-model - modelled state
event - custom event to change state. "click" by default
className - custom class to add. default - checked

With v-model

<vue-boolean v-model="booleanModel">
    <button>With model</button> 
</vue-boolean>

when clicked it renders to:

<button class="checked">With model</button> 

Without v-model

<vue-boolean>
    <button>without model</button> 
</vue-boolean>

With true by default

<vue-boolean :checked="true">
    <button>with default</button> 
</vue-boolean>

With custom event

<vue-boolean :event="mouseover">
    <button>with event</button> 
</vue-boolean>

With custom class

<vue-boolean class-name="state-checked" v-model="booleanModel">
    <button>With custom class</button> 
</vue-boolean>

renders to

<button class="state-checked">With custom class</button>