@vaadin/multi-select-combo-box 25.1.0-alpha9 → 25.1.0-beta2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/custom-elements.json +777 -501
  2. package/package.json +15 -15
  3. package/src/vaadin-multi-select-combo-box-mixin.js +1 -1
  4. package/web-types.json +34 -12
  5. package/web-types.lit.json +1 -1
package/custom-elements.json CHANGED
@@ -19,306 +19,237 @@
19
19
  },
20
20
  {
21
21
  "kind": "javascript-module",
22
- "path": "src/vaadin-multi-select-combo-box-chip.js",
23
- "declarations": [],
24
- "exports": []
25
- },
26
- {
27
- "kind": "javascript-module",
28
- "path": "src/vaadin-multi-select-combo-box-container.js",
29
- "declarations": [],
30
- "exports": []
31
- },
32
- {
33
- "kind": "javascript-module",
34
- "path": "src/vaadin-multi-select-combo-box-item.js",
22
+ "path": "src/vaadin-multi-select-combo-box-mixin.js",
35
23
  "declarations": [
36
24
  {
37
- "kind": "class",
38
- "description": "An item element used by the `<vaadin-multi-select-combo-box>` dropdown.\n\n### Styling\n\nThe following shadow DOM parts are available for styling:\n\nPart name | Description\n------------|--------------\n`checkmark` | The graphical checkmark shown for a selected item\n`content` | The element that wraps the item content\n\nThe following state attributes are exposed for styling:\n\nAttribute | Description\n-------------|-------------\n`selected` | Set when the item is selected\n`focused` | Set when the item is focused\n\nSee [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.",
39
- "name": "MultiSelectComboBoxItem",
25
+ "kind": "mixin",
26
+ "description": "",
27
+ "name": "MultiSelectComboBoxMixin",
40
28
  "members": [
41
29
  {
42
30
  "kind": "field",
43
- "name": "focused",
31
+ "name": "accessibleName",
44
32
  "privacy": "public",
45
33
  "type": {
46
- "text": "boolean"
34
+ "text": "string"
47
35
  },
48
- "description": "True when item is focused.",
49
- "attribute": "focused",
36
+ "description": "String used to label the component to screen reader users.",
37
+ "attribute": "accessible-name",
50
38
  "inheritedFrom": {
51
- "name": "ComboBoxItemMixin",
52
- "package": "@vaadin/combo-box/src/vaadin-combo-box-item-mixin.js"
39
+ "name": "FieldMixin",
40
+ "package": "@vaadin/field-base/src/field-mixin.js"
53
41
  }
54
42
  },
55
43
  {
56
44
  "kind": "field",
57
- "name": "index",
45
+ "name": "accessibleNameRef",
58
46
  "privacy": "public",
59
47
  "type": {
60
- "text": "number"
48
+ "text": "string"
61
49
  },
62
- "description": "The index of the item.",
63
- "attribute": "index",
50
+ "description": "Id of the element used as label of the component to screen reader users.",
51
+ "attribute": "accessible-name-ref",
64
52
  "inheritedFrom": {
65
- "name": "ComboBoxItemMixin",
66
- "package": "@vaadin/combo-box/src/vaadin-combo-box-item-mixin.js"
53
+ "name": "FieldMixin",
54
+ "package": "@vaadin/field-base/src/field-mixin.js"
67
55
  }
68
56
  },
69
57
  {
70
58
  "kind": "field",
71
- "name": "item",
59
+ "name": "allowCustomValue",
72
60
  "privacy": "public",
73
61
  "type": {
74
- "text": "object"
62
+ "text": "boolean"
75
63
  },
76
- "description": "The item to render.",
77
- "attribute": "item",
78
- "inheritedFrom": {
79
- "name": "ComboBoxItemMixin",
80
- "package": "@vaadin/combo-box/src/vaadin-combo-box-item-mixin.js"
81
- }
64
+ "description": "When true, the user can input a value that is not present in the items list.",
65
+ "attribute": "allow-custom-value"
82
66
  },
83
67
  {
84
68
  "kind": "field",
85
- "name": "label",
69
+ "name": "allowedCharPattern",
86
70
  "privacy": "public",
87
71
  "type": {
88
72
  "text": "string"
89
73
  },
90
- "description": "The text to render in the item.",
91
- "attribute": "label",
74
+ "description": "A pattern matched against individual characters the user inputs.\n\nWhen set, the field will prevent:\n- `keydown` events if the entered key doesn't match `/^allowedCharPattern$/`\n- `paste` events if the pasted text doesn't match `/^allowedCharPattern*$/`\n- `drop` events if the dropped text doesn't match `/^allowedCharPattern*$/`\n\nFor example, to allow entering only numbers and minus signs, use:\n`allowedCharPattern = \"[\\\\d-]\"`",
75
+ "attribute": "allowed-char-pattern",
92
76
  "inheritedFrom": {
93
- "name": "ComboBoxItemMixin",
94
- "package": "@vaadin/combo-box/src/vaadin-combo-box-item-mixin.js"
77
+ "name": "InputControlMixin",
78
+ "package": "@vaadin/field-base/src/input-control-mixin.js"
95
79
  }
96
80
  },
97
81
  {
98
82
  "kind": "field",
99
- "name": "renderer",
83
+ "name": "autoExpandHorizontally",
100
84
  "privacy": "public",
101
85
  "type": {
102
- "text": "function"
86
+ "text": "boolean"
103
87
  },
104
- "description": "Custom function for rendering the item content.",
105
- "attribute": "renderer",
106
- "inheritedFrom": {
107
- "name": "ComboBoxItemMixin",
108
- "package": "@vaadin/combo-box/src/vaadin-combo-box-item-mixin.js"
109
- }
88
+ "description": "Set to true to auto expand horizontally, causing input field to\ngrow until max width is reached.",
89
+ "attribute": "auto-expand-horizontally"
110
90
  },
111
91
  {
112
- "kind": "method",
113
- "name": "requestContentUpdate",
114
- "description": "Requests an update for the content of the item.\nWhile performing the update, it invokes the renderer passed in the `renderer` property.\n\nIt is not guaranteed that the update happens immediately (synchronously) after it is requested.",
115
- "inheritedFrom": {
116
- "name": "ComboBoxItemMixin",
117
- "package": "@vaadin/combo-box/src/vaadin-combo-box-item-mixin.js"
118
- }
92
+ "kind": "field",
93
+ "name": "autoExpandVertically",
94
+ "privacy": "public",
95
+ "type": {
96
+ "text": "boolean"
97
+ },
98
+ "description": "Set to true to not collapse selected items chips into the overflow\nchip and instead always expand vertically, causing input field to\nwrap into multiple lines when width is limited.",
99
+ "attribute": "auto-expand-vertically"
119
100
  },
120
101
  {
121
102
  "kind": "field",
122
- "name": "selected",
103
+ "name": "autoOpenDisabled",
123
104
  "privacy": "public",
124
105
  "type": {
125
106
  "text": "boolean"
126
107
  },
127
- "description": "True when item is selected.",
128
- "attribute": "selected",
108
+ "description": "Set true to prevent the overlay from opening automatically.",
109
+ "attribute": "auto-open-disabled",
129
110
  "inheritedFrom": {
130
- "name": "ComboBoxItemMixin",
131
- "package": "@vaadin/combo-box/src/vaadin-combo-box-item-mixin.js"
111
+ "name": "ComboBoxBaseMixin",
112
+ "package": "@vaadin/combo-box/src/vaadin-combo-box-base-mixin.js"
132
113
  }
133
- }
134
- ],
135
- "mixins": [
136
- {
137
- "name": "ComboBoxItemMixin",
138
- "package": "@vaadin/combo-box/src/vaadin-combo-box-item-mixin.js"
139
114
  },
140
115
  {
141
- "name": "ThemableMixin",
142
- "package": "@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js"
116
+ "kind": "field",
117
+ "name": "autoselect",
118
+ "privacy": "public",
119
+ "type": {
120
+ "text": "boolean"
121
+ },
122
+ "description": "If true, the input text gets fully selected when the field is focused using click or touch / tap.",
123
+ "attribute": "autoselect",
124
+ "inheritedFrom": {
125
+ "name": "InputControlMixin",
126
+ "package": "@vaadin/field-base/src/input-control-mixin.js"
127
+ }
143
128
  },
144
129
  {
145
- "name": "DirMixin",
146
- "package": "@vaadin/component-base/src/dir-mixin.js"
130
+ "kind": "method",
131
+ "name": "checkValidity",
132
+ "description": "Returns true if the current input value satisfies all constraints (if any).",
133
+ "return": {
134
+ "type": {
135
+ "text": "boolean"
136
+ }
137
+ }
147
138
  },
148
139
  {
149
- "name": "PolylitMixin",
150
- "package": "@vaadin/component-base/src/polylit-mixin.js"
140
+ "kind": "method",
141
+ "name": "clear",
142
+ "description": "Clears the selected items."
151
143
  },
152
144
  {
153
- "name": "LumoInjectionMixin",
154
- "package": "@vaadin/vaadin-themable-mixin/lumo-injection-mixin.js"
155
- }
156
- ],
157
- "superclass": {
158
- "name": "LitElement",
159
- "package": "lit"
160
- },
161
- "tagName": "vaadin-multi-select-combo-box-item",
162
- "customElement": true,
163
- "attributes": [
164
- {
165
- "name": "focused",
145
+ "kind": "field",
146
+ "name": "clearButtonVisible",
147
+ "privacy": "public",
166
148
  "type": {
167
149
  "text": "boolean"
168
150
  },
169
- "description": "True when item is focused.",
170
- "fieldName": "focused",
151
+ "description": "Set to true to display the clear icon which clears the input.\n\nIt is up to the component to choose where to place the clear icon:\nin the Shadow DOM or in the light DOM. In any way, a reference to\nthe clear icon element should be provided via the `clearElement` getter.",
152
+ "attribute": "clear-button-visible",
171
153
  "inheritedFrom": {
172
- "name": "ComboBoxItemMixin",
173
- "package": "@vaadin/combo-box/src/vaadin-combo-box-item-mixin.js"
154
+ "name": "ClearButtonMixin",
155
+ "package": "@vaadin/field-base/src/clear-button-mixin.js"
174
156
  }
175
157
  },
176
158
  {
177
- "name": "hidden",
159
+ "kind": "method",
160
+ "name": "clearCache",
161
+ "description": "Clears the cached pages and reloads data from data provider when needed.",
178
162
  "inheritedFrom": {
179
- "name": "ComboBoxItemMixin",
180
- "package": "@vaadin/combo-box/src/vaadin-combo-box-item-mixin.js"
163
+ "name": "ComboBoxDataProviderMixin",
164
+ "package": "@vaadin/combo-box/src/vaadin-combo-box-data-provider-mixin.js"
181
165
  }
182
166
  },
183
167
  {
184
- "name": "index",
185
- "type": {
186
- "text": "number"
187
- },
188
- "description": "The index of the item.",
189
- "fieldName": "index",
168
+ "kind": "method",
169
+ "name": "close",
170
+ "description": "Closes the dropdown list.",
190
171
  "inheritedFrom": {
191
- "name": "ComboBoxItemMixin",
192
- "package": "@vaadin/combo-box/src/vaadin-combo-box-item-mixin.js"
172
+ "name": "ComboBoxBaseMixin",
173
+ "package": "@vaadin/combo-box/src/vaadin-combo-box-base-mixin.js"
193
174
  }
194
175
  },
195
176
  {
196
- "name": "label",
177
+ "kind": "field",
178
+ "name": "dataProvider",
179
+ "privacy": "public",
197
180
  "type": {
198
- "text": "string"
181
+ "text": "ComboBoxDataProvider | undefined"
199
182
  },
200
- "description": "The text to render in the item.",
201
- "fieldName": "label",
183
+ "description": "Function that provides items lazily. Receives arguments `params`, `callback`\n\n`params.page` Requested page index\n\n`params.pageSize` Current page size\n\n`params.filter` Currently applied filter\n\n`callback(items, size)` Callback function with arguments:\n - `items` Current page of items\n - `size` Total number of items.",
184
+ "attribute": "data-provider",
202
185
  "inheritedFrom": {
203
- "name": "ComboBoxItemMixin",
204
- "package": "@vaadin/combo-box/src/vaadin-combo-box-item-mixin.js"
186
+ "name": "ComboBoxDataProviderMixin",
187
+ "package": "@vaadin/combo-box/src/vaadin-combo-box-data-provider-mixin.js"
205
188
  }
206
189
  },
207
190
  {
208
- "name": "renderer",
191
+ "kind": "field",
192
+ "name": "errorMessage",
193
+ "privacy": "public",
209
194
  "type": {
210
- "text": "function"
195
+ "text": "string"
211
196
  },
212
- "description": "Custom function for rendering the item content.",
213
- "fieldName": "renderer",
197
+ "description": "Error to show when the field is invalid.",
198
+ "attribute": "error-message",
214
199
  "inheritedFrom": {
215
- "name": "ComboBoxItemMixin",
216
- "package": "@vaadin/combo-box/src/vaadin-combo-box-item-mixin.js"
200
+ "name": "FieldMixin",
201
+ "package": "@vaadin/field-base/src/field-mixin.js"
217
202
  }
218
203
  },
219
- {
220
- "name": "selected",
221
- "type": {
222
- "text": "boolean"
223
- },
224
- "description": "True when item is selected.",
225
- "fieldName": "selected",
226
- "inheritedFrom": {
227
- "name": "ComboBoxItemMixin",
228
- "package": "@vaadin/combo-box/src/vaadin-combo-box-item-mixin.js"
229
- }
230
- }
231
- ],
232
- "events": []
233
- }
234
- ],
235
- "exports": [
236
- {
237
- "kind": "js",
238
- "name": "MultiSelectComboBoxItem",
239
- "declaration": {
240
- "name": "MultiSelectComboBoxItem",
241
- "module": "src/vaadin-multi-select-combo-box-item.js"
242
- }
243
- }
244
- ]
245
- },
246
- {
247
- "kind": "javascript-module",
248
- "path": "src/vaadin-multi-select-combo-box-mixin.js",
249
- "declarations": [
250
- {
251
- "kind": "mixin",
252
- "description": "",
253
- "name": "MultiSelectComboBoxMixin",
254
- "members": [
255
204
  {
256
205
  "kind": "field",
257
- "name": "allowCustomValue",
206
+ "name": "filter",
258
207
  "privacy": "public",
259
208
  "type": {
260
- "text": "boolean"
209
+ "text": "string"
261
210
  },
262
- "description": "When true, the user can input a value that is not present in the items list.",
263
- "attribute": "allow-custom-value"
211
+ "description": "Filtering string the user has typed into the input field.",
212
+ "attribute": "filter",
213
+ "inheritedFrom": {
214
+ "name": "ComboBoxItemsMixin",
215
+ "package": "@vaadin/combo-box/src/vaadin-combo-box-items-mixin.js"
216
+ }
264
217
  },
265
218
  {
266
219
  "kind": "field",
267
- "name": "autoExpandHorizontally",
220
+ "name": "filteredItems",
268
221
  "privacy": "public",
269
222
  "type": {
270
- "text": "boolean"
223
+ "text": "!Array<!ComboBoxItem | string> | undefined"
271
224
  },
272
- "description": "Set to true to auto expand horizontally, causing input field to\ngrow until max width is reached.",
273
- "attribute": "auto-expand-horizontally"
225
+ "description": "A subset of items, filtered based on the user input. Filtered items\ncan be assigned directly to omit the internal filtering functionality.\nThe items can be of either `String` or `Object` type.",
226
+ "attribute": "filtered-items",
227
+ "inheritedFrom": {
228
+ "name": "ComboBoxItemsMixin",
229
+ "package": "@vaadin/combo-box/src/vaadin-combo-box-items-mixin.js"
230
+ }
274
231
  },
275
232
  {
276
233
  "kind": "field",
277
- "name": "autoExpandVertically",
234
+ "name": "helperText",
278
235
  "privacy": "public",
279
236
  "type": {
280
- "text": "boolean"
237
+ "text": "string"
281
238
  },
282
- "description": "Set to true to not collapse selected items chips into the overflow\nchip and instead always expand vertically, causing input field to\nwrap into multiple lines when width is limited.",
283
- "attribute": "auto-expand-vertically"
284
- },
285
- {
286
- "kind": "method",
287
- "name": "checkValidity",
288
- "description": "Returns true if the current input value satisfies all constraints (if any).",
289
- "return": {
290
- "type": {
291
- "text": "boolean"
292
- }
239
+ "description": "String used for the helper text.",
240
+ "attribute": "helper-text",
241
+ "inheritedFrom": {
242
+ "name": "FieldMixin",
243
+ "package": "@vaadin/field-base/src/field-mixin.js"
293
244
  }
294
245
  },
295
- {
296
- "kind": "method",
297
- "name": "clear",
298
- "description": "Clears the selected items."
299
- },
300
- {
301
- "kind": "method",
302
- "name": "clearCache",
303
- "description": "Clears the cached pages and reloads data from data provider when needed."
304
- },
305
246
  {
306
247
  "kind": "field",
307
248
  "name": "i18n",
308
249
  "description": "The object used to localize this component. To change the default\nlocalization, replace this with an object that provides all properties, or\njust the individual properties you want to change.\n\nThe object has the following JSON structure and default values:\n```js\n{\n // Screen reader announcement on clear button click.\n cleared: 'Selection cleared',\n // Screen reader announcement when a chip is focused.\n focused: ' focused. Press Backspace to remove',\n // Screen reader announcement when item is selected.\n selected: 'added to selection',\n // Screen reader announcement when item is deselected.\n deselected: 'removed from selection',\n // Screen reader announcement of the selected items count.\n // {count} is replaced with the actual count of items.\n total: '{count} items selected',\n}\n```",
309
- "return": {
310
- "type": {
311
- "text": "!MultiSelectComboBoxI18n"
312
- }
250
+ "type": {
251
+ "text": "Object"
313
252
  },
314
- "parameters": [
315
- {
316
- "name": "value",
317
- "type": {
318
- "text": "Object"
319
- }
320
- }
321
- ],
322
253
  "inheritedFrom": {
323
254
  "name": "I18nMixin",
324
255
  "package": "@vaadin/component-base/src/i18n-mixin.js"
@@ -344,6 +275,62 @@
344
275
  "description": "Path for the id of the item, used to detect whether the item is selected.",
345
276
  "attribute": "item-id-path"
346
277
  },
278
+ {
279
+ "kind": "field",
280
+ "name": "itemLabelGenerator",
281
+ "privacy": "public",
282
+ "type": {
283
+ "text": "object"
284
+ },
285
+ "description": "A function that is used to generate the label for dropdown\nitems based on the item. Receives one argument:\n- `item` The item to generate the label for.",
286
+ "attribute": "item-label-generator",
287
+ "inheritedFrom": {
288
+ "name": "ComboBoxItemsMixin",
289
+ "package": "@vaadin/combo-box/src/vaadin-combo-box-items-mixin.js"
290
+ }
291
+ },
292
+ {
293
+ "kind": "field",
294
+ "name": "itemLabelPath",
295
+ "privacy": "public",
296
+ "type": {
297
+ "text": "string"
298
+ },
299
+ "description": "Path for label of the item. If `items` is an array of objects, the\n`itemLabelPath` is used to fetch the displayed string label for each\nitem.\n\nThe item label is also used for matching items when processing user\ninput, i.e., for filtering and selecting items.",
300
+ "attribute": "item-label-path",
301
+ "inheritedFrom": {
302
+ "name": "ComboBoxItemsMixin",
303
+ "package": "@vaadin/combo-box/src/vaadin-combo-box-items-mixin.js"
304
+ }
305
+ },
306
+ {
307
+ "kind": "field",
308
+ "name": "items",
309
+ "privacy": "public",
310
+ "type": {
311
+ "text": "!Array<!ComboBoxItem | string> | undefined"
312
+ },
313
+ "description": "A full set of items to filter the visible options from.\nThe items can be of either `String` or `Object` type.",
314
+ "attribute": "items",
315
+ "inheritedFrom": {
316
+ "name": "ComboBoxItemsMixin",
317
+ "package": "@vaadin/combo-box/src/vaadin-combo-box-items-mixin.js"
318
+ }
319
+ },
320
+ {
321
+ "kind": "field",
322
+ "name": "itemValuePath",
323
+ "privacy": "public",
324
+ "type": {
325
+ "text": "string"
326
+ },
327
+ "description": "Path for the value of the item. If `items` is an array of objects, the\n`itemValuePath:` is used to fetch the string value for the selected\nitem.\n\nThe item value is used in the `value` property of the combo box,\nto provide the form value.",
328
+ "attribute": "item-value-path",
329
+ "inheritedFrom": {
330
+ "name": "ComboBoxItemsMixin",
331
+ "package": "@vaadin/combo-box/src/vaadin-combo-box-items-mixin.js"
332
+ }
333
+ },
347
334
  {
348
335
  "kind": "field",
349
336
  "name": "keepFilter",
@@ -354,6 +341,20 @@
354
341
  "description": "When true, filter string isn't cleared after selecting an item.",
355
342
  "attribute": "keep-filter"
356
343
  },
344
+ {
345
+ "kind": "field",
346
+ "name": "label",
347
+ "privacy": "public",
348
+ "type": {
349
+ "text": "string"
350
+ },
351
+ "description": "The label text for the input node.\nWhen no light dom defined via [slot=label], this value will be used.",
352
+ "attribute": "label",
353
+ "inheritedFrom": {
354
+ "name": "FieldMixin",
355
+ "package": "@vaadin/field-base/src/field-mixin.js"
356
+ }
357
+ },
357
358
  {
358
359
  "kind": "field",
359
360
  "name": "loading",
@@ -364,10 +365,56 @@
364
365
  "description": "True when loading items from the data provider, false otherwise.",
365
366
  "attribute": "loading"
366
367
  },
368
+ {
369
+ "kind": "field",
370
+ "name": "name",
371
+ "privacy": "public",
372
+ "type": {
373
+ "text": "string"
374
+ },
375
+ "description": "The name of this field.",
376
+ "attribute": "name",
377
+ "inheritedFrom": {
378
+ "name": "InputControlMixin",
379
+ "package": "@vaadin/field-base/src/input-control-mixin.js"
380
+ }
381
+ },
367
382
  {
368
383
  "kind": "method",
369
384
  "name": "open",
370
- "description": "Opens the dropdown list."
385
+ "description": "Opens the dropdown list.",
386
+ "inheritedFrom": {
387
+ "name": "ComboBoxBaseMixin",
388
+ "package": "@vaadin/combo-box/src/vaadin-combo-box-base-mixin.js"
389
+ }
390
+ },
391
+ {
392
+ "kind": "field",
393
+ "name": "opened",
394
+ "privacy": "public",
395
+ "type": {
396
+ "text": "boolean"
397
+ },
398
+ "description": "True if the dropdown is open, false otherwise.",
399
+ "attribute": "opened",
400
+ "inheritedFrom": {
401
+ "name": "ComboBoxBaseMixin",
402
+ "package": "@vaadin/combo-box/src/vaadin-combo-box-base-mixin.js"
403
+ }
404
+ },
405
+ {
406
+ "kind": "field",
407
+ "name": "pageSize",
408
+ "privacy": "public",
409
+ "type": {
410
+ "text": "number"
411
+ },
412
+ "description": "Number of items fetched at a time from the dataprovider.",
413
+ "attribute": "page-size",
414
+ "inheritedFrom": {
415
+ "name": "ComboBoxDataProviderMixin",
416
+ "package": "@vaadin/combo-box/src/vaadin-combo-box-data-provider-mixin.js"
417
+ }
371
418
  },
372
419
  {
373
420
  "kind": "field",
@@ -377,7 +424,11 @@
377
424
  "text": "string"
378
425
  },
379
426
  "description": "A hint to the user of what can be entered in the control.\nThe placeholder will be only displayed in the case when\nthere is no item selected.",
380
- "attribute": "placeholder"
427
+ "attribute": "placeholder",
428
+ "inheritedFrom": {
429
+ "name": "InputControlMixin",
430
+ "package": "@vaadin/field-base/src/input-control-mixin.js"
431
+ }
381
432
  },
382
433
  {
383
434
  "kind": "field",
@@ -387,7 +438,11 @@
387
438
  "text": "boolean"
388
439
  },
389
440
  "description": "When present, it specifies that the field is read-only.",
390
- "attribute": "readonly"
441
+ "attribute": "readonly",
442
+ "inheritedFrom": {
443
+ "name": "InputControlMixin",
444
+ "package": "@vaadin/field-base/src/input-control-mixin.js"
445
+ }
391
446
  },
392
447
  {
393
448
  "kind": "field",
@@ -423,6 +478,34 @@
423
478
  },
424
479
  "description": "Set to true to group selected items at the top of the overlay.",
425
480
  "attribute": "selected-items-on-top"
481
+ },
482
+ {
483
+ "kind": "field",
484
+ "name": "size",
485
+ "privacy": "public",
486
+ "type": {
487
+ "text": "number"
488
+ },
489
+ "description": "Total number of items.",
490
+ "attribute": "size",
491
+ "inheritedFrom": {
492
+ "name": "ComboBoxDataProviderMixin",
493
+ "package": "@vaadin/combo-box/src/vaadin-combo-box-data-provider-mixin.js"
494
+ }
495
+ },
496
+ {
497
+ "kind": "field",
498
+ "name": "title",
499
+ "privacy": "public",
500
+ "type": {
501
+ "text": "string"
502
+ },
503
+ "description": "The text usually displayed in a tooltip popup when the mouse is over the field.",
504
+ "attribute": "title",
505
+ "inheritedFrom": {
506
+ "name": "InputControlMixin",
507
+ "package": "@vaadin/field-base/src/input-control-mixin.js"
508
+ }
426
509
  }
427
510
  ],
428
511
  "events": [
@@ -441,438 +524,350 @@
441
524
  ],
442
525
  "attributes": [
443
526
  {
444
- "name": "allow-custom-value",
527
+ "name": "accessible-name",
445
528
  "type": {
446
- "text": "boolean"
529
+ "text": "string"
447
530
  },
448
- "description": "When true, the user can input a value that is not present in the items list.",
449
- "fieldName": "allowCustomValue"
531
+ "description": "String used to label the component to screen reader users.",
532
+ "fieldName": "accessibleName",
533
+ "inheritedFrom": {
534
+ "name": "FieldMixin",
535
+ "package": "@vaadin/field-base/src/field-mixin.js"
536
+ }
450
537
  },
451
538
  {
452
- "name": "auto-expand-horizontally",
539
+ "name": "accessible-name-ref",
453
540
  "type": {
454
- "text": "boolean"
541
+ "text": "string"
455
542
  },
456
- "description": "Set to true to auto expand horizontally, causing input field to\ngrow until max width is reached.",
457
- "fieldName": "autoExpandHorizontally"
543
+ "description": "Id of the element used as label of the component to screen reader users.",
544
+ "fieldName": "accessibleNameRef",
545
+ "inheritedFrom": {
546
+ "name": "FieldMixin",
547
+ "package": "@vaadin/field-base/src/field-mixin.js"
548
+ }
458
549
  },
459
550
  {
460
- "name": "auto-expand-vertically",
551
+ "name": "allow-custom-value",
461
552
  "type": {
462
553
  "text": "boolean"
463
554
  },
464
- "description": "Set to true to not collapse selected items chips into the overflow\nchip and instead always expand vertically, causing input field to\nwrap into multiple lines when width is limited.",
465
- "fieldName": "autoExpandVertically"
466
- },
467
- {
468
- "name": "i18n",
469
- "inheritedFrom": {
470
- "name": "I18nMixin",
471
- "package": "@vaadin/component-base/src/i18n-mixin.js"
472
- }
555
+ "description": "When true, the user can input a value that is not present in the items list.",
556
+ "fieldName": "allowCustomValue"
473
557
  },
474
558
  {
475
- "name": "item-id-path",
559
+ "name": "allowed-char-pattern",
476
560
  "type": {
477
561
  "text": "string"
478
562
  },
479
- "description": "Path for the id of the item, used to detect whether the item is selected.",
480
- "fieldName": "itemIdPath"
563
+ "description": "A pattern matched against individual characters the user inputs.\n\nWhen set, the field will prevent:\n- `keydown` events if the entered key doesn't match `/^allowedCharPattern$/`\n- `paste` events if the pasted text doesn't match `/^allowedCharPattern*$/`\n- `drop` events if the dropped text doesn't match `/^allowedCharPattern*$/`\n\nFor example, to allow entering only numbers and minus signs, use:\n`allowedCharPattern = \"[\\\\d-]\"`",
564
+ "fieldName": "allowedCharPattern",
565
+ "inheritedFrom": {
566
+ "name": "InputControlMixin",
567
+ "package": "@vaadin/field-base/src/input-control-mixin.js"
568
+ }
481
569
  },
482
570
  {
483
- "name": "keep-filter",
571
+ "name": "auto-expand-horizontally",
484
572
  "type": {
485
573
  "text": "boolean"
486
574
  },
487
- "description": "When true, filter string isn't cleared after selecting an item.",
488
- "fieldName": "keepFilter"
575
+ "description": "Set to true to auto expand horizontally, causing input field to\ngrow until max width is reached.",
576
+ "fieldName": "autoExpandHorizontally"
489
577
  },
490
578
  {
491
- "name": "loading",
579
+ "name": "auto-expand-vertically",
492
580
  "type": {
493
581
  "text": "boolean"
494
582
  },
495
- "description": "True when loading items from the data provider, false otherwise.",
496
- "fieldName": "loading"
583
+ "description": "Set to true to not collapse selected items chips into the overflow\nchip and instead always expand vertically, causing input field to\nwrap into multiple lines when width is limited.",
584
+ "fieldName": "autoExpandVertically"
497
585
  },
498
586
  {
499
- "name": "placeholder",
587
+ "name": "auto-open-disabled",
500
588
  "type": {
501
- "text": "string"
589
+ "text": "boolean"
502
590
  },
503
- "description": "A hint to the user of what can be entered in the control.\nThe placeholder will be only displayed in the case when\nthere is no item selected.",
504
- "fieldName": "placeholder"
591
+ "description": "Set true to prevent the overlay from opening automatically.",
592
+ "fieldName": "autoOpenDisabled",
593
+ "inheritedFrom": {
594
+ "name": "ComboBoxBaseMixin",
595
+ "package": "@vaadin/combo-box/src/vaadin-combo-box-base-mixin.js"
596
+ }
505
597
  },
506
598
  {
507
- "name": "readonly",
599
+ "name": "autoselect",
508
600
  "type": {
509
601
  "text": "boolean"
510
602
  },
511
- "description": "When present, it specifies that the field is read-only.",
512
- "fieldName": "readonly"
603
+ "description": "If true, the input text gets fully selected when the field is focused using click or touch / tap.",
604
+ "fieldName": "autoselect",
605
+ "inheritedFrom": {
606
+ "name": "InputControlMixin",
607
+ "package": "@vaadin/field-base/src/input-control-mixin.js"
608
+ }
513
609
  },
514
610
  {
515
- "name": "renderer",
611
+ "name": "clear-button-visible",
516
612
  "type": {
517
- "text": "function"
613
+ "text": "boolean"
518
614
  },
519
- "description": "Custom function for rendering the content of every item.\nReceives three arguments:\n\n- `root` The `<vaadin-multi-select-combo-box-item>` internal container DOM element.\n- `comboBox` The reference to the `<vaadin-multi-select-combo-box>` element.\n- `model` The object with the properties related with the rendered\n item, contains:\n - `model.index` The index of the rendered item.\n - `model.item` The item.",
520
- "fieldName": "renderer"
615
+ "description": "Set to true to display the clear icon which clears the input.\n\nIt is up to the component to choose where to place the clear icon:\nin the Shadow DOM or in the light DOM. In any way, a reference to\nthe clear icon element should be provided via the `clearElement` getter.",
616
+ "fieldName": "clearButtonVisible",
617
+ "inheritedFrom": {
618
+ "name": "ClearButtonMixin",
619
+ "package": "@vaadin/field-base/src/clear-button-mixin.js"
620
+ }
521
621
  },
522
622
  {
523
- "name": "selected-items",
623
+ "name": "data-provider",
524
624
  "type": {
525
- "text": "array"
625
+ "text": "ComboBoxDataProvider | undefined"
526
626
  },
527
- "description": "The list of selected items.\nNote: modifying the selected items creates a new array each time.",
528
- "fieldName": "selectedItems"
627
+ "description": "Function that provides items lazily. Receives arguments `params`, `callback`\n\n`params.page` Requested page index\n\n`params.pageSize` Current page size\n\n`params.filter` Currently applied filter\n\n`callback(items, size)` Callback function with arguments:\n - `items` Current page of items\n - `size` Total number of items.",
628
+ "fieldName": "dataProvider",
629
+ "inheritedFrom": {
630
+ "name": "ComboBoxDataProviderMixin",
631
+ "package": "@vaadin/combo-box/src/vaadin-combo-box-data-provider-mixin.js"
632
+ }
529
633
  },
530
634
  {
531
- "name": "selected-items-on-top",
635
+ "name": "error-message",
532
636
  "type": {
533
- "text": "boolean"
637
+ "text": "string"
534
638
  },
535
- "description": "Set to true to group selected items at the top of the overlay.",
536
- "fieldName": "selectedItemsOnTop"
639
+ "description": "Error to show when the field is invalid.",
640
+ "fieldName": "errorMessage",
641
+ "inheritedFrom": {
642
+ "name": "FieldMixin",
643
+ "package": "@vaadin/field-base/src/field-mixin.js"
644
+ }
537
645
  },
538
646
  {
539
- "name": "value",
647
+ "name": "filter",
540
648
  "type": {
541
649
  "text": "string"
542
650
  },
543
- "fieldName": "value"
544
- }
545
- ],
546
- "mixins": [
547
- {
548
- "name": "I18nMixin",
549
- "package": "@vaadin/component-base/src/i18n-mixin.js"
550
- }
551
- ],
552
- "parameters": [
553
- {
554
- "name": "superClass"
555
- }
556
- ]
557
- }
558
- ],
559
- "exports": [
560
- {
561
- "kind": "js",
562
- "name": "MultiSelectComboBoxMixin",
563
- "declaration": {
564
- "name": "MultiSelectComboBoxMixin",
565
- "module": "src/vaadin-multi-select-combo-box-mixin.js"
566
- }
567
- }
568
- ]
569
- },
570
- {
571
- "kind": "javascript-module",
572
- "path": "src/vaadin-multi-select-combo-box-overlay.js",
573
- "declarations": [],
574
- "exports": []
575
- },
576
- {
577
- "kind": "javascript-module",
578
- "path": "src/vaadin-multi-select-combo-box-scroller.js",
579
- "declarations": [
580
- {
581
- "kind": "class",
582
- "description": "An element used internally by `<vaadin-multi-select-combo-box>`. Not intended to be used separately.",
583
- "name": "MultiSelectComboBoxScroller",
584
- "members": [
585
- {
586
- "kind": "field",
587
- "name": "focusedIndex",
588
- "privacy": "public",
589
- "type": {
590
- "text": "number"
591
- },
592
- "description": "Index of an item that has focus outline and is scrolled into view.\nThe actual focus still remains in the input field.",
593
- "attribute": "focused-index",
651
+ "description": "Filtering string the user has typed into the input field.",
652
+ "fieldName": "filter",
594
653
  "inheritedFrom": {
595
- "name": "ComboBoxScrollerMixin",
596
- "package": "@vaadin/combo-box/src/vaadin-combo-box-scroller-mixin.js"
654
+ "name": "ComboBoxItemsMixin",
655
+ "package": "@vaadin/combo-box/src/vaadin-combo-box-items-mixin.js"
597
656
  }
598
657
  },
599
658
  {
600
- "kind": "field",
601
- "name": "getItemLabel",
602
- "privacy": "public",
659
+ "name": "helper-text",
603
660
  "type": {
604
- "text": "object"
661
+ "text": "string"
605
662
  },
606
- "description": "Function used to set a label for every combo-box item.",
607
- "attribute": "get-item-label",
663
+ "description": "String used for the helper text.",
664
+ "fieldName": "helperText",
608
665
  "inheritedFrom": {
609
- "name": "ComboBoxScrollerMixin",
610
- "package": "@vaadin/combo-box/src/vaadin-combo-box-scroller-mixin.js"
666
+ "name": "FieldMixin",
667
+ "package": "@vaadin/field-base/src/field-mixin.js"
611
668
  }
612
669
  },
613
670
  {
614
- "kind": "field",
615
- "name": "itemClassNameGenerator",
616
- "privacy": "public",
617
- "type": {
618
- "text": "object"
619
- },
620
- "description": "A function used to generate CSS class names for dropdown\nitems based on the item. The return value should be the\ngenerated class name as a string, or multiple class names\nseparated by whitespace characters.",
621
- "attribute": "item-class-name-generator",
671
+ "name": "i18n",
622
672
  "inheritedFrom": {
623
- "name": "ComboBoxScrollerMixin",
624
- "package": "@vaadin/combo-box/src/vaadin-combo-box-scroller-mixin.js"
673
+ "name": "I18nMixin",
674
+ "package": "@vaadin/component-base/src/i18n-mixin.js"
625
675
  }
626
676
  },
627
677
  {
628
- "kind": "field",
629
- "name": "itemIdPath",
630
- "privacy": "public",
678
+ "name": "item-id-path",
631
679
  "type": {
632
680
  "text": "string"
633
681
  },
634
682
  "description": "Path for the id of the item, used to detect whether the item is selected.",
635
- "attribute": "item-id-path",
636
- "inheritedFrom": {
637
- "name": "ComboBoxScrollerMixin",
638
- "package": "@vaadin/combo-box/src/vaadin-combo-box-scroller-mixin.js"
639
- }
683
+ "fieldName": "itemIdPath"
640
684
  },
641
685
  {
642
- "kind": "field",
643
- "name": "items",
644
- "privacy": "public",
686
+ "name": "item-label-path",
645
687
  "type": {
646
- "text": "array"
688
+ "text": "string"
647
689
  },
648
- "description": "A full set of items to filter the visible options from.\nSet to an empty array when combo-box is not opened.",
649
- "attribute": "items",
690
+ "description": "Path for label of the item. If `items` is an array of objects, the\n`itemLabelPath` is used to fetch the displayed string label for each\nitem.\n\nThe item label is also used for matching items when processing user\ninput, i.e., for filtering and selecting items.",
691
+ "fieldName": "itemLabelPath",
650
692
  "inheritedFrom": {
651
- "name": "ComboBoxScrollerMixin",
652
- "package": "@vaadin/combo-box/src/vaadin-combo-box-scroller-mixin.js"
693
+ "name": "ComboBoxItemsMixin",
694
+ "package": "@vaadin/combo-box/src/vaadin-combo-box-items-mixin.js"
653
695
  }
654
696
  },
655
697
  {
656
- "kind": "field",
657
- "name": "loading",
658
- "privacy": "public",
698
+ "name": "item-value-path",
659
699
  "type": {
660
- "text": "boolean"
700
+ "text": "string"
661
701
  },
662
- "description": "Set to true while combo-box fetches new page from the data provider.",
663
- "attribute": "loading",
702
+ "description": "Path for the value of the item. If `items` is an array of objects, the\n`itemValuePath:` is used to fetch the string value for the selected\nitem.\n\nThe item value is used in the `value` property of the combo box,\nto provide the form value.",
703
+ "fieldName": "itemValuePath",
664
704
  "inheritedFrom": {
665
- "name": "ComboBoxScrollerMixin",
666
- "package": "@vaadin/combo-box/src/vaadin-combo-box-scroller-mixin.js"
705
+ "name": "ComboBoxItemsMixin",
706
+ "package": "@vaadin/combo-box/src/vaadin-combo-box-items-mixin.js"
667
707
  }
668
708
  },
669
709
  {
670
- "kind": "field",
671
- "name": "opened",
672
- "privacy": "public",
710
+ "name": "keep-filter",
673
711
  "type": {
674
712
  "text": "boolean"
675
713
  },
676
- "description": "Whether the combo-box is currently opened or not. If set to false,\ncalling `scrollIntoView` does not have any effect.",
677
- "attribute": "opened",
678
- "inheritedFrom": {
679
- "name": "ComboBoxScrollerMixin",
680
- "package": "@vaadin/combo-box/src/vaadin-combo-box-scroller-mixin.js"
681
- }
714
+ "description": "When true, filter string isn't cleared after selecting an item.",
715
+ "fieldName": "keepFilter"
682
716
  },
683
717
  {
684
- "kind": "field",
685
- "name": "owner",
686
- "privacy": "public",
718
+ "name": "label",
687
719
  "type": {
688
- "text": "object"
720
+ "text": "string"
689
721
  },
690
- "description": "Reference to the owner (combo-box owner), used by the item elements.",
691
- "attribute": "owner",
722
+ "description": "The label text for the input node.\nWhen no light dom defined via [slot=label], this value will be used.",
723
+ "fieldName": "label",
692
724
  "inheritedFrom": {
693
- "name": "ComboBoxScrollerMixin",
694
- "package": "@vaadin/combo-box/src/vaadin-combo-box-scroller-mixin.js"
725
+ "name": "FieldMixin",
726
+ "package": "@vaadin/field-base/src/field-mixin.js"
695
727
  }
696
728
  },
697
729
  {
698
- "kind": "field",
699
- "name": "renderer",
700
- "privacy": "public",
730
+ "name": "loading",
701
731
  "type": {
702
- "text": "object"
732
+ "text": "boolean"
703
733
  },
704
- "description": "Function used to render the content of every combo-box item.",
705
- "attribute": "renderer",
706
- "inheritedFrom": {
707
- "name": "ComboBoxScrollerMixin",
708
- "package": "@vaadin/combo-box/src/vaadin-combo-box-scroller-mixin.js"
709
- }
734
+ "description": "True when loading items from the data provider, false otherwise.",
735
+ "fieldName": "loading"
710
736
  },
711
737
  {
712
- "kind": "method",
713
- "name": "requestContentUpdate",
714
- "description": "Updates the virtualizer's size and items.",
738
+ "name": "name",
739
+ "type": {
740
+ "text": "string"
741
+ },
742
+ "description": "The name of this field.",
743
+ "fieldName": "name",
715
744
  "inheritedFrom": {
716
- "name": "ComboBoxScrollerMixin",
717
- "package": "@vaadin/combo-box/src/vaadin-combo-box-scroller-mixin.js"
745
+ "name": "InputControlMixin",
746
+ "package": "@vaadin/field-base/src/input-control-mixin.js"
718
747
  }
719
748
  },
720
749
  {
721
- "kind": "method",
722
- "name": "scrollIntoView",
723
- "parameters": [
724
- {
725
- "name": "index",
726
- "type": {
727
- "text": "number"
728
- }
729
- }
730
- ],
731
- "description": "Scrolls an item at given index into view and adjusts `scrollTop`\nso that the element gets fully visible on Arrow Down key press.",
750
+ "name": "opened",
751
+ "type": {
752
+ "text": "boolean"
753
+ },
754
+ "description": "True if the dropdown is open, false otherwise.",
755
+ "fieldName": "opened",
732
756
  "inheritedFrom": {
733
- "name": "ComboBoxScrollerMixin",
734
- "package": "@vaadin/combo-box/src/vaadin-combo-box-scroller-mixin.js"
757
+ "name": "ComboBoxBaseMixin",
758
+ "package": "@vaadin/combo-box/src/vaadin-combo-box-base-mixin.js"
735
759
  }
736
760
  },
737
761
  {
738
- "kind": "field",
739
- "name": "selectedItem",
740
- "privacy": "public",
762
+ "name": "page-size",
741
763
  "type": {
742
- "text": "object"
764
+ "text": "number"
743
765
  },
744
- "description": "The selected item from the `items` array.",
745
- "attribute": "selected-item",
766
+ "description": "Number of items fetched at a time from the dataprovider.",
767
+ "fieldName": "pageSize",
746
768
  "inheritedFrom": {
747
- "name": "ComboBoxScrollerMixin",
748
- "package": "@vaadin/combo-box/src/vaadin-combo-box-scroller-mixin.js"
769
+ "name": "ComboBoxDataProviderMixin",
770
+ "package": "@vaadin/combo-box/src/vaadin-combo-box-data-provider-mixin.js"
749
771
  }
750
772
  },
751
773
  {
752
- "kind": "field",
753
- "name": "theme",
754
- "privacy": "public",
774
+ "name": "placeholder",
755
775
  "type": {
756
776
  "text": "string"
757
777
  },
758
- "description": "Used to propagate the `theme` attribute from the host element.",
759
- "attribute": "theme",
778
+ "description": "A hint to the user of what can be entered in the control.\nThe placeholder will be only displayed in the case when\nthere is no item selected.",
779
+ "fieldName": "placeholder",
760
780
  "inheritedFrom": {
761
- "name": "ComboBoxScrollerMixin",
762
- "package": "@vaadin/combo-box/src/vaadin-combo-box-scroller-mixin.js"
781
+ "name": "InputControlMixin",
782
+ "package": "@vaadin/field-base/src/input-control-mixin.js"
763
783
  }
764
- }
765
- ],
766
- "mixins": [
767
- {
768
- "name": "ComboBoxScrollerMixin",
769
- "package": "@vaadin/combo-box/src/vaadin-combo-box-scroller-mixin.js"
770
- },
771
- {
772
- "name": "PolylitMixin",
773
- "package": "@vaadin/component-base/src/polylit-mixin.js"
774
- }
775
- ],
776
- "superclass": {
777
- "name": "LitElement",
778
- "package": "lit"
779
- },
780
- "tagName": "vaadin-multi-select-combo-box-scroller",
781
- "customElement": true,
782
- "attributes": [
784
+ },
783
785
  {
784
- "name": "focused-index",
786
+ "name": "readonly",
785
787
  "type": {
786
- "text": "number"
788
+ "text": "boolean"
787
789
  },
788
- "description": "Index of an item that has focus outline and is scrolled into view.\nThe actual focus still remains in the input field.",
789
- "fieldName": "focusedIndex",
790
+ "description": "When present, it specifies that the field is read-only.",
791
+ "fieldName": "readonly",
790
792
  "inheritedFrom": {
791
- "name": "ComboBoxScrollerMixin",
792
- "package": "@vaadin/combo-box/src/vaadin-combo-box-scroller-mixin.js"
793
+ "name": "InputControlMixin",
794
+ "package": "@vaadin/field-base/src/input-control-mixin.js"
793
795
  }
794
796
  },
795
797
  {
796
- "name": "item-id-path",
798
+ "name": "renderer",
797
799
  "type": {
798
- "text": "string"
800
+ "text": "function"
799
801
  },
800
- "description": "Path for the id of the item, used to detect whether the item is selected.",
801
- "fieldName": "itemIdPath",
802
- "inheritedFrom": {
803
- "name": "ComboBoxScrollerMixin",
804
- "package": "@vaadin/combo-box/src/vaadin-combo-box-scroller-mixin.js"
805
- }
802
+ "description": "Custom function for rendering the content of every item.\nReceives three arguments:\n\n- `root` The `<vaadin-multi-select-combo-box-item>` internal container DOM element.\n- `comboBox` The reference to the `<vaadin-multi-select-combo-box>` element.\n- `model` The object with the properties related with the rendered\n item, contains:\n - `model.index` The index of the rendered item.\n - `model.item` The item.",
803
+ "fieldName": "renderer"
806
804
  },
807
805
  {
808
- "name": "items",
806
+ "name": "selected-items",
809
807
  "type": {
810
808
  "text": "array"
811
809
  },
812
- "description": "A full set of items to filter the visible options from.\nSet to an empty array when combo-box is not opened.",
813
- "fieldName": "items",
814
- "inheritedFrom": {
815
- "name": "ComboBoxScrollerMixin",
816
- "package": "@vaadin/combo-box/src/vaadin-combo-box-scroller-mixin.js"
817
- }
810
+ "description": "The list of selected items.\nNote: modifying the selected items creates a new array each time.",
811
+ "fieldName": "selectedItems"
818
812
  },
819
813
  {
820
- "name": "loading",
814
+ "name": "selected-items-on-top",
821
815
  "type": {
822
816
  "text": "boolean"
823
817
  },
824
- "description": "Set to true while combo-box fetches new page from the data provider.",
825
- "fieldName": "loading",
826
- "inheritedFrom": {
827
- "name": "ComboBoxScrollerMixin",
828
- "package": "@vaadin/combo-box/src/vaadin-combo-box-scroller-mixin.js"
829
- }
818
+ "description": "Set to true to group selected items at the top of the overlay.",
819
+ "fieldName": "selectedItemsOnTop"
830
820
  },
831
821
  {
832
- "name": "opened",
822
+ "name": "size",
833
823
  "type": {
834
- "text": "boolean"
824
+ "text": "number"
835
825
  },
836
- "description": "Whether the combo-box is currently opened or not. If set to false,\ncalling `scrollIntoView` does not have any effect.",
837
- "fieldName": "opened",
826
+ "description": "Total number of items.",
827
+ "fieldName": "size",
838
828
  "inheritedFrom": {
839
- "name": "ComboBoxScrollerMixin",
840
- "package": "@vaadin/combo-box/src/vaadin-combo-box-scroller-mixin.js"
829
+ "name": "ComboBoxDataProviderMixin",
830
+ "package": "@vaadin/combo-box/src/vaadin-combo-box-data-provider-mixin.js"
841
831
  }
842
832
  },
843
833
  {
844
- "name": "theme",
834
+ "name": "title",
845
835
  "type": {
846
836
  "text": "string"
847
837
  },
848
- "description": "Used to propagate the `theme` attribute from the host element.",
849
- "fieldName": "theme",
838
+ "description": "The text usually displayed in a tooltip popup when the mouse is over the field.",
839
+ "fieldName": "title",
850
840
  "inheritedFrom": {
851
- "name": "ComboBoxScrollerMixin",
852
- "package": "@vaadin/combo-box/src/vaadin-combo-box-scroller-mixin.js"
841
+ "name": "InputControlMixin",
842
+ "package": "@vaadin/field-base/src/input-control-mixin.js"
853
843
  }
854
844
  }
855
845
  ],
856
- "events": [
846
+ "mixins": [
857
847
  {
858
- "name": "index-requested",
859
- "type": {
860
- "text": "CustomEvent"
861
- },
862
- "inheritedFrom": {
863
- "name": "ComboBoxScrollerMixin",
864
- "package": "@vaadin/combo-box/src/vaadin-combo-box-scroller-mixin.js"
865
- }
848
+ "name": "I18nMixin",
849
+ "package": "@vaadin/component-base/src/i18n-mixin.js"
866
850
  },
867
851
  {
868
- "name": "selection-changed",
869
- "type": {
870
- "text": "CustomEvent"
871
- },
872
- "inheritedFrom": {
873
- "name": "ComboBoxScrollerMixin",
874
- "package": "@vaadin/combo-box/src/vaadin-combo-box-scroller-mixin.js"
875
- }
852
+ "name": "ComboBoxDataProviderMixin",
853
+ "package": "@vaadin/combo-box/src/vaadin-combo-box-data-provider-mixin.js"
854
+ },
855
+ {
856
+ "name": "ComboBoxItemsMixin",
857
+ "package": "@vaadin/combo-box/src/vaadin-combo-box-items-mixin.js"
858
+ },
859
+ {
860
+ "name": "InputControlMixin",
861
+ "package": "@vaadin/field-base/src/input-control-mixin.js"
862
+ },
863
+ {
864
+ "name": "ResizeMixin",
865
+ "package": "@vaadin/component-base/src/resize-mixin.js"
866
+ }
867
+ ],
868
+ "parameters": [
869
+ {
870
+ "name": "superClass"
876
871
  }
877
872
  ]
878
873
  }
@@ -880,10 +875,10 @@
880
875
  "exports": [
881
876
  {
882
877
  "kind": "js",
883
- "name": "MultiSelectComboBoxScroller",
878
+ "name": "MultiSelectComboBoxMixin",
884
879
  "declaration": {
885
- "name": "MultiSelectComboBoxScroller",
886
- "module": "src/vaadin-multi-select-combo-box-scroller.js"
880
+ "name": "MultiSelectComboBoxMixin",
881
+ "module": "src/vaadin-multi-select-combo-box-mixin.js"
887
882
  }
888
883
  }
889
884
  ]
@@ -911,6 +906,20 @@
911
906
  "module": "src/vaadin-multi-select-combo-box-mixin.js"
912
907
  }
913
908
  },
