Autocomplete cell type

Collect user input with a list of choices, by using the autocomplete cell type.

The autocomplete cell type provides a text input with suggestions from a predefined list. Use it when users should choose from known values but can also type freely.

Overview

You can edit the autocomplete-typed cells in three different ways:

Flexible mode
Strict mode
Strict mode with asynchronous data

In all three modes, the source option can be provided in two formats:

An array of values
An array of objects with key and value properties

Autocomplete flexible mode

This example uses the autocomplete feature in the default flexible mode. In this mode, the user can choose one of the suggested options while typing or enter a custom value that is not included in the suggestions.

The visibleRows option sets how many suggestions the dropdown shows without scrolling. The default is 10 rows. The Chassis color column sets visibleRows: 4, so the dropdown shows only four suggestions at a time and scrolls to reveal the rest.

The trimDropdown option controls the dropdown’s width. By default (trimDropdown: true), the dropdown matches the width of the edited cell, which can truncate long suggestions. The Bumper color column sets trimDropdown: false, so the dropdown expands to fit its widest suggestion, even if that makes it wider than the cell.

1
/* file: app.component.ts */
2
import { Component } from '@angular/core';
3
import { GridSettings, HotTableModule} from '@handsontable/angular-wrapper';
4

5
const colors = [
6
  'yellow',
7
  'red',
8
  'orange and another color',
9
  'green',
10
  'blue',
11
  'gray',
12
  'black',
13
  'white',
14
  'purple',
15
  'lime',
16
  'olive',
17
  'cyan',
18
];
19

20
@Component({
21
  selector: 'example1-autocomplete-cell-type',
22
  standalone: true,
23
  imports: [HotTableModule],
24
  template: ` <div>
25
    <hot-table [data]="data" [settings]="gridSettings"></hot-table>
26
  </div>`,
27
})
28
export class AppComponent {
29

30
  readonly data = [
31
    ['BMW', 2017, 'black', 'black'],
32
    ['Nissan', 2018, 'blue', 'blue'],
33
    ['Chrysler', 2019, 'yellow', 'black'],
34
    ['Volvo', 2020, 'white', 'gray'],
35
  ];
36

37
  readonly gridSettings: GridSettings = {
38
    height: 'auto',
39
    colHeaders: ['Car', 'Year', 'Chassis color', 'Bumper color'],
40
    autoWrapRow: true,
41
    autoWrapCol: true,
42
    columns: [
43
      {
44
        type: 'autocomplete',
45
        source: ['BMW', 'Chrysler', 'Nissan', 'Suzuki', 'Toyota', 'Volvo'],
46
        strict: false,
47
      },
48
      { type: 'numeric' },
49
      {
50
        type: 'autocomplete',
51
        source: colors,
52
        strict: false,
53
        visibleRows: 4,
54
      },
55
      {
56
        type: 'autocomplete',
57
        source: colors,
58
        strict: false,
59
        trimDropdown: false,
60
      },
61
    ]
62
  };
63
}
64
/* end-file */
65

66

67

68
/* file: app.config.ts */
69
import { ApplicationConfig, provideZoneChangeDetection } from '@angular/core';
70
import { registerAllModules } from 'handsontable/registry';
71
import { HOT_GLOBAL_CONFIG, HotGlobalConfig, NON_COMMERCIAL_LICENSE } from '@handsontable/angular-wrapper';
72

73
// register Handsontable's modules
74
registerAllModules();
75

76
export const appConfig: ApplicationConfig = {
77
  providers: [
78
    provideZoneChangeDetection({ eventCoalescing: true }),
79
    {
80
      provide: HOT_GLOBAL_CONFIG,
81
      useValue: { license: NON_COMMERCIAL_LICENSE } as HotGlobalConfig,
82
    },
83
  ],
84
};
85
/* end-file */

1
<div>
2
  <example1-autocomplete-cell-type></example1-autocomplete-cell-type>
3
</div>

Autocomplete strict mode

