Angular library that wraps @yaireo/tagify
npm install ngx-tagifyProper Angular library that wraps @yaireo/tagify.
It allows multiple instances of tagify, implements ControlValueAccessor (for use with ngModel and reactive forms), and includes proper type declarations.
__Demo__
* Install
* Component
* Usage with ngModel
* Usage with Reactive Forms
* Predefined values
* Inputs
* Outputs
* Service
* Styling
* FAQ
Install via npm:
npm install ngx-tagify
Import module:
``typescript
import { TagifyModule } from 'ngx-tagify';
@NgModule({
imports: [
...
TagifyModule,
...
]
})
export class AppModule {}
`
Include styling (see below).
You can use the component either with ngModel or with reactive forms.string
Either way, it takes a or an array of TagData, i.e. an Object that contains a unique property value:
`typescript`
interface TagData {
value: string;
[key: string]: any;
}
If a string is passed, it gets parsed for tags by Tagify. The returned string is the stringified tags array or, if mode: 'mix', the mixed text and tags string.
Import FormsModule to your module.
`html`
inputClass="form-control"
[settings]="settings"
[whitelist]="whitelist$"
[readonly]="readonly"
[disabled]="disabled"
(add)="onAdd($event)"
(remove)="onRemove($event)"
>
`typescript
import { Component } from '@angular/core';
import { BehaviorSubject } from 'rxjs';
import { TagData, TagifySettings } from 'ngx-tagify';
@Component({
selector: 'app-root',
templateUrl: './app.component.html',
styleUrls: ['./app.component.css']
})
export class AppComponent {
tags: TagData[] = [{ value: 'foo' }];
// tags = 'foo'; -> if you want to pass as string
settings: TagifySettings = {
placeholder: 'Start typing...',
blacklist: ['fucking', 'shit'],
callbacks: {
click: (e) => { console.log(e.detail); }
}
};
whitelist$ = new BehaviorSubject
readonly = false;
disabled = false;
onAdd(tagify) {
console.log('added a tag', tagify);
}
onRemove(tags) {
console.log('removed a tag', tags);
}
}
`
__Note:__ The component only recognizes reference changes, it won't deep check for changes within the array.
this.tags.push({value: 'bar'}); won't do anything.this.tags = this.tags.concat([{value: 'bar'}]);
Instead, use (or similar) to update changes.
Import ReactiveFormsModule to your module.
`html`
`typescript
import { Component, OnInit } from '@angular/core';
import { FormControl, FormGroup } from '@angular/forms';
@Component({
selector: 'app-root',
templateUrl: './app.component.html',
styleUrls: ['./app.component.css']
})
export class AppComponent implements OnInit {
form = new FormGroup({
tags: new FormControl([{ value: 'Reactive' }])
});
ngOnInit(): void {
this.form.valueChanges.subscribe(value => {
console.log('form value changed', value);
});
}
}
`
Use ngModel or reactive forms with an initial string value that gets parsed by Tagify.
If you want to pass predefined tags as text, but receive a tags array as output, pass the value as text between . Mixed text & tags are also supported.`html`html`
[[Eric Cartman]] and [[kyle]] do not know [[homer simpson]] because he's a relic.
Angular has problems with hard-coded single curly braces. Use property binding to add predefined tags with json syntax.
`typescript`
originalText = '[[{"id":200, "value":"cartman", "title":"Eric Cartman"}]] and [[kyle]] do not know [[{"value":"homer simpson", "readonly":true}]] because he\'s a relic.';html`
{{ originalText }}
| | |
|--------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| settings | _Type:_ TagifySettings
See tagify/Settings. |
| | _Type:_ string
Apply one or more CSS classes to the input field (e.g. Bootstrap's ). |whitelist
| | _Type:_ Observable
Execution of the observable updates the whitelist of tagify. You can listen to user's inputs and update the whitelist respectively using this observable. |
| | _Type:_ boolean
Dynamically change readonly status. |
| | _Type:_ boolean
Dynamically change disabled status. |
| | _Type:_ string
Use the name attribute if you want to access the tagify component via the service. This name should be unique. |
| | |
|---|---|
|add|Fires when a tag has been added.|remove
||Fires when a tag has been removed.|tInput
||Listen to the input event of the tagify input element.|
Listen to all other events by defining respective callbacks (tagify/Events).
You can also gain access to the full tagify API via a service.
Provide a name, such that the tagify instance will be available via the service.
`html`
`typescript
import { Component } from '@angular/core';
import { TagifyService } from 'ngx-tagify';
@Component({
selector: 'app-root',
templateUrl: './app.component.html',
styleUrls: ['./app.component.css']
})
export class AppComponent {
constructor(
private tagifyService: TagifyService
) {}
addTags() {
this.tagifyService.get('example').addTags(['this', 'is', 'cool']);
}
}
`
The original Tagify class is also exposed and can be used for type declarations or custom implementations.
`typescript
import { Tagify } from 'ngx-tagify';
const tagify: Tagify = new Tagify(inputElement);
`
You have two options to include the styling of Tagify.
__Option 1:__ Modify your angular.json by adding the .scss file to the styles property.
`json`
"options": {
"styles": [
"node_modules/ngx-tagify/styles/tagify.scss",
"src/styles.scss"
]
}
__Option 2:__ If you want to override some of the styling, import it to a sass file. Have a look at tagify/CSS Variables and respective demo page for details.
`scss
// src/styles.scss
@use "ngx-tagify/styles/tagify";
.tagify
--tags-border-color: #ff0000;
`
#### Usage with Bootstrap
If you are using Bootstrap as CSS framework (as used in the demo), you might need to tweak some styles in order that Tagify looks pretty:
`scss`
.tagify {
--tag-pad: 0.15rem 0.5rem;
}
.tagify__input {
min-height: 1.25lh;
}
.tagify__input:empty::before {
line-height: inherit;
}
.tagify.form-control {
height: unset;
}
You are getting TypeScript compilation error with an error output like this:
`
node_modules/@types/yaireo__tagify/index.d.ts:475:1
475 export = Tagify;
~~~~~~~~~~~~~~~~
This module is declared with using 'export =', and can only be used with a default import when using the 'allowSyntheticDefaultImports' flag.
To resolve this issue, set allowSyntheticDefaultImports within compilerOptions in your tsconfig.json:
`json`
{
"compilerOptions": {
"allowSyntheticDefaultImports": true,
}
}
`
Module build failed (from ./node_modules/@angular-devkit/build-angular/node_modules/sass-loader/dist/cjs.js):
Can't find stylesheet to import.
╷
1 │ @import "@yaireo/tagify/src/tagify";
│ ^^^^^^^^^^^^^^^^^^^^^^^^^^^
╵
node_modules/ngx-tagify/styles/tagify.scss 1:9 root stylesheet
Make sure you include node_modules in the stylePreprocessorOptions within your angular.json:
`json``
"stylePreprocessorOptions": {
"includePaths": ["node_modules"]
},