tiagogm / aurelia-tags-input

A tag input plugin built in aurelia

Aurelia tags input

An Aurelia tags input plugin

Install

npm install aurelia-tags-input --save

Use

  export async function configure(aurelia) {
    //...
    aurelia.use
      //..
      .plugin('aurelia-tags-input')
  }

<aurelia-tags-input
  tags.bind="tags"
  on-changed.bind="onTagsChanged">
</aurelia-tags-input>

Optional bindable props

• tags - array of string to render on the input as tags
• on-changed - callback function called when tags are changed

Using aurelia-cli

Add this entry to aurelia.json depedencies:

{
  "name": "aurelia-tags-input",
  "main": "index",
  "path": "../node_modules/aurelia-tags-input/dist/amd",
  "resources": [
    "aurelia-tags-input.css",
    "aurelia-tags-input.html"
  ]
}

Note: aurelia-cli changes frequently so it's best to check the current way to do it here:

http://aurelia.io/docs/build-systems/aurelia-cli#adding-client-libraries-to-your-project

Building The Code

To build the code, follow these steps.

1. Ensure that NodeJS is installed. This provides the platform on which the build tooling runs.
2. From the project folder, execute the following command:

npm install

3. Ensure that Gulp is installed. If you need to install it, use the following command:

npm install -g gulp

4. To build the code, you can now run:

gulp build

5. You will find the compiled code in the dist folder, available in three module formats: AMD, CommonJS and ES6.

6. See gulpfile.js for other tasks related to generating the docs and linting.

Running The Tests

To run the unit tests, first ensure that you have followed the steps above in order to install all dependencies and successfully build the library. Once you have done that, proceed with these additional steps:

1. Ensure that the Karma CLI is installed. If you need to install it, use the following command:

npm install -g karma-cli

2. Ensure that jspm is installed. If you need to install it, use the following commnand:

npm install -g jspm

3. Install the client-side dependencies with jspm:

jspm install

4. You can now run the tests with this command:

karma start

aurelia-tags-input's Issues

Control not rendering in CLI

Hi, I'm trying to use this component with Aurelia and it doesn't render the control. I'm guessing it's not loading the html/css. I've tried many combinations in the dependency registration in Aurelia.json, and none of it worked. Could you please provide the dependency signature? Or what else could be going wrong? I'm using cli and this is the registration I currently use:

{ "name": "aurelia-tags-input", "path": "../node_modules/aurelia-tags-input/dist/amd", "main": "aurelia-tags-input", "resources": [ "**/*.{css,html}" ] }