This is the same example as above, the difference being that autocomplete now runs in strict mode. In this mode, the autocomplete cells will only accept values that are defined in the source array. The mouse and keyboard bindings are identical to the handsontable cell type but with the differences below:

If there is at least one option visible, there always is a selection in HOT-in-HOT
When the first row is selected, pressing Arrow Up does not deselect HOT-in-HOT. Instead, it behaves as the Enter key but moves the selection in the main HOT upwards

In strict mode, the allowInvalid option determines the behaviour in the case of manual user input:

allowInvalid: true optional - allows manual input of a value that does not exist in the source, the field background is highlighted in red, and the selection advances to the next cell
allowInvalid: false - does not allow manual input of a value that does not exist in the source, the Enter key is ignored, and the editor field remains open

1
/* file: app.component.ts */
2
import { Component } from '@angular/core';
3
import { GridSettings, HotTableModule} from '@handsontable/angular-wrapper';
4

5
const colors = [
6
  'yellow',
7
  'red',
8
  'orange and another color',
9
  'green',
10
  'blue',
11
  'gray',
12
  'black',
13
  'white',
14
  'purple',
15
  'lime',
16
  'olive',
17
  'cyan',
18
];
19

20
@Component({
21
  selector: 'example2-autocomplete-cell-type',
22
  standalone: true,
23
  imports: [HotTableModule],
24
  template: ` <div>
25
    <hot-table [data]="data" [settings]="gridSettings"></hot-table>
26
  </div>`,
27
})
28
export class AppComponent {
29

30
  readonly data = [
31
    ['BMW', 2017, 'black', 'black'],
32
    ['Nissan', 2018, 'blue', 'blue'],
33
    ['Chrysler', 2019, 'yellow', 'black'],
34
    ['Volvo', 2020, 'white', 'gray'],
35
  ];
36

37
  readonly gridSettings: GridSettings = {
38
    height: 'auto',
39
    colHeaders: [
40
      'Car<br>(allowInvalid true)',
41
      'Year',
42
      'Chassis color',
43
      'Bumper color<br>(allowInvalid true)',
44
    ],
45
    autoWrapRow: true,
46
    autoWrapCol: true,
47
    columns: [
48
      {
49
        type: 'autocomplete',
50
        source: ['BMW', 'Chrysler', 'Nissan', 'Suzuki', 'Toyota', 'Volvo'],
51
        strict: true,
52
      },
53
      {},
54
      {
55
        type: 'autocomplete',
56
        source: colors,
57
        strict: true,
58
      },
59
      {
60
        type: 'autocomplete',
61
        source: colors,
62
        strict: true,
63
        allowInvalid: true, // true is default
64
      },
65
    ]
66
  };
67
}
68
/* end-file */
69

70

71

72
/* file: app.config.ts */
73
import { ApplicationConfig, provideZoneChangeDetection } from '@angular/core';
74
import { registerAllModules } from 'handsontable/registry';
75
import { HOT_GLOBAL_CONFIG, HotGlobalConfig, NON_COMMERCIAL_LICENSE } from '@handsontable/angular-wrapper';
76

77
// register Handsontable's modules
78
registerAllModules();
79

80
export const appConfig: ApplicationConfig = {
81
  providers: [
82
    provideZoneChangeDetection({ eventCoalescing: true }),
83
    {
84
      provide: HOT_GLOBAL_CONFIG,
85
      useValue: { license: NON_COMMERCIAL_LICENSE } as HotGlobalConfig,
86
    },
87
  ],
88
};
89
/* end-file */

1
<div>
2
  <example2-autocomplete-cell-type></example2-autocomplete-cell-type>
3
</div>

Autocomplete strict mode with asynchronous data

Autocomplete can also use asynchronous data sources. In the example below, suggestions for the “Car” column are loaded from the server with the Fetch API. To load data from a remote source, assign a function to the source option. The function receives the query string and the process callback. Call process() with the result array when the request completes.

