Tagify - Tags input Component

basic

Passing the input element as a parameter to Tagify will transform it into a tags-component. Without any settings, the user will be allowed to create any tags they want, without a count limit.

If the input element has a pre-defined value attribute, tags will be created from it.

(Try Double-clicking a tag to edit it)

Code

HTML

<input name='basic' value='tag1, tag2' autofocus>

JAVASCRIPT

// The DOM element you wish to replace with Tagify
var input = document.querySelector('input[name=basic]');

// initialize Tagify on the above input node reference
new Tagify(input)

Text Input

In this example:

Tagify instance with initial settings Object
Only allow tags from the whitelist to exist
Manually create initial whitelist from the original input's value
Simulate fetching whitelist (from a server) as the user is typing
"Remove all tags" by an external button
Listen to various Tagify events
Un-listen to specific event (see onAddTag function)

Intro:

The input element is pre-ocupied with 4 tags. The last tag, "CSS", has the same value as the first tag, and will be removed, because the duplicates setting is set to true.

Note that whitelist & blacklist may also be set on to Tagify as data- attributes on the input tag itself as a list of tags seperated by the same delimeter defined in the Tagify's configuration. Default is comma (,)

As text is typed, the onInput Tagify event is fired, on each key stroke. Reseting the current whitelist and fetching a new one (from mockAjax())

In real-life scenarios, a developer might wish to use different whitelists suggested to the user, according to the typed text, asusming the possibilities are too large to load at-once as the inital whitelist.

Code

HTML

<!-- https://codepen.io/vsync/pen/PoNqYVY -->
<input name='input' class='some_class_name' placeholder='Type an English letter' value='css, html, javascript, css' data-blacklist='.NET, PHP'>
<br/>
<button class='tags--removeAllBtn' type='button'>Remove all these tags ⬆</button>

JAVASCRIPT

var inputElm = document.querySelector('input[name=input]'),
    whitelist = ["A# .NET", "A# (Axiom)", "A-0 System", "A+", "A++", "ABAP", "ABC", "ABC ALGOL", "ABSET", "ABSYS", "ACC", "Accent", "Ace DASL", "ACL2", "Avicsoft", "ACT-III", "Action!", "ActionScript", "Ada", "Adenine", "Agda", "Agilent VEE", "Agora", "AIMMS", "Alef", "ALF", "ALGOL 58", "ALGOL 60", "ALGOL 68", "ALGOL W", "Alice", "Alma-0", "AmbientTalk", "Amiga E", "AMOS", "AMPL", "Apex (Salesforce.com)", "APL", "AppleScript", "Arc", "ARexx", "Argus", "AspectJ", "Assembly language", "ATS", "Ateji PX", "AutoHotkey", "Autocoder", "AutoIt", "AutoLISP / Visual LISP", "Averest", "AWK", "Axum", "Active Server Pages", "ASP.NET", "B", "Babbage", "Bash", "BASIC", "bc", "BCPL", "BeanShell", "Batch (Windows/Dos)", "Bertrand", "BETA", "Bigwig", "Bistro", "BitC", "BLISS", "Blockly", "BlooP", "Blue", "Boo", "Boomerang", "Bourne shell (including bash and ksh)", "BREW", "BPEL", "B", "C--", "C++ – ISO/IEC 14882", "C# – ISO/IEC 23270", "C/AL", "Caché ObjectScript", "C Shell", "Caml", "Cayenne", "CDuce", "Cecil", "Cesil", "Céu", "Ceylon", "CFEngine", "CFML", "Cg", "Ch", "Chapel", "Charity", "Charm", "Chef", "CHILL", "CHIP-8", "chomski", "ChucK", "CICS", "Cilk", "Citrine (programming language)", "CL (IBM)", "Claire", "Clarion", "Clean", "Clipper", "CLIPS", "CLIST", "Clojure", "CLU", "CMS-2", "COBOL – ISO/IEC 1989", "CobolScript – COBOL Scripting language", "Cobra", "CODE", "CoffeeScript", "ColdFusion", "COMAL", "Combined Programming Language (CPL)", "COMIT", "Common Intermediate Language (CIL)", "Common Lisp (also known as CL)", "COMPASS", "Component Pascal", "Constraint Handling Rules (CHR)", "COMTRAN", "Converge", "Cool", "Coq", "Coral 66", "Corn", "CorVision", "COWSEL", "CPL", "CPL", "Cryptol", "csh", "Csound", "CSP", "CUDA", "Curl", "Curry", "Cybil", "Cyclone", "Cython", "Java", "Javascript", "M2001", "M4", "M#", "Machine code", "MAD (Michigan Algorithm Decoder)", "MAD/I", "Magik", "Magma", "make", "Maple", "MAPPER now part of BIS", "MARK-IV now VISION:BUILDER", "Mary", "MASM Microsoft Assembly x86", "MATH-MATIC", "Mathematica", "MATLAB", "Maxima (see also Macsyma)", "Max (Max Msp – Graphical Programming Environment)", "Maya (MEL)", "MDL", "Mercury", "Mesa", "Metafont", "Microcode", "MicroScript", "MIIS", "Milk (programming language)", "MIMIC", "Mirah", "Miranda", "MIVA Script", "ML", "Model 204", "Modelica", "Modula", "Modula-2", "Modula-3", "Mohol", "MOO", "Mortran", "Mouse", "MPD", "Mathcad", "MSIL – deprecated name for CIL", "MSL", "MUMPS", "Mystic Programming L"];


// initialize Tagify on the above input node reference
var tagify = new Tagify(inputElm, {
    enforceWhitelist: true,
    whitelist: inputElm.value.trim().split(/\s*,\s*/) // Array of values. stackoverflow.com/a/43375571/104380
})



// "remove all tags" button event listener
document.querySelector('.tags--removeAllBtn')
    .addEventListener('click', tagify.removeAllTags.bind(tagify))

// Chainable event listeners
tagify.on('add', onAddTag)
      .on('remove', onRemoveTag)
      .on('input', onInput)
      .on('edit', onTagEdit)
      .on('invalid', onInvalidTag)
      .on('click', onTagClick)
      .on('focus', onTagifyFocusBlur)
      .on('blur', onTagifyFocusBlur)
      .on('dropdown:hide dropdown:show', e => console.log(e.type))
      .on('dropdown:select', onDropdownSelect)

var mockAjax = (function mockAjax(){
    var timeout;
    return function(duration){
        clearTimeout(timeout); // abort last request
        return new Promise(function(resolve, reject){
            timeout = setTimeout(resolve, duration || 700, whitelist)
        })
    }
})()

// tag added callback
function onAddTag(e){
    console.log("onAddTag: ", e.detail);
    console.log("original input value: ", inputElm.value)
    tagify.off('add', onAddTag) // exmaple of removing a custom Tagify event
}

// tag remvoed callback
function onRemoveTag(e){
    console.log("onRemoveTag:", e.detail, "tagify instance value:", tagify.value)
}

// on character(s) added/removed (user is typing/deleting)
function onInput(e){
    console.log("onInput: ", e.detail);
    tagify.whitelist = null; // reset current whitelist
    tagify.loading(true) // show the loader animation

    // get new whitelist from a delayed mocked request (Promise)
    mockAjax()
        .then(function(result){
            tagify.settings.whitelist = result.concat(tagify.value) // add already-existing tags to the new whitelist array

            tagify
                .loading(false)
                // render the suggestions dropdown.
                .dropdown.show(e.detail.value);
        })
        .catch(err => tagify.dropdown.hide())
}

function onTagEdit(e){
    console.log("onTagEdit: ", e.detail);
}

// invalid tag added callback
function onInvalidTag(e){
    console.log("onInvalidTag: ", e.detail);
}

// invalid tag added callback
function onTagClick(e){
    console.log(e.detail);
    console.log("onTagClick: ", e.detail);
}

function onTagifyFocusBlur(e){
    console.log(e.type, "event fired")
}

function onDropdownSelect(e){
    console.log("onDropdownSelect: ", e.detail)
}

Same using custom suggestions:

The dropdown will appear immediately when Tagify has focus.

The suggestions are styled as tags this time. Clicking on a suggested it, it will be added to Tagify

Code

HTML

<input name='input-custom-dropdown' class='tagify--custom-dropdown' placeholder='Type an English letter' value='css, html, javascript'>

JAVASCRIPT

