npm

Need private packages and team management tools?Check out npm Orgs. »

angular-tag

3.0.0 • Public • Published

angular-tag

Build Status David npm Bower

Tags input directive for AngularJS. Check out the ReadMe on angular-tag website for more information.

angular-tag

Requirements

Installation

Add library

This module is available as bower package, install it with this command:

bower install angular-tag

and it's available too as npm package, install it with this command:

npm install angular-tag

or you may download the latest release

Include library

<link href="/angular-tag/angular-tag.min.css" rel="stylesheet" />
<script src="angular/angular.js"></script>
<script type="text/javascript" src="/angular-tag/angular-tag.min.js"></script>

Add dependency

var app = angular.module('myModule', ['angular-tag']);

Example

/example.html

  <!DOCTYPE html >
  <html lang="en" ng-app="example">
  <head>
      <meta charset="UTF-8">
      <title>Tag Test</title>
      <!--Dependencies for ngDragDrop-->
  <script src="bower_components/jquery/dist/jquery.min.js"></script> 
  <script src="bower_components/jquery-ui/jquery-ui.min.js"></script> 
  
  <script src="bower_components/angular/angular.js"></script> 
  <script src="bower_components/angular-animate/angular-animate.js"></script> 
  <script src="bower_components/angular-dragdrop/src/angular-dragdrop.min.js"></script> 
  
  <script src="dist/angular-tag.min.js"></script> 
  <link rel="stylesheet" href="dist/angular-tag.min.css"/>
  
     <script>
         angular.module('example',['ngAnimate','angular-tag', 'ngDragDrop'])
  
           .controller('MainCtrl',function ($scope) {
      $scope.data=[{texti:'Jss1',added:'test'},{texti:'Jss2',add:'test3'},{texti:'Jss3',value:'owk'}];
      $scope.selected=[];
  
               $scope.max=2; //set the maximum number of tag entry
               $scope.delimiter=[",","x","-"];
  
        $scope.tagUpdated=function (event) {
                  console.log("Event:"+event.action);
                  console.log(event.item);
               };
      })
     </script> 
  </head>
  <body ng-controller="MainCtrl" >
  <p>Tag Me</p>
  <p>Data: {{data}}</p>
  <p>Selected: {{selected}}</p>
  <p>Max Selected Allowed: {{selected.length+" in "+max}}</p>
  <tag-me type="input"
          data="data" selected="selected"
          display-field="texti"
          theme="material"
           max="max" delimiter="delimiter"
          on-tag-maximum="tagUpdated(event)"
          on-tag-added="tagUpdated(event)"
          on-tag-removed="tagUpdated(event)"></tag-me>
  
  <p ng-init="selectedi=[{text:'Test'},{text:'three'}]">Selected: {{selectedi}}</p>
  <tag-me
          type="input"   selected="selectedi"
          placeholder="your own placeholder"
          typehead="false" allow-outside-data-set="true"
          same-input="true"
          on-tag-added="tagUpdated(event)"
          on-tag-removed="tagUpdated(event)"
          on-tag-active="tagUpdated(event)"
  >
  </tag-me>
  <br>
  <p>
      <strong>Using Required in Form Instance</strong>
       <pre>this disables the form submit button when the form is $dirty , better use with angular form</pre>
  </p>
  <form name="formName">
      <tag-me name="fieldName" type="input"
              data="data" selected="selected"
              display-field="texti"
              theme="material"
              max="max" delimiter="delimiter"
              on-tag-maximum="tagUpdated(event)"
              on-tag-added="tagUpdated(event)"
              on-tag-removed="tagUpdated(event)"
              required="true"
      ></tag-me>
      <!--you error template here-->
  <span style="color: red;" ng-show="formName.fieldName.$error.required"><strong>Tag Me is Required</strong></span>
      <!--end your error template-->
 
      <button type="submit" ng-disabled="formName.fieldName.$error.required">Save</button>
  </form>
  </body>
  </html>

Options

The tag works separately with the options based on the value

theme

it comes with two themes which can take the value of `default` or `material`. if used optionally it takes
 the default of `default`

type

for now the type is just for `input`

data

if set , is where what `angular-tag` use in our data set to check if the entered item match any of the 
fields/items in it or in filtering **typehead**

selected

return the selected item(s)/tags here, which can be used for other processing

sameInput

to allow same input , that is a selected item can appear more than once in our tagging system, 
takes either `true` or `false`

allowOutsideDataSet

if the allowed input should be outside the data set specified in `data` , takes either `true` or `false`

typehead

used in turning type head to assist users when typing or not , takes either `true` or `false`, if animation is wanted 
simply inject ngAnimate to your app module to see the type head in action

displayField

field to display to the user in the data set to the tag view , i.e which field to show to the user 
when typing or when adding tag, default if not specified uses the `text` object field parameter like in {text:'text'}

placeholder

assist users so they can use their place holders , if not placed it would use the default placeholder which is 
`Enter Text with , separated`

delimeter

delimiter to separate the text entered, checks if the user hit on the delimiter activate the tag, default it uses `,` 
and always uses `Enter Key` along side

max

max is used in limiting users of the number of tag that can be created , default it allows for infinity entry of tag when not specified

required

this is used when form validation is required to valid if a tag is selected and the input is empty too , then it makes the form $dirty. check the 3rd tag-me in the _example.html_ above

name

this is used along side **required** which is used in targetting a particular tag-me directive in the page in the case of many tag-me , default value is **tagMe**

Events

The directive handles 4 types of events action which is listed below and a second parameter item. Each of the event uses a directive attribute to handle each of them like this on-tag-removed='eventHandle(event)' where event.action is the name of the event listed below

        onTagAdded //this is send along the added item object
        onTagRemoved //this also send along the item object removed 
        onTagActive //this also send along the selected active selected tag
        onTagMaximum //this event is also triggered with the input typed returned too

and event.item is the tag object or accompany parameter. Used in the example html above

Demo

You can see the directive in action in the demo page.

Contributing

Setting up your environment

Here's what you need to do before start working on the code:

  1. Install Node.js (0.10.22 or higher)

  2. Install gulp v4 globally

     npm install -g 'gulpjs/gulp.git#4.0' karma-cli
    
  3. Clone your repository

     git clone https://github.com/<your_github_username>/angular-tag
    
  4. Go to the angular-tag directory

     cd angular-tag
    
  5. Add the main angular-tag repo as an upstream remote

     git remote add upstream https://github.com/theo4u/angular-tag
    
  6. Install the development dependencies

     npm install
     bower install 
    

Building from the source code

You can build angular-tag with a single command:

gulp build

That performs all tasks needed to produce the final JavaScript and CSS files. After the build completes, a folder named dist will be generated containing the following files:

angular-tag.js
angular-tag.css
angular-tag.min.js
angular-tag.min.css

Running It on local server

You can run it using the task below, which would run and watch any changes to our .js and .css and anything inside the template folder

gulp serve

The task above would run and listen for any js and run the gulp build-js or gulp build-css or gulp template-build for css and template respectively

License

See the LICENSE file.

install

npm i angular-tag

Downloadsweekly downloads

31

version

3.0.0

license

ISC

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability