jQuery – Add/Delete Tags with jQuery Input Plugin

jQuery plugin converts a simple text input into a tag list with remove tag option.

This plugin creates a input in your form that will contains a comma-separated list of tags.

Simply call the tagsInput function on any field that should be treated as a list of tags.

$(‘#tags_tg’).tagsInput();

To add tags – Call the addTag() function.

$(‘#tags_tg’).addTag(‘foo’);

To remove tags – Call the removeTag() function.

$(‘#tags_tg’).removeTag(‘bar’);

To import a list of tags – Call the importTags() function.

$(‘#tags_tg’).importTags(‘foo,bar,baz’);

To reset the tag list – Call the importTags() function.

$(‘#tags_tg’).importTags(”);

By default, if the cursor is immediately after a tag and you are hitting backspace will
delete that tag.

jQuery Tags Input
jQuery Tags Input

Demo Code

jquery_tags.html

<link rel="stylesheet" type="text/css" href="jquery.tagsinput.css" />
<script type="text/javascript" src="https://ajax.googleapis.com/ajax/libs/jquery/1.5.2/jquery.min.js"></script>
<script type="text/javascript" src="jquery.tagsinput.js"></script>
<script type='text/javascript' src='https://ajax.googleapis.com/ajax/libs/jqueryui/1.8.13/jquery-ui.min.js'></script>
<link rel="stylesheet" type="text/css" href="http://ajax.googleapis.com/ajax/libs/jqueryui/1.8.13/themes/start/jquery-ui.css" />
<script type="text/javascript">
$(function() {	
	$('#tags_tg').tagsInput({
		width: 'auto',
		onChange: function(elem, elem_tags){
			var languages = ['php','mysql','javascript','jquery','ajax'];
			$('.tag', elem_tags).each(function(){
				if($(this).text().search(new RegExp('\\b(' + languages.join('|') + ')\\b')) >= 0){
					//$(this).css('background-color', 'yellow');
				}
			});				
			var tempValue = "";
			tempValue = $("#tags_tg").map(function(n){  //map all the added value to tempValue with ',' seperated
            	return this.value;
  			}).get().join(',');
   			$("#added_tags").val(tempValue);			
		}
	});	
});
</script>
<form name="jquery_tagging" method="post" action="" enctype="multipart/form-data">
	<p><label>Default Tags:</label>	 
	<input type="hidden" name="added_tags" id="added_tags" />
	<input id="tags_tg" type="text" class="tags" value="foo,bar,baz" /></p>	
</form>

jquery.tagsinput.css

div.tagsinput { 
	border:1px solid #CCC; 
	background:#FFF; 
	padding:5px; 
	width:300px; 
	height:100px; 
	overflow-y:auto;
}
div.tagsinput span.tag { 
	border:1px solid #a5d24a; 
	-moz-border-radius:2px; 
	-webkit-border-radius:2px; 
	display:block; 
	float:left; 
	padding:5px; 
	text-decoration:none; 
	background:#cde69c; 
	color:#638421; 
	margin-right:5px; 
	margin-bottom:5px;
	font-family:helvetica;  
	font-size:13px;
}
div.tagsinput span.tag a { 
	font-weight:bold; 
	color:#82ad2b; 
	text-decoration:none; 
	font-size:11px;  
} 
div.tagsinput input { 
	width:80px; 
	margin:0px; 
	font-family:helvetica; 
	font-size:13px; 
	border:1px solid transparent; 
	padding:5px;
	background:transparent; 
	color:#000; 
	outline:0px;  
	margin-right:5px; 
	margin-bottom:5px; 
}
div.tagsinput div { 
	display:block; 
	float:left; 
} 
.tags_clear { 
	clear:both; 
	width:100%; 
	height:0px; 
}
.not_valid {
	background:#FBD8DB !important; 
	color:#90111A !important;
}

jquery.tagsinput.js

(function($) {
	var delimiter = new Array();
	var tags_callbacks = new Array();
	
	$.fn.doAutosize = function(o){
		var minWidth = $(this).data('minwidth'),
	    maxWidth = $(this).data('maxwidth'),
	    val = '',
	    input = $(this),
	    testSubject = $('#'+$(this).data('tester_id'));
	
	    if (val === (val = input.val())) {
			return;
		}
	
	    // Enter new content into testSubject
	    var escaped = val.replace(/&/g, '&amp;').replace(/\s/g,' ').replace(/</g, '&lt;').replace(/>/g, '&gt;');
	    testSubject.html(escaped);
	    // Calculate new width + whether to change
	    var testerWidth = testSubject.width(),
	        newWidth = (testerWidth + o.comfortZone) >= minWidth ? testerWidth + o.comfortZone : minWidth,
	        currentWidth = input.width(),
	        isValidWidthChange = (newWidth < currentWidth && newWidth >= minWidth) || (newWidth > minWidth && newWidth < maxWidth);
	
	    // Animate width
	    if (isValidWidthChange) {
	        input.width(newWidth);
	    }
	};
  	
	$.fn.resetAutosize = function(options){
    	// alert(JSON.stringify(options));
    	var minWidth =  $(this).data('minwidth') || options.minInputWidth || $(this).width(),
        maxWidth = $(this).data('maxwidth') || options.maxInputWidth || ($(this).closest('.tagsinput').width() - options.inputPadding),
        val = '',
        input = $(this),
        testSubject = $('<tester/>').css({
        	position: 'absolute',
            top: -9999,
            left: -9999,
            width: 'auto',
            fontSize: input.css('fontSize'),
            fontFamily: input.css('fontFamily'),
            fontWeight: input.css('fontWeight'),
            letterSpacing: input.css('letterSpacing'),
            whiteSpace: 'nowrap'
        }),
        testerId = $(this).attr('id')+'_autosize_tester';
		if(! $('#'+testerId).length > 0){
			testSubject.attr('id', testerId);
		  	testSubject.appendTo('body');
		}
		input.data('minwidth', minWidth);
		input.data('maxwidth', maxWidth);
		input.data('tester_id', testerId);
		input.css('width', minWidth);
  	};
  
	$.fn.addTag = function(value,options) {
		options = jQuery.extend({focus:false,callback:true},options);
		this.each(function() { 
			var id = $(this).attr('id');

			var tagslist = $(this).val().split(delimiter[id]);
			if (tagslist[0] == '') { 
				tagslist = new Array();
			}

			value = jQuery.trim(value);
		
			if (options.unique) {
				var skipTag = $(this).tagExist(value);
				if(skipTag == true) {
				    //Marks fake input as not_valid to let styling it
    			    $('#'+id+'_tag').addClass('not_valid');
    			}
			} else {
				var skipTag = false; 
			}
				
			if (value !='' && skipTag != true) { 
            	$('<span>').addClass('tag').append(
                	$('<span>').text(value).append('&nbsp;&nbsp;'),
                    $('<a>', {
                    	href  : '#',
                        title : 'Remove tag',
                        text  : 'x'
                    }).click(function () {
                    	return $('#' + id).removeTag(escape(value));
            		})
            	).insertBefore('#' + id + '_addTag');

				tagslist.push(value);
					
				$('#'+id+'_tag').val('');
				if (options.focus) {
					$('#'+id+'_tag').focus();
				} else {		
					$('#'+id+'_tag').blur();
				}
						
				$.fn.tagsInput.updateTagsField(this,tagslist);
						
				if (options.callback && tags_callbacks[id] && tags_callbacks[id]['onAddTag']) {
					var f = tags_callbacks[id]['onAddTag'];
					f.call(this, value);
				}
				if(tags_callbacks[id] && tags_callbacks[id]['onChange']) {
					var i = tagslist.length;
					var f = tags_callbacks[id]['onChange'];
					f.call(this, $(this), tagslist[i-1]);
				}					
			}
		});		
		return false;
	};
		
	$.fn.removeTag = function(value) { 
		value = unescape(value);
		this.each(function() { 
			var id = $(this).attr('id');
	
			var old = $(this).val().split(delimiter[id]);
					
			$('#'+id+'_tagsinput .tag').remove();
			str = '';
			for (i=0; i< old.length; i++) { 
				if (old[i]!=value) { 
					str = str + delimiter[id] +old[i];
				}
			}
				
			$.fn.tagsInput.importTags(this,str);
	
			if (tags_callbacks[id] && tags_callbacks[id]['onRemoveTag']) {
				var f = tags_callbacks[id]['onRemoveTag'];
				f.call(this, value);
			}
		});
		return false;
	};
	
	$.fn.tagExist = function(val) {
		var id = $(this).attr('id');
		var tagslist = $(this).val().split(delimiter[id]);
		return (jQuery.inArray(val, tagslist) >= 0); //true when tag exists, false when not
	};
	
	// clear all existing tags and import new ones from a string
	$.fn.importTags = function(str) {
    	id = $(this).attr('id');
		$('#'+id+'_tagsinput .tag').remove();
		$.fn.tagsInput.importTags(this,str);
	}
		
	$.fn.tagsInput = function(options) { 
    	var settings = jQuery.extend({
      		interactive:true,
      		defaultText:'add a tag',
		  	minChars:0,
		  	width:'300px',
		  	height:'100px',
		  	autocomplete: {selectFirst: false },
		  	'hide':true,
		  	'delimiter':',',
		  	'unique':true,
		  	removeWithBackspace:true,
		  	placeholderColor:'#666666',
		  	autosize: true,
		  	comfortZone: 20,
		  	inputPadding: 6*2
    	},options);

		this.each(function() { 
			if (settings.hide) { 
				$(this).hide();				
			}
			var id = $(this).attr('id');
			if (!id || delimiter[$(this).attr('id')]) {
				id = $(this).attr('id', 'tags' + new Date().getTime()).attr('id');
			}
			
			var data = jQuery.extend({
				pid:id,
				real_input: '#'+id,
				holder: '#'+id+'_tagsinput',
				input_wrapper: '#'+id+'_addTag',
				fake_input: '#'+id+'_tag'
			},settings);
	
			delimiter[id] = data.delimiter;
			
			if (settings.onAddTag || settings.onRemoveTag || settings.onChange) {
				tags_callbacks[id] = new Array();
				tags_callbacks[id]['onAddTag'] = settings.onAddTag;
				tags_callbacks[id]['onRemoveTag'] = settings.onRemoveTag;
				tags_callbacks[id]['onChange'] = settings.onChange;
			}
	
			var markup = '<div id="'+id+'_tagsinput" class="tagsinput"><div id="'+id+'_addTag">';
			
			if (settings.interactive) {
				markup = markup + '<input id="'+id+'_tag" value="" data-default="'+settings.defaultText+'" />';
			}
			
			markup = markup + '</div><div class="tags_clear"></div></div>';
			
			$(markup).insertAfter(this);

			$(data.holder).css('width',settings.width);
			$(data.holder).css('min-height',settings.height);
			$(data.holder).css('height',settings.height);
	
			if ($(data.real_input).val()!='') { 
				$.fn.tagsInput.importTags($(data.real_input),$(data.real_input).val());
			}		
			if (settings.interactive) { 
				$(data.fake_input).val($(data.fake_input).attr('data-default'));
				$(data.fake_input).css('color',settings.placeholderColor);
		        $(data.fake_input).resetAutosize(settings);
		
				$(data.holder).bind('click',data,function(event) {
					$(event.data.fake_input).focus();
				});
			
				$(data.fake_input).bind('focus',data,function(event) {
					if ($(event.data.fake_input).val()==$(event.data.fake_input).attr('data-default')) { 
						$(event.data.fake_input).val('');
					}
					$(event.data.fake_input).css('color','#000000');		
				});
						
				if (settings.autocomplete_url != undefined) {
					autocomplete_options = {source: settings.autocomplete_url};
					for (attrname in settings.autocomplete) { 
						autocomplete_options[attrname] = settings.autocomplete[attrname]; 
					}
				
					if (jQuery.Autocompleter !== undefined) {
						$(data.fake_input).autocomplete(settings.autocomplete_url, settings.autocomplete);
						$(data.fake_input).bind('result',data,function(event,data,formatted) {
							if (data) {
								$('#'+id).addTag(data[0] + "",{focus:true,unique:(settings.unique)});
							}
					  	});
					} else if (jQuery.ui.autocomplete !== undefined) {
						$(data.fake_input).autocomplete(autocomplete_options);
						$(data.fake_input).bind('autocompleteselect',data,function(event,ui) {
							$(event.data.real_input).addTag(ui.item.value,{focus:true,unique:(settings.unique)});
							return false;
						});
					}
				
					
				} else {
					// if a user tabs out of the field, create a new tag
					// this is only available if autocomplete is not used.
					$(data.fake_input).bind('blur',data,function(event) { 
						var d = $(this).attr('data-default');
						if ($(event.data.fake_input).val()!='' && $(event.data.fake_input).val()!=d) { 
							if( (event.data.minChars <= $(event.data.fake_input).val().length) && (!event.data.maxChars || (event.data.maxChars >= $(event.data.fake_input).val().length)) )
								$(event.data.real_input).addTag($(event.data.fake_input).val(),{focus:true,unique:(settings.unique)});
						} else {
							$(event.data.fake_input).val($(event.data.fake_input).attr('data-default'));
							$(event.data.fake_input).css('color',settings.placeholderColor);
						}
						return false;
					});
				
				}
				// if user types a comma, create a new tag
				$(data.fake_input).bind('keypress',data,function(event) {
					if (event.which==event.data.delimiter.charCodeAt(0) || event.which==13 ) {
					    event.preventDefault();
						if( (event.data.minChars <= $(event.data.fake_input).val().length) && (!event.data.maxChars || (event.data.maxChars >= $(event.data.fake_input).val().length)) )
							$(event.data.real_input).addTag($(event.data.fake_input).val(),{focus:true,unique:(settings.unique)});
					  	$(event.data.fake_input).resetAutosize(settings);
						return false;
					} else if (event.data.autosize) {
			            $(event.data.fake_input).doAutosize(settings);
            
          			}
				});
				//Delete last tag on backspace
				data.removeWithBackspace && $(data.fake_input).bind('keydown', function(event){
					if(event.keyCode == 8 && $(this).val() == ''){
						 event.preventDefault();
						 var last_tag = $(this).closest('.tagsinput').find('.tag:last').text();
						 var id = $(this).attr('id').replace(/_tag$/, '');
						 last_tag = last_tag.replace(/[\s]+x$/, '');
						 $('#' + id).removeTag(escape(last_tag));
						 $(this).trigger('focus');
					}
				});
				$(data.fake_input).blur();
				
				//Removes the not_valid class when user changes the value of the fake input
				if(data.unique) {
				    $(data.fake_input).keydown(function(event){
				        if(event.keyCode == 8 || String.fromCharCode(event.which).match(/\w+|[áéíóúÁÉÍÓÚñÑ,/]+/)) {
				            $(this).removeClass('not_valid');
				        }
				    });
				}
			} // if settings.interactive
		});			
		return this;	
	};
	
	$.fn.tagsInput.updateTagsField = function(obj,tagslist) { 
		var id = $(obj).attr('id');
		$(obj).val(tagslist.join(delimiter[id]));
	};
	
	$.fn.tagsInput.importTags = function(obj,val) {			
		$(obj).val('');
		var id = $(obj).attr('id');
		var tags = val.split(delimiter[id]);
		for (i=0; i<tags.length; i++) { 
			$(obj).addTag(tags[i],{focus:false,callback:false});
		}
		if(tags_callbacks[id] && tags_callbacks[id]['onChange']){
			var f = tags_callbacks[id]['onChange'];
			f.call(obj, obj, tags[i]);
		}
	};
})(jQuery);

Leave a Reply

Your email address will not be published.

*