https://github.com/tiagogm/aurelia-tags-input
A tag input plugin built in aurelia
https://github.com/tiagogm/aurelia-tags-input
aurelia aurelia-plugins tags tags-input
Last synced: about 2 months ago
JSON representation
A tag input plugin built in aurelia
- Host: GitHub
- URL: https://github.com/tiagogm/aurelia-tags-input
- Owner: tiagogm
- License: cc0-1.0
- Created: 2016-11-24T11:07:52.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-10-30T12:03:44.000Z (over 7 years ago)
- Last Synced: 2025-04-12T19:17:37.333Z (about 2 months ago)
- Topics: aurelia, aurelia-plugins, tags, tags-input
- Language: JavaScript
- Homepage:
- Size: 1.18 MB
- Stars: 8
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Aurelia tags input
### An Aurelia tags input plugin
### Install
`npm install aurelia-tags-input --save`
### Use
```javascript
export async function configure(aurelia) {
//...
aurelia.use
//..
.plugin('aurelia-tags-input')
}
```
```html
```
## 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](http://aurelia.io/docs/build-systems/aurelia-c)
## Building The Code
To build the code, follow these steps.
1. Ensure that [NodeJS](http://nodejs.org/) is installed. This provides the platform on which the build tooling runs.
2. From the project folder, execute the following command:
```shell
npm install
```
3. Ensure that [Gulp](http://gulpjs.com/) is installed. If you need to install it, use the following command:
```shell
npm install -g gulp
```
4. To build the code, you can now run:
```shell
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](http://karma-runner.github.io/) CLI is installed. If you need to install it, use the following command:
```shell
npm install -g karma-cli
```
2. Ensure that [jspm](http://jspm.io/) is installed. If you need to install it, use the following commnand:
```shell
npm install -g jspm
```
3. Install the client-side dependencies with jspm:
```shell
jspm install
```
4. You can now run the tests with this command:
```shell
karma start
```