# Tag list
- Entry point: `@koobiq/components/tags`
- NgModule: `KbqTagsModule`
- Page: https://koobiq.io/en/components/tag-list/overview
## Overview
Tag List displays a collection of tags and supports keyboard navigation, multiple selection, and removal.
**Example: Tag list overview** (`tag-list-overview`)
```ts tag-list-overview-example.ts
import { moveItemInArray } from '@angular/cdk/drag-drop';
import { ChangeDetectionStrategy, Component, model } from '@angular/core';
import { KbqComponentColors } from '@koobiq/components/core';
import { KbqIconModule } from '@koobiq/components/icon';
import { KbqTagEvent, KbqTagListDroppedEvent, KbqTagsModule } from '@koobiq/components/tags';
const getTags = () => Array.from({ length: 3 }, (_, i) => ({ value: `Tag ${i}` }));
@Component({
selector: 'tag-list-overview-example',
imports: [KbqTagsModule, KbqIconModule],
template: `
@for (tag of tags(); track tag) {
{{ tag.value }}
} @empty {
}
`,
styles: `
:host {
display: flex;
flex-direction: column;
align-items: center;
gap: var(--kbq-size-m);
min-height: var(--kbq-size-xxl);
margin: var(--kbq-size-5xl);
}
`,
changeDetection: ChangeDetectionStrategy.OnPush
})
export class TagListOverviewExample {
protected readonly colors = KbqComponentColors;
protected readonly tags = model(getTags());
protected removed(event: KbqTagEvent): void {
this.tags.update((tags) => {
const index = tags.indexOf(event.tag.value);
tags.splice(index, 1);
console.log(`Tag #${index} was removed:`, event);
return tags;
});
}
protected restart(): void {
this.tags.update(() => getTags());
}
protected dropped({ previousIndex, currentIndex }: KbqTagListDroppedEvent): void {
moveItemInArray(this.tags(), previousIndex, currentIndex);
}
}
```
### Tag removal
Tag removal order:
- If there are selected tags, all of them will be removed.
- If there are no selected tags, the focused tag will be removed.
Tags can be removed in several ways:
- Click on the remove icon (`kbqTagRemove` directive) inside the tag.
- Press `Delete` or `Backspace` key.
- Programmatic removal through the component [API](https://koobiq.io/en/components/tag.md).
The removal option is configured using the `removable` attribute (enabled by default). A disabled tag does not show its remove icon.
**Example: Tag list removable** (`tag-list-removable`)
```ts tag-list-removable-example.ts
import { ChangeDetectionStrategy, Component, model } from '@angular/core';
import { KbqComponentColors } from '@koobiq/components/core';
import { KbqIconModule } from '@koobiq/components/icon';
import { KbqTagEvent, KbqTagsModule } from '@koobiq/components/tags';
const getTags = () => Array.from({ length: 3 }, (_, i) => ({ value: `Removable tag ${i}` }));
@Component({
selector: 'tag-list-removable-example',
imports: [KbqTagsModule, KbqIconModule],
template: `
@for (tag of tags(); track tag) {
{{ tag.value }}
} @empty {
}
`,
styles: `
:host {
display: flex;
flex-direction: column;
align-items: center;
gap: var(--kbq-size-m);
min-height: var(--kbq-size-xxl);
margin: var(--kbq-size-5xl);
}
`,
changeDetection: ChangeDetectionStrategy.OnPush
})
export class TagListRemovableExample {
protected readonly colors = KbqComponentColors;
protected readonly tags = model(getTags());
protected removed(event: KbqTagEvent): void {
this.tags.update((tags) => {
const index = tags.indexOf(event.tag.value);
tags.splice(index, 1);
console.log(`Tag #${index} was removed:`, event);
return tags;
});
}
protected restart(): void {
this.tags.update(() => getTags());
}
}
```
### Tag selection
Tags can be selected in several ways:
- Click on a tag while holding `Ctrl`.
- Click on a tag while holding `Shift` to change the selection range from the anchor tag to the clicked tag.
- Press `Shift` + `←` / `→` to expand or shrink the range.
- Press `Ctrl+A` key combination.
- `Space` when the tag is focused.
- Programmatic selection through the component [API](https://koobiq.io/en/components/tag.md).
Pointer and keyboard interactions change the same range relative to its initial tag. When the range shrinks, tags outside it are deselected. Disabled tags remain unchanged.
The selection option is configured using the `selectable` attribute (enabled by default).
### Editing
To enable editing mode, you need to set the `editable` property for `kbq-tag-list` or individual `kbq-tag`.
Entering the mode:
- By double-clicking on the tag.
- By pressing the `Enter` or `F2` key (when focused on the tag).
Saving changes:
- By pressing the `Enter` key.
- By clicking the confirmation button (`kbqTagEditSubmit` directive).
Canceling changes:
- By pressing the `Escape` key.
- When losing focus.
**Example: Tag list editable** (`tag-list-editable`)
```ts tag-list-editable-example.ts
import { ChangeDetectionStrategy, Component, model } from '@angular/core';
import { FormsModule } from '@angular/forms';
import { KbqComponentColors } from '@koobiq/components/core';
import { KbqIconModule } from '@koobiq/components/icon';
import { KbqInputModule } from '@koobiq/components/input';
import { KbqTagEditChange, KbqTagEvent, KbqTagsModule } from '@koobiq/components/tags';
import { KbqTitleModule } from '@koobiq/components/title';
const getTags = () => Array.from({ length: 3 }, (_, i) => ({ value: `Editable tag ${i}` }));
@Component({
selector: 'tag-list-editable-example',
imports: [KbqTagsModule, KbqIconModule, FormsModule, KbqInputModule, KbqTitleModule],
template: `
@for (tag of tags(); track tag) {
{{ tag.value }}
@if (editInputModel().length === 0) {
} @else {
}
} @empty {
}
`,
styles: `
:host {
display: flex;
flex-direction: column;
align-items: center;
gap: var(--kbq-size-xl);
min-height: var(--kbq-size-7xl);
margin: var(--kbq-size-5xl);
}
.kbq-tag-list {
max-width: 100%;
}
`,
changeDetection: ChangeDetectionStrategy.OnPush
})
export class TagListEditableExample {
protected readonly color = KbqComponentColors;
protected readonly tags = model(getTags());
protected readonly editInputModel = model('');
protected editChange({ reason, type, tag }: KbqTagEditChange, index: number): void {
switch (type) {
case 'start': {
console.info(`Tag #${index} edit was started. Reason: "${reason}".`);
this.editInputModel.set(tag.value.value);
break;
}
case 'cancel': {
console.info(`Tag #${index} edit was canceled. Reason: "${reason}".`);
this.editInputModel.set('');
break;
}
case 'submit': {
console.info(`Tag #${index} edit was submitted. Reason: "${reason}".`);
if (!this.editInputModel()) {
tag.remove();
} else {
this.tags.update((tags) => {
tags[index].value = this.editInputModel();
return tags;
});
this.editInputModel.set('');
}
break;
}
default:
}
}
protected removed(event: KbqTagEvent): void {
this.tags.update((tags) => {
const index = tags.indexOf(event.tag.value);
tags.splice(index, 1);
console.info(`Tag #${index} was removed.`);
return [...tags];
});
}
protected restart(): void {
this.tags.update(() => getTags());
}
}
```
### Drag and drop
To enable tag reordering, you need to set the `draggable` property for `kbq-tag-list`.
**Example: Tag list draggable** (`tag-list-draggable`)
```ts tag-list-draggable-example.ts
import { moveItemInArray } from '@angular/cdk/drag-drop';
import { ChangeDetectionStrategy, Component, model } from '@angular/core';
import { FormsModule } from '@angular/forms';
import { KbqComponentColors } from '@koobiq/components/core';
import { KbqIconModule } from '@koobiq/components/icon';
import { KbqTagEvent, KbqTagListDroppedEvent, KbqTagsModule } from '@koobiq/components/tags';
import { KbqToggleModule } from '@koobiq/components/toggle';
const getTags = () => Array.from({ length: 6 }, (_, id) => ({ id, value: `Draggable tag ${id}` }));
@Component({
selector: 'tag-list-draggable-example',
imports: [KbqTagsModule, KbqToggleModule, FormsModule, KbqIconModule],
template: `
Draggable
@for (tag of tags(); track tag.id) {
{{ tag.value }}
} @empty {
}
`,
styles: `
:host {
display: flex;
flex-direction: column;
align-items: center;
gap: var(--kbq-size-m);
margin: var(--kbq-size-5xl);
}
`,
changeDetection: ChangeDetectionStrategy.OnPush
})
export class TagListDraggableExample {
protected readonly tags = model(getTags());
protected readonly draggable = model(true);
protected readonly color = KbqComponentColors;
protected dropped({ previousIndex, currentIndex, tag }: KbqTagListDroppedEvent): void {
moveItemInArray(this.tags(), previousIndex, currentIndex);
setTimeout(() => tag.focus());
}
protected removed(event: KbqTagEvent): void {
this.tags.update((tags) => {
const index = tags.findIndex(({ value }) => value === event.tag.value);
tags.splice(index, 1);
console.log(`Tag #${index} was removed:`, event);
return tags;
});
}
protected restart(): void {
this.tags.update(() => getTags());
}
}
```
### Keyboard navigation
#### Focus on tag
| Key | Action |
| ------------------ | -------------------------------- |
| ← / → | Move focus to previous/next tag. |
| Shift + ← / → | Change the range and move focus. |
| Space | Select/deselect tag. |
| Delete / Backspace | Remove tag. |
| F2 / Enter | Start editing. |
| Ctrl + A | Select all tags. |
| Home / End | Move focus to first/last tag. |
#### Tag editing mode
| Key | Action |
| ----- | --------------- |
| Enter | Save changes. |
| Esc | Cancel changes. |
## API
### Components
#### KbqTag (component)
```ts
@Component({
selector: 'kbq-tag, [kbq-tag], kbq-basic-tag, [kbq-basic-tag]',
exportAs: 'kbqTag'
})
class KbqTag extends KbqColorDirective implements IFocusableOption, KbqTitleTextRef {
readonly editable = input();
readonly preventEditSubmit = input(false);
readonly selected = input(false);
value = input | null | undefined>();
readonly selectable = input(false);
readonly removable = input(true);
tabindex = input();
disabled = input();
readonly color = input();
readonly editChange = output();
readonly selectionChange = output();
readonly destroyed = output();
readonly removed = output();
changeDetectorRef: ChangeDetectorRef;
readonly contentChildren: Signal;
readonly avatar: Signal;
readonly trailingIcon: Signal;
readonly removeIcon: Signal;
get canRemove(): boolean;
get colorClassName(): string;
select(): void;
deselect(): void;
toggleSelected(isUserInput?: boolean): boolean;
focus(): void;
remove(): void;
setDefaultColor(color: T): void;
}
```
- `[editable]`: `boolean | undefined` — Whether the tag is editable.
- `[preventEditSubmit]`: `boolean` — Whether the tag edits can't be submitted.
- `[selected]`: `Signal` — Whether the tag is selected.
- `[value]`: `NonNullable | null | undefined` — The value of the tag. Defaults to the content inside `` tags.
- `[selectable]`: `Signal` — Whether the tag is selectable.
- `[removable]`: `Signal` — Determines whether the tag is removable.
- `[tabindex]`: `number | null | undefined` — Tab order of the tag.
- `[disabled]`: `boolean | undefined` — Whether the tag is disabled.
- `[localeOverrides]`: `KbqPartialLocaleData | undefined` — Localized strings for this element and its subtree, keyed by locale section. Every key is optional at
every depth.
- `[color]`: `T | null | undefined` — Color of the component. A value set in code holds until the input changes, and the default color is used
while both are unset or falsy.
- `(editChange)`: `KbqTagEditChange` — Emits event when the tag is edited.
- `(selectionChange)`: `KbqTagSelectionChange` — Emitted when the tag is selected or deselected.
- `(destroyed)`: `KbqTagEvent` — Emitted when the tag is destroyed and leaving the DOM.
- `(removed)`: `KbqTagEvent` — Emitted when a tag is to be removed.
Fires on programmatic and UI removal (click or keyboard).
- `avatar`: `Signal` — The tag avatar
- `trailingIcon`: `Signal` — The tag's trailing icon.
- `removeIcon`: `Signal` — The tag's remove toggler.
- `canRemove`: `boolean` — Whether the user may remove this tag through the controls the tag itself offers — the remove
control and the `Delete` key. A disabled tag offers neither.
This is the affordance, not the channel: `remove()` stays open so the list can still clear a
disabled tag when `clearPredicate` asks for it.
- `colorClassName`: `string` — current class name of color
- `select()`: `void` — Selects the tag.
- `deselect()`: `void` — Deselects the tag.
- `toggleSelected()`: `boolean` — Toggles the current selected state of the tag.
- `focus()`: `void` — Focuses the tag.
- `remove()`: `void` — Allows for programmatic removal of the tag. Called by the KbqTagList when the DELETE or
BACKSPACE keys are pressed.
Informs any listeners of the removal request. Does not remove the tag from the DOM.
- `setDefaultColor()`: `void` — this color will be used as a default value. For example [color]="'' | false | undefined | null".
#### KbqTagList (component)
```ts
@Component({ selector: 'kbq-tag-list', exportAs: 'kbqTagList' })
class KbqTagList implements KbqFormFieldControl, ControlValueAccessor, CanUpdateErrorState {
draggable = input();
readonly selectable = input(true);
readonly editable = input(false);
readonly clearPredicate = input<(tag: KbqTag) => boolean>(
(tag) => !tag.disabled
);
readonly removable = input(true);
readonly errorStateMatcher = input();
readonly dropped = output();
readonly change = output();
defaultErrorStateMatcher: ErrorStateMatcher;
parentForm: NgForm | null;
parentFormGroup: FormGroupDirective | null;
ngControl: NgControl;
readonly focused: Signal;
notifyPendingTagChange(): void;
focus(): void;
blur(): void;
markAsTouched(): void;
}
```
- `[draggable]`: `boolean | undefined` — Whether the tags in the list can be reordered by dragging.
- `[selectable]`: `boolean` — Whether or not this tag list is selectable. When a tag list is not selectable,
the selected states for all the tags inside the tag list are always ignored.
- `[editable]`: `boolean` — Whether the tags in the list are editable.
- `[clearPredicate]`: `(tag: KbqTag) => boolean` — Decides which tags the projected `KbqCleaner` removes: return `true` to clear the tag, `false` to
keep it. Disabled tags are kept by default. Bind a stable reference — a new function on every change
detection re-runs the predicate over every tag.
A tag the list does not allow to be removed is never offered, whatever the predicate answers.
- `[removable]`: `boolean` — Whether the tags in the list are removable.
- `[errorStateMatcher]`: `ErrorStateMatcher` — An object used to control when error messages are shown.
- `(dropped)`: `KbqTagListDroppedEvent` — Emits when the user drops tag inside tag list container.
- `(change)`: `KbqTagListChange` — Event emitted when the selected tag list value has been changed by the user.
- `focused`: `Signal` — Whether any tags or the kbqTagInput inside of this tag-list has focus.
- `notifyPendingTagChange()`: `void` — Notifies that the next `tags.changes` emission is UI-initiated.
- `focus()`: `void` — Focuses the tag list. If there is a tag input, focuses that instead.
- `blur()`: `void` — When blurred, mark the field as touched when focus moved outside the tag list.
- `markAsTouched()`: `void` — Mark the field as touched
### Directives
#### KbqTagEditInput (directive)
Directive to add input behavior for the editable tag.
```ts
@Directive({ selector: '[kbqTagEditInput]', exportAs: 'kbqTagEditInput' })
class KbqTagEditInput {}
```
#### KbqTagEditSubmit (directive)
Directive to add submit behavior for the editable tag.
```ts
@Directive({ selector: '[kbqTagEditSubmit]', exportAs: 'kbqTagEditSubmit' })
class KbqTagEditSubmit {}
```
#### KbqTagInput (directive)
Directive that adds tag-specific behaviors to an input element inside ``.
May be placed inside or outside of an ``.
```ts
@Directive({
selector: 'input[kbqTagInputFor]',
exportAs: 'kbqTagInput, kbqTagInputFor'
})
class KbqTagInput implements KbqTagTextControl {
readonly separatorKeyCodes = input(
this.defaultOptions.separatorKeyCodes,
{ alias: 'kbqTagInputSeparatorKeyCodes' }
);
readonly distinct = input(false);
readonly placeholder = input('');
readonly id = input(
inject(_IdGenerator).getId('kbq-tag-list-input-')
);
readonly tagList = input(undefined, {
alias: 'kbqTagInputFor'
});
readonly addOnBlur = input(true, {
alias: 'kbqTagInputAddOnBlur'
});
readonly addOnPaste = input(
this.defaultOptions.addOnPaste ?? true,
{ alias: 'kbqTagInputAddOnPaste' }
);
disabled = input();
readonly tagEnd = output({
alias: 'kbqTagInputTokenEnd'
});
readonly autofilled: Signal;
readonly empty: Signal;
focus(): void;
}
```
- `[kbqTagInputSeparatorKeyCodes]`: `number[]` — The list of key codes that will trigger a tagEnd event.
Defaults to `[ENTER]`.
- `[distinct]`: `boolean` — A value indicating whether allow/prevent tags duplication
- `[placeholder]`: `string` — The input's placeholder text.
- `[id]`: `string` — Unique id for the input.
- `[kbqTagInputFor]`: `KbqTagList | undefined` — Register input for tag list.
- `[kbqTagInputAddOnBlur]`: `boolean` — Whether or not the tagEnd event will be emitted when the input is blurred.
- `[kbqTagInputAddOnPaste]`: `boolean` — Whether the tagEnd event will be emitted when the text pasted. Defaults to `addOnPaste` of
`KBQ_TAGS_DEFAULT_OPTIONS`, or `true`.
- `[disabled]`: `boolean | undefined` — Whether the input is disabled.
- `(kbqTagInputTokenEnd)`: `KbqTagInputEvent` — Emitted when a tag is to be added.
- `autofilled`: `Signal` — Whether the control's value was filled in by the browser.
- `empty`: `Signal` — Whether the input is empty.
- `focus()`: `void` — Focuses the input.
#### KbqTagPrefix (directive)
Marks content to be projected into the prefix (leading) slot of a tag.
```ts
@Directive({ selector: '[kbqTagPrefix]' })
class KbqTagPrefix {}
```
#### KbqTagRemove (directive)
Example:
`cancel`
You *may* use a custom icon, but you may need to override the `kbq-tag-remove` positioning
styles to properly center the icon within the tag.
```ts
@Directive({ selector: '[kbqTagRemove]' })
class KbqTagRemove {
readonly ariaLabel = input(undefined, {
alias: 'aria-label'
});
}
```
- `[aria-label]`: `string | undefined` — Accessible name of the button. Defaults to the localized "Remove".
#### KbqTagSuffix (directive)
Marks content to be projected into the suffix (trailing) slot of a tag.
```ts
@Directive({ selector: '[kbqTagSuffix]' })
class KbqTagSuffix {}
```
### Classes
#### KbqTagEditChange (class)
Event object emitted by KbqTag when the tag is edited.
```ts
class KbqTagEditChange {
readonly tag: KbqTag;
readonly type: "start" | "cancel" | "submit";
readonly reason: string;
constructor(
tag: KbqTag,
type: "start" | "cancel" | "submit",
reason: string
);
}
```
#### KbqTagListChange (class)
Change event object that is emitted when the tag list value has changed.
```ts
class KbqTagListChange {
source: KbqTagList;
value: any;
constructor(source: KbqTagList, value: any);
}
```
#### KbqTagSelectionChange (class)
Event object emitted by KbqTag when selected or deselected.
```ts
class KbqTagSelectionChange {
source: KbqTag;
selected: boolean;
isUserInput: boolean;
constructor(
source: KbqTag,
selected: boolean,
isUserInput?: boolean
);
}
```
### Types
#### KbqTagEvent (type)
Event object emitted by KbqTag.
```ts
type KbqTagEvent = {
tag: KbqTag;
};
```
#### KbqTagFocusEvent (type)
Event object emitted when the KbqTag is focused.
```ts
type KbqTagFocusEvent = KbqTagEvent & {
origin: FocusOrigin;
};
```
#### KbqTagInputEvent (interface)
Represents an input event on a `kbqTagInput`.
```ts
interface KbqTagInputEvent {
input: HTMLInputElement;
value: string;
}
```
- `input`: `HTMLInputElement` — The native `` element that the event is being fired for.
- `value`: `string` — The value of the input.
#### KbqTagListDroppedEvent (type)
```ts
type KbqTagListDroppedEvent = Pick, 'event' | 'previousIndex' | 'currentIndex'> & {
tag: KbqTag;
};
```
#### KbqTagsDefaultOptions (interface)
Default options for the tags module that can be overridden.
```ts
interface KbqTagsDefaultOptions {
separatorKeyCodes: number[];
separators?: KbqTagSeparator[];
addOnPaste?: boolean;
}
```
- `separatorKeyCodes`: `number[]` — The list of key codes that will trigger a tagEnd event.
- `separators?`: `KbqTagSeparator[]` — Custom separator definitions to use instead of the built-in defaults.
- `addOnPaste?`: `boolean` — Whether the tagEnd event will be emitted when text is pasted.
#### KbqTagSeparator (interface)
Defines a character or pattern that ends a tag, and the contexts in which it applies.
```ts
interface KbqTagSeparator {
symbol: RegExp;
key?: string;
keyCode?: number;
appliesTo?: KbqTagSeparatorContext[];
}
```
- `symbol`: `RegExp` — Regular expression used to match/split this separator in text.
- `key?`: `string` — `KeyboardEvent.key` that triggers this separator while typing.
Omit for separators with no single-keystroke equivalent (e.g. a run of whitespace) —
those are implicitly paste-only, since they can never match a `keydown`.
- `keyCode?`: `number` — Numeric key code gating whether this separator is enabled, set via `kbqTagInputSeparatorKeyCodes`.
Omit together with `key` for separators that should always be active regardless of that input.
- `appliesTo?`: `KbqTagSeparatorContext[]` — Contexts this separator applies to. Defaults to `['input', 'paste']`.
#### KbqTagSeparatorContext (type)
Contexts a `KbqTagSeparator` can be active in.
```ts
type KbqTagSeparatorContext = 'input' | 'paste';
```
### Constants
#### KBQ_TAGS_DEFAULT_OPTIONS (const)
Injection token to be used to override the default options.
```ts
const KBQ_TAGS_DEFAULT_OPTIONS: InjectionToken;
```
#### kbqTagsDefaultOptionsProvider (const)
Utility provider for `KBQ_TAGS_DEFAULT_OPTIONS`.
```ts
const kbqTagsDefaultOptionsProvider: (
options: Partial
) => Provider;
```