1
/* file: app.component.ts */
2
import { Component } from '@angular/core';
3
import { GridSettings, HotTableModule} from '@handsontable/angular-wrapper';
4

5
@Component({
6
  selector: 'example3-autocomplete-cell-type',
7
  standalone: true,
8
  imports: [HotTableModule],
9
  template: ` <div>
10
    <hot-table [data]="data" [settings]="gridSettings"></hot-table>
11
  </div>`
12
})
13
export class AppComponent {
14

15
  readonly data = [
16
    ['BMW', 2017, 'black', 'black'],
17
    ['Nissan', 2018, 'blue', 'blue'],
18
    ['Chrysler', 2019, 'yellow', 'black'],
19
    ['Volvo', 2020, 'white', 'gray'],
20
  ];
21

22
  readonly gridSettings: GridSettings = {
23
    height: 'auto',
24
    colHeaders: ['Car', 'Year', 'Chassis color', 'Bumper color'],
25
    autoWrapRow: true,
26
    autoWrapCol: true,
27
    columns: [
28
      {
29
        type: 'autocomplete',
30
        source: (_query: string, process: (items: string[]) => void) => {
31
          fetch('https://handsontable.com/docs/scripts/json/autocomplete.json')
32
              .then((response) => response.json())
33
              .then((response) => process(response.data));
34
        },
35
        strict: true,
36
      },
37
      {}, // Year is a default text column
38
      {}, // Chassis color is a default text column
39
      {}, // Bumper color is a default text column
40
    ]
41
  };
42
}
43
/* end-file */
44

45

46

47
/* file: app.config.ts */
48
import { ApplicationConfig, provideZoneChangeDetection } from '@angular/core';
49
import { registerAllModules } from 'handsontable/registry';
50
import { HOT_GLOBAL_CONFIG, HotGlobalConfig, NON_COMMERCIAL_LICENSE } from '@handsontable/angular-wrapper';
51

52
// register Handsontable's modules
53
registerAllModules();
54

55
export const appConfig: ApplicationConfig = {
56
  providers: [
57
    provideZoneChangeDetection({ eventCoalescing: true }),
58
    {
59
      provide: HOT_GLOBAL_CONFIG,
60
      useValue: { license: NON_COMMERCIAL_LICENSE } as HotGlobalConfig,
61
    },
62
  ],
63
};
64
/* end-file */

1
<div>
2
  <example3-autocomplete-cell-type></example3-autocomplete-cell-type>
3
</div>

The `source` option

The source option can be provided in two formats:

Array of values

You can provide the source option as an array of values that will be used as the autocomplete suggestions.

1
/* file: app.component.ts */
2
import { Component } from '@angular/core';
3
import { GridSettings, HotTableModule} from '@handsontable/angular-wrapper';
4

5
@Component({
6
  selector: 'example4-autocomplete-cell-type',
7
  standalone: true,
8
  imports: [HotTableModule],
9
  template: ` <div>
10
    <hot-table [data]="shipmentKVData" [settings]="gridSettings"></hot-table>
11
  </div>`
12
})
13
export class AppComponent {
14
  readonly shipmentKVData = [
15
    ['Electronics and Gadgets','Los Angeles International Airport'],
16
    ['Medical Supplies', 'John F. Kennedy International Airport'],
17
    ['Auto Parts', 'Chicago O\'Hare International Airport'],
18
    ['Fresh Produce', 'London Heathrow Airport'],
19
    ['Textiles', 'Charles de Gaulle Airport'],
20
    ['Industrial Equipment', 'Dubai International Airport'],
21
    ['Pharmaceuticals', 'Tokyo Haneda Airport'],
22
    ['Consumer Goods', 'Beijing Capital International Airport'],
23
    ['Machine Parts', 'Singapore Changi Airport'],
24
    ['Food Products', 'Amsterdam Airport Schiphol']
25
  ];
26

27
  readonly airportKVData = [
28
    'Los Angeles International Airport',
29
    'John F. Kennedy International Airport',
30
    'Chicago O\'Hare International Airport',
31
    'London Heathrow Airport',
32
    'Charles de Gaulle Airport',
33
    'Dubai International Airport',
34
    'Tokyo Haneda Airport',
35
    'Beijing Capital International Airport',
36
    'Singapore Changi Airport',
37
    'Amsterdam Airport Schiphol',
38
    'Frankfurt Airport',
39
    'Seoul Incheon International Airport',
40
    'Toronto Pearson International Airport',
41
    'Madrid-Barajas Airport',
42
    'Bangkok Suvarnabhumi Airport',
43
    'Munich International Airport',
44
    'Sydney Kingsford Smith Airport',
45
    'Barcelona-El Prat Airport',
46
    'Kuala Lumpur International Airport',
47
    'Zurich Airport'
48
  ];
49

50
  readonly gridSettings: GridSettings = {
51
    height: 'auto',
52
    autoWrapRow: true,
53
    autoWrapCol: true,
54
    columns: [
55
      {
56
        title: 'Shipment',
57
      },
58
      {
59
        type: 'autocomplete',
60
        source: this.airportKVData,
61
        title: 'Airport',
62
      },
63
    ],
64
  };
65
}
66
/* end-file */
67