909
+ {
910
+ "kind": "field",
911
+ "name": "allowedCharPattern",
912
+ "privacy": "public",
913
+ "type": {
914
+ "text": "string"
915
+ },
916
+ "description": "A pattern matched against individual characters the user inputs.\n\nWhen set, the field will prevent:\n- `keydown` events if the entered key doesn't match `/^allowedCharPattern$/`\n- `paste` events if the pasted text doesn't match `/^allowedCharPattern*$/`\n- `drop` events if the dropped text doesn't match `/^allowedCharPattern*$/`\n\nFor example, to allow entering only numbers and minus signs, use:\n`allowedCharPattern = \"[\\\\d-]\"`",
917
+ "attribute": "allowed-char-pattern",
918
+ "inheritedFrom": {
919
+ "name": "InputControlMixin",
920
+ "package": "@vaadin/field-base/src/input-control-mixin.js"
921
+ }
922
+ },
914
923
  {
915
924
  "kind": "field",
916
925
  "name": "autoExpandHorizontally",
@@ -939,6 +948,20 @@
939
948
  "module": "src/vaadin-multi-select-combo-box-mixin.js"
940
949
  }
941
950
  },
951
+ {
952
+ "kind": "field",
953
+ "name": "autoselect",
954
+ "privacy": "public",
955
+ "type": {
956
+ "text": "boolean"
957
+ },
958
+ "description": "If true, the input text gets fully selected when the field is focused using click or touch / tap.",
959
+ "attribute": "autoselect",
960
+ "inheritedFrom": {
961
+ "name": "InputControlMixin",
962
+ "package": "@vaadin/field-base/src/input-control-mixin.js"
963
+ }
964
+ },
942
965
  {
943
966
  "kind": "method",
944
967
  "name": "checkValidity",
@@ -967,27 +990,59 @@
967
990
  "name": "clearCache",
968
991
  "description": "Clears the cached pages and reloads data from data provider when needed.",
969
992
  "inheritedFrom": {
970
- "name": "MultiSelectComboBoxMixin",
971
- "module": "src/vaadin-multi-select-combo-box-mixin.js"
993
+ "name": "ComboBoxDataProviderMixin",
994
+ "package": "@vaadin/combo-box/src/vaadin-combo-box-data-provider-mixin.js"
995
+ }
996
+ },
997
+ {
998
+ "kind": "field",
999
+ "name": "dataProvider",
1000
+ "privacy": "public",
1001
+ "type": {
1002
+ "text": "ComboBoxDataProvider | undefined"
1003
+ },
1004
+ "description": "Function that provides items lazily. Receives arguments `params`, `callback`\n\n`params.page` Requested page index\n\n`params.pageSize` Current page size\n\n`params.filter` Currently applied filter\n\n`callback(items, size)` Callback function with arguments:\n - `items` Current page of items\n - `size` Total number of items.",
1005
+ "attribute": "data-provider",
1006
+ "inheritedFrom": {
1007
+ "name": "ComboBoxDataProviderMixin",
1008
+ "package": "@vaadin/combo-box/src/vaadin-combo-box-data-provider-mixin.js"
1009
+ }
1010
+ },
1011
+ {
1012
+ "kind": "field",
1013
+ "name": "filter",
1014
+ "privacy": "public",
1015
+ "type": {
1016
+ "text": "string"
1017
+ },
1018
+ "description": "Filtering string the user has typed into the input field.",
1019
+ "attribute": "filter",
1020
+ "inheritedFrom": {
1021
+ "name": "ComboBoxItemsMixin",
1022
+ "package": "@vaadin/combo-box/src/vaadin-combo-box-items-mixin.js"
1023
+ }
1024
+ },
1025
+ {
1026
+ "kind": "field",
1027
+ "name": "filteredItems",
1028
+ "privacy": "public",
1029
+ "type": {
1030
+ "text": "!Array<!ComboBoxItem | string> | undefined"
1031
+ },
1032
+ "description": "A subset of items, filtered based on the user input. Filtered items\ncan be assigned directly to omit the internal filtering functionality.\nThe items can be of either `String` or `Object` type.",
1033
+ "attribute": "filtered-items",
1034
+ "inheritedFrom": {
1035
+ "name": "ComboBoxItemsMixin",
1036
+ "package": "@vaadin/combo-box/src/vaadin-combo-box-items-mixin.js"
972
1037
  }
973
1038
  },
