tag_it 0.0.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in arun-tag-it.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Levy Carneiro Jr.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,217 @@
+# Tag-it: a jQuery UI plugin
+
+Tag-it was originally inspired by the "tag suggestion" form field in ZenDesk.com. Now it is a full jQuery UI widget, supporting various configurations and themes.
+
+
+## Demo
+
+![Screenshot](http://aehlke.github.com/tag-it/screenshot.png)
+
+Check the [example.html](http://aehlke.github.com/tag-it/example.html) for several demos.
+
+
+## Usage
+
+First, load [jQuery](http://jquery.com/) (v1.4 or greater), [jQuery UI](http://jqueryui.com/) (v1.8 or greater), and the plugin:
+
+    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.5.2/jquery.min.js" type="text/javascript" charset="utf-8"></script>
+    <script src="https://ajax.googleapis.com/ajax/libs/jqueryui/1.8.12/jquery-ui.min.js" type="text/javascript" charset="utf-8"></script>
+    <script src="js/tag-it.js" type="text/javascript" charset="utf-8"></script>
+
+The plugin requires a jQuery UI theme to be present, as well as its own included base CSS file ([jquery.tagit.css](http://github.com/aehlke/tag-it/raw/master/css/jquery.tagit.css)). Here we use the Flick theme as an example:
+
+    <link rel="stylesheet" type="text/css" href="http://ajax.googleapis.com/ajax/libs/jqueryui/1/themes/flick/jquery-ui.css">
+	<link href="css/jquery.tagit.css" rel="stylesheet" type="text/css">
+
+Now, let's attach it to an existing `<ul>` box:
+
+    <script type="text/javascript">
+        $(document).ready(function() {
+            $("#mytags").tagit();
+        });
+    </script>
+
+    <ul id="mytags">
+        <!-- Existing list items will be pre-added to the tags -->
+        <li>Tag1</li>
+        <li>Tag2</li>
+    </ul>
+
+This will turn the list into a tag-it list:
+
+    <ul id="mytags" class="tagit ui-widget ui-widget-content ui-corner-all">
+        <!-- Existing list items will be pre-added to the tags. -->
+        <li class="tagit-choice ui-widget-content ui-state-default ui-corner-all">
+            <span class="tagit-label">Tag1</span>
+            <a class="close"><span class="ui-icon ui-icon-close"></span></a>
+            <input type="hidden" style="display:none;" value="Tag1" name="item[tags][]">
+        </li>
+        <li class="tagit-choice ui-widget-content ui-state-default ui-corner-all">
+            <span class="tagit-label">Tag2</span>
+            <a class="close"><span class="ui-icon ui-icon-close"></span></a>
+            <input type="hidden" style="display:none;" value="Tag2" name="item[tags][]">
+        </li>
+        <li class="tagit-new">
+            <input type="text" class="ui-widget-content ui-autocomplete-input" autocomplete="off" role="textbox" aria-autocomplete="list" aria-haspopup="true">
+        </li>
+    </ul>
+
+There are several other possible configurations and ways to instantiate the widget, including one that uses a single comma-delimited `input` field rather than one per tag, so see the **Options** documentation below as well as the [examples page](http://aehlke.github.com/tag-it/examples.html) which demonstrates most of them.
+
+
+## Theming
+
+Tag-it is as easily themeable as any jQuery UI widget, using your own theme made with [Themeroller](http://jqueryui.com/themeroller/), or one of the jQuery UI [premade themes](http://jqueryui.com/themeroller/#themeGallery). The old ZenDesk-like theme is included as an optional CSS file ([tagit.ui-zendesk.css](http://github.com/aehlke/tag-it/raw/master/css/tagit.ui-zendesk.css)).
+
+
+## Options
+
+Tag-it accepts several options to customize the behaviour:
+
+### itemName (String)
+
+Used to build the name of the hidden input field: `itemName[fieldName][]`.
+
+    $("#mytags").tagit({
+        itemName: "user"
+    });
+
+Defaults to *item*.
+
+### fieldName (String)
+
+Used to build the name of the hidden input field: `itemName[fieldName][]`.
+
+    $("#mytags").tagit({
+        fieldName: "skills"
+    });
+
+Defaults to *tags*.
+
+### availableTags (Array)
+
+Used as source for the autocompletion.
+
+    $("#mytags").tagit({
+        availableTags: ["c++", "java", "php", "javascript", "ruby", "python", "c"]
+    });
+
+Defaults to an empty array *[]*.
+
+### tagSource (function)
+
+Can be overwritten in order to use custom autocompletion sources like Ajax requests.
+The default function filters the strings in **availableTags** and subtracts the already assigned tags.
+
+### removeConfirmation (boolean)
+
+When removeConfirmation is enabled the user has to press the backspace key twice to remove the last tag.
+After the first keypress the last tag receives a *remove* css class which can be used to visually highlight the tag.
+
+Defaults to *false*.
+
+### caseSensitive (boolean)
+
+whether the duplication check should do a case sensitive check or not.
+
+Defaults to *true*.
+
+### allowSpaces (boolean)
+
+When allowSpaces is enabled the user is not required to wrap multi-word tags in quotation marks.
+For example, the user can enter `John Smith` instead of `"John Smith"`.
+
+Defaults to *false*.
+
+### singleField (boolean)
+
+When enabled, will use a single hidden field for the form, rather than one per tag.
+It will delimit tags in the field with **singleFieldDelimiter**.
+
+Defaults to *false*, unless Tag-it was created on an `input` element, in which case **singleField** will be overridden as true.
+
+### singleFieldDelimiter (String)
+
+Defaults to *","*
+
+### singleFieldNode (DomNode)
+
+Set this to an input DOM node to use an existing form field.
+Any text in it will be erased on init. But it will be populated with the text of tags as they are created, delimited by **singleFieldDelimiter**.
+If this is not set, we create an input node for it, with the name given in **fieldName**, ignoring **itemName**.
+
+Defaults to *null*, unless Tag-it was created on an `input` element, in which case **singleFieldNode** will be overridden with that element.
+
+### tabIndex (integer)
+Optionally set a *tabindex* attribute on the `input` that gets created for tag-it user input.
+
+Defaults to *null*
+
+
+## Events
+
+### onTagAdded (function, Callback)
+
+Can be used to add custom behaviour before the Tag is added to the DOM.
+The function receives an empty event, and the tag as parameters.
+
+    $("#mytags").tagit({
+        onTagAdded: function(event, tag) {
+            // do something special
+        }
+    });
+
+### onTagRemoved (function, Callback)
+
+Can be used to add custom behaviour before the Tag is removed from the DOM.
+The function receives an empty event, and the tag as parameters.
+
+    $("#mytags").tagit({
+        onTagRemoved: function(event, tag) {
+            // do something special
+        }
+    });
+
+### onTagClicked (function, Callback)
+
+Can be used to add custom behaviour when the Tag is clicked from the DOM.
+The function receives the click event and the tag as parameters.
+
+    $("#mytags").tagit({
+        onTagClicked: function(event, tag) {
+            // do something special
+        }
+    });
+
+
+## Methods
+
+### assignedTags()
+Returns an array of the text values of all the tags currently in the widget.
+
+    $("#mytags").tagit("assignedTags");
+
+### createTag(tagName, additionalClass)
+Adds new tag to the list. The `additionalClass` parameter is an optional way to add classes to the tag element.
+
+    $("#mytags").tagit("createTag", "brand-new-tag");
+
+### removeAll()
+Clears the widget of all tags -- removes each tag it contains, so the onTagRemoved event callback (if set in the options) will be called for each.
+
+    $("#mytags").tagit("removeAll");
+
+
+## Authors
+
+* [Levy Carneiro Jr.](http://github.com/levycarneiro) *original author*
+* [Martin Rehfeld](http://github.com/martinrehfeld)
+* [Tobias Schmidt](http://github.com/grobie)
+* [Skylar Challand](http://github.com/sskylar)
+* [Alex Ehlke](http://github.com/aehlke) *current maintainer*
+
+
+## License
+
+tag-it is released under the [MIT license](http://github.com/aehlke/tag-it/raw/master/LICENSE).
+

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/TODO

@@ -0,0 +1,14 @@
+* Update the autocomplete to use the new jQuery UI autocomplete widget. The 
+current one is deprecated, though still functional.
+
+* Add keyboard shortcuts for highlighting tags to remove them upon backspace.
+
+* minLength for autocomplete
+
+* hide the singleFieldNode
+
+* add quotesAllowed option (or quotedSpacesAllowed)
+
+* autogrow the input (http://stackoverflow.com/questions/931207/is-there-a-jquery-autogrow-plugin-for-text-fields)
+
+

data/examples.html

@@ -0,0 +1,237 @@
+<!doctype html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>Tag-it! example</title>
+
+    <!-- These few CSS files are just to make this example page look nice. You can ignore them. -->
+    <link rel="stylesheet" type="text/css" href="http://yui.yahooapis.com/2.9.0/build/reset-fonts/reset-fonts.css">
+    <link rel="stylesheet" type="text/css" href="http://yui.yahooapis.com/2.9.0/build/base/base-min.css">
+    <link href='http://fonts.googleapis.com/css?family=Brawler' rel='stylesheet' type='text/css'>
+    <link href="css/master.css" rel="stylesheet" type="text/css">
+    <link href="css/examples.css" rel="stylesheet" type="text/css">
+    <!-- /ignore -->
+
+
+    <!-- These 2 CSS files are required: any 1 jQuery UI theme CSS, plus the Tag-it base CSS. -->
+    <link rel="stylesheet" type="text/css" href="http://ajax.googleapis.com/ajax/libs/jqueryui/1/themes/flick/jquery-ui.css">
+    <link rel="stylesheet" type="text/css" href="css/jquery.tagit.css">
+
+    <!-- This is an optional CSS theme that only applies to this widget. Use it in addition to the jQuery UI theme. -->
+    <link href="css/tagit.ui-zendesk.css" rel="stylesheet" type="text/css">
+
+    <!-- jQuery and jQuery UI are required dependencies. -->
+    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js" type="text/javascript" charset="utf-8"></script>
+    <script src="https://ajax.googleapis.com/ajax/libs/jqueryui/1.8.12/jquery-ui.min.js" type="text/javascript" charset="utf-8"></script>
+
+    <!-- The real deal -->
+	<script src="js/tag-it.js" type="text/javascript" charset="utf-8"></script>
+
+	<script>
+	    $(function(){
+            var sampleTags = ['c++', 'java', 'php', 'coldfusion', 'javascript', 'asp', 'ruby', 'python', 'c', 'scala', 'groovy', 'haskell', 'perl', 'erlang', 'apl', 'cobol', 'go', 'lua'];
+
+            //-------------------------------
+            // Minimal
+            //-------------------------------
+            $('#myTags').tagit();
+
+            //-------------------------------
+            // Single field
+            //-------------------------------
+		    $('#singleFieldTags').tagit({
+			    availableTags: sampleTags,
+			    // This will make Tag-it submit a single form value, as a comma-delimited field.
+			    singleField: true,
+                singleFieldNode: $('#mySingleField')
+		    });
+
+            // singleFieldTags2 is an INPUT element, rather than a UL as in the other 
+            // examples, so it automatically defaults to singleField.
+		    $('#singleFieldTags2').tagit({
+			    availableTags: sampleTags
+		    });
+
+
+            //-------------------------------
+            // Preloading data in markup
+            //-------------------------------
+            $('#myULTags').tagit({
+			    availableTags: sampleTags, // this param is of course optional. it's for autocomplete.
+			    // configure the name of the input field (will be submitted with form), default: item[tags]
+			    itemName: 'item',
+			    fieldName: 'tags'
+		    });
+
+            //-------------------------------
+            // Tag events
+            //-------------------------------
+            var eventTags = $('#eventTags');
+            eventTags.tagit({
+                availableTags: sampleTags,
+                onTagRemoved: function(evt, tag) {
+                    console.log(evt);
+                    alert('This tag is being removed: ' + eventTags.tagit('tagLabel', tag));
+                },
+                onTagClicked: function(evt, tag) {
+                    console.log(tag);
+                    alert('This tag was clicked: ' + eventTags.tagit('tagLabel', tag));
+                }
+            }).tagit('option', 'onTagAdded', function(evt, tag) {
+                // Add this callbackafter we initialize the widget,
+                // so that onTagAdded doesn't get called on page load.
+                alert('This tag is being added: ' + eventTags.tagit('tagLabel', tag));
+            });
+
+            //-------------------------------
+            // Tag-it methods
+            //-------------------------------
+            $('#methodTags').tagit({
+			    availableTags: sampleTags
+		    });
+
+            //-------------------------------
+            // Allow spaces without quotes.
+            //-------------------------------
+            $('#allowSpacesTags').tagit({
+                availableTags: sampleTags,
+                allowSpaces: true
+            });
+
+            //-------------------------------
+            // Remove confirmation
+            //-------------------------------
+            $('#removeConfirmationTags').tagit({
+                availableTags: sampleTags,
+                removeConfirmation: true
+            });
+            
+	    });
+	</script>
+
+</head>
+<body>
+
+<a href="http://github.com/aehlke/tag-it"><img style="position: absolute; top: 0; right: 0; border: 0;" src="http://s3.amazonaws.com/github/ribbons/forkme_right_white_ffffff.png" alt="Fork me on GitHub" /></a>
+
+<div id="wrapper"> 
+	<div id="header"> 
+		<h2>Tag-it! Usage Examples</h2> 
+		
+		<ul id="nav">
+            <li><a href="http://aehlke.github.com/tag-it">&laquo; back to widget home</a></li>
+		</ul>
+	</div>
+	
+    <div id="content">
+        <p>These demo various features of Tag-it. View the source to see how each works.</p>
+
+        <hr>
+        <h3>Minimal</h3>
+   	    <form>
+            <p>
+                Vanilla example &mdash; the absolute minimum amount of code required, no configuration. No autocomplete, either. See the other examples for that.
+            </p>
+		    <ul id="myTags"></ul>
+	        <input type="submit" value="Submit">
+	    </form>
+
+        <hr>
+        <h3>Single Input Field</h3>
+   	    <form>
+		    <p>
+                Example using a single input form field to hold all the tag values, instead of one per tag (see settings.singleField).
+                This method is particularly useful if you have a form with one input field for comma-delimited tags that you want to trivially "upgrade" to this fancy jQuery UI widget.
+                This configuration will also degrade nicely as well for browsers without JS &mdash; the default behavior is to have one input per tag, which does not degrade as well as one comma-delimited input.
+            </p>
+            <p>
+                Normally this input field will be hidden &mdash; we leave it visible here so you can see how it is manipulated by the widget:
+                <input name="tags" id="mySingleField" value="Apple, Orange" disabled="true"> <!-- only disabled for demonstration purposes -->
+            </p>
+		    <ul id="singleFieldTags"></ul>
+			<input type="submit" value="Submit">
+	    </form>
+
+        <hr>
+        <h3><a name="graceful-degredation"></a>Single Input Field (2)</h3>
+   	    <form>
+		    <p>
+                If you instantiate Tag-it on an INPUT element, it will default to being singleField, with that INPUT element as the singleFieldNode. This is the simplest way to have a gracefully-degrading tag widget.
+            </p>
+            <input name="tags" id="singleFieldTags2" value="Apple, Orange">
+			<input type="submit" value="Submit">
+	    </form>
+
+        <hr>
+        <h3>Spaces Allowed Without Quotes</h3>
+        <p>You can already do multiword tags with spaces in them by default, but those must be wrapped in quotes. This option lets you use spaces without requiring the user to quote the input.</p>
+        <p>There are normally 5 ways to insert a tag after inputting some text: space, comma, enter, selecting an autocomplete option, or defocusing the widget. With the "allowSpaces" option set to true, space no longer inserts a tag, it just adds a space to the current tag input.</p>
+   	    <form>
+			<p></p>
+			<ul id="allowSpacesTags"></ul>
+			<input type="submit" value="Submit">
+	    </form>
+
+        <hr>
+        <h3>Preloading Data in Markup</h3>
+   	    <form>
+            <p>
+                Using a UL in HTML to prefill the widget with some tags.
+            </p>
+		    <ul id="myULTags">
+			    <!-- Existing list items will be pre-added to the tags. -->
+			    <li>Tag1</li>
+			    <li>Tag2</li>
+		    </ul>
+	        <input type="submit" value="Submit">
+	    </form>
+
+        <hr>
+        <h3>Events</h3>
+   	    <form>
+			<p>Example of tag events. Try adding or removing a tag, or clicking on a tag's label.</p>
+			<ul id="eventTags">
+                <li>Click my label</li>
+                <li>Remove me</li>
+            </ul>
+			<input type="submit" value="Submit">
+	    </form>
+
+        <hr>
+        <h3>Methods</h3>
+   	    <form>
+			<p>Demos the available widget methods. Click the links below the widget to try them.</p>
+			<ul id="methodTags"></ul>
+            <p><a href="#" onclick="var inp=prompt('Enter a tag value to test the createTag method.');$('#methodTags').tagit('createTag', inp);return false;">Create tag</a></p>
+            <p><a href="#" onclick="$('#methodTags').tagit('removeAll');return false;">Clear tags</a></p>
+			<input type="submit" value="Submit">
+	    </form>
+
+        <hr>
+        <h3>Remove Confirmation</h3>
+   	    <form>
+			<p>
+                When removeConfirmation is enabled the user has to press the backspace key twice to remove the last tag.
+            </p>
+			<ul id="removeConfirmationTags">
+                <li>backspace me</li>
+                <li>me too</li>
+            </ul>
+			<input type="submit" value="Submit">
+	    </form>
+
+    </div>
+
+
+
+	<div id="footer"> 
+        <div class="left">
+	        <p>Built with <a href="http://jquery.com/" target="_blank">jQuery</a> and <a href="http://jqueryui.com/" target="_blank">jQuery UI</a>.</p>
+	        <p>Originally created by <a href="http://levycarneiro.com/">Levy Carneiro Jr</a>. Currently maintained by <a href="http://github.com/aehlke">Alex Ehlke</a>.</p>
+        </div>
+		<p class="right weak">Template adopted from <a href="http://orderedlist.com/demos/fancy-zoom-jquery/">orderedlist.com</a></p>
+		<br class="clear"/>
+	</div> 
+</div>
+</body>
+</html>