var input = document.querySelector('input[name="input-custom-dropdown"]'),
    // init Tagify script on the above inputs
    tagify = new Tagify(input, {
        whitelist: ["A# .NET", "A# (Axiom)", "A-0 System", "A+", "A++", "ABAP", "ABC", "ABC ALGOL", "ABSET", "ABSYS", "ACC", "Accent", "Ace DASL", "ACL2", "Avicsoft", "ACT-III", "Action!", "ActionScript", "Ada", "Adenine", "Agda", "Agilent VEE", "Agora", "AIMMS", "Alef", "ALF", "ALGOL 58", "ALGOL 60", "ALGOL 68", "ALGOL W", "Alice", "Alma-0", "AmbientTalk", "Amiga E", "AMOS", "AMPL", "Apex (Salesforce.com)", "APL", "AppleScript", "Arc", "ARexx", "Argus", "AspectJ", "Assembly language", "ATS", "Ateji PX", "AutoHotkey", "Autocoder", "AutoIt", "AutoLISP / Visual LISP", "Averest", "AWK", "Axum", "Active Server Pages", "ASP.NET", "B", "Babbage", "Bash", "BASIC", "bc", "BCPL", "BeanShell", "Batch (Windows/Dos)", "Bertrand", "BETA", "Bigwig", "Bistro", "BitC", "BLISS", "Blockly", "BlooP", "Blue", "Boo", "Boomerang", "Bourne shell (including bash and ksh)", "BREW", "BPEL", "B", "C--", "C++ – ISO/IEC 14882", "C# – ISO/IEC 23270", "C/AL", "Caché ObjectScript", "C Shell", "Caml", "Cayenne", "CDuce", "Cecil", "Cesil", "Céu", "Ceylon", "CFEngine", "CFML", "Cg", "Ch", "Chapel", "Charity", "Charm", "Chef", "CHILL", "CHIP-8", "chomski", "ChucK", "CICS", "Cilk", "Citrine (programming language)", "CL (IBM)", "Claire", "Clarion", "Clean", "Clipper", "CLIPS", "CLIST", "Clojure", "CLU", "CMS-2", "COBOL – ISO/IEC 1989", "CobolScript – COBOL Scripting language", "Cobra", "CODE", "CoffeeScript", "ColdFusion", "COMAL", "Combined Programming Language (CPL)", "COMIT", "Common Intermediate Language (CIL)", "Common Lisp (also known as CL)", "COMPASS", "Component Pascal", "Constraint Handling Rules (CHR)", "COMTRAN", "Converge", "Cool", "Coq", "Coral 66", "Corn", "CorVision", "COWSEL", "CPL", "CPL", "Cryptol", "csh", "Csound", "CSP", "CUDA", "Curl", "Curry", "Cybil", "Cyclone", "Cython", "Java", "Javascript", "M2001", "M4", "M#", "Machine code", "MAD (Michigan Algorithm Decoder)", "MAD/I", "Magik", "Magma", "make", "Maple", "MAPPER now part of BIS", "MARK-IV now VISION:BUILDER", "Mary", "MASM Microsoft Assembly x86", "MATH-MATIC", "Mathematica", "MATLAB", "Maxima (see also Macsyma)", "Max (Max Msp – Graphical Programming Environment)", "Maya (MEL)", "MDL", "Mercury", "Mesa", "Metafont", "Microcode", "MicroScript", "MIIS", "Milk (programming language)", "MIMIC", "Mirah", "Miranda", "MIVA Script", "ML", "Model 204", "Modelica", "Modula", "Modula-2", "Modula-3", "Mohol", "MOO", "Mortran", "Mouse", "MPD", "Mathcad", "MSIL – deprecated name for CIL", "MSL", "MUMPS", "Mystic Programming L"],
        maxTags: 10,
        dropdown: {
            maxItems: 20,           // <- maximum allowed rendered suggestions
            classname: 'tags-look', // <- custom classname for this dropdown, so it could be targeted
            enabled: 0,             // <- show suggestions on focus
            closeOnSelect: false    // <- do not hide the suggestions dropdown once an item has been selected
        }
    })

CSS

textarea

In this example, the field is pre-ocupied with 3 tags, and last tag is not included in the whitelist, and will be removed because the enforceWhitelist setting flag is set to true

🚩 This example is very interesting because it shows another layer of complexity - Films' names might include commas (,), and therefore it is very important to load initial values as Object Collection (Array of Objects) where each Object is proper JSON as shown in the example below, or else initial tags will not get parsed well if they include commas.

🚩 Another important thing to keep in mind is that the default delimiters setting of Tagify is to split tags by commas, and when tags (might) contain commas inside them, this setting should be changed to null, so when a user is typing, for example, a movie name which contains commans, a tag will not be created as soon as comma was inputed.

Code

HTML

<textarea name='tags2' placeholder='Movie names'> [{"value":"The Good, the Bad and the Ugly"}, {"value":"The Matrix"}]</textarea>

JAVASCRIPT

var input = document.querySelector('textarea[name=tags2]'),
    tagify = new Tagify(input, {
        enforceWhitelist : true,
        delimiters       : null,
        whitelist        : ["The Shawshank Redemption", "The Godfather", "The Godfather: Part II", "The Dark Knight", "12 Angry Men", "Schindler's List", "Pulp Fiction", "The Lord of the Rings: The Return of the King", "The Good, the Bad and the Ugly", "Fight Club", "The Lord of the Rings: The Fellowship of the Ring", "Star Wars: Episode V - The Empire Strikes Back", "Forrest Gump", "Inception", "The Lord of the Rings: The Two Towers", "One Flew Over the Cuckoo's Nest", "Goodfellas", "The Matrix", "Seven Samurai", "Star Wars: Episode IV - A New Hope", "City of God", "Se7en", "The Silence of the Lambs", "It's a Wonderful Life", "The Usual Suspects", "Life Is Beautiful", "Léon: The Professional", "Spirited Away", "Saving Private Ryan", "La La Land", "Once Upon a Time in the West", "American History X", "Interstellar", "Casablanca", "Psycho", "City Lights", "The Green Mile", "Raiders of the Lost Ark", "The Intouchables", "Modern Times", "Rear Window", "The Pianist", "The Departed", "Terminator 2: Judgment Day", "Back to the Future", "Whiplash", "Gladiator", "Memento", "Apocalypse Now", "The Prestige", "The Lion King", "Alien", "Dr. Strangelove or: How I Learned to Stop Worrying and Love the Bomb", "Sunset Boulevard", "The Great Dictator", "Cinema Paradiso", "The Lives of Others", "Paths of Glory", "Grave of the Fireflies", "Django Unchained", "The Shining", "WALL·E", "American Beauty", "The Dark Knight Rises", "Princess Mononoke", "Aliens", "Oldboy", "Once Upon a Time in America", "Citizen Kane", "Das Boot", "Witness for the Prosecution", "North by Northwest", "Vertigo", "Star Wars: Episode VI - Return of the Jedi", "Reservoir Dogs", "M", "Braveheart", "Amélie", "Requiem for a Dream", "A Clockwork Orange", "Taxi Driver", "Lawrence of Arabia", "Like Stars on Earth", "Double Indemnity", "To Kill a Mockingbird", "Eternal Sunshine of the Spotless Mind", "Toy Story 3", "Amadeus", "My Father and My Son", "Full Metal Jacket", "The Sting", "2001: A Space Odyssey", "Singin' in the Rain", "Bicycle Thieves", "Toy Story", "Dangal", "The Kid", "Inglourious Basterds", "Snatch", "Monty Python and the Holy Grail", "Hacksaw Ridge", "3 Idiots", "L.A. Confidential", "For a Few Dollars More", "Scarface", "Rashomon", "The Apartment", "The Hunt", "Good Will Hunting", "Indiana Jones and the Last Crusade", "A Separation", "Metropolis", "Yojimbo", "All About Eve", "Batman Begins", "Up", "Some Like It Hot", "The Treasure of the Sierra Madre", "Unforgiven", "Downfall", "Raging Bull", "The Third Man", "Die Hard", "Children of Heaven", "The Great Escape", "Heat", "Chinatown", "Inside Out", "Pan's Labyrinth", "Ikiru", "My Neighbor Totoro", "On the Waterfront", "Room", "Ran", "The Gold Rush", "The Secret in Their Eyes", "The Bridge on the River Kwai", "Blade Runner", "Mr. Smith Goes to Washington", "The Seventh Seal", "Howl's Moving Castle", "Lock, Stock and Two Smoking Barrels", "Judgment at Nuremberg", "Casino", "The Bandit", "Incendies", "A Beautiful Mind", "A Wednesday", "The General", "The Elephant Man", "Wild Strawberries", "Arrival", "V for Vendetta", "Warrior", "The Wolf of Wall Street", "Manchester by the Sea", "Sunrise", "The Passion of Joan of Arc", "Gran Torino", "Rang De Basanti", "Trainspotting", "Dial M for Murder", "The Big Lebowski", "The Deer Hunter", "Tokyo Story", "Gone with the Wind", "Fargo", "Finding Nemo", "The Sixth Sense", "The Thing", "Hera Pheri", "Cool Hand Luke", "Andaz Apna Apna", "Rebecca", "No Country for Old Men", "How to Train Your Dragon", "Munna Bhai M.B.B.S.", "Sholay", "Kill Bill: Vol. 1", "Into the Wild", "Mary and Max", "Gone Girl", "There Will Be Blood", "Come and See", "It Happened One Night", "Life of Brian", "Rush", "Hotel Rwanda", "Platoon", "Shutter Island", "Network", "The Wages of Fear", "Stand by Me", "Wild Tales", "In the Name of the Father", "Spotlight", "Star Wars: The Force Awakens", "The Nights of Cabiria", "The 400 Blows", "Butch Cassidy and the Sundance Kid", "Mad Max: Fury Road", "The Maltese Falcon", "12 Years a Slave", "Ben-Hur", "The Grand Budapest Hotel", "Persona", "Million Dollar Baby", "Amores Perros", "Jurassic Park", "The Princess Bride", "Hachi: A Dog's Tale", "Memories of Murder", "Stalker", "Nausicaä of the Valley of the Wind", "Drishyam", "The Truman Show", "The Grapes of Wrath", "Before Sunrise", "Touch of Evil", "Annie Hall", "The Message", "Rocky", "Gandhi", "Harry Potter and the Deathly Hallows: Part 2", "The Bourne Ultimatum", "Diabolique", "Donnie Darko", "Monsters, Inc.", "Prisoners", "8½", "The Terminator", "The Wizard of Oz", "Catch Me If You Can", "Groundhog Day", "Twelve Monkeys", "Zootopia", "La Haine", "Barry Lyndon", "Jaws", "The Best Years of Our Lives", "Infernal Affairs", "Udaan", "The Battle of Algiers", "Strangers on a Train", "Dog Day Afternoon", "Sin City", "Kind Hearts and Coronets", "Gangs of Wasseypur", "The Help"],
        callbacks        : {
            add    : console.log,  // callback when adding a tag
            remove : console.log   // callback when removing a tag
        }
    })