974
1039
  {
975
1040
  "kind": "field",
976
1041
  "name": "i18n",
977
1042
  "description": "The object used to localize this component. To change the default\nlocalization, replace this with an object that provides all properties, or\njust the individual properties you want to change.\n\nThe object has the following JSON structure and default values:\n```js\n{\n // Screen reader announcement on clear button click.\n cleared: 'Selection cleared',\n // Screen reader announcement when a chip is focused.\n focused: ' focused. Press Backspace to remove',\n // Screen reader announcement when item is selected.\n selected: 'added to selection',\n // Screen reader announcement when item is deselected.\n deselected: 'removed from selection',\n // Screen reader announcement of the selected items count.\n // {count} is replaced with the actual count of items.\n total: '{count} items selected',\n}\n```",
978
- "return": {
979
- "type": {
980
- "text": "!MultiSelectComboBoxI18n"
981
- }
1043
+ "type": {
1044
+ "text": "Object"
982
1045
  },
983
- "parameters": [
984
- {
985
- "name": "value",
986
- "type": {
987
- "text": "Object"
988
- }
989
- }
990
- ],
991
1046
  "inheritedFrom": {
992
1047
  "name": "I18nMixin",
993
1048
  "package": "@vaadin/component-base/src/i18n-mixin.js"
@@ -1021,6 +1076,62 @@
1021
1076
  "module": "src/vaadin-multi-select-combo-box-mixin.js"
1022
1077
  }
1023
1078
  },
1079
+ {
1080
+ "kind": "field",
1081
+ "name": "itemLabelGenerator",
1082
+ "privacy": "public",
1083
+ "type": {
1084
+ "text": "object"
1085
+ },
1086
+ "description": "A function that is used to generate the label for dropdown\nitems based on the item. Receives one argument:\n- `item` The item to generate the label for.",
1087
+ "attribute": "item-label-generator",
1088
+ "inheritedFrom": {
1089
+ "name": "ComboBoxItemsMixin",
1090
+ "package": "@vaadin/combo-box/src/vaadin-combo-box-items-mixin.js"
1091
+ }
1092
+ },
1093
+ {
1094
+ "kind": "field",
1095
+ "name": "itemLabelPath",
1096
+ "privacy": "public",
1097
+ "type": {
1098
+ "text": "string"
1099
+ },
1100
+ "description": "Path for label of the item. If `items` is an array of objects, the\n`itemLabelPath` is used to fetch the displayed string label for each\nitem.\n\nThe item label is also used for matching items when processing user\ninput, i.e., for filtering and selecting items.",
1101
+ "attribute": "item-label-path",
1102
+ "inheritedFrom": {
1103
+ "name": "ComboBoxItemsMixin",
1104
+ "package": "@vaadin/combo-box/src/vaadin-combo-box-items-mixin.js"
1105
+ }
1106
+ },
1107
+ {
1108
+ "kind": "field",
1109
+ "name": "items",
1110
+ "privacy": "public",
1111
+ "type": {
1112
+ "text": "!Array<!ComboBoxItem | string> | undefined"
1113
+ },
1114
+ "description": "A full set of items to filter the visible options from.\nThe items can be of either `String` or `Object` type.",
1115
+ "attribute": "items",
1116
+ "inheritedFrom": {
1117
+ "name": "ComboBoxItemsMixin",
1118
+ "package": "@vaadin/combo-box/src/vaadin-combo-box-items-mixin.js"
1119
+ }
1120
+ },
1121
+ {
1122
+ "kind": "field",
1123
+ "name": "itemValuePath",
1124
+ "privacy": "public",
1125
+ "type": {
1126
+ "text": "string"
1127
+ },
1128
+ "description": "Path for the value of the item. If `items` is an array of objects, the\n`itemValuePath:` is used to fetch the string value for the selected\nitem.\n\nThe item value is used in the `value` property of the combo box,\nto provide the form value.",
1129
+ "attribute": "item-value-path",
1130
+ "inheritedFrom": {
1131
+ "name": "ComboBoxItemsMixin",
1132
+ "package": "@vaadin/combo-box/src/vaadin-combo-box-items-mixin.js"
1133
+ }
1134
+ },
1024
1135
  {
1025
1136
  "kind": "field",
1026
1137
  "name": "keepFilter",
@@ -1049,6 +1160,20 @@
1049
1160
  "module": "src/vaadin-multi-select-combo-box-mixin.js"
1050
1161
  }
1051
1162
  },
