1.0.2 • Published 4 years ago

vs-tag v1.0.2

Weekly downloads
-
License
MIT
Repository
github
Last release
4 years ago

Vue Simple Tag

🗃 A simple vue tag. Perfect for all your tag scenarios.

A light weight vue plugin built groundup.

npm npm

forthebadge forthebadge forthebadge forthebadge forthebadge forthebadge

📺 Live Demo

Code Sandbox: Link

🛠 Install

npm i vs-tag
yarn add vs-tag

🚀 Usage

<template>
  <vs-tag type="primary">
    Primary
  </vs-tag>
</template>

<script>
  import VsTag from 'vs-tag';

  export default {
    components: {
      VsTag,
    },
  };
</script>

🌎 CDN

<script src="https://unpkg.com/vs-tag@1/dist/vs-tag.min.js"></script>
<template>
  <vs-tag type="primary">
    Primary
  </vs-tag>
</template>

Nuxt Code Snippet

After installation,

  • Create a file /plugins/vs-tag.js

    import Vue from 'vue';
    import VsTag from 'vs-tag';
    
    Vue.component('vs-tag', VsTag);
  • Update nuxt.config.js

    module.exports = {
      ...
      plugins: [
        { src: '~plugins/vs-tag', mode: 'client' }
        ...
      ]
    }
  • In the page/ component

    <template>
      <vs-tag type="primary">
        Primary
      </vs-tag>
    </template>

Note

  • For older Nuxt versions, use <no-ssr>...</no-ssr> tag.
  • You can also do import VsTag from 'vs-tag' & add in component:{VsTag} and use it within component, without globally installing in plugin folder.

⚙ Props

NameTypeDefaultDescription
typeString-Type of tag to be shown. (primary, secondary, warning, danger)
sizeStringmediumSize of tag. (small, medium, large)
is-boldBooleantrueBold text for tag.
is-pillBooleanmediumApplies pill styling
is-roundBooleanmediumApplies styles to round the tag
bg-colorString-Applies hex/rgb/text color to tags background color
text-colorString-Applies hex/rgb/text color to tags text color

📎 Slots

You can define own item markup via slots:

NameDescription
(default)Holds the tag content and can contain HTML.