RTL & uncapped dropdown width

In this example, the Tagify field is inside a container which has dir='rtl' attribute and also the Tagify RTL setting for the dropdown is set accordingly (because it's better not infer it from the HTML but defined explicitly)

This example also showcases the ability to have the suggestions dropdown's maximum width as wide as the longest item in the suggestions list, but still not less wide than the Taigy field for which the dropdown "belongs".

Code

HTML

<div dir='rtl'>
    <input name='rtl-example' class='tagify--rtl-exmaple' placeholder='לחץ בשדה והוסף ערך'/>
</div>

JAVASCRIPT

// The DOM element you wish to replace with Tagify
var input = document.querySelector('input[name=rtl-example]');

// initialize Tagify on the above input node reference
new Tagify(input, {
    whitelist: [
        { value: "מיכאל כהן", full: "<em>מיכאל כהן</em> - פיתוח תוכנה מתקדם ויישום טכנולוגיות חדשניות בתחום התעשייה והייצור" },
        { value: "שרה לוי", full: "<em>שרה לוי</em> - ניהול ופיתוח פתרונות אקולוגיים וסביבתיים למתן יתרון תחרותי לעסקים" },
        { value: "אברהם גולן", full: "<em>אברהם גולן</em> - יישום ופיתוח טכנולוגיות מתקדמות לשיפור פרודוקטיביות ויצירתיות בארגונים" },
        { value: "רחל רביבו", full: "<em>רחל רביבו</em> - מחקר ופיתוח טכנולוגי בתחום החדשנות והיזמות לקידום עסקים ותעשיות" },
        { value: "דוד כהן", full: "<em>דוד כהן</em> - פיתוח ויישום טכנולוגיות מתקדמות לשיפור תשתיות מידע עסקיות" },
        { value: "רבקה אריאל", full: "<em>רבקה אריאל</em> - ייזום ופיתוח מוצרים חדשניים עבור תעשיות יצירתיות ומתקדמות" }
    ],
    dropdown: {
        mapValueTo: 'full',
        classname: 'tagify__dropdown--rtl-example',
        enabled: 0, // shows the suggestiosn dropdown once field is focused
        RTL: true,
        escapeHTML: false // allows HTML inside each suggestion item
    }
})

CSS

Easy to customize

The easiest way to customize styles (colors, borders, spacing, radii, etc.) is by using CSS variables.

No placeholder, and no way of adding tags from within the component, but only by clicking the (+) button, which is not related to Tagify in anyway, but in this example it is shown how combining a few simple things make customization easy.

(This example also shows how to implement minimum-allowed tags)

Code

HTML

<input class='customLook' value='some.name@website.com'><button type="button">+</button>

JAVASCRIPT

// generate random whilist items (for the demo)
var randomStringsArr = Array.apply(null, Array(100)).map(function () {
    return Array.apply(null, Array(~~(Math.random() * 10 + 3))).map(function () {
        return String.fromCharCode(Math.random() * (123 - 97) + 97)
    }).join('') + '@gmail.com'
})

var input = document.querySelector('.customLook'),
    button = input.nextElementSibling,
    tagify = new Tagify(input, {
        editTags: {
            keepInvalid: false, // better to auto-remove invalid tags which are in edit-mode (on blur)
        },
        // email address validation (https://stackoverflow.com/a/46181/104380)
        pattern: /^(([^<>()\[\]\\.,;:\s@"]+(\.[^<>()\[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$/,
        whitelist: randomStringsArr,
        callbacks: {
            "invalid": onInvalidTag
        },
        dropdown: {
            position: 'text',
            enabled: 1 // show suggestions dropdown after 1 typed character
        }
    });  // "add new tag" action-button

button.addEventListener("click", onAddButtonClick)

function onAddButtonClick() {
    tagify.addEmptyTag()
}

function onInvalidTag(e) {
    console.log("invalid", e.detail)
}

CSS

Mix text & tags

It is possible to configure Tagify to supoprt mixed content. A common example would be tagging people while writing a comment on a social website.

To allow mix content, simply pass the setting mode : 'mix'

In this example, there are a few Southpark character names and a few Simpsons ones. when @ is typed, following 1 more character, suggestions dropdown will show Southpark-only items, and when starting with #, Simpsons items list.

Note that the two whitelists are very different from eachother in teams of structure. The first is quite complex, as it uses numeric IDs as value ("value" prop is always unique), and the rendered text is placed in a custom property named "text".
The other whitelist, Simpsons is very basic, just a flat array of strings.

Note that "homer simpson" tag is set to readonly in this example. If tried to select all text and delete everything, readonly tags will remain.

When a textarea already has mixed-content and it wasn't pre-configured using a whitelist, the tags will ignored, so keep that in mind when populating a textarea with server data and expecting tags to "magically" appear. Whitelist must exist because not everything that starts with @ or # (or whatever was defined as pattern) is meant to be rendered as a tag.

This example also validates the tags using the validate setting with a function as a value.

Creating new tags:

To create new tags (ones not included in your whitelist collection), simply make sure to keep the enforceWhitelist setting as false, which is the default. After a new tags has been added, you should listen to the add and probably update your local state (Ex. server request).

Code

HTML

<textarea name='mix'>[[{"id":101, "value":"cartman", "title":"Eric Cartman"}]] and [[kyle]] do not know [[{"value":"homer simpson", "readonly":true}]] because he's a relic.</textarea>

JAVASCRIPT

// Define two types of whitelists, each used for the dropdown suggestions menu,
// depending on the prefix pattern typed (@/#). See settings below.
var whitelist_1 = [
    { value: 100, text: 'kenny', title: 'Kenny McCormick' },
    { value: 200, text: 'cartman', title: 'Eric Cartman' },
    { value: 300, text: 'kyle', title: 'Kyle Broflovski' },
    { value: 400, text: 'token', title: 'Token Black' },
    { value: 500, text: 'jimmy', title: 'Jimmy Valmer' },
    { value: 600, text: 'butters', title: 'Butters Stotch' },
    { value: 700, text: 'stan', title: 'Stan Marsh' },
    { value: 800, text: 'randy', title: 'Randy Marsh' },
    { value: 900, text: 'Mr. Garrison', title: 'POTUS' },
    { value: 1000, text: 'Mr. Mackey', title: "M'Kay" }
  ]

// Second whitelist, which is shown only when starting to type "#".
// Below whitelist is the simplest possible format.
var whitelist_2 = ['Homer simpson', 'Marge simpson', 'Bart', 'Lisa', 'Maggie', 'Mr. Burns', 'Ned', 'Milhouse', 'Moe'];


// initialize Tagify
var input = document.querySelector('[name=mix]'),
    // init Tagify script on the above inputs
    tagify = new Tagify(input, {
    //  mixTagsInterpolator: [", "],
        mode: 'mix',  // <--  Enable mixed-content
        pattern: /@|#/,  // <--  Text starting with @ or # (if single, String can be used here)
        tagTextProp: 'text',  // <-- the default property (from whitelist item) for the text to be rendered in a tag element.
        // Array for initial interpolation, which allows only these tags to be used
        whitelist: whitelist_1.concat(whitelist_2).map(function(item){
            return typeof item == 'string' ? {value:item} : item
        }),

        // custom validation - no special characters
        validate(data){
            return !/[^a-zA-Z0-9 ]/.test(data.value)
        },

        dropdown : {
            enabled: 1,
            position: 'text', // <-- render the suggestions list next to the typed text ("caret")
            mapValueTo: 'text', // <-- similar to above "tagTextProp" setting, but for the dropdown items
            highlightFirst: true  // automatically highlights first sugegstion item in the dropdown
        },
        callbacks: {
            add: console.log,  // callback when adding a tag
            remove: console.log   // callback when removing a tag
        }
    })


// A good place to pull server suggestion list accoring to the prefix/value
tagify.on('input', function(e){
    var prefix = e.detail.prefix;

    // first, clean the whitlist array, because the below code, while not, might be async,
    // therefore it should be up to you to decide WHEN to render the suggestions dropdown
    // tagify.settings.whitelist.length = 0;

    if( prefix ){
        if( prefix == '@' )
            tagify.whitelist = whitelist_1;

        if( prefix == '#' )
            tagify.whitelist = whitelist_2;

        if( e.detail.value.length > 1 )
            tagify.dropdown.show(e.detail.value);
    }

    console.log( tagify.value )
    console.log('mix-mode "input" event value: ', e.detail)
})

tagify.on('add', function(e){
    console.log(e)
})

outside-of-the-box

Some designs might require showing the tags outside of the input box, so to set this up some manual CSS changes has to be made, and also the dropdown.position setting should be set to "input" so the suggestions dropdown will be rendered right next to input element and not relative to the whole component (which is the default)

Code

HTML

<input name='tags-outside' class='tagify--outside' value='tag1, tag2, tag3' placeholder='write tags to add below'>

JAVASCRIPT

var input = document.querySelector('input[name=tags-outside]')

var tagify = new Tagify(input, {
    whitelist: ['foo', 'bar', 'baz'],
    focusable: false,
    dropdown: {
        position: 'input',
        enabled: 0 // always opens dropdown when input gets focus
    }
})

CSS

Render suggestions list manually

Renders the suggestions list manually - useful for situations where it is wished showing the suggestions list inside a modal or your own popup implementaion, or even always show it. In this example the list is always shown.

Code

HTML

<input name='tags-manual-suggestions' placeholder='write some tags'>
<h3>☝ Add items from below list:</h3>

JAVASCRIPT

var input = document.querySelector('input[name=tags-manual-suggestions]'),
    // init Tagify script on the above inputs
    tagify = new Tagify(input, {
        whitelist: ["A# .NET", "A# (Axiom)", "A-0 System", "A+", "A++", "ABAP", "ABC", "ABC ALGOL", "ABSET", "ABSYS", "ACC", "Accent", "Ace DASL", "ACL2", "Avicsoft", "ACT-III", "Action!", "ActionScript", "Ada", "Adenine", "Agda", "Agilent VEE", "Agora", "AIMMS", "Alef", "ALF", "ALGOL 58", "ALGOL 60", "ALGOL 68", "ALGOL W", "Alice", "Alma-0", "AmbientTalk", "Amiga E", "AMOS", "AMPL", "Apex (Salesforce.com)", "APL", "AppleScript", "Arc", "ARexx", "Argus", "AspectJ", "Assembly language", "ATS", "Ateji PX", "AutoHotkey", "Autocoder", "AutoIt", "AutoLISP / Visual LISP", "Averest", "AWK", "Axum", "Active Server Pages", "ASP.NET", "B", "Babbage", "Bash", "BASIC", "bc", "BCPL", "BeanShell", "Batch (Windows/Dos)", "Bertrand", "BETA", "Bigwig", "Bistro", "BitC", "BLISS", "Blockly", "BlooP", "Blue", "Boo", "Boomerang", "Bourne shell (including bash and ksh)", "BREW", "BPEL", "B", "C--", "C++ – ISO/IEC 14882", "C# – ISO/IEC 23270", "C/AL", "Caché ObjectScript", "C Shell", "Caml", "Cayenne", "CDuce", "Cecil", "Cesil", "Céu", "Ceylon", "CFEngine", "CFML", "Cg", "Ch", "Chapel", "Charity", "Charm", "Chef", "CHILL", "CHIP-8", "chomski", "ChucK", "CICS", "Cilk", "Citrine (programming language)", "CL (IBM)", "Claire", "Clarion", "Clean", "Clipper", "CLIPS", "CLIST", "Clojure", "CLU", "CMS-2", "COBOL – ISO/IEC 1989", "CobolScript – COBOL Scripting language", "Cobra", "CODE", "CoffeeScript", "ColdFusion", "COMAL", "Combined Programming Language (CPL)", "COMIT", "Common Intermediate Language (CIL)", "Common Lisp (also known as CL)", "COMPASS", "Component Pascal", "Constraint Handling Rules (CHR)", "COMTRAN", "Converge", "Cool", "Coq", "Coral 66", "Corn", "CorVision", "COWSEL", "CPL", "CPL", "Cryptol", "csh", "Csound", "CSP", "CUDA", "Curl", "Curry", "Cybil", "Cyclone", "Cython", "Java", "Javascript", "M2001", "M4", "M#", "Machine code", "MAD (Michigan Algorithm Decoder)", "MAD/I", "Magik", "Magma", "make", "Maple", "MAPPER now part of BIS", "MARK-IV now VISION:BUILDER", "Mary", "MASM Microsoft Assembly x86", "MATH-MATIC", "Mathematica", "MATLAB", "Maxima (see also Macsyma)", "Max (Max Msp – Graphical Programming Environment)", "Maya (MEL)", "MDL", "Mercury", "Mesa", "Metafont", "Microcode", "MicroScript", "MIIS", "Milk (programming language)", "MIMIC", "Mirah", "Miranda", "MIVA Script", "ML", "Model 204", "Modelica", "Modula", "Modula-2", "Modula-3", "Mohol", "MOO", "Mortran", "Mouse", "MPD", "Mathcad", "MSIL – deprecated name for CIL", "MSL", "MUMPS", "Mystic Programming L"],
        dropdown: {
            position: "manual",
            maxItems: Infinity,
            enabled: 0,
            classname: "customSuggestionsList"
        },
        templates: {
            dropdownItemNoMatch() {
                return `<div class='empty'>Nothing Found</div>`;
            }
        },
        enforceWhitelist: true
    })

tagify.on("dropdown:show", onSuggestionsListUpdate)
      .on("dropdown:hide", onSuggestionsListHide)
      .on('dropdown:scroll', onDropdownScroll)

renderSuggestionsList()  // defined down below

// ES2015 argument destructuring
function onSuggestionsListUpdate({ detail: suggestionsElm }) {
    console.log(suggestionsElm)
}

function onSuggestionsListHide() {
    console.log("hide dropdown")
}

function onDropdownScroll(e) {
    console.log(e.detail)
}

// https://developer.mozilla.org/en-US/docs/Web/API/Element/insertAdjacentElement
function renderSuggestionsList() {
    tagify.dropdown.show() // load the list
    tagify.DOM.scope.parentNode.appendChild(tagify.DOM.dropdown)
}

CSS

disabled-user-input

User cannot type or paste any input not edit already-exiting tags.
Tags can only be selected from the suggestions list (whitelist) dropdown.

Code

HTML

<input name='disabled-user-input' placeholder='Select tags from the list'>

JAVASCRIPT

var input = document.querySelector('input[name=disabled-user-input]'),
    tagify = new Tagify(input, {
        whitelist: [1,2,3,4,5],
        userInput: false
    })

users-list

This example shows how to customize Tagify further. It also includes an Add All option as the first item in the suggestions dropdown list.

tagTextProp is very interesting in this example as it allows inputing both a value or a name and have them both match against the whitelist items. First the "value" is looked for, and if failed, then prop which was defined by the tagTextProp setting.

Code

HTML

<input name='users-list-tags' class='users-list' value='abatisse2@nih.gov, Justinian Hattersley'>

JAVASCRIPT

var inputElm = document.querySelector('input[name=users-list-tags]');

function tagTemplate(tagData) {
    return `
        <tag title="${tagData.email}"
                contenteditable='false'
                spellcheck='false'
                tabIndex="-1"
                class="tagify__tag ${tagData.class ? tagData.class : ""}"
                ${this.getAttributes(tagData)}>
            <x title='' class='tagify__tag__removeBtn' role='button' aria-label='remove tag'></x>
            <div>
                <div class='tagify__tag__avatar-wrap'>
                    <img onerror="this.style.visibility='hidden'" src="${tagData.avatar}">
                </div>
                <span class='tagify__tag-text'>${tagData.name}</span>
            </div>
        </tag>
    `
}

function suggestionItemTemplate(tagData) {
    return `
        <div ${this.getAttributes(tagData)}
            class='tagify__dropdown__item ${tagData.class ? tagData.class : ""}'
            tabindex="0"
            role="option">
            ${tagData.avatar ? `
                <div class='tagify__dropdown__item__avatar-wrap'>
                    <img onerror="this.style.visibility='hidden'" src="${tagData.avatar}">
                </div>` : ''
        }
            <strong>${tagData.name}</strong>
            <span>${tagData.email}</span>
        </div>
    `
}

function dropdownHeaderTemplate(suggestions) {
    return `
        <header data-selector='tagify-suggestions-header' class="${this.settings.classNames.dropdownItem} ${this.settings.classNames.dropdownItem}__addAll">
            <strong style='grid-area: add'>${this.value.length ? `Add Remaning` : 'Add All'}</strong>
            <span style='grid-area: remaning'>${suggestions.length} members</span>
            <a class='remove-all-tags'>Remove all</a>
        </header>
    `
}

// initialize Tagify on the above input node reference
var tagify = new Tagify(inputElm, {
    tagTextProp: 'name', // very important since a custom template is used with this property as text
    // enforceWhitelist: true,
    skipInvalid: true, // do not remporarily add invalid tags
    dropdown: {
        closeOnSelect: false,
        enabled: 0,
        classname: 'users-list',
        searchKeys: ['name', 'email']  // very important to set by which keys to search for suggesttions when typing
    },
    templates: {
        tag: tagTemplate,
        dropdownItem: suggestionItemTemplate,
        dropdownHeader: dropdownHeaderTemplate
    },
    whitelist: [
        {
            "value": 1,
            "name": "Justinian Hattersley",
            "avatar": "https://i.pravatar.cc/80?img=1",
            "email": "jhattersley0@ucsd.edu",
            "team": "A"
        },
        {
            "value": 2,
            "name": "Antons Esson",
            "avatar": "https://i.pravatar.cc/80?img=2",
            "email": "aesson1@ning.com",
            "team": "B"

        },
        {
            "value": 3,
            "name": "Ardeen Batisse",
            "avatar": "https://i.pravatar.cc/80?img=3",
            "email": "abatisse2@nih.gov",
            "team": "A"
        },
        {
            "value": 4,
            "name": "Graeme Yellowley",
            "avatar": "https://i.pravatar.cc/80?img=4",
            "email": "gyellowley3@behance.net",
            "team": "C"
        },
        {
            "value": 5,
            "name": "Dido Wilford",
            "avatar": "https://i.pravatar.cc/80?img=5",
            "email": "dwilford4@jugem.jp",
            "team": "A"
        },
        {
            "value": 6,
            "name": "Celesta Orwin",
            "avatar": "https://i.pravatar.cc/80?img=6",
            "email": "corwin5@meetup.com",
            "team": "C"
        },
        {
            "value": 7,
            "name": "Sally Main",
            "avatar": "https://i.pravatar.cc/80?img=7",
            "email": "smain6@techcrunch.com",
            "team": "A"
        },
        {
            "value": 8,
            "name": "Grethel Haysman",
            "avatar": "https://i.pravatar.cc/80?img=8",
            "email": "ghaysman7@mashable.com",
            "team": "B"
        },
        {
            "value": 9,
            "name": "Marvin Mandrake",
            "avatar": "https://i.pravatar.cc/80?img=9",
            "email": "mmandrake8@sourceforge.net",
            "team": "B"
        },
        {
            "value": 10,
            "name": "Corrie Tidey",
            "avatar": "https://i.pravatar.cc/80?img=10",
            "email": "ctidey9@youtube.com",
            "team": "A"
        },
        {
            "value": 11,
            "name": "foo",
            "avatar": "https://i.pravatar.cc/80?img=11",
            "email": "foo@bar.com",
            "team": "B"
        },
        {
            "value": 12,
            "name": "foo",
            "avatar": "https://i.pravatar.cc/80?img=12",
            "email": "foo.aaa@foo.com",
            "team": "A"
        },
    ],

    transformTag: (tagData, originalData) => {
        var { name, email } = parseFullValue(tagData.name)
        tagData.name = name
        tagData.email = email || tagData.email
    },

    validate({ name, email }) {
        // when editing a tag, there will only be the "name" property which contains name + email (see 'transformTag' above)
        if (!email && name) {
            var parsed = parseFullValue(name)
            name = parsed.name
            email = parsed.email
        }

        if (!name) return "Missing name"
        if (!validateEmail(email)) return "Invalid email"

        return true
    }
})

// The below code is printed as escaped, so please copy this function from:
// https://github.com/yairEO/tagify/blob/master/src/parts/helpers.js#L89-L97
function escapeHTML(s) {
    return typeof s == 'string' ? s
        .replace(/&/g, "&amp;")
        .replace(/</g, "&lt;")
        .replace(/>/g, "&gt;")
        .replace(/"/g, "&quot;")
        .replace(/`|'/g, "&#039;")
        : s;
}

// The below part is only if you want to split the users into groups, when rendering the suggestions list dropdown:
// (since each user also has a 'team' property)
tagify.dropdown.createListHTML = sugegstionsList => {
    const teamsOfUsers = sugegstionsList.reduce((acc, suggestion) => {
        const team = suggestion.team || 'Not Assigned';

        if (!acc[team])
            acc[team] = [suggestion]
        else
            acc[team].push(suggestion)

        return acc
    }, {})

    const getUsersSuggestionsHTML = teamUsers => teamUsers.map((suggestion, idx) => {
        if (typeof suggestion == 'string' || typeof suggestion == 'number')
            suggestion = { value: suggestion }

        var value = tagify.dropdown.getMappedValue.call(tagify, suggestion)

        suggestion.value = value && typeof value == 'string' ? escapeHTML(value) : value

        return tagify.settings.templates.dropdownItem.apply(tagify, [suggestion]);
    }).join("")


    // assign the user to a group
    return Object.entries(teamsOfUsers).map(([team, teamUsers]) => {
        return `<div class="tagify__dropdown__itemsGroup" data-title="Team ${team}:">${getUsersSuggestionsHTML(teamUsers)}</div>`
    }).join("")
}

// attach events listeners
tagify.on('dropdown:select', onSelectSuggestion) // allows selecting all the suggested (whitelist) items
      .on('edit:start', onEditStart)  // show custom text in the tag while in edit-mode

function onSelectSuggestion(e) {
    if (e.detail.event.target.matches('.remove-all-tags')) {
        tagify.removeAllTags()
    }

    // custom class from "dropdownHeaderTemplate"
    else if (e.detail.elm.classList.contains(`${tagify.settings.classNames.dropdownItem}__addAll`))
        tagify.dropdown.selectAll();
}

function onEditStart({ detail: { tag, data } }) {
    tagify.setTagTextNode(tag, `${data.name} <${data.email}>`)
}

// https://stackoverflow.com/a/9204568/104380
function validateEmail(email) {
    return /^[^\s@]+@[^\s@]+\.[^\s@]+$/.test(email)
}

function parseFullValue(value) {
    // https://stackoverflow.com/a/11592042/104380
    var parts = value.split(/<(.*?)>/g),
        name = parts[0].trim(),
        email = parts[1]?.replace(/<(.*?)>/g, '').trim();

    return { name, email }
}

CSS

advance-options

In this example, the dropdown.enabled setting is set (minimum charactes typed to show the dropdown) to 3.
Maximum number of tags is set to 6

Each (valid) tag gets a random color, via the transformTag callback which modifies the tag's data object before creating the tag element. Another way of giving colors to tags is discussed here. Clicking a tag once will change its color.

HTML5 pattern attribute is automatically used to validate tags.
Also, the delimiters setting using both comma or space as tags seperators.

The keepInvalidTags setting flag is switched on to true so invaild tags are not removed but are only marked.

If there is no match for the typed text, a special dropdown item will be renderd using the optional settings: templates.dropdownItemNoMatch

Code

HTML

<input class='advance-options' value='[{"value":"point"}, {"value":"soft"}]' pattern='^[A-Za-z_✲ ]{1,15}$'>

JAVASCRIPT

var input = document.querySelector('input.advance-options'),
    tagify = new Tagify(input, {
        pattern             : /^.{0,20}$/,  // Validate typed tag(s) by Regex. Here maximum chars length is defined as "20"
        delimiters          : ",| ",        // add new tags when a comma or a space character is entered
        trim                : false,        // if "delimiters" setting is using space as a delimeter, then "trim" should be set to "false"
        keepInvalidTags     : true,         // do not remove invalid tags (but keep them marked as invalid)
        // createInvalidTags: false,
        editTags            : {
            clicks: 2,              // single click to edit a tag
            keepInvalid: false      // if after editing, tag is invalid, auto-revert
        },
        maxTags             : 6,
        blacklist           : ["foo", "bar", "baz"],
        whitelist           : ["temple","stun","detective","sign","passion","routine","deck","discriminate","relaxation","fraud","attractive","soft","forecast","point","thank","stage","eliminate","effective","flood","passive","skilled","separation","contact","compromise","reality","district","nationalist","leg","porter","conviction","worker","vegetable","commerce","conception","particle","honor","stick","tail","pumpkin","core","mouse","egg","population","unique","behavior","onion","disaster","cute","pipe","sock","dialect","horse","swear","owner","cope","global","improvement","artist","shed","constant","bond","brink","shower","spot","inject","bowel","homosexual","trust","exclude","tough","sickness","prevalence","sister","resolution","cattle","cultural","innocent","burial","bundle","thaw","respectable","thirsty","exposure","team","creed","facade","calendar","filter","utter","dominate","predator","discover","theorist","hospitality","damage","woman","rub","crop","unpleasant","halt","inch","birthday","lack","throne","maximum","pause","digress","fossil","policy","instrument","trunk","frame","measure","hall","support","convenience","house","partnership","inspector","looting","ranch","asset","rally","explicit","leak","monarch","ethics","applied","aviation","dentist","great","ethnic","sodium","truth","constellation","lease","guide","break","conclusion","button","recording","horizon","council","paradox","bride","weigh","like","noble","transition","accumulation","arrow","stitch","academy","glimpse","case","researcher","constitutional","notion","bathroom","revolutionary","soldier","vehicle","betray","gear","pan","quarter","embarrassment","golf","shark","constitution","club","college","duty","eaux","know","collection","burst","fun","animal","expectation","persist","insure","tick","account","initiative","tourist","member","example","plant","river","ratio","view","coast","latest","invite","help","falsify","allocation","degree","feel","resort","means","excuse","injury","pupil","shaft","allow","ton","tube","dress","speaker","double","theater","opposed","holiday","screw","cutting","picture","laborer","conservation","kneel","miracle","brand","nomination","characteristic","referral","carbon","valley","hot","climb","wrestle","motorist","update","loot","mosquito","delivery","eagle","guideline","hurt","feedback","finish","traffic","competence","serve","archive","feeling","hope","seal","ear","oven","vote","ballot","study","negative","declaration","particular","pattern","suburb","intervention","brake","frequency","drink","affair","contemporary","prince","dry","mole","lazy","undermine","radio","legislation","circumstance","bear","left","pony","industry","mastermind","criticism","sheep","failure","chain","depressed","launch","script","green","weave","please","surprise","doctor","revive","banquet","belong","correction","door","image","integrity","intermediate","sense","formal","cane","gloom","toast","pension","exception","prey","random","nose","predict","needle","satisfaction","establish","fit","vigorous","urgency","X-ray","equinox","variety","proclaim","conceive","bulb","vegetarian","available","stake","publicity","strikebreaker","portrait","sink","frog","ruin","studio","match","electron","captain","channel","navy","set","recommend","appoint","liberal","missile","sample","result","poor","efflux","glance","timetable","advertise","personality","aunt","dog"],
        transformTag        : transformTag,
        backspace           : "edit",
        placeholder         : "Type something",
        dropdown : {
            enabled: 1,            // show suggestion after 1 typed character
            fuzzySearch: false,    // match only suggestions that starts with the typed characters
            position: 'text',      // position suggestions list next to typed text
            caseSensitive: true,   // allow adding duplicate items if their case is different
        },
        templates: {
            dropdownItemNoMatch: function(data) {
                return `<div class='${this.settings.classNames.dropdownItem}' value="noMatch" tabindex="0" role="option">No suggestion found for: <strong>${data.value}</strong></div>`
            }
        }
    })

tagify.on('change', updatePlaceholderByTagsCount);

function updatePlaceholderByTagsCount() {
    tagify.setPlaceholder(`${tagify.value.length || 'no'} tags added`)
}

updatePlaceholderByTagsCount()

// generate a random color (in HSL format, which I like to use)
function getRandomColor(){
    function rand(min, max) {
        return min + Math.random() * (max - min);
    }

    var h = rand(1, 360)|0,
        s = rand(40, 70)|0,
        l = rand(65, 72)|0;

    return 'hsl(' + h + ',' + s + '%,' + l + '%)';
}

function transformTag( tagData ){
    tagData.color = getRandomColor();
    tagData.style = "--tag-bg:" + tagData.color;

    if( tagData.value.toLowerCase() == 'shit' )
        tagData.value = 's✲✲t'
}

tagify.on('add', function(e){
    console.log(e.detail)
})

tagify.on('invalid', function(e){
    console.log(e, e.detail);
})

var clickDebounce;

tagify.on('click', function(e){
    const {tag:tagElm, data:tagData} = e.detail;

    // a delay is needed to distinguish between regular click and double-click.
    // this allows enough time for a possible double-click, and noly fires if such
    // did not occur.
    clearTimeout(clickDebounce);
    clickDebounce = setTimeout(() => {
        tagData.color = getRandomColor();
        tagData.style = "--tag-bg:" + tagData.color;
        tagify.replaceTag(tagElm, tagData);
    }, 200);
})

tagify.on('dblclick', function(e){
    // when souble clicking, do not change the color of the tag
    clearTimeout(clickDebounce);
})

CSS

Tags with properties

Some cases requires more control per-tag, for example, sending a different value to the server than the textual value the user sees/entered.

Another example, would be different colors for different tags or tags' groups.

It's possible to add any number of properties for a tag. The only constant is the value property which must be unique and declared per-tag, and by default that will be the rendered text, unless specified otherwise using the settings.

The properties shown in the example below, declared in the allowedTags Array, will be transformed into HTML attributes for each tag element rendered from the allowed whitelist settings, so naturally some attributes are in the specs and the made-up ones should technically be prefixed with data-.

💡 In this example, some countries have an extra property searchBy which is used for smarter suggestions matching when the user types something.

Code

HTML

<input class='countries' name='extra-properties' placeholder="Try adding tags from the list">

JAVASCRIPT

var tagify = new Tagify(document.querySelector('input[name=extra-properties]'), {
    delimiters: null,
    templates: {
        tag: function (tagData) {
            try {
                return `<tag title='${tagData.value}' contenteditable='false' spellcheck="false" class='tagify__tag ${tagData.class ? tagData.class : ""}' ${this.getAttributes(tagData)}>
                        <x title='remove tag' class='tagify__tag__removeBtn'></x>
                        <div>
                            ${tagData.code ?
                        `<img onerror="this.style.visibility='hidden'" src='https://flagicons.lipis.dev/flags/4x3/${tagData.code.toLowerCase()}.svg'>` : ''
                    }
                            <span class='tagify__tag-text'>${tagData.value}</span>
                        </div>
                    </tag>`
            }
            catch (err) { }
        },

        dropdownItem: function (tagData) {
            try {
                return `<div ${this.getAttributes(tagData)} class='tagify__dropdown__item ${tagData.class ? tagData.class : ""}' >
                            <img onerror="this.style.visibility = 'hidden'"
                                src='https://flagicons.lipis.dev/flags/4x3/${tagData.code.toLowerCase()}.svg'>
                            <span>${tagData.value}</span>
                        </div>`
            }
            catch (err) { console.error(err) }
        }
    },
    enforceWhitelist: true,
    whitelist: [
        { value: 'Afghanistan', code: 'AF' },
        { value: 'Åland Islands', code: 'AX' },
        { value: 'Albania', code: 'AL' },
        { value: 'Algeria', code: 'DZ' },
        { value: 'American Samoa', code: 'AS' },
        { value: 'Andorra', code: 'AD' },
        { value: 'Angola', code: 'AO' },
        { value: 'Anguilla', code: 'AI' },
        { value: 'Antarctica', code: 'AQ' },
        { value: 'Antigua and Barbuda', code: 'AG' },
        { value: 'Argentina', code: 'AR' },
        { value: 'Armenia', code: 'AM' },
        { value: 'Aruba', code: 'AW' },
        { value: 'Australia', code: 'AU', searchBy: 'beach, sub-tropical' },
        { value: 'Austria', code: 'AT' },
        { value: 'Azerbaijan', code: 'AZ' },
        { value: 'Bahamas', code: 'BS' },
        { value: 'Bahrain', code: 'BH' },
        { value: 'Bangladesh', code: 'BD' },
        { value: 'Barbados', code: 'BB' },
        { value: 'Belarus', code: 'BY' },
        { value: 'Belgium', code: 'BE' },
        { value: 'Belize', code: 'BZ' },
        { value: 'Benin', code: 'BJ' },
        { value: 'Bermuda', code: 'BM' },
        { value: 'Bhutan', code: 'BT' },
        { value: 'Bolivia', code: 'BO' },
        { value: 'Bosnia and Herzegovina', code: 'BA' },
        { value: 'Botswana', code: 'BW' },
        { value: 'Bouvet Island', code: 'BV' },
        { value: 'Brazil', code: 'BR' },
        { value: 'British Indian Ocean Territory', code: 'IO' },
        { value: 'Brunei Darussalam', code: 'BN' },
        { value: 'Bulgaria', code: 'BG' },
        { value: 'Burkina Faso', code: 'BF' },
        { value: 'Burundi', code: 'BI' },
        { value: 'Cambodia', code: 'KH' },
        { value: 'Cameroon', code: 'CM' },
        { value: 'Canada', code: 'CA' },
        { value: 'Cape Verde', code: 'CV' },
        { value: 'Cayman Islands', code: 'KY' },
        { value: 'Central African Republic', code: 'CF' },
        { value: 'Chad', code: 'TD' },
        { value: 'Chile', code: 'CL' },
        { value: 'China', code: 'CN' },
        { value: 'Christmas Island', code: 'CX' },
        { value: 'Cocos (Keeling) Islands', code: 'CC' },
        { value: 'Colombia', code: 'CO' },
        { value: 'Comoros', code: 'KM' },
        { value: 'Congo', code: 'CG' },
        { value: 'Congo, The Democratic Republic of the', code: 'CD' },
        { value: 'Cook Islands', code: 'CK' },
        { value: 'Costa Rica', code: 'CR' },
        { value: 'Cote D\'Ivoire', code: 'CI' },
        { value: 'Croatia', code: 'HR' },
        { value: 'Cuba', code: 'CU' },
        { value: 'Cyprus', code: 'CY' },
        { value: 'Czech Republic', code: 'CZ' },
        { value: 'Denmark', code: 'DK' },
        { value: 'Djibouti', code: 'DJ' },
        { value: 'Dominica', code: 'DM' },
        { value: 'Dominican Republic', code: 'DO' },
        { value: 'Ecuador', code: 'EC' },
        { value: 'Egypt', code: 'EG' },
        { value: 'El Salvador', code: 'SV' },
        { value: 'Equatorial Guinea', code: 'GQ' },
        { value: 'Eritrea', code: 'ER' },
        { value: 'Estonia', code: 'EE' },
        { value: 'Ethiopia', code: 'ET' },
        { value: 'Falkland Islands (Malvinas)', code: 'FK' },
        { value: 'Faroe Islands', code: 'FO' },
        { value: 'Fiji', code: 'FJ' },
        { value: 'Finland', code: 'FI' },
        { value: 'France', code: 'FR' },
        { value: 'French Guiana', code: 'GF' },
        { value: 'French Polynesia', code: 'PF' },
        { value: 'French Southern Territories', code: 'TF' },
        { value: 'Gabon', code: 'GA' },
        { value: 'Gambia', code: 'GM' },
        { value: 'Georgia', code: 'GE' },
        { value: 'Germany', code: 'DE' },
        { value: 'Ghana', code: 'GH' },
        { value: 'Gibraltar', code: 'GI' },
        { value: 'Greece', code: 'GR' },
        { value: 'Greenland', code: 'GL' },
        { value: 'Grenada', code: 'GD' },
        { value: 'Guadeloupe', code: 'GP' },
        { value: 'Guam', code: 'GU' },
        { value: 'Guatemala', code: 'GT' },
        { value: 'Guernsey', code: 'GG' },
        { value: 'Guinea', code: 'GN' },
        { value: 'Guinea-Bissau', code: 'GW' },
        { value: 'Guyana', code: 'GY' },
        { value: 'Haiti', code: 'HT' },
        { value: 'Heard Island and Mcdonald Islands', code: 'HM' },
        { value: 'Holy See (Vatican City State)', code: 'VA' },
        { value: 'Honduras', code: 'HN' },
        { value: 'Hong Kong', code: 'HK' },
        { value: 'Hungary', code: 'HU' },
        { value: 'Iceland', code: 'IS' },
        { value: 'India', code: 'IN' },
        { value: 'Indonesia', code: 'ID' },
        { value: 'Iran, Islamic Republic Of', code: 'IR' },
        { value: 'Iraq', code: 'IQ' },
        { value: 'Ireland', code: 'IE' },
        { value: 'Isle of Man', code: 'IM' },
        { value: 'Israel', code: 'IL', searchBy: 'holy land, desert' },
        { value: 'Italy', code: 'IT' },
        { value: 'Jamaica', code: 'JM' },
        { value: 'Japan', code: 'JP' },
        { value: 'Jersey', code: 'JE' },
        { value: 'Jordan', code: 'JO' },
        { value: 'Kazakhstan', code: 'KZ' },
        { value: 'Kenya', code: 'KE' },
        { value: 'Kiribati', code: 'KI' },
        { value: 'Korea, Democratic People\'S Republic of', code: 'KP' },
        { value: 'Korea, Republic of', code: 'KR' },
        { value: 'Kuwait', code: 'KW' },
        { value: 'Kyrgyzstan', code: 'KG' },
        { value: 'Lao People\'S Democratic Republic', code: 'LA' },
        { value: 'Latvia', code: 'LV' },
        { value: 'Lebanon', code: 'LB' },
        { value: 'Lesotho', code: 'LS' },
        { value: 'Liberia', code: 'LR' },
        { value: 'Libyan Arab Jamahiriya', code: 'LY' },
        { value: 'Liechtenstein', code: 'LI' },
        { value: 'Lithuania', code: 'LT' },
        { value: 'Luxembourg', code: 'LU' },
        { value: 'Macao', code: 'MO' },
        { value: 'Macedonia, The Former Yugoslav Republic of', code: 'MK' },
        { value: 'Madagascar', code: 'MG' },
        { value: 'Malawi', code: 'MW' },
        { value: 'Malaysia', code: 'MY' },
        { value: 'Maldives', code: 'MV' },
        { value: 'Mali', code: 'ML' },
        { value: 'Malta', code: 'MT' },
        { value: 'Marshall Islands', code: 'MH' },
        { value: 'Martinique', code: 'MQ' },
        { value: 'Mauritania', code: 'MR' },
        { value: 'Mauritius', code: 'MU' },
        { value: 'Mayotte', code: 'YT' },
        { value: 'Mexico', code: 'MX' },
        { value: 'Micronesia, Federated States of', code: 'FM' },
        { value: 'Moldova, Republic of', code: 'MD' },
        { value: 'Monaco', code: 'MC' },
        { value: 'Mongolia', code: 'MN' },
        { value: 'Montserrat', code: 'MS' },
        { value: 'Morocco', code: 'MA' },
        { value: 'Mozambique', code: 'MZ' },
        { value: 'Myanmar', code: 'MM' },
        { value: 'Namibia', code: 'NA' },
        { value: 'Nauru', code: 'NR' },
        { value: 'Nepal', code: 'NP' },
        { value: 'Netherlands', code: 'NL' },
        { value: 'Netherlands Antilles', code: 'AN' },
        { value: 'New Caledonia', code: 'NC' },
        { value: 'New Zealand', code: 'NZ' },
        { value: 'Nicaragua', code: 'NI' },
        { value: 'Niger', code: 'NE' },
        { value: 'Nigeria', code: 'NG' },
        { value: 'Niue', code: 'NU' },
        { value: 'Norfolk Island', code: 'NF' },
        { value: 'Northern Mariana Islands', code: 'MP' },
        { value: 'Norway', code: 'NO' },
        { value: 'Oman', code: 'OM' },
        { value: 'Pakistan', code: 'PK' },
        { value: 'Palau', code: 'PW' },
        { value: 'Palestinian Territory, Occupied', code: 'PS' },
        { value: 'Panama', code: 'PA' },
        { value: 'Papua New Guinea', code: 'PG' },
        { value: 'Paraguay', code: 'PY' },
        { value: 'Peru', code: 'PE' },
        { value: 'Philippines', code: 'PH' },
        { value: 'Pitcairn', code: 'PN' },
        { value: 'Poland', code: 'PL' },
        { value: 'Portugal', code: 'PT' },
        { value: 'Puerto Rico', code: 'PR' },
        { value: 'Qatar', code: 'QA' },
        { value: 'Reunion', code: 'RE' },
        { value: 'Romania', code: 'RO' },
        { value: 'Russian Federation', code: 'RU' },
        { value: 'RWANDA', code: 'RW' },
        { value: 'Saint Helena', code: 'SH' },
        { value: 'Saint Kitts and Nevis', code: 'KN' },
        { value: 'Saint Lucia', code: 'LC' },
        { value: 'Saint Pierre and Miquelon', code: 'PM' },
        { value: 'Saint Vincent and the Grenadines', code: 'VC' },
        { value: 'Samoa', code: 'WS' },
        { value: 'San Marino', code: 'SM' },
        { value: 'Sao Tome and Principe', code: 'ST' },
        { value: 'Saudi Arabia', code: 'SA' },
        { value: 'Senegal', code: 'SN' },
        { value: 'Serbia and Montenegro', code: 'CS' },
        { value: 'Seychelles', code: 'SC' },
        { value: 'Sierra Leone', code: 'SL' },
        { value: 'Singapore', code: 'SG' },
        { value: 'Slovakia', code: 'SK' },
        { value: 'Slovenia', code: 'SI' },
        { value: 'Solomon Islands', code: 'SB' },
        { value: 'Somalia', code: 'SO' },
        { value: 'South Africa', code: 'ZA' },
        { value: 'South Georgia and the South Sandwich Islands', code: 'GS' },
        { value: 'Spain', code: 'ES' },
        { value: 'Sri Lanka', code: 'LK' },
        { value: 'Sudan', code: 'SD' },
        { value: 'Suriname', code: 'SR' },
        { value: 'Svalbard and Jan Mayen', code: 'SJ' },
        { value: 'Swaziland', code: 'SZ' },
        { value: 'Sweden', code: 'SE' },
        { value: 'Switzerland', code: 'CH' },
        { value: 'Syrian Arab Republic', code: 'SY' },
        { value: 'Taiwan', code: 'TW' },
        { value: 'Tajikistan', code: 'TJ' },
        { value: 'Tanzania, United Republic of', code: 'TZ' },
        { value: 'Thailand', code: 'TH' },
        { value: 'Timor-Leste', code: 'TL' },
        { value: 'Togo', code: 'TG' },
        { value: 'Tokelau', code: 'TK' },
        { value: 'Tonga', code: 'TO' },
        { value: 'Trinidad and Tobago', code: 'TT' },
        { value: 'Tunisia', code: 'TN' },
        { value: 'Turkey', code: 'TR' },
        { value: 'Turkmenistan', code: 'TM' },
        { value: 'Turks and Caicos Islands', code: 'TC' },
        { value: 'Tuvalu', code: 'TV' },
        { value: 'Uganda', code: 'UG' },
        { value: 'Ukraine', code: 'UA' },
        { value: 'United Arab Emirates', code: 'AE' },
        { value: 'United Kingdom', code: 'GB' },
        { value: 'United States', code: 'US' },
        { value: 'United States Minor Outlying Islands', code: 'UM' },
        { value: 'Uruguay', code: 'UY' },
        { value: 'Uzbekistan', code: 'UZ' },
        { value: 'Vanuatu', code: 'VU' },
        { value: 'Venezuela', code: 'VE' },
        { value: 'Viet Nam', code: 'VN' },
        { value: 'Virgin Islands, British', code: 'VG' },
        { value: 'Virgin Islands, U.S.', code: 'VI' },
        { value: 'Wallis and Futuna', code: 'WF' },
        { value: 'Western Sahara', code: 'EH' },
        { value: 'Yemen', code: 'YE' },
        { value: 'Zambia', code: 'ZM' },
        { value: 'Zimbabwe', code: 'ZW' }
    ],
    dropdown: {
        enabled: 1, // suggest tags after a single character input
        classname: 'extra-properties' // custom class for the suggestions dropdown
    } // map tags' values to this property name, so this property will be the actual value and not the printed value on the screen
})

tagify.on('click', function (e) {
    console.log(e.detail);
});

tagify.on('remove', function (e) {
    console.log(e.detail);
});

tagify.on('add', function (e) {
    console.log("original Input:", tagify.DOM.originalInput);
    console.log("original Input's value:", tagify.DOM.originalInput.value);
    console.log("event detail:", e.detail);
});

// add the first 2 tags and makes them readonly
var tagsToAdd = tagify.whitelist.slice(0, 2)
tagify.addTags(tagsToAdd)

CSS

readonly

If the original input field has a readonly attribute, then, via CSS, Tagify blocks interactions with pointer-events: none;

Code

HTML

<input readonly value='tag1, tag 2, another tag'>

JAVASCRIPT

var input = document.querySelector('input[readonly]'),
    tagify = new Tagify(input);

readonly-mixed

Tags that are read-only mixed with removable tags

Code

HTML

<input
    name='readonly-mix'
    placeholder='Type something'
    value='[
        {
            "value": "foo",
            "readonly": true,
            "title": "read-only tag"
        },
        {
            "value": "bar"
        },
        {
            "value": "Locked tag",
            "readonly": true,
            "title": "Another readonly tag"
        }
    ]'
/>

JAVASCRIPT

var input = document.querySelector('input[name=readonly-mix]'),
    tagify = new Tagify(input)

disabled

If the original input field has a disabled attribute, then, via CSS, Tagify blocks interactions with pointer-events: none;

Code

HTML

<input disabled value='tag1, tag 2, another tag'>

JAVASCRIPT

var input = document.querySelector('input[disabled]'),
    tagify = new Tagify(input);

Drag & Sort

To be able to sort tags by draging, a 3rd-party script is needed. In this example I will be using my own - lightweight & simple native HTML5 dragsort script.

Any drag & drop script would do that is able to also sort the elements. The only requirement is that when the sorting it done, tagify.updateValueByDOMTags() must be called to sync Tagify with the change.

Code

HTML

<input name='drag-sort' value='tag 1, tag 2, tag 3, tag 4, tag 5, tag 6'/>

JAVASCRIPT

var input = document.querySelector('input[name=drag-sort]'),
    tagify = new Tagify(input);

// using 3-party script "dragsort"
// https://github.com/yairEO/dragsort
var dragsort = new DragSort(tagify.DOM.scope, {
    selector:'.' + tagify.settings.classNames.tag,
    callbacks: {
        dragEnd: onDragEnd
    }
})

function onDragEnd(elm){
    tagify.updateValueByDOMTags()
}

single-value select

Similar to native <Select> element, but allows free text as value.

If the `enforceWhitelist` setting is set to `true` and a tag is currently selected, user text input will be disabled, so altering the currently selected tag is forbidden.

Code

HTML

<input name='mode-select' placeholder="Please select" />

JAVASCRIPT

var input = document.querySelector('input[name=mode-select]'),
    tagify = new Tagify(input, {
        enforceWhitelist: true,
        mode : "select",
        whitelist: ["first option", "second option", "third option"],
        blacklist: ['foo', 'bar'],
    })

// bind events
tagify.on('add', onAddTag)
tagify.DOM.input.addEventListener('focus', onSelectFocus)

function onAddTag(e){
    console.log(e.detail)
}

function onSelectFocus(e){
    console.log(e)
}