Auto Complete Component

A smart autocomplete component with real-time search, highlighting, and customizable suggestions.

Installation

Install the Package

npm install @vui/auto-complete

Import in Your Component

import { VuiAutocompleteComponent } from '@vui/auto-complete';

@Component({
  standalone: true,
  imports: [VuiAutocompleteComponent],
  template: `
    <ng-vui-autocomplete
      [data]="suggestions"
      [searchKeywords]="searchFields"
      (selectedItem)="onItemSelected($event)"
      placeholder="Search...">
    </ng-vui-autocomplete>
  `
})

Basic Usage

Live Demo

export class AutoCompleteExample {
  cities = [
    { id: 1, name: 'New York', country: 'USA' },
    { id: 2, name: 'Los Angeles', country: 'USA' },
    { id: 3, name: 'Chicago', country: 'USA' }
  ];

  searchFields = ['name', 'country'];

  onItemSelected(item: any): void {
    console.log('Selected:', item);
  }
}

API Reference

Component Properties

Inputs

Property Type Default Description
data any[] [] Array of suggestions data
searchKeywords string[] ['name'] Fields to search in
placeholder string 'Search...' Input placeholder text
disabled boolean false Disable the component
maxSuggestions number 10 Maximum number of suggestions to show

Outputs

Event Type Description
selectedItem EventEmitter<any> Emitted when an item is selected
searchChanged EventEmitter<string> Emitted when search text changes
suggestionsOpened EventEmitter<void> Emitted when suggestions dropdown opens
suggestionsClosed EventEmitter<void> Emitted when suggestions dropdown closes