68

69

70
/* file: app.config.ts */
71
import { ApplicationConfig, provideZoneChangeDetection } from '@angular/core';
72
import { registerAllModules } from 'handsontable/registry';
73
import { HOT_GLOBAL_CONFIG, HotGlobalConfig, NON_COMMERCIAL_LICENSE } from '@handsontable/angular-wrapper';
74

75
// register Handsontable's modules
76
registerAllModules();
77

78
export const appConfig: ApplicationConfig = {
79
  providers: [
80
    provideZoneChangeDetection({ eventCoalescing: true }),
81
    {
82
      provide: HOT_GLOBAL_CONFIG,
83
      useValue: { license: NON_COMMERCIAL_LICENSE } as HotGlobalConfig,
84
    },
85
  ],
86
};
87
/* end-file */

1
<div>
2
  <example4-autocomplete-cell-type></example4-autocomplete-cell-type>
3
</div>

Array of objects

You can provide the source option as an array of objects with key and value properties. The value property will be used as the autocomplete suggestion, while the entire object will be used as the value of the cell.

1
/* file: app.component.ts */
2
import { Component } from '@angular/core';
3
import { GridSettings, HotTableModule} from '@handsontable/angular-wrapper';
4

5
@Component({
6
  selector: 'example5-autocomplete-cell-type',
7
  standalone: true,
8
  imports: [HotTableModule],
9
  template: ` <div>
10
    <hot-table [data]="shipmentKVData" [settings]="gridSettings"></hot-table>
11
  </div>`
12
})
13
export class AppComponent {
14
  readonly shipmentKVData = [
15
    [
16
      'Electronics and Gadgets',
17
      { key: 'LAX', value: 'Los Angeles International Airport' },
18
    ],
19
    [
20
      'Medical Supplies',
21
      { key: 'JFK', value: 'John F. Kennedy International Airport' }
22
    ],
23
    [
24
      'Auto Parts',
25
      { key: 'ORD', value: 'Chicago O\'Hare International Airport' }
26
    ],
27
    [
28
      'Fresh Produce',
29
      { key: 'LHR', value: 'London Heathrow Airport' }
30
    ],
31
    [
32
      'Textiles',
33
      { key: 'CDG', value: 'Charles de Gaulle Airport' }
34
    ],
35
    [
36
      'Industrial Equipment',
37
      { key: 'DXB', value: 'Dubai International Airport' }
38
    ],
39
    [
40
      'Pharmaceuticals',
41
      { key: 'HND', value: 'Tokyo Haneda Airport' }
42
    ],
43
    [
44
      'Consumer Goods',
45
      { key: 'PEK', value: 'Beijing Capital International Airport' }
46
    ],
47
    [
48
      'Machine Parts',
49
      { key: 'SIN', value: 'Singapore Changi Airport' }
50
    ],
51
    [
52
      'Food Products',
53
      { key: 'AMS', value: 'Amsterdam Airport Schiphol' }
54
    ]
55
  ];
56

57
  readonly airportKVData = [
58
    { key: 'LAX', value: 'Los Angeles International Airport' },
59
    { key: 'JFK', value: 'John F. Kennedy International Airport' },
60
    { key: 'ORD', value: 'Chicago O\'Hare International Airport' },
61
    { key: 'LHR', value: 'London Heathrow Airport' },
62
    { key: 'CDG', value: 'Charles de Gaulle Airport' },
63
    { key: 'DXB', value: 'Dubai International Airport' },
64
    { key: 'HND', value: 'Tokyo Haneda Airport' },
65
    { key: 'PEK', value: 'Beijing Capital International Airport' },
66
    { key: 'SIN', value: 'Singapore Changi Airport' },
67
    { key: 'AMS', value: 'Amsterdam Airport Schiphol' },
68
    { key: 'FRA', value: 'Frankfurt Airport' },
69
    { key: 'ICN', value: 'Seoul Incheon International Airport' },
70
    { key: 'YYZ', value: 'Toronto Pearson International Airport' },
71
    { key: 'MAD', value: 'Madrid-Barajas Airport' },
72
    { key: 'BKK', value: 'Bangkok Suvarnabhumi Airport' },
73
    { key: 'MUC', value: 'Munich International Airport' },
74
    { key: 'SYD', value: 'Sydney Kingsford Smith Airport' },
75
    { key: 'BCN', value: 'Barcelona-El Prat Airport' },
76
    { key: 'KUL', value: 'Kuala Lumpur International Airport' },
77
    { key: 'ZRH', value: 'Zurich Airport' }
78
  ];
79

80
  readonly gridSettings: GridSettings = {
81
    height: 'auto',
82
    autoWrapRow: true,
83
    autoWrapCol: true,
84
    columns: [
85
      {
86
        title: 'Shipment',
87
      },
88
      {
89
        type: 'autocomplete',
90
        source: this.airportKVData,
91
        title: 'Airport',
92
      },
93
    ],
94
  };
95
}
96
/* end-file */
97