1163
+ {
1164
+ "kind": "field",
1165
+ "name": "name",
1166
+ "privacy": "public",
1167
+ "type": {
1168
+ "text": "string"
1169
+ },
1170
+ "description": "The name of this field.",
1171
+ "attribute": "name",
1172
+ "inheritedFrom": {
1173
+ "name": "InputControlMixin",
1174
+ "package": "@vaadin/field-base/src/input-control-mixin.js"
1175
+ }
1176
+ },
1052
1177
  {
1053
1178
  "kind": "method",
1054
1179
  "name": "open",
@@ -1058,6 +1183,20 @@
1058
1183
  "module": "src/vaadin-multi-select-combo-box-mixin.js"
1059
1184
  }
1060
1185
  },
1186
+ {
1187
+ "kind": "field",
1188
+ "name": "pageSize",
1189
+ "privacy": "public",
1190
+ "type": {
1191
+ "text": "number"
1192
+ },
1193
+ "description": "Number of items fetched at a time from the dataprovider.",
1194
+ "attribute": "page-size",
1195
+ "inheritedFrom": {
1196
+ "name": "ComboBoxDataProviderMixin",
1197
+ "package": "@vaadin/combo-box/src/vaadin-combo-box-data-provider-mixin.js"
1198
+ }
1199
+ },
1061
1200
  {
1062
1201
  "kind": "field",
1063
1202
  "name": "placeholder",
@@ -1068,8 +1207,8 @@
1068
1207
  "description": "A hint to the user of what can be entered in the control.\nThe placeholder will be only displayed in the case when\nthere is no item selected.",
1069
1208
  "attribute": "placeholder",
1070
1209
  "inheritedFrom": {
1071
- "name": "MultiSelectComboBoxMixin",
1072
- "module": "src/vaadin-multi-select-combo-box-mixin.js"
1210
+ "name": "InputControlMixin",
1211
+ "package": "@vaadin/field-base/src/input-control-mixin.js"
1073
1212
  }
1074
1213
  },
