A versatile tag input component built with Vue 3 Composition API ⛺
MIT License
A versatile tag input component built with Vue 3 Composition API.
Please read this article to learn how to build this package step by step and the background story.
To learn vue js please check out our courses Vue.js Complete Course + Guide and Vue 3 Essentials
Follow us on FaceBook to get the latest discount coupons and update to our articles and packages.
To keep it thin and performant we have chosen to provide only the minified version. Because, that's what you really need. In case you are looking for the full version build your own from this source code as per Build section.
npm i @mayank1513/vue-tag-input --production
or
pnpm i @mayank1513/vue-tag-input --production
or
yarn add @mayank1513/vue-tag-input --production
<script src="https://unpkg.com/vue@3/dist/vue.global.js"></script>
<script src="https://unpkg.com/@mayank1513/vue-tag-input"></script>
<link rel="stylesheet" href="https://unpkg.com/@mayank1513/[email protected]/dist/style.css">
<template>
...
<tag-input v-model="tags" />
...
</template>
<script>
import TagInput from '@mayank1513/vue-tag-input'
import '@mayank1513/vue-tag-input/style.css'
...
export default {
name: 'App',
data() {
return {
tags: [],
...
};
},
components: {
TagInput,
...
},
...
}
</script>
Detailed Docs available at (https://vue-tag-input.vercel.app)[https://vue-tag-input.vercel.app]
basic usage
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Vue Tag Input Demo</title>
<script src="https://unpkg.com/vue@3/dist/vue.global.js"></script>
<script src="https://unpkg.com/@mayank1513/vue-tag-input"></script>
<link
rel="stylesheet"
href="https://unpkg.com/@mayank1513/[email protected]/style.css"
/>
</head>
<body>
<div id="app">
<tag-input></tag-input>
</div>
</body>
<script>
Vue.createApp({
components: {
TagInput,
},
}).mount("#app");
</script>
</html>
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Document</title>
<script src="https://unpkg.com/vue@3/dist/vue.global.js"></script>
<script src="https://unpkg.com/@mayank1513/vue-tag-input"></script>
<link
rel="stylesheet"
href="https://unpkg.com/@mayank1513/[email protected]/style.css"
/>
<style>
#app {
font-family: Avenir, Helvetica, Arial, sans-serif;
-webkit-font-smoothing: antialiased;
-moz-osx-font-smoothing: grayscale;
text-align: center;
color: #2c3e50;
margin-top: 60px;
max-width: 1400px;
margin: auto;
}
.main {
text-align: start;
}
</style>
</head>
<body>
<div id="app">
<img
class="logo"
alt="Krishna Apps logo"
src="https://raw.githubusercontent.com/mayank1513/tag-input/master/src/assets/logo.png"
/>
<br />
<h2>Presents</h2>
<h1>Vue Tag Input</h1>
<hr />
<div class="main">
<h1>Default options</h1>
<tag-input v-model="tags" />
<br />
<span
>Use <code>enter</code> key or <code>tab</code> key to create a new
tag.</span
>
<h1>With custom delimiter and colors</h1>
<tag-input
tagBgColor="lightgreen"
tagTextColor="darkgreen"
:customDelimiter="customDelimiter"
v-model="tags"
/>
<br />
<span
>Use <code>enter</code> key or <code>tab</code> key or any of the
custom delimeters to create a new tag.</span
>
<p>
Custom delimiters:
<code v-for="delim in customDelimiter" :key="delim">
"{{delim}}"</code
>
</p>
<br />
<h1>Do not allow custom tags</h1>
<tag-input
:autocomplete-items="autocompleteItems"
validator="onlyAutocompleteItems"
tagBgColor="blue"
tagTextColor="lightblue"
:customDelimiter="customDelimiter"
v-model="tags"
/>
<br />
Try entering tag that is not in autocompleteItems and hit
<code>enter</code>
<br />
<span
>Use <code>enter</code> key or <code>tab</code> key or any of the
custom delimeters to create a new tag.</span
>
<p>
Allowed Tags:
<code v-for="tag in autocompleteItems" :key="tag"> "{{tag}}"</code>
</p>
<p>
Custom delimiters:
<code v-for="delim in customDelimiter" :key="delim">
"{{delim}}"</code
>
</p>
<br />
<h1>
Provide autocompleteItems for autofill but also allow custom tags
</h1>
<tag-input
:autocomplete-items="autocompleteItems"
tagBgColor="blue"
tagTextColor="lightblue"
:customDelimiter="customDelimiter"
v-model="tags"
/>
<br />
<span
>Use <code>enter</code> key or <code>tab</code> key or any of the
custom delimeters to create a new tag.</span
>
<p>
Allowed Tags:
<code v-for="tag in autocompleteItems" :key="tag"> "{{tag}}"</code>
</p>
<p>
Custom delimiters:
<code v-for="delim in customDelimiter" :key="delim">
"{{delim}}"</code
>
</p>
<br />
</div>
</div>
<script>
Vue.createApp({
data() {
return {
tags: [],
customDelimiter: [",", " "],
autocompleteItems: [
"vue",
"composition",
"js",
"mytag1",
"mayank1513",
],
};
},
components: {
TagInput,
},
}).mount("#app");
</script>
</body>
</html>
To build the example clone the repo git clone https://github.com/mayank1513/tag-input.git
and run
npm i && npm run build
// or
pnpm i && npm run build
Licensed as MIT open source. Copyright © 2023 Mayank Kumar Chaudhari