98

99

100
/* file: app.config.ts */
101
import { ApplicationConfig, provideZoneChangeDetection } from '@angular/core';
102
import { registerAllModules } from 'handsontable/registry';
103
import { HOT_GLOBAL_CONFIG, HotGlobalConfig, NON_COMMERCIAL_LICENSE } from '@handsontable/angular-wrapper';
104

105
// register Handsontable's modules
106
registerAllModules();
107

108
export const appConfig: ApplicationConfig = {
109
  providers: [
110
    provideZoneChangeDetection({ eventCoalescing: true }),
111
    {
112
      provide: HOT_GLOBAL_CONFIG,
113
      useValue: { license: NON_COMMERCIAL_LICENSE } as HotGlobalConfig,
114
    },
115
  ],
116
};
117
/* end-file */

1
<div>
2
  <example5-autocomplete-cell-type></example5-autocomplete-cell-type>
3
</div>

API methods

When working with object-based autocomplete data, you can use methods like getSourceData(), getSourceDataAtCell(), getSourceDataAtRow() etc., to get the data in its original object format with both key and value properties. The getData() method will return only the value property’s value.

The `filter` option

By default, the autocomplete dropdown hides options that don’t match what the user is typing. Set filter: false to always show the full list of source options, regardless of the current input. This is useful when you want to give users a visual reference of all available choices while they type.

The left column uses the default behavior (filter: true) — options are narrowed as you type. The right column has filter: false — all options remain visible no matter what you enter.

1
/* file: app.component.ts */
2
import { Component } from '@angular/core';
3
import { GridSettings, HotTableModule} from '@handsontable/angular-wrapper';
4