1075
1214
  {
@@ -1082,8 +1221,8 @@
1082
1221
  "description": "When present, it specifies that the field is read-only.",
1083
1222
  "attribute": "readonly",
1084
1223
  "inheritedFrom": {
1085
- "name": "MultiSelectComboBoxMixin",
1086
- "module": "src/vaadin-multi-select-combo-box-mixin.js"
1224
+ "name": "InputControlMixin",
1225
+ "package": "@vaadin/field-base/src/input-control-mixin.js"
1087
1226
  }
1088
1227
  },
1089
1228
  {
@@ -1136,6 +1275,34 @@
1136
1275
  "name": "MultiSelectComboBoxMixin",
1137
1276
  "module": "src/vaadin-multi-select-combo-box-mixin.js"
1138
1277
  }
1278
+ },
1279
+ {
1280
+ "kind": "field",
1281
+ "name": "size",
1282
+ "privacy": "public",
1283
+ "type": {
1284
+ "text": "number"
1285
+ },
1286
+ "description": "Total number of items.",
1287
+ "attribute": "size",
1288
+ "inheritedFrom": {
1289
+ "name": "ComboBoxDataProviderMixin",
1290
+ "package": "@vaadin/combo-box/src/vaadin-combo-box-data-provider-mixin.js"
1291
+ }
1292
+ },
1293
+ {
1294
+ "kind": "field",
1295
+ "name": "title",
1296
+ "privacy": "public",
1297
+ "type": {
1298
+ "text": "string"
1299
+ },
1300
+ "description": "The text usually displayed in a tooltip popup when the mouse is over the field.",
1301
+ "attribute": "title",
1302
+ "inheritedFrom": {
1303
+ "name": "InputControlMixin",
1304
+ "package": "@vaadin/field-base/src/input-control-mixin.js"
1305
+ }
1139
1306
  }
