jq-tag-input v1.4.1

jq-tag-input

A jquery plugin for converting a normal text input into a tag input. Supports typeahead using the typeahead.js library.

Table of Contents

• Installation
• Commands
• Usage
  • API
  • Configuration
  • Events
  • Styling Tips and Tricks
• Browser Support
• Versioning

Installation

• To install from npm, run npm install jq-tag-input.
• To install from GitHub clone the repository, install all packages with npm install, and build the plugin with npm run build.

Commands

• npm run build - Builds to source and outputs the minified package to the dist folder.
• npm run test - Run all test suites. Opens test/testingground.html in the browser, which runs the tests using QUnit.

Usage

API

Several methods for interacting with the tag input are provided with this plugin:

• $(input).tagInput("addTag", "tagtext") - Adds a new tag with the given text to the end of the list of tags if it doesn't already exist. Returns true if the tag was added successfully, or false if no tag was added.
• $(input).tagInput("removeTag", "tagtext") - Removes the tag with the given text from the list of tags if it exists. Returns true if the tag was removed successfully, or false if no tag was removed.
• $(input).tagInput("getTags") - Returns an array containing the text of each tag in the order they were added.

Note: With V1.4.0 directly accessing the TagInput object is no longer the preferred method of interacting with the tag input. The old API still exists and remains unchanged for backwards compatibility, but you should probably still update to the new API.

Configuration

Below is an example configuration utilizing all configuration values:

$("#my-input").tagInput({
  classNames: {
    overall: "tag-input",
    tag: "tag",
    tagDelete: "delete-tag",
    input: ""
  },
  deleteWithBackspace: false,
  useDefaultStyle: true,
  placeholderText: "",
  typeaheadjs: {
    // See typeahead.js docs for options
    exactMatchOnly: false,
    datasets: [
      // See typeahead.js docs for dataset syntax
    ]
  }
});

• classNames is used to override the default CSS class names used by the generated elements. These can be used to avoid naming conflicts, or to apply styles from external CSS libraries. When changing the classes to use CSS libraries, it is recommended that you append additional classes while keeping the defaults, as they provide some basic structure to the input.

  • overall (Default value "tag-input") determines the class(es) of the <div> element that is the root of the tag input.
  • tag (Default value "tag") determines the class(es) of the tags within the input.
  • tagDelete (Default value "delete-tag") determines the class(es) of the delete button on each tag.
  • input (Default value "") determines the class(es) of the input used to enter new tags.

• deleteWithBackspace (Default value false) enables using the backspace key to delete the most recently added tag when the input field is empty.

• useDefaultStyle (Default value true) controls whether or not the default visual styles provided with the CSS file are applied. These styles are only intended for providing a baseline of usability while testing, and are not pretty. Setting useDefaultStyle to false will disable these styles. This has no effect on the styles used to structure the tag input.

• placeholderText (Default value "") determines the placeholder text in the tag input.

• typeaheadjs (Default value false) controls typeahead functionality and provides options for the typeaheadjs plugin. Options are passed directly to the typeaheadjs plugin without modification, so any options it supports will be supported here.

  • exactMatchOnly controls whether or not entered tags must be an exact match to a tag from one or more datasets. addTag() will not obey this restriction.
  • datasets contains an array of all of the datasets that you want to pass to the typeahead plugin. The datasets are passed unaltered to the typeahead plugin.

Events

The following events are triggered at various times on the original input used to create the tag input:

• change - The normal change event you're likely familiar with. Fired every time a tag is added or removed.
• tagInput:addTag - Fires whenever a tag is successfully added to the tag input. The event handler will be invoked with 2 arguments: the jQuery event object, and the name of the tag that was added.
• tagInput:removeTag - Fires whenever a tag is successfully removed from the tag input. The event handler will be invoked with 2 arguments: the jQuery event object, and the name of the tag that was removed.

Styling Tips and Tricks

The <div> containing the tags and the input field is a flexbox, so you can use all of the powerful features of flexbox for your styling. For example:

• By default tags all appear in the same order they were added in, but you can make them appear in a different order by setting the order style.
• By default tags are left-aligned, but this can be changed by setting the justify-content style on the parent <div>.

Browser Support

• Desktop
  • Edge
  • Chrome 49+
  • Firefox 45+
  • Safari 10+
  • Opera 36+

Note: The plugin is not tested for mobile compatibility, but probably still works.

Versioning

Versions are numbered using semantic versioning following the <major>.<minor>.<patch> format.

• <major> goes up each time a change breaks backwards compatibility.
• <minor> goes up each time new features are added without breaking backwards compatibility.
• <patch> goes up each time for each minor change or bugfix not covered above.