5
@Component({
6
  selector: 'example6-autocomplete-cell-type',
7
  standalone: true,
8
  imports: [HotTableModule],
9
  template: ` <div>
10
    <hot-table [data]="data" [settings]="gridSettings"></hot-table>
11
  </div>`
12
})
13
export class AppComponent {
14
  readonly fruits = [
15
    'Apple',
16
    'Apricot',
17
    'Avocado',
18
    'Banana',
19
    'Blueberry',
20
    'Cherry',
21
    'Grape',
22
    'Lemon',
23
    'Lime',
24
    'Mango',
25
    'Orange',
26
    'Peach',
27
    'Pear',
28
    'Pineapple',
29
    'Plum',
30
    'Raspberry',
31
    'Strawberry',
32
    'Watermelon',
33
  ];
34

35
  readonly data = [
36
    ['Apple', 'Apple'],
37
    ['Banana', 'Banana'],
38
    ['Cherry', 'Cherry'],
39
    ['Mango', 'Mango'],
40
    ['Orange', 'Orange'],
41
  ];
42

43
  readonly gridSettings: GridSettings = {
44
    height: 'auto',
45
    autoWrapRow: true,
46
    autoWrapCol: true,
47
    colHeaders: ['Filter: true (default)', 'Filter: false'],
48
    columns: [
49
      {
50
        type: 'autocomplete',
51
        source: this.fruits,
52
        strict: false,
53
      },
54
      {
55
        type: 'autocomplete',
56
        source: this.fruits,
57
        strict: false,
58
        // don't hide options that don't match the search query
59
        filter: false,
60
      },
61
    ],
62
  };
63
}
64
/* end-file */
65

66

67

68
/* file: app.config.ts */
69
import { ApplicationConfig, provideZoneChangeDetection } from '@angular/core';
70
import { registerAllModules } from 'handsontable/registry';
71
import { HOT_GLOBAL_CONFIG, HotGlobalConfig, NON_COMMERCIAL_LICENSE } from '@handsontable/angular-wrapper';
72

73
// register Handsontable's modules
74
registerAllModules();
75

76
export const appConfig: ApplicationConfig = {
77
  providers: [
78
    provideZoneChangeDetection({ eventCoalescing: true }),
79
    {
80
      provide: HOT_GLOBAL_CONFIG,
81
      useValue: { license: NON_COMMERCIAL_LICENSE } as HotGlobalConfig,
82
    },
83
  ],
84
};
85
/* end-file */

1
<div>
2
  <example6-autocomplete-cell-type></example6-autocomplete-cell-type>
3
</div>

The `filteringCaseSensitive` option

By default, the autocomplete search is case-insensitive — typing "bl" matches both "Black" and "blue". Set filteringCaseSensitive: true to require an exact case match when filtering suggestions.

The left column uses the default case-insensitive behavior. The right column has filteringCaseSensitive: true — only options whose case matches the typed characters are shown.

1
/* file: app.component.ts */
2
import { Component } from '@angular/core';
3
import { GridSettings, HotTableModule} from '@handsontable/angular-wrapper';
4

5
@Component({
6
  selector: 'example7-autocomplete-cell-type',
7
  standalone: true,
8
  imports: [HotTableModule],
9
  template: ` <div>
10
    <hot-table [data]="data" [settings]="gridSettings"></hot-table>
11
  </div>`
12
})
13
export class AppComponent {
14
  readonly colors = [
15
    'Black',
16
    'Blue',
17
    'brown',
18
    'cyan',
19
    'Gray',
20
    'green',
21
    'Lime',
22
    'Magenta',
23
    'Navy',
24
    'olive',
25
    'orange',
26
    'Pink',
27
    'Purple',
28
    'Red',
29
    'silver',
30
    'Teal',
31
    'White',
32
    'Yellow',
33
  ];
34

35
  readonly data = [
36
    ['Black', 'Black'],
37
    ['Blue', 'Blue'],
38
    ['Gray', 'Gray'],
39
    ['Red', 'Red'],
40
    ['White', 'White'],
41
  ];
42

43
  readonly gridSettings: GridSettings = {
44
    height: 'auto',
45
    autoWrapRow: true,
46
    autoWrapCol: true,
47
    colHeaders: ['Case-insensitive (default)', 'Case-sensitive'],
48
    columns: [
49
      {
50
        type: 'autocomplete',
51
        source: this.colors,
52
        strict: false,
53
      },
54
      {
55
        type: 'autocomplete',
56
        source: this.colors,
57
        strict: false,
58
        // match case while searching autocomplete options
59
        filteringCaseSensitive: true,
60
      },
61
    ],
62
  };
63
}
64
/* end-file */
65