1140
1307
  ],
1141
1308
  "events": [
@@ -1238,6 +1405,18 @@
1238
1405
  "module": "src/vaadin-multi-select-combo-box-mixin.js"
1239
1406
  }
1240
1407
  },
1408
+ {
1409
+ "name": "allowed-char-pattern",
1410
+ "type": {
1411
+ "text": "string"
1412
+ },
1413
+ "description": "A pattern matched against individual characters the user inputs.\n\nWhen set, the field will prevent:\n- `keydown` events if the entered key doesn't match `/^allowedCharPattern$/`\n- `paste` events if the pasted text doesn't match `/^allowedCharPattern*$/`\n- `drop` events if the dropped text doesn't match `/^allowedCharPattern*$/`\n\nFor example, to allow entering only numbers and minus signs, use:\n`allowedCharPattern = \"[\\\\d-]\"`",
1414
+ "fieldName": "allowedCharPattern",
1415
+ "inheritedFrom": {
1416
+ "name": "InputControlMixin",
1417
+ "package": "@vaadin/field-base/src/input-control-mixin.js"
1418
+ }
1419
+ },
1241
1420
  {
1242
1421
  "name": "auto-expand-horizontally",
1243
1422
  "type": {
@@ -1262,6 +1441,42 @@
1262
1441
  "module": "src/vaadin-multi-select-combo-box-mixin.js"
1263
1442
  }
1264
1443
  },
