Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mayank1513/tag-input
A versatile tag input component built with Vue 3 Composition API ⛺
https://github.com/mayank1513/tag-input
tag-input tags typescript upforgrabs vue vue3 vue3-composition-api vue3-typescript vuejs
Last synced: 2 days ago
JSON representation
A versatile tag input component built with Vue 3 Composition API ⛺
- Host: GitHub
- URL: https://github.com/mayank1513/tag-input
- Owner: mayank1513
- License: mit
- Created: 2021-07-05T09:53:50.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2024-05-25T04:58:26.000Z (4 months ago)
- Last Synced: 2024-08-10T10:55:29.051Z (about 2 months ago)
- Topics: tag-input, tags, typescript, upforgrabs, vue, vue3, vue3-composition-api, vue3-typescript, vuejs
- Language: Vue
- Homepage: https://vue-tag-input.vercel.app
- Size: 383 KB
- Stars: 18
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# TagInput
A versatile tag input component built with Vue 3 Composition API.
[](https://www.npmjs.com/package/@mayank1513/vue-tag-input) [](https://codecov.io/gh/mayank1513/tag-input) [](https://www.npmjs.com/package/@mayank1513/vue-tag-input) [](https://www.npmjs.com/package/@mayank1513/vue-tag-input) [](https://github.com/mayank1513/tag-input/actions/workflows/publish-to-npm-on-new-release.yml) [](https://www.codementor.io/@mayank1513?refer=badge)
## Features
- ✅ No dependencies
- ✅ Input box stays focused - no need to re-focus the input => better UX
- ✅ Autocompletion
- ✅ Use arrow keys to navigate and enter key to select autocompleteItems
- ✅ Fast setup
- ✅ Customize tag validator
- ✅ Works with Vuex
- ✅ Small size: 1.6 kB gzipped
- ✅ Many customization options
- ✅ Delete tags on backspace / delete key
- ✅ Confirm before delete - tags turns red when backspace is pressed, gets deleted when backspace is pressed again
- ✅ Works well with copy & paste
- ✅ Excellent UX and accessibility
- ✅ Examples & Docs
Please read [this article](https://mayank1513.medium.com/creating-a-tag-input-component-using-the-vue-3-composition-api-feae06d58492) 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](https://www.udemy.com/course/vuejs-complete-course-plus-guide/?referralCode=93BDA4A1FE3F73C37CD2) and [Vue 3 Essentials](https://www.udemy.com/course/vue-3-essentials/?referralCode=E6D2FDE2B8B06C1991F1)
Follow us on [FaceBook](https://www.facebook.com/Learn-Vue-Js-104953725168718/) 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](#Build) section.
## [live demo](https://vue-tag-input.vercel.app)
## Install
### NPM
```bash
npm i @mayank1513/vue-tag-input --production
```
or
```bash
pnpm i @mayank1513/vue-tag-input --production
```
or
```bash
yarn add @mayank1513/vue-tag-input --production
```
### CDN
```
```
## Usage
### npm
```vue
...
...
import TagInput from '@mayank1513/vue-tag-input'
import '@mayank1513/vue-tag-input/style.css'
...
export default {
name: 'App',
data() {
return {
tags: [],
...
};
},
components: {
TagInput,
...
},
...
}
```
Detailed Docs available at (https://vue-tag-input.vercel.app)[https://vue-tag-input.vercel.app]
### cdn
basic usage
```html
Vue Tag Input Demo
Vue.createApp({
components: {
TagInput,
},
}).mount("#app");
```
#### advanced usage
```html
Document
#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;
}
Presents
Vue Tag Input
Default options
Use enter key or tab key to create a new
tag.
With custom delimiter and colors
Use enter key or tab key or any of the
custom delimeters to create a new tag.
Custom delimiters:
"{{delim}}"
Do not allow custom tags
Try entering tag that is not in autocompleteItems and hit
enter
Use enter key or tab key or any of the
custom delimeters to create a new tag.
Allowed Tags:
"{{tag}}"
Custom delimiters:
"{{delim}}"
Provide autocompleteItems for autofill but also allow custom tags
Use enter key or tab key or any of the
custom delimeters to create a new tag.
Allowed Tags:
"{{tag}}"
Custom delimiters:
"{{delim}}"
Vue.createApp({
data() {
return {
tags: [],
customDelimiter: [",", " "],
autocompleteItems: [
"vue",
"composition",
"js",
"mytag1",
"mayank1513",
],
};
},
components: {
TagInput,
},
}).mount("#app");
```
## Build
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
```
## Contribute
### Todo
- Update docs
## Help us to help you more
- Please start this repo
- Follow us on [FaceBook](https://www.facebook.com/Learn-Vue-Js-104953725168718/)
- Upvote our helpful posts on [StackOverflow](https://stackoverflow.com/users/9640177/mayank-kumar-chaudhari)
- Refer our courses to your colleagues, friends and business leaders
- [Vue.js Complete Course + Guide](https://www.udemy.com/course/vuejs-complete-course-plus-guide/?referralCode=93BDA4A1FE3F73C37CD2)
- [Vue 3 Essentials](https://www.udemy.com/course/vue-3-essentials/?referralCode=E6D2FDE2B8B06C1991F1)
- Use our referrals to get advantage of special offers
- Open your free demat account with [Groww](https://groww.app.link/refe/mayank-kumar8914309)
- Open your demat account with leading discount broker [Zerodha](https://zerodha.com/?c=GG0215&s=CONSOLE)
- Buy what you need on [amzon.in](https://www.amazon.in/ref=assoc_aax_fallback_300x250?tag=mayank1513-21&linkCode=ur8) using [our refferal](https://www.amazon.in/ref=assoc_aax_fallback_300x250?tag=mayank1513-21&linkCode=ur8)
- Buy what you need on [amazon.com](https://amzn.to/3i2PPsE)
- Donate for social cause. We are happy if you help anyone in need. It need not be only us!
- Want to learn business skills? Checkout [Bada Business](https://www.badabusiness.com/dd/BIMK003866)
## Contribute for a Cause
- [PM Cares Fund](https://www.pmcares.gov.in/en/)
- [#IamOxygenMan](https://www.badabusiness.com/IamOxygenMan)
## License
Licensed as MIT open source. Copyright © 2023 Mayank Kumar Chaudhari
with 💖 by Mayank Kumar Chaudhari