@yaireo/tagify

<h1 align="center"> <a href='https://yaireo.github.io/tagify'><img src="/docs/readme-header.svg" width="320" height="160"><a/> <br><br> <a href='https://yaireo.github.io/tagify'>Tagify</a> - <em>tags</em> input component </h1> <p align="center"> Transforms an input field or a textarea into a <em>Tags component</em>, in an easy, customizable way, with great performance and small code footprint, exploded with features. <br> <strong>Vanilla</strong> ⚡ <strong>React</strong> ⚡ <strong>Vue</strong> ⚡ <strong>Angular</strong> <p> <h3 align="center"> 👉 <a href="https://yaireo.github.io/tagify">See Many Examples</a> 👈 <br/><br/> </h3> <p align="center"> <a href='https://www.npmjs.com/package/@yaireo/tagify'> <img src="https://img.shields.io/npm/v/@yaireo/tagify.svg" /> </a> <a href='https://simple.wikipedia.org/wiki/MIT_License'> <img src="https://img.shields.io/badge/license-MIT-lightgrey" /> </a> <img src="https://img.shields.io/bundlephobia/minzip/@yaireo/tagify" /> <img src="https://img.shields.io/npm/dw/@yaireo/tagify" /> </p> <p align="center"> <a href="https://yaireo.github.io/tagify/#section-mix"> <img src="/docs/mix3.gif?sanitize=true" /> </a> <a href="https://yaireo.github.io/tagify/#users-list"> <img src="/docs/demo2.apng?sanitize=true" /> </a> </p> ## Table of Contents  - [Table of Contents](#table-of-contents) - [Installation](#installation) - [Option 1 - import from CDN:](#option-1---import-from-cdn) - [option 2 - import as a *Node module*:](#option-2---import-as-a-node-module) - [Basic Usage Examples](#basic-usage-examples) - [Debugging](#debugging) - [Features](#features) - [Building the project](#building-the-project) - [Output files:](#output-files) - [Adding tags dynamically](#adding-tags-dynamically) - [Output value](#output-value) - [Modify original input value format](#modify-original-input-value-format) - [Ajax whitelist](#ajax-whitelist) - [Persisted data](#persisted-data) - [Edit tags](#edit-tags) - [Validations](#validations) - [Drag \& Sort](#drag--sort) - [Integration example:](#integration-example) - [DOM Templates](#dom-templates) - [Example of overriding the `tag` template:](#example-of-overriding-the-tag-template) - [Suggestions list](#suggestions-list) - [Example for a suggestion item alias](#example-for-a-suggestion-item-alias) - [Example whitelist:](#example-whitelist) - [Mixed-Content](#mixed-content) - [Single-Value](#single-value) - [React](#react) - [Update regarding `onChange` prop:](#update-regarding-onchange-prop) - [Updating the component's state](#updating-the-components-state) - [Vue](#vue) - [jQuery version](#jquery-version) - [`jQuery.tagify.js`](#jquerytagifyjs) - [HTML input \& textarea attributes](#html-input--textarea-attributes) - [Caveats](#caveats) - [FAQ](#faq) - [CSS Variables](#css-variables) - [Suggestions Dropdown CSS variables](#suggestions-dropdown-css-variables) - [Full list of Tagify's SCSS variables](#full-list-of-tagifys-scss-variables) - [Methods](#methods) - [Events](#events) - [Hooks](#hooks) - [Settings](#settings)  ## Installation ### Option 1 - import from CDN: Place these lines before any other code which is (or will be) using *Tagify* ([Example here](https://jsbin.com/jekuqap/edit?html)) ```html <script src="https://cdn.jsdelivr.net/npm/@yaireo/tagify"></script> <script src="https://cdn.jsdelivr.net/npm/@yaireo/tagify/dist/tagify.polyfills.min.js"></script> <link href="https://cdn.jsdelivr.net/npm/@yaireo/tagify/dist/tagify.css" rel="stylesheet" type="text/css" /> ``` `Tagify` will then be available globally. To load specific version use `@` - for example: `unpkg.com/@yaireo/tagify@3.1.0` ### option 2 - import as a *Node module*: ```sh npm i @yaireo/tagify --save ``` ## Basic Usage Examples - Many demos with code examples can be [seen here](https://yaireo.github.io/tagify/) - [CodeSandbox live demo](https://codesandbox.io/s/simple-tagify-setup-6pfi2) ```js import Tagify from '@yaireo/tagify' var inputElem = document.querySelector('input') // the 'input' element which will be transformed into a Tagify component var tagify = new Tagify(inputElem, { // A list of possible tags. This setting is optional if you want to allow // any possible tag to be added without suggesting any to the user. whitelist: ['foo', 'bar', 'and baz', 0, 1, 2] }) ``` The above example shows the most basic `whitelist` array setting possible, with a mix of *Strings* and *Numbers* but the array also support Objects whic a must-have property of `value`: ```js whitelist: [{value: 'foo', id: '123', email: 'foo@whatever.com'}, ...] ``` The `value` property is what will be used when actually defining the `value` property of the original input element (`inputElem` in the example above) which was transformed into a *Tagify* component, and so when the form data is sent to the server, it will contain all the values (which are the selected tags in the component). For selected tags to show a different text than what is defined in `value` for a whitelist item, see the `tagTextProp` [setting](#settings) ⚠️ Important: Don't forget to **include `tagify.css`** file in your project. CSS location: `@yaireo/tagify/dist/tagify.css` SCSS location: `@yaireo/tagify/src/tagify.scss` [See SCSS usecase & example](https://github.com/yairEO/tagify/pull/282) ### Debugging There are several places in the source code which emits `console.warn` logs to help identify issues. <del>Those will only work if `Tagify.logger.enabled` flag is set to `true`</del>. To disable the default logging, set the following global variable: ```js window.TAGIFY_DEBUG = false var tagify = new Tagify(...) ``` ## Features * Can be applied to input & textarea elements * Supports [mix content](#mixed-content) (text and tags together) * Supports [single-value](#single-value) mode (like `<select>`) * Supports whitelist/blacklist * Customizable HTML templates for the different areas of the component (wrapper, tags, dropdown, dropdown item, dropdown header, dropdown footer) * Shows suggestions list (flexiable settings & styling) at *full (component) width* or *next to* the typed texted (caret) * Allows setting suggestions' [aliases](#example-for-a-suggestion-item-alias) for easier fuzzy-searching * Auto-suggest input as-you-type with the ability to auto-complete * Can paste in multiple values: `tag 1, tag 2, tag 3` or even newline-separated tags * Tags can be created by Regex delimiter or by pressing the "Enter" key / focusing of the input * Validate tags by Regex *pattern* or by function * Tags may be [editable](#edit-tags) (double-click) * <del>ARIA accessibility support</del>(Component too generic for any meaningful ARIA) * Supports read-only mode to the whole component or per-tag * Each tag can have any properties desired (class, data-whatever, readonly...) * Automatically disallow duplicate tags (vis "settings" object) * Has built-in CSS loader, if needed (Ex. <em>AJAX</em> whitelist pulling) * Tags can be trimmed via `hellip` by giving `max-width` to the `tag` element in your `CSS` * RTL alignment ([See demo](https://yaireo.github.io/tagify/#section-rtl)) * <del>Internet Explorer - A polyfill script should be used: `tagify.polyfills.min.js` (in `/dist`)</del> ***(IE support has been dropped)*** * Many useful custom [events](#events) * Original input/textarea element values kept in sync with Tagify ## Building the project Simply run `gulp` in your terminal, from the project's path ([Gulp](https://gulpjs.com) should be installed first). Source files are this path: `/src/` Output files, which are automatically generated using Gulp, are in: `/dist/` ### Output files: Filename | Info ------------------------------------ | ----------------------------------------------------------- `tagify.esm.js` | ESM version. [see jsbin demo](https://jsbin.com/sulijap/edit?html,output) `tagify.js` | *minified* UMD version, including its souremaps. This is the **main** file the package exports. `tagify.polyfills.min.js` | Used for old Internet Explorer browser support `react.tagify.js` | Wrapper-only for React. [Read more](#react) <del>`jQuery.tagify.min.js`</del> | jQuery wrapper - same as `tagify.js`. Might be removed in the future. **(Deprecaded as of APR 24')** `tagify.css` | ## Adding tags dynamically ```javascript var tagify = new Tagify(...); tagify.addTags(["banana", "orange", "apple"]) // or add tags with pre-defined properties tagify.addTags([{value:"banana", color:"yellow"}, {value:"apple", color:"red"}, {value:"watermelon", color:"green"}]) ``` ## Output value There are two possible ways to get the value of the tags: 1. Access the tagify's instance's `value` prop: `tagify.value` (Array of tags) 2. Access the *original* input's value: `inputElm.value` (Stringified Array of tags) The most common way is to simply listen to the `change` event on the *original input* ```javascript var inputElm = document.querySelector, tagify = new Tagify (inputElm); inputElm.addEventListener('change', onChange) function onChange(e){ // outputs a String console.log(e.target.value) } ``` ### [Modify original input value format](https://jsbin.com/paxijaj/edit?html,js,output) Default format is a JSON string:<br> `'[{"value":"cat"}, {"value":"dog"}]'` I **recommend** keeping this because some situations might have values such as addresses (tags contain commas):<br> `'[{"value":"Apt. 2A, Jacksonville, FL 39404"}, {"value":"Forrest Ray, 191-103 Integer Rd., Corona New Mexico"}]'` Another example for complex tags state might be disabled tags, or ones with custom identifier *class*:<br> *(tags can be clicked, so delevopers can choose to use this to disable/enable tags)*<br> `'[{"value":"cat", "disabled":true}, {"value":"dog"}, {"value":"bird", "class":"color-green"}]'` To change the format, assuming your tags have no commas and are fairly simple: ```js var tagify = new Tagify(inputElm, { originalInputValueFormat: valuesArr => valuesArr.map(item => item.value).join(',') }) ``` **Output:**<br> `"cat,dog"` ## Ajax whitelist Dynamically-loaded suggestions list (*whitelist*) from the server (as the user types) is a frequent need to many. Tagify comes with its own loading animation, which is a very lightweight CSS-only code, and the <em>loading</em> state is controlled by the method `tagify.loading` which accepts `true` or `false` as arguments. Below is a basic example using the `fetch` API. I advise aborting the last request on any input before starting a new request. <details> <summary>Example:</summary> ```javascript var input = document.querySelector('input'), tagify = new Tagify(input, {whitelist:[]}), controller; // for aborting the call // listen to any keystrokes which modify tagify's input tagify.on('input', onInput) function onInput( e ){ var value = e.detail.value tagify.whitelist = null // reset the whitelist // https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort controller && controller.abort() controller = new AbortController() // show loading animation. tagify.loading(true) fetch('http://get_suggestions.com?value=' + value, {signal:controller.signal}) .then(RES => RES.json()) .then(function(newWhitelist){ tagify.whitelist = newWhitelist // update whitelist Array in-place tagify.loading(false).dropdown.show(value) // render the suggestions dropdown }) } ``` </details> ## Persisted data Sometimes the whitelist might be loaded asynchronously, and so any pre-filled value in the original input field will be removed if the `enforceWhitelist` is set to `true`. Tagify can automatically restore the last used `whitelist` by setting a ***unique id*** to the Tagify instance, by using the *localstorage* to persist the `whitelist` & `value` data: ```js var input = document.querySelector('input'), tagify = new Tagify(input, { id: 'test1', // must be unique (per-tagify instance) enforceWhitelist: true, }), ``` ## Edit tags Tags that aren't `read-only` can be edited by double-clicking them (by default) or by changing the `editTags` *setting* to `1`, making tags editable by single-clicking them. The value is saved on `blur` or by pressing `enter` key. Pressing `Escape` will revert the change trigger `blur`. <kbd>ctrl</kbd><kbd>z</kbd> will revert the change if an edited tag was marked as not valid (perhaps duplicate or blacklisted) To prevent *all* tags from being allowed to be editable, set the `editTags` setting to `false` (or `null`).<br> To do the same but for specific tag(s), set those tags' data with `editable` property set to `false`: ```html <input value='[{"value":"foo", "editable":false}, {"value":"bar"}]'> ``` ## Validations For "regular" tags (not *mix-mode* or *select-mode*) the easiest way is to use the `pattern` setting and use a Regex, or apply the `pattern` attribute directly on the `input` which will be "transformed" into a *Tagify* component (for vanilla code where the `input` tag is fully accessible to developers). If the `pattern` setting does not meet your needs, use the [`validate` setting](#settings), which recieves a *tag data object* as an argument and should return `true` if validaiton is passing, or `false`/`string` of not. A *string* may be returned as the reason of the validation failure so it would be printed as the `title` attribute of the invalid tag. [Here's an example](https://jsbin.com/rojixul/edit?js,output) for async validation for an added tag. The idea is to listen to `"add"` event, and when it fires, first set the tag to "loading" state, run an async call, and then set the *loading* state (of the tag) back to `false`. If the custom async validation failed, call the `replaceTag` Tagify method and set the `__isValid` tag data property to the error string which will be shown when hovering the tag. Note - there is a setting to keep invalid tags ([`keepInvalidTags`](#settings)) and if it's set to `true`, the user can see the reason for the invalidation by hovering the tag and see the browser's native tooltip via the `title` attribute: ```js { empty : "empty", exceed : "number of tags exceeded", pattern : "pattern mismatch", duplicate : "already exists", notAllowed : "not allowed" } ``` The texts for those (invalid tags) *titles* can be customized from the settings: ```js new Tagify(inputElement, { texts: { duplicate: "Duplicates are not allowed" } }) ``` Or by directly manipulating the *Tagify* function *prototype*: ```js Tagify.prototype.TEXTS = {...Tagify.prototype.TEXTS, {duplicate: "Duplicates are not allowed"}} ``` ## Drag & Sort To be able to sort tags by dragging, a 3rd-party script is needed. I have made a very simple *drag & drop* (~`11kb` *unminified*) script which uses [HTML5 native API](https://developer.mozilla.org/en-US/docs/Web/API/HTML_Drag_and_Drop_API) and it is available to download via [NPM](https://www.npmjs.com/package/@yaireo/dragsort) or [Github](https://github.com/yairEO/dragsort) but any other *drag & drop* script may work. I could not find on the whole internet a decent lightweight script. ### [Integration example](https://codepen.io/vsync/pen/jOqYOVJ): ```js var tagify = new Tagify(inputElement) // bind "DragSort" to Tagify's main element and tell // it that all the items with the below "selector" are "draggable" var dragsort = new DragSort(tagify.DOM.scope, { selector: '.'+tagify.settings.classNames.tag, callbacks: { dragEnd: onDragEnd } }) // must update Tagify's value according to the re-ordered nodes in the DOM function onDragEnd(elm){ tagify.updateValueByDOMTags() } ``` ## DOM Templates It's possible to control the templates for some of the HTML elements Tagify is using by modifying the `settings.templates` Object with your own custom functions which **must return** an *HTML string*. Available templates are: `wrapper`, `input`, `tag`, `dropdown`, `dropdownItem`, `dropdownContent`, `dropdownHeader`, `dropdownFooter` and the optional `dropdownItemNoMatch` which is a special template for rendering a suggestion item (in the dropdown list) only if there were no matches found for the typed input, for example: ```js // ...more tagify settings... templates: { dropdownItemNoMatch: data => `<div class='${tagify.settings.classNames.dropdownItem}' value="noMatch" tabindex="0" role="option"> No suggestion found for: <strong>${data.value}</strong> </div>` } ``` [View templates](https://github.com/yairEO/tagify/blob/master/src/parts/templates.js) ### Example of overriding the `tag` template: Each template function is automatically binded with `this` pointing to the current *Tagify* instance. It is imperative to preserve the class names and also the `this.getAttributes(tagData)` for proper functionality. ```js new Tagify(inputElem, { templates: { tag(tagData, tagify){ return `<tag title="${(tagData.title || tagData.value)}" contenteditable='false' spellcheck='false' tabIndex="${this.settings.a11y.focusableTags ? 0 : -1}" class="${this.settings.classNames.tag} ${tagData.class ? tagData.class : ""}" ${this.getAttributes(tagData)}> <x title='' class="${this.settings.classNames.tagX}" role='button' aria-label='remove tag'></x> <div> <span class="${this.settings.classNames.tagText}">${tagData[this.settings.tagTextProp] || tagData.value}</span> </div> </tag>`, dropdownFooter(suggestions){ var hasMore = suggestions.length - this.settings.dropdown.maxItems; return hasMore > 0 ? `<footer data-selector='tagify-suggestions-footer' class="${this.settings.classNames.dropdownFooter}"> ${hasMore} more items. Refine your search. </footer>` : ''; } } }) ``` ## Suggestions list <p align="center"> <img src="/docs/suggestions-list.apng" alt='suggestions list dropdown'/> </p> The suggestions list is a *whitelist Array* of *Strings* or *Objects* which was set in the [settings](#settings) Object when the Tagify instance was created, and can be set later directly on the instance: `tagifyInstance.whitelist = ["tag1", "tag2", ...]`. The suggestions dropdown will be appended to the document's `<body>` element and will be rendered by default in a position below (bottom of) the Tagify element. Using the keyboard arrows up/down will highlight an option from the list, and hitting the Enter key to select. It is possible to tweak the list dropdown via 2 settings: - `enabled` - this is a numeral value that tells Tagify when to show the suggestions dropdown, when a minimum of N characters were typed. - `maxItems` - Limits the number of items the suggestions list will render ```javascript var input = document.querySelector('input'), tagify = new Tagify(input, { whitelist : ['aaa', 'aaab', 'aaabb', 'aaabc', 'aaabd', 'aaabe', 'aaac', 'aaacc'], dropdown : { classname : "color-blue", enabled : 0, // show the dropdown immediately on focus maxItems : 5, position : "text", // place the dropdown near the typed text closeOnSelect : false, // keep the dropdown open after selecting a suggestion highlightFirst: true } }); ``` <p align="center"><b>Will render</b></p> ```html <div class="tagify__dropdown tagify__dropdown--text" style="left:993.5px; top:106.375px; width:616px;"> <div class="tagify__dropdown__wrapper"> <div class="tagify__dropdown__item tagify__dropdown__item--active" value="aaab">aaab</div> <div class="tagify__dropdown__item" value="aaabb">aaabb</div> <div class="tagify__dropdown__item" value="aaabc">aaabc</div> <div class="tagify__dropdown__item" value="aaabd">aaabd</div> <div class="tagify__dropdown__item" value="aaabe">aaabe</div> </div> </div> ``` By default searching the suggestions is using [fuzzy-search](https://en.wikipedia.org/wiki/Approximate_string_matching) (see [settings](#settings)). If you wish to assign *alias* to items (in your suggestion list), add the `searchBy` property to *whitelist* items you wish to have an *alias* for. In the below example, typing a part of a string which is included in the `searchBy` property, for example *`land midd"`* - the suggested item which matches the value "Israel" will be rendered in the suggestions (dropdown) list. ### [Example](https://yaireo.github.io/tagify/#section-extra-properties) for a suggestion item alias ```javascript whitelist = [ ... { value:'Israel', code:'IL', searchBy:'holy land, desert, middle east' }, ... ] ``` Another handy setting is `dropdown.searchKeys` which, like the above `dropdown.searchBy` setting, allows expanding the search of any typed terms to more than the `value` property of the whitelist items (if items are a *Collection*). ### Example whitelist: ```javascript [ { value : 123456, nickname : "foo", email : "foo@mail.com" }, { value : 987654, nickname : "bar", email : "bar@mail.com" }, ...more.. ] ``` Modified `searchKeys` setting to also search in other keys: ```javascript { dropdown: { searchKeys: ["nickname", "email"] // fuzzy-search matching for those whitelist items' properties } } ``` ## Mixed-Content [See demo here](https://yaireo.github.io/tagify/#section-mix) This feature must be toggled using these [settings](#settings): ```js { // mixTagsInterpolator: ["{{", "}}"], // optional: interpolation before & after string mode: 'mix', // <-- Enable mixed-content pattern: /@|#/ // <-- Text starting with @ or # (if single, String can be used here instead of Regex) } ``` When mixing text with tags, the original textarea (or input) element will have a value as follows: [[cartman]]⁠ and [[kyle]]⁠ do not know [[Homer simpson]]⁠ If the initial value of the textarea or input is formatted as the above example, Tagify will try to automatically convert everything between `[[` & `]]` to a tag, if tag exists in the *whitelist*, so make sure when the Tagify instance is initialized, that it has tags with the correct `value` property that match the same values that appear between `[[` & `]]`. Applying the setting `dropdown.position:"text"` is encouraged for mixed-content tags, because the suggestions list weird when there is already a lot of content on multiple lines. If a tag does not exist in the *whitelist*, it may be created by the user and all you should do is listen to the `add` event and update your local/remote state. ## Single-Value Similar to native `<Select>` element, but allows typing text as value. ## React See [**live demo**](https://codesandbox.io/s/tagify-react-wrapper-oempc) for React integration examples. ⚠️ Tagify is **not** a [controlled component](https://github.com/yairEO/tagify/issues/489#issuecomment-629316093). A none-minified and raw source-code Tagify React component is exported from [`react.tagify.jsx`](https://github.com/yairEO/tagify/blob/master/src/react.tagify.jsx) and you can import it as seen in the below code example. This React port will only work if your bundler can handle raw source-code in ES2015+ which is better for tree-shaking. --- ### Update regarding `onChange` prop: I have changed how the `onChange` works internally within the Wrapper of Tagify so as of *March 30, 2021* the `e` argument will include a `detail` parameter with the value as string. There is no more `e.target`, and to access the original DOM input element, do this: `e.detail.tagify.DOM.originalInput`. ---- > Note: You will need to import Tagify's CSS also, either by JavaScript or by SCSS `@import` (which is preferable) > Also note that you will need to use [*dart-sass*](https://www.npmjs.com/package/sass) and not *node-sass* in order to compile the file. ```javascript import { useCallback, useRef } from 'react' import Tags from '@yaireo/tagify/react' // React-wrapper file import '@yaireo/tagify/dist/tagify.css' // Tagify CSS const App = () => { // on tag add/edit/remove const onChange = useCallback((e) => { console.log("CHANGED:" , e.detail.tagify.value // Array where each tag includes tagify's (needed) extra properties , e.detail.tagify.getCleanValue() // Same as above, without the extra properties , e.detail.value // a string representing the tags ) }, []) return ( <Tags whitelist={['item 1', 'another item', 'item 3']} placeholder='Add some tags' settings={{ blacklist: ["xxx"], maxTags: 4, dropdown: { enabled: 0 // always show suggestions dropdown } }} defaultValue="a,b,c" // initial value onChange={onChange} /> ) } ``` To gain full access to Tagify's (instance) inner methods, A custom `ref` can be used: ```jsx import Tags, {MixedTags} from "@yaireo/tagify/react"; ... const tagifyRef = useRef() ... <Tags tagifyRef={tagifyRef} ... /> // or mix-mode <MixedTags settings={...} onChange={...} defaultValue={`This is a textarea which mixes text with [[{"value":"tags"}]].`} /> ``` `<MixedTags>` component is a shorthand for `<Tags InputMode="textarea">` #### Updating the component's state The `settings` prop is **only used once** in the initialization process, please do not update it afterwards. --- <details> <summary>📖 List of (React) props for the <code><Tags/></code> component</summary> Prop | Type | Updatable | Info ----------------------- | ------------------------- |:---------:| ----------------------------------------------------------- settings | <sub>Object</sub> | | See [*settings* section](#settings) name | <sub>String</sub> | ✔ | `<input>`'s element `name` attribute value | <sub>String/Array</sub> | ✔ | Initial value. defaultValue | <sub>String/Array</sub> | | Same as `value prop placeholder | <sub>String</sub> | ✔ | placeholder text for the component readOnly | <sub>Boolean</sub> | ✔ | Toggles `readonly` state. With capital `O`. tagifyRef | <sub>Object</sub> | | `useRef` hook refference for the component inner instance of vanilla *Tagify* (for methods access) showDropdown | <sub>Boolean/String</sub> | ✔ | if `true` shows the suggestions dropdown. if assigned a String, show the dropdown pre-filtered. loading | <sub>Boolean</sub> | ✔ | Toggles `loading` state for the whole component whitelist | <sub>Array</sub> | ✔ | Sets the `whitelist` which is the basis for the suggestions dropdown & autocomplete className | <sub>String</sub> | | Component's optional class name to be added InputMode | <sub>String</sub> | | `"textarea"` will create a `<textarea>` (hidden) element instead of the default `<input>` and automatically make Tagify act as [*"mix mode"*](#mixed-content) autoFocus | <sub>Boolean</sub> | | Should the component have focus on mount. Must be unique, per-page. children | <sub>String/Array</sub> | | `value`/`defaultValue` props are prefered onChange | <sub>Function</sub> | | See [*events* section](#events) onInput | <sub>Function</sub> | | See [*events* section](#events) onAdd | <sub>Function</sub> | | See [*events* section](#events) onRemove | <sub>Function</sub> | | See [*events* section](#events) onInvalid | <sub>Function</sub> | | See [*events* section](#events) onClick | <sub>Function</sub> | | See [*events* section](#events) onKeydown | <sub>Function</sub> | | See [*events* section](#events) onFocus | <sub>Function</sub> | | See [*events* section](#events) onBlur | <sub>Function</sub> | | See [*events* section](#events) onEditInput | <sub>Function</sub> | | See [*events* section](#events) onEditBeforeUpdate | <sub>Function</sub> | | See [*events* section](#events) onEditUpdated | <sub>Function</sub> | | See [*events* section](#events) onEditStart | <sub>Function</sub> | | See [*events* section](#events) onEditKeydown | <sub>Function</sub> | | See [*events* section](#events) onDropdownShow | <sub>Function</sub> | | See [*events* section](#events) onDropdownHide | <sub>Function</sub> | | See [*events* section](#events) onDropdownSelect | <sub>Function</sub> | | See [*events* section](#events) onDropdownScroll | <sub>Function</sub> | | See [*events* section](#events) onDropdownNoMatch | <sub>Function</sub> | | See [*events* section](#events) onDropdownUpdated | <sub>Function</sub> | | See [*events* section](#events) </details> --- ## Vue I don't know *Vue* at all and this thin wrapper was built by a friend who knows. To import the [wrapper file](https://github.com/yairEO/tagify/blob/master/dist/tagify.vue), use the import path `@yaireo/tagify/vue` ## jQuery version This variant of Tagify code has been **deprecated** because it doesn't really add much in terms of ease-of-use. I only made it so it would be possible to use jQuery selectors & chaining but the (jQuery) port really isn't needed when implementing Tagify within a jQuery code. Below is the documentation for previous Tagify packages versions which included support: #### `jQuery.tagify.js` A jQuery wrapper version is also available, but I advise not using it because it's basically the exact same as the "normal" script (non-jqueryfied) and all the jQuery's wrapper does is allowing to chain the event listeners for ('add', 'remove', 'invalid') ```javascript $('[name=tags]') .tagify() .on('add', function(e, tagData){ console.log('added', ...tagData) // data, index, and DOM node }); ``` Accessing methods can be done via the [`.data('tagify')`](https://api.jquery.com/data): ```javascript $('[name=tags]').tagify(); // get tags from the server (ajax) and add them: $('[name=tags]').data('tagify').addTags('aaa, bbb, ccc') ```` ## HTML input & textarea attributes The below list of *attributes* affect *Tagify*.<br> These can also be set by Tagify [settings](#settings) Object manually, and not *declerativly* (via attributes). Attribute | Example | Info ----------------- | ----------------------------------------------------- | -------------------- [pattern](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern) | <pre lang=html>`<input pattern='^[A-Za-z_✲ ]{1,15}$'>`</pre> | Tag Regex pattern which tag input is validated by. [placeholder](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdefplaceholder) | <pre lang=html>`<input placeholder='please type your tags'>`</pre> | This attribute's value will be used as a constant placeholder, which is visible unless something is being typed. readOnly | <pre lang=html>`<input readOnly>`</pre> | No user-interaction (add/remove/edit) allowed. autofocus | <pre lang=html>`<input autofocus>`</pre> | Automatically focus the the Tagify component when the component is loaded required | <pre lang=html>`<input required>`</pre> | Adds a `required` attribute to the Tagify wrapper element. Does nothing more. ## Caveats - `<input>` wrapped in a `<label>` doesn't work - [#1219](https://github.com/yairEO/tagify/issues/1219) and so Tagify internally sets the label's `for` attribute to an empty string, so clicking the Tagify component will not blur it and re-focus on the hidden input/textarea element Tagify is "connected" to ## FAQ List of questions & scenarios which might come up during development with Tagify: <details> <summary><strong>Dynamic whitelist</strong></summary> The whitelist initial value is set like so: ```js const tagify = new Tagify(tagNode, { whitelist: ["a", "b", "c"] }) ``` If changes to the whitelist are needed, they should be done like so: **Incorrect:** ```js tagify.settings.whitelist = ["foo", "bar"] ``` **Correct:** ```js // set the whitelist directly on the instance and not on the "settings" property tagify.whitelist = ["foo", "bar"] ``` </details> --- <details> <summary><strong>tags/whitelist data structure</strong></summary> Tagify does not accept just *any* kind of data structure.<br> If a tag data is represented as an `Object`, it **must** contain a **unique** property `value` which Tagify uses to check if a tag already exists, among other things, so make sure it is present. **Incorrect:** ```javascript [{ "id":1, "name":"foo bar" }] ``` **Correct:** ```javascript [{ "id":1, "value": 1, "name":"foo bar" }] ``` ```javascript [{ "value":1, "name":"foo bar" }] ``` ```javascript [{ "value":"foo bar" }] ``` ```javascript // ad a simple array of Strings ["foo bar"] ``` </details> --- <details> <summary><strong>Save changes (Ex. to a server)</strong></summary> In framework-less projects, the developer should save the state of the Tagify component (somewhere), and the question is:<br/> **when should the state be saved?** On every change made to *Tagify's* internal state (`tagify.value` via the `update()` method).<br> ```javascript var tagify = new Tagify(...) // listen to "change" events on the "original" input/textarea element tagify.DOM.originalInput.addEventListener('change', onTagsChange) // This example uses async/await but you can use Promises, of course, if you prefer. async function onTagsChange(e){ const {name, value} = e.target // "imaginary" async function "saveToServer" should get the field's name & value await saveToServer(name, value) } ``` If you are using *React/Vue/Angular* or any "modern" framework, then you already know how to attach "onChange" event listeners to your `<input>`/`<textarea>` elements, so the above is irrelevant. </details> ---- <details> <summary><strong>Render tags in one single line</strong></summary> Stopping tags from wrapping to new lines, add this to your `.tagify` *selector CSS Rule*: ```css flex-wrap: nowrap; ```` </details> ---- <details> <summary><strong>Submit on `Enter` key</strong></summary> Tagify internally has `state` property, per `Tagify` instance and this may be useful for a variety of things when implementing a specific scenario. ```js var tagify = new Tagify(...) var formElm = document.forms[0]; // just an example tagify.on('keydown', onTagifyKeyDown) function onTagifyKeyDown(e){ if( e.detail.event.key == 'Enter' && // "enter" key pressed !tagify.state.inputText && // assuming user is not in the middle or adding a tag !tagify.state.editing // user not editing a tag ){ setTimeout(() => formElm.submit()) // put some buffer to make sure tagify has done with whatever, to be on the safe-side } } ``` </details> --- * [Disable the automatic whitelist (suggestions) filtering](https://github.com/yairEO/tagify/issues/1114) * [Double-click tag fires both "edit" & "click" custom events](https://github.com/yairEO/tagify/issues/247) * [Manualy open the suggestions dropdown](https://github.com/yairEO/tagify/issues/254) * [Render your own suggestions dropdown](https://github.com/yairEO/tagify/issues/244) * [Allow max length on mix mode](https://github.com/yairEO/tagify/issues/252) * [Always show dropdown](https://github.com/yairEO/tagify/issues/253) * [Limit the length of a tag value (minimum & maximum)](https://github.com/yairEO/tagify/issues/245) * [*Mixed mode* initial value](https://github.com/yairEO/tagify/issues/237) * [Random colors for each tag](https://github.com/yairEO/tagify/issues/223) * [Format input value for server side](https://github.com/yairEO/tagify/issues/220) * [Writing to tagify textarea](https://github.com/yairEO/tagify/issues/294) * [Scroll all tags within one line, instead of growing vertically](https://github.com/yairEO/tagify/issues/145) * [Insert emoji at caret location when editing a tag](https://github.com/yairEO/tagify/issues/365) * [propagate `change` event](https://github.com/yairEO/tagify/issues/413) * [Manually update tag data after it was added](https://github.com/yairEO/tagify/issues/433) * [Ajax Whitelist with "enforceWhitelist" setting enabled](https://github.com/yairEO/tagify/issues/465) * [Custom (multiple) tag validation & AJAX](https://github.com/yairEO/tagify/issues/474) * [Make tags from pasted multi-line text](https://github.com/yairEO/tagify/issues/160) * [Add a tag at *caret* position in *mixed mode*](https://github.com/yairEO/tagify/issues/524#issuecomment-699140465) * [Change automatic title tooltips for invalid tags](https://github.com/yairEO/tagify/issues/862) * [Create a submenu for the suggestions dropdown](https://github.com/yairEO/tagify/issues/1016#issuecomment-1106910803) * [Hide placeholder if tags exist](https://github.com/yairEO/tagify/issues/495#issuecomment-620498047) ## CSS Variables > Learn more about [CSS Variables](https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_custom_properties)) (custom properties) Tagify's utilizes *CSS variables* which allow easy customization without the need to manually write CSS. If you do wish to heavily style your Tagify components, then you can (and should) use the below variables within your modified styles as much as you can. For a *live* example, see the [demos page](https://yaireo.github.io/tagify/#section-different-look). Name | Info ------------------------------- | -------------------------------- --tags-disabled-bg | Tag background color when *disabled* --tags-border-color | The outer border color which surrounds tagify --tags-hover-border-color | *hover* state --tags-focus-border-color | *focus* state --tag-border-radius | Tag border radius --tag-bg | Tag background color --tag-hover | Tag background color on hover (mouse) --tag-text-color | Tag text color --tag-text-color--edit | Tag text color when a Tag is being edited --tag-pad | Tag padding, from all sides. Ex. `.3em .5em` --tag--min-width | Minimum Tag width --tag--max-width | Maximum tag width, which gets trimmed with *hellip* after --tag-inset-shadow-size | This is the inner shadow size, which dictates the color of the Tags.<br>It's important the size fits *exactly* to the tag.<br>Change this if you change the `--tag-pad` or fontsize. --tag-invalid-color | For border color of edited tags with invalid value being typed into them --tag-invalid-bg | Background color for invalid Tags. --tag-remove-bg | Tag background color when hovering the `×` button. --tag-remove-btn-color | Remove (`×`) button text color --tag-remove-btn-bg | Remove (`×`) button background color --tag-remove-btn-bg--hover | Remove (`×`) button hover background color --input-color | Input text color --tag-hide-transition | Controls the transition property when a tag is removed. default is '.3s' --placeholder-color | Placeholder text color --placeholder-color-focus | Placeholder text color when Tagify has focus and no input was typed --loader-size | Loading animation size. `1em` is pretty big, default is a bit less. --readonly-striped | Either a value `1` or `0` can be used to toggle the striped diagonal background in *readonly* ### Suggestions Dropdown CSS variables should be appiled on the `:root {...}` selector Name | Info --------------------------------- | -------------------------------- --tagify-dd-color-primary | Sugegstion's background color on hover --tagify-dd-text-color | Sugegstion's text color --tagify-dd-bg-color | The suggestion's dropdown background color --tagify-dd-item--hidden-duration | When selecting a suggestion, this is the duration for it to become hidden (shrink) --tagify-dd-item-pad | Suggestion item padding --tagify-dd-max-height | Maximum height of the suggestions dropdown (`300px` by default) ### Full list of Tagify's [SCSS variables](https://github.com/yairEO/tagify/blob/master/src/tagify.scss#L9-L24) ## Methods `Tagify` is [prototype](https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Objects/Object_prototypes) based and There are many methods, but I've chosen to list the most relevant ones: Name | Parameters | Info -------------------------- | --------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- `destroy` | | Reverts the input element back as it was before Tagify was applied `removeAllTags` | | Removes all tags and resets the original input tag's value property `addTags` | <ol><li>`Array`/`String`/`Object` tag(s) to add</li><li>`Boolean` clear input after adding</li><li>`Boolean` - skip adding invalids</li><ol> | Accepts a String (word, single or multiple with a delimiter), an Array of Objects (see above) or Strings. `addMixTags` | `Array`/`String` | Bypasses the normalization process in `addTags`, forcefully adding tags at the last caret location or at the end, if there's no last caret location saved (at `tagify.state.selection`) `removeTags` | <ol><li>`Array`/`HTMLElement`/`String` tag(s) to remove</li><li>`silent` does not update the component's value</li><li>`tranDuration` Transition duration (in `ms`)</li></ul> | (#502) Remove single/multiple Tags. When nothing passed, removes last tag. <ul><li>`silent` - A flag, which when turned on, does not remove any value and does not update the original input value but simply removes the tag from tagify</li><li>`tranDuration` - delay for animation, after which the tag will be removed from the DOM</li></ul> `addEmptyTag` | `Object` <sub>(`tagData`)</sub> | Create an empty tag (optionally with pre-defined data) and enters "edit" mode directly. [See demo](https://yaireo.github.io/tagify#section-different-look) `loadOriginalValues` | `String`/`Array` | Converts the input's value into tags. This method gets called automatically when instansiating Tagify. Also works for mixed-tags `getWhitelistItemsByValue` | `Object` | `{value}` - return an Array of found matching items (case-insensitive) `getTagIndexByValue` | `String` | Returns the index of a specific tag, by value `getTagElmByValue` | `String` | Returns the first matched tag node, if found `isTagDuplicate` | `String` | Returns how many tags already exists with that value `parseMixTags` | `String` | Converts a String argument (`[[foo]]⁠ and [[bar]]⁠ are..`) into HTML with mixed tags & texts `getTagElms` | | Returns a DOM nodes list of all the tags `getTagElmByValue` | `String` | Returns a specific tag DOM node by value `getSetTagData` | `HTMLElement`, `Object` | set/get tag data on a tag element (has`.tagify__tag` class by default) `editTag` | `HTMLElement` | Goes to edit-mode in a specific tag `getTagTextNode` | `HTMLElement` | Get the node which has the actual tag's content `setTagTextNode` | `HTMLElement`, `String` | Sets the text of a tag (DOM only, does not affect actual data) `replaceTag` | `tagElm`, `Object` <sub>(`tagData`)</sub> | Exit a tag's edit-mode. if "tagData" exists, replace the tag element with new data and update Tagify value `loading` | `Boolean` | toggle loading state on/off (Ex. AJAX whitelist pulling) `tagLoading` | `HTMLElement`, `Boolean` | same as above but for a specific tag element `createTagElem` | `Object` <sub>(`tagData`)</sub> | Returns a tag element from the supplied tag data `injectAtCaret` | `HTMLElement` <sub>(`injectedNode`)</sub>, `Object` <sub>(`range`)</sub> | Injects text or HTML node at last caret position. `range` parameter is *optional* `placeCaretAfterNode` | `HTMLElement` | Places the caret after a given node `setRangeAtStartEnd` | `Boolean`, `HTMLElement` | Places the caret at the start or the end of a node. `insertAfterTag` | `HTMLElement` <sub>(tag element)</sub>, `HTMLElement`/`String` <sub>(whatever to insert after)</sub> | `toggleClass` | `Boolean` | Toggles `class` on the main *tagify* container (`scope`) `dropdown.selectAll` | | Add **all** whitelist items as tags and close the suggestion dropdown `dropdown.show` | `String` | Shows the suggestions list dropdown. A string parameter allows filtering the results `dropdown.hide` | `Boolean` | Hides the suggestions list dropdown (if it's not managed manually by the developer) `dropdown.toggle` | `Boolean` | Toggles dropdown show/hide. the boolean parameter will force-show `updateValueByDOMTags` | | Iterate tag DOM nodes and re-build the `tagify.value` array (call this if tags get sorted manually) `parseTemplate` | `String`/`Function` <sub>(template name or function)</sub>, `Array` <sub>(data)</sub> | converts a template string (by selecting one from the `settings.templates` by name or supplying a template function which returns a String) into a DOM node `setReadonly` | `Boolean` | Toggles "readonly" mode on/off `setDisabled` | `Boolean` | Toggles "disabled" mode on/off `getPersistedData` | `String` | Get data for the specific instance by parameter `setPersistedData` | `*`, `String` | Set data for the specific instance. Must supply a second parameter which will be the key to save the data in the localstorage (under the tagify namespace) `clearPersistedData` | `String` | Clears data for the specific instance, by parameter. If the parameter is ommited, clears all persisted data related to this instance (by its `id` which was set in the instance's settings) `setPlaceholder` | `String` | Sets the placeholder's value. [See demo](https://yaireo.github.io/tagify/#section-advance-options) ## Events To listen to `tagif