1444
+ {
1445
+ "name": "autoselect",
1446
+ "type": {
1447
+ "text": "boolean"
1448
+ },
1449
+ "description": "If true, the input text gets fully selected when the field is focused using click or touch / tap.",
1450
+ "fieldName": "autoselect",
1451
+ "inheritedFrom": {
1452
+ "name": "InputControlMixin",
1453
+ "package": "@vaadin/field-base/src/input-control-mixin.js"
1454
+ }
1455
+ },
1456
+ {
1457
+ "name": "data-provider",
1458
+ "type": {
1459
+ "text": "ComboBoxDataProvider | undefined"
1460
+ },
1461
+ "description": "Function that provides items lazily. Receives arguments `params`, `callback`\n\n`params.page` Requested page index\n\n`params.pageSize` Current page size\n\n`params.filter` Currently applied filter\n\n`callback(items, size)` Callback function with arguments:\n - `items` Current page of items\n - `size` Total number of items.",
1462
+ "fieldName": "dataProvider",
1463
+ "inheritedFrom": {
1464
+ "name": "ComboBoxDataProviderMixin",
1465
+ "package": "@vaadin/combo-box/src/vaadin-combo-box-data-provider-mixin.js"
1466
+ }
1467
+ },
1468
+ {
1469
+ "name": "filter",
1470
+ "type": {
1471
+ "text": "string"
1472
+ },
1473
+ "description": "Filtering string the user has typed into the input field.",
1474
+ "fieldName": "filter",
1475
+ "inheritedFrom": {
1476
+ "name": "ComboBoxItemsMixin",
1477
+ "package": "@vaadin/combo-box/src/vaadin-combo-box-items-mixin.js"
1478
+ }
1479
+ },
1265
1480
  {
1266
1481
  "name": "i18n",
1267
1482
  "inheritedFrom": {
@@ -1281,6 +1496,30 @@
1281
1496
  "module": "src/vaadin-multi-select-combo-box-mixin.js"
1282
1497
  }
1283
1498
  },