66

67

68
/* file: app.config.ts */
69
import { ApplicationConfig, provideZoneChangeDetection } from '@angular/core';
70
import { registerAllModules } from 'handsontable/registry';
71
import { HOT_GLOBAL_CONFIG, HotGlobalConfig, NON_COMMERCIAL_LICENSE } from '@handsontable/angular-wrapper';
72

73
// register Handsontable's modules
74
registerAllModules();
75

76
export const appConfig: ApplicationConfig = {
77
  providers: [
78
    provideZoneChangeDetection({ eventCoalescing: true }),
79
    {
80
      provide: HOT_GLOBAL_CONFIG,
81
      useValue: { license: NON_COMMERCIAL_LICENSE } as HotGlobalConfig,
82
    },
83
  ],
84
};
85
/* end-file */

1
<div>
2
  <example7-autocomplete-cell-type></example7-autocomplete-cell-type>
3
</div>

The `sortByRelevance` option

By default, the autocomplete dropdown shows suggestions in the order you provide them in the source array. Set sortByRelevance: false to sort suggestions alphabetically instead.

The left column uses the default behavior (sortByRelevance: true) — suggestions keep the order from source. The right column has sortByRelevance: false — suggestions sort alphabetically.

1
/* file: app.component.ts */
2
import { Component } from '@angular/core';
3
import { GridSettings, HotTableModule} from '@handsontable/angular-wrapper';
4

5
@Component({
6
  selector: 'example8-autocomplete-cell-type',
7
  standalone: true,
8
  imports: [HotTableModule],
9
  template: ` <div>
10
    <hot-table [data]="data" [settings]="gridSettings"></hot-table>
11
  </div>`
12
})
13
export class AppComponent {
14
  readonly statuses = [
15
    'Backlog',
16
    'In progress',
17
    'Blocked',
18
    'Done',
19
    'Cancelled',
20
  ];
21

22
  readonly data = [
23
    ['Backlog', 'Backlog'],
24
    ['In progress', 'In progress'],
25
    ['Blocked', 'Blocked'],
26
    ['Done', 'Done'],
27
    ['Cancelled', 'Cancelled'],
28
  ];
29

30
  readonly gridSettings: GridSettings = {
31
    height: 'auto',
32
    autoWrapRow: true,
33
    autoWrapCol: true,
34
    colHeaders: ['Source order (default)', 'Alphabetical order'],
35
    columns: [
36
      {
37
        type: 'autocomplete',
38
        source: this.statuses,
39
        strict: false,
40
      },
41
      {
42
        type: 'autocomplete',
43
        source: this.statuses,
44
        strict: false,
45
        // sort suggestions alphabetically instead of using the `source` order
46
        sortByRelevance: false,
47
      },
48
    ],
49
  };
50
}
51
/* end-file */
52

53

54

55
/* file: app.config.ts */
56
import { ApplicationConfig, provideZoneChangeDetection } from '@angular/core';
57
import { registerAllModules } from 'handsontable/registry';
58
import { HOT_GLOBAL_CONFIG, HotGlobalConfig, NON_COMMERCIAL_LICENSE } from '@handsontable/angular-wrapper';
59

60
// register Handsontable's modules
61
registerAllModules();
62

63
export const appConfig: ApplicationConfig = {
64
  providers: [
65
    provideZoneChangeDetection({ eventCoalescing: true }),
66
    {
67
      provide: HOT_GLOBAL_CONFIG,
68
      useValue: { license: NON_COMMERCIAL_LICENSE } as HotGlobalConfig,
69
    },
70
  ],
71
};
72
/* end-file */

