pz-checkbox-vue v0.1.1

PZ Checkbox Vue

This Vue-based component allows you to use checkbox for forms easily.

Pre-requirements

To use pz-checkbox-vue it is necessary to have Vue installed (version 3 is recommended) in the project to deploy this component.

To use pz-checkbox-vue it is necessary to have Tailwind installed in the project to implement this component.

Enabling JIT mode

To enable just-in-time mode, set the mode option to 'jit' in your tailwind.config.js file:

// tailwind.config.js
module.exports = {

mode: 'jit',
important: true,
purge: [
    // ...
],
theme: {
    // ...
}
// ...
}

Purge CSS

To get started, provide an array of paths to all of your template files using the purge option:

// tailwind.config.js
module.exports = {
  purge: [
    './node_modules/pz-checkbox-vue/**/*.vue',
  ],
  theme: {},
  variants: {},
  plugins: [],
}

NPM Cache (optional)

This command should only be executed if the component is not compiling properly.

npm cache clean --force

Installation

This is the way to install using npm pz-checkbox-vue in our project.

npm i pz-checkbox-vue@latest

Importing

This is the way to import pz-checkbox-vue into our project.

import PZCheckboxVue from 'pz-checkbox-vue'

Usage

Simple example

<template>
    <PZCheckboxVue v-model:checked="test" class="appearance-none ring-test1 checked:bg-test1 checked:ring checked:ring-offset-2 checked:border-transparent" />
</template>

Example:

<template>
    <PZCheckboxVue v-model:checked="test" class="appearance-none ring-test1 checked:bg-test1 checked:ring checked:ring-offset-2 checked:border-transparent" />
</template>

<style scoped>
</style>

<script>
import PZCheckboxVue from 'pz-checkbox-vue'

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

Authors

Team working on the development of pz-checkbox-vue.

• PONZACENIO | Web developer

License

pz-checkbox-vue is ISC licensed.