1499
+ {
1500
+ "name": "item-label-path",
1501
+ "type": {
1502
+ "text": "string"
1503
+ },
1504
+ "description": "Path for label of the item. If `items` is an array of objects, the\n`itemLabelPath` is used to fetch the displayed string label for each\nitem.\n\nThe item label is also used for matching items when processing user\ninput, i.e., for filtering and selecting items.",
1505
+ "fieldName": "itemLabelPath",
1506
+ "inheritedFrom": {
1507
+ "name": "ComboBoxItemsMixin",
1508
+ "package": "@vaadin/combo-box/src/vaadin-combo-box-items-mixin.js"
1509
+ }
1510
+ },
1511
+ {
1512
+ "name": "item-value-path",
1513
+ "type": {
1514
+ "text": "string"
1515
+ },
1516
+ "description": "Path for the value of the item. If `items` is an array of objects, the\n`itemValuePath:` is used to fetch the string value for the selected\nitem.\n\nThe item value is used in the `value` property of the combo box,\nto provide the form value.",
1517
+ "fieldName": "itemValuePath",
1518
+ "inheritedFrom": {
1519
+ "name": "ComboBoxItemsMixin",
1520
+ "package": "@vaadin/combo-box/src/vaadin-combo-box-items-mixin.js"
1521
+ }
1522
+ },
1284
1523
  {
1285
1524
  "name": "keep-filter",
1286
1525
  "type": {
@@ -1305,6 +1544,30 @@
1305
1544
  "module": "src/vaadin-multi-select-combo-box-mixin.js"
1306
1545
  }
1307
1546
  },
1547
+ {
1548
+ "name": "name",
1549
+ "type": {
1550
+ "text": "string"
1551
+ },
1552
+ "description": "The name of this field.",
1553
+ "fieldName": "name",
1554
+ "inheritedFrom": {
1555
+ "name": "InputControlMixin",
1556
+ "package": "@vaadin/field-base/src/input-control-mixin.js"
1557
+ }
1558
+ },
1559
+ {
1560
+ "name": "page-size",
1561
+ "type": {
1562
+ "text": "number"
1563
+ },
1564
+ "description": "Number of items fetched at a time from the dataprovider.",
1565
+ "fieldName": "pageSize",
1566
+ "inheritedFrom": {
1567
+ "name": "ComboBoxDataProviderMixin",
1568
+ "package": "@vaadin/combo-box/src/vaadin-combo-box-data-provider-mixin.js"
1569
+ }
1570
+ },
1308
1571
  {
1309
1572
  "name": "placeholder",
1310
1573
  "type": {
@@ -1313,8 +1576,8 @@
1313
1576
  "description": "A hint to the user of what can be entered in the control.\nThe placeholder will be only displayed in the case when\nthere is no item selected.",
1314
1577
  "fieldName": "placeholder",
1315
1578
  "inheritedFrom": {
1316
- "name": "MultiSelectComboBoxMixin",
1317
- "module": "src/vaadin-multi-select-combo-box-mixin.js"
1579
+ "name": "InputControlMixin",
1580
+ "package": "@vaadin/field-base/src/input-control-mixin.js"
1318
1581
  }
1319
1582
  },
1320
1583
  {
@@ -1325,8 +1588,8 @@
1325
1588
  "description": "When present, it specifies that the field is read-only.",
1326
1589
  "fieldName": "readonly",
1327
1590
  "inheritedFrom": {
1328
- "name": "MultiSelectComboBoxMixin",
1329
- "module": "src/vaadin-multi-select-combo-box-mixin.js"
1591
+ "name": "InputControlMixin",
1592
+ "package": "@vaadin/field-base/src/input-control-mixin.js"
1330
1593
  }
1331
1594
  },
1332
1595
  {
@@ -1366,14 +1629,27 @@
1366
1629
  }
1367
1630
  },
1368
1631
  {
1369
- "name": "value",
1632
+ "name": "size",
1633
+ "type": {
1634
+ "text": "number"
1635
+ },
1636
+ "description": "Total number of items.",
1637
+ "fieldName": "size",
1638
+ "inheritedFrom": {
1639
+ "name": "ComboBoxDataProviderMixin",
1640
+ "package": "@vaadin/combo-box/src/vaadin-combo-box-data-provider-mixin.js"
1641
+ }
1642
+ },
1643
+ {
1644
+ "name": "title",
1370
1645
  "type": {
1371
1646
  "text": "string"
1372
1647
  },
1373
- "fieldName": "value",
1648
+ "description": "The text usually displayed in a tooltip popup when the mouse is over the field.",
1649
+ "fieldName": "title",
1374
1650
  "inheritedFrom": {
1375
- "name": "MultiSelectComboBoxMixin",
1376
- "module": "src/vaadin-multi-select-combo-box-mixin.js"
1651
+ "name": "InputControlMixin",
1652
+ "package": "@vaadin/field-base/src/input-control-mixin.js"
1377
1653
  }
1378
1654
  }
1379
1655
  ]