TagSelect.js v1.0.0

TagSelect.js

Overview

HTML5-based input for typing lists of tags, tokens, or other discrete values.

No dependencies required. 6kb gzipped.

Features:

• Built-in validation, with visual feedback on unexpected values.
• Full keyboard/cursor support (you can type anywhere in the input).
• Full copy/paste support.

Currently, all non-word characters are treated as tag dividers. More separator options may be added in the future.

Compatibility: Only modern browsers are supported. Some of the nicer features of this plugin (copy/paste support, native selection and cursor movement) aren't realistic on older browsers.

Quickstart (Scripts)

Include the files from dist/ in your project. Example:

<link rel="stylesheet" href="tagselect.min.css">
<script src="tagselect.min.js"></script>

Next, you can use the plugin in your own JavaScript. If you have an element with the ID 'my-input':

<div id="my-input"></div>

var element = document.querySelector('#my-input');
var tags = new TagSelect(element, {
    options: ['Red', 'Green', 'Blue', 'Yellow', 'Orange', 'Magenta']
});

Quickstart (NPM + Browserify / Webpack)

Add the dependency:

npm install --save TagSelect.js

And use it in your script:

var TagSelect = require('TagSelect.js');

var element = document.querySelector('#my-input');
var tags = new TagSelect(element, {
    options: ['Red', 'Green', 'Blue', 'Yellow', 'Orange', 'Magenta']
});

Methods

/* .get()
*************************/
var selected = tags.get();
// => ['Magenta, 'Yellow']

/* .set()
*************************/
tags.set(['Orange']);

/* .on()
*************************/
tags.on('change', function () {
    console.log('Tags updated!');
    console.log(tags.get());
})

Contributing

Development

To get started, you'll need install the development dependencies:

npm install

Development tasks, like compiling Sass and minifying JavaScript, are handled by NPM scripts.

# Run a local development server, recompiling files on update.
npm run dev

# Rebuild all CSS and JS.
npm run build

# Bump the version, commit the dist/, and release on NPM.
npm version [ major | minor | patch ]