Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jcubic/tagger
Zero Dependency, Vanilla JavaScript Tag Editor
https://github.com/jcubic/tagger
component editor hacktoberfest interface javascript ui ui-component widget
Last synced: 24 days ago
JSON representation
Zero Dependency, Vanilla JavaScript Tag Editor
- Host: GitHub
- URL: https://github.com/jcubic/tagger
- Owner: jcubic
- Created: 2019-04-11T21:37:46.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-09-12T15:44:54.000Z (about 2 months ago)
- Last Synced: 2024-10-07T23:14:39.535Z (about 1 month ago)
- Topics: component, editor, hacktoberfest, interface, javascript, ui, ui-component, widget
- Language: JavaScript
- Homepage:
- Size: 96.7 KB
- Stars: 359
- Watchers: 7
- Forks: 20
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
- zero - tagger
- my-awesome-list - tagger
README
```
_____
|_ _|___ ___ ___ ___ ___
| | | .'| . | . | -_| _|
|_| |__,|_ |_ |___|_|
|___|___| version 0.6.2
```
# [Tagger: Zero dependency, Vanilla JavaScript Tag Editor](https://github.com/jcubic/tagger)
[](https://www.npmjs.com/package/@jcubic/tagger)
[Online Demo](https://codepen.io/jcubic/pen/YbYpqO)
## Installation
```
npm install @jcubic/tagger
```
or
```
yarn add @jcubic/tagger
```
## Usage
```
tagger(document.querySelector('[name="tags"]'), {allow_spaces: false});
```
Multiple inputs can be created by passing a NodeList or array of elements (eg. document.querySelectorAll()). If only one element is contained in the list then tagger will return the tagger instance, an array of tagger instances will be returned if the number of elements is greater than 1.
## Usage with React
Tagger can easily be used with ReactJS.
```javascript
import { useRef, useState, useEffect } from 'react'
import tagger from '@jcubic/tagger'
const App = () => {
const [tags, setTags] = useState([]);
const inputRef = useRef(null);
useEffect(() => {
const taggerOptions = {
allow_spaces: true,
};
tagger(inputRef.current, taggerOptions);
onChange();
}, [inputRef]);
const onChange = () => {
setTags(tags_array(inputRef.current.value));
};
return (
{tags.map((tag, index) => - {tag}
)}
)
}
function tags_array(str) {
return str.split(/\s*,\s*/).filter(Boolean);
}
export default App
```
See demo in action on [CodePen](https://codepen.io/jcubic/pen/YzRdbmp?editors=0010).
## API
### methods:
* `add_tag(string): boolean`
* `remove_tag(string): booelan`
* `complete(string): void`
### Options:
* **wrap** (default false) allow tags to wrap onto new lines instead of overflow scroll
* **allow_duplicates** (default false)
* **allow_spaces** (default true)
* **add_on_blur** (default false)
* **completion** `{list: string[] | function(): Promise(string[])|string[], delay: miliseconds, min_length: number}`
* **link** `function(name): string|false` it should return what should be in href attribute or false
* **tag_limit** `number` (default -1) limit number of tags, when set to -1 there are no limits
* **placeholder** `string` (default unset) If set in options or on the initial input, this placeholder value will be shown in the tag entry input
* **filter** `function(name): string` it should return the tag name after applying any filters (eg String.toUpperCase()), empty string to filter out tag and prevent creation.
**NOTE:** if you're familiar with TypeScript you can check the API by looking at
TypeScript definition file:
[tagger.d.ts](https://github.com/jcubic/tagger/blob/master/tagger.d.ts)
## Press
* JavaScript Weekly
* [Issue #527](https://javascriptweekly.com/issues/527)
* [Issue #652](https://javascriptweekly.com/issues/652)
* [Web Tools Weekly](https://webtoolsweekly.com/archives/issue-396/)
* [Minimal Tagging Input In Pure JavaScript – Tagger](https://www.cssscript.com/tagging-input-tagger/)
## License
Copyright (c) 2018-2024 [Jakub T. Jankiewicz](https://jcubic.pl/me)
Released under the MIT license