1
<div>
2
  <example8-autocomplete-cell-type></example8-autocomplete-cell-type>
3
</div>

The `allowHtml` option

By default, the autocomplete dropdown and cell renderer display source values as plain text, so any HTML tags they contain show up literally. Set allowHtml: true to render source values as HTML instead, for example to show colored status labels.

The left column uses the default behavior (allowHtml: false) — HTML tags in source show up as plain text. The right column has allowHtml: true — the same source values render as colored labels.

1
/* file: app.component.ts */
2
import { Component } from '@angular/core';
3
import { GridSettings, HotTableModule} from '@handsontable/angular-wrapper';
4

5
@Component({
6
  selector: 'example9-autocomplete-cell-type',
7
  standalone: true,
8
  imports: [HotTableModule],
9
  template: ` <div>
10
    <hot-table [data]="data" [settings]="gridSettings"></hot-table>
11
  </div>`
12
})
13
export class AppComponent {
14
  readonly stockStatuses = [
15
    '<span style="color: #1a7f37">In stock</span>',
16
    '<span style="color: #b35900">Low stock</span>',
17
    '<span style="color: #c92a2a">Out of stock</span>',
18
    '<span style="color: #495057">Backordered</span>',
19
    '<span style="color: #495057">Discontinued</span>',
20
  ];
21

22
  readonly data = [
23
    [this.stockStatuses[0], this.stockStatuses[0]],
24
    [this.stockStatuses[1], this.stockStatuses[1]],
25
    [this.stockStatuses[2], this.stockStatuses[2]],
26
    [this.stockStatuses[3], this.stockStatuses[3]],
27
    [this.stockStatuses[4], this.stockStatuses[4]],
28
  ];
29

30
  readonly gridSettings: GridSettings = {
31
    height: 'auto',
32
    autoWrapRow: true,
33
    autoWrapCol: true,
34
    colHeaders: ['allowHtml: false (default)', 'allowHtml: true'],
35
    columns: [
36
      {
37
        type: 'autocomplete',
38
        source: this.stockStatuses,
39
        strict: false,
40
      },
41
      {
42
        type: 'autocomplete',
43
        source: this.stockStatuses,
44
        strict: false,
45
        // render `source` values as HTML — only use with trusted, static data
46
        allowHtml: true,
47
      },
48
    ],
49
  };
50
}
51
/* end-file */
52

53

54

55
/* file: app.config.ts */
56
import { ApplicationConfig, provideZoneChangeDetection } from '@angular/core';
57
import { registerAllModules } from 'handsontable/registry';
58
import { HOT_GLOBAL_CONFIG, HotGlobalConfig, NON_COMMERCIAL_LICENSE } from '@handsontable/angular-wrapper';
59

60
// register Handsontable's modules
61
registerAllModules();
62

63
export const appConfig: ApplicationConfig = {
64
  providers: [
65
    provideZoneChangeDetection({ eventCoalescing: true }),
66
    {
67
      provide: HOT_GLOBAL_CONFIG,
68
      useValue: { license: NON_COMMERCIAL_LICENSE } as HotGlobalConfig,
69
    },
70
  ],
71
};
72
/* end-file */

1
<div>
2
  <example9-autocomplete-cell-type></example9-autocomplete-cell-type>
3
</div>

Result

After configuring the autocomplete cell type, cells display a text input that shows matching suggestions as the user types. In strict mode, only values from the source list are accepted. In flexible mode, users can also enter custom values not in the list.

Keyboard shortcuts

The autocomplete cell editor shares its keyboard shortcuts with the handsontable editor. In strict mode, a few of these shortcuts behave differently — see Autocomplete strict mode.

Related guides

Cell type

Dropdown cell type

Select cell type

Configuration options

allowHtml

allowInvalid

filter

filteringCaseSensitive

Core methods

Hooks