@vaadin/multi-select-combo-box 25.1.0-alpha6 → 25.1.0-alpha8
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.
- package/custom-elements.json +1336 -0
- package/package.json +17 -15
- package/src/vaadin-multi-select-combo-box-chip.js +1 -1
- package/src/vaadin-multi-select-combo-box-container.js +1 -1
- package/src/vaadin-multi-select-combo-box-item.js +3 -2
- package/src/vaadin-multi-select-combo-box-overlay.js +1 -1
- package/src/vaadin-multi-select-combo-box-scroller.js +1 -1
- package/src/vaadin-multi-select-combo-box.js +1 -1
- package/web-types.json +1 -1
- package/web-types.lit.json +1 -1
|
@@ -0,0 +1,1336 @@
|
|
|
1
|
+
{
|
|
2
|
+
"schemaVersion": "1.0.0",
|
|
3
|
+
"readme": "",
|
|
4
|
+
"modules": [
|
|
5
|
+
{
|
|
6
|
+
"kind": "javascript-module",
|
|
7
|
+
"path": "vaadin-multi-select-combo-box.js",
|
|
8
|
+
"declarations": [],
|
|
9
|
+
"exports": [
|
|
10
|
+
{
|
|
11
|
+
"kind": "js",
|
|
12
|
+
"name": "*",
|
|
13
|
+
"declaration": {
|
|
14
|
+
"name": "*",
|
|
15
|
+
"module": "src/vaadin-multi-select-combo-box.js"
|
|
16
|
+
}
|
|
17
|
+
}
|
|
18
|
+
]
|
|
19
|
+
},
|
|
20
|
+
{
|
|
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",
|
|
35
|
+
"declarations": [
|
|
36
|
+
{
|
|
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",
|
|
40
|
+
"members": [
|
|
41
|
+
{
|
|
42
|
+
"kind": "field",
|
|
43
|
+
"name": "focused",
|
|
44
|
+
"privacy": "public",
|
|
45
|
+
"type": {
|
|
46
|
+
"text": "boolean"
|
|
47
|
+
},
|
|
48
|
+
"description": "True when item is focused.",
|
|
49
|
+
"attribute": "focused",
|
|
50
|
+
"inheritedFrom": {
|
|
51
|
+
"name": "ComboBoxItemMixin",
|
|
52
|
+
"package": "@vaadin/combo-box/src/vaadin-combo-box-item-mixin.js"
|
|
53
|
+
}
|
|
54
|
+
},
|
|
55
|
+
{
|
|
56
|
+
"kind": "field",
|
|
57
|
+
"name": "index",
|
|
58
|
+
"privacy": "public",
|
|
59
|
+
"type": {
|
|
60
|
+
"text": "number"
|
|
61
|
+
},
|
|
62
|
+
"description": "The index of the item.",
|
|
63
|
+
"attribute": "index",
|
|
64
|
+
"inheritedFrom": {
|
|
65
|
+
"name": "ComboBoxItemMixin",
|
|
66
|
+
"package": "@vaadin/combo-box/src/vaadin-combo-box-item-mixin.js"
|
|
67
|
+
}
|
|
68
|
+
},
|
|
69
|
+
{
|
|
70
|
+
"kind": "field",
|
|
71
|
+
"name": "item",
|
|
72
|
+
"privacy": "public",
|
|
73
|
+
"type": {
|
|
74
|
+
"text": "object"
|
|
75
|
+
},
|
|
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
|
+
}
|
|
82
|
+
},
|
|
83
|
+
{
|
|
84
|
+
"kind": "field",
|
|
85
|
+
"name": "label",
|
|
86
|
+
"privacy": "public",
|
|
87
|
+
"type": {
|
|
88
|
+
"text": "string"
|
|
89
|
+
},
|
|
90
|
+
"description": "The text to render in the item.",
|
|
91
|
+
"attribute": "label",
|
|
92
|
+
"inheritedFrom": {
|
|
93
|
+
"name": "ComboBoxItemMixin",
|
|
94
|
+
"package": "@vaadin/combo-box/src/vaadin-combo-box-item-mixin.js"
|
|
95
|
+
}
|
|
96
|
+
},
|
|
97
|
+
{
|
|
98
|
+
"kind": "field",
|
|
99
|
+
"name": "renderer",
|
|
100
|
+
"privacy": "public",
|
|
101
|
+
"type": {
|
|
102
|
+
"text": "function"
|
|
103
|
+
},
|
|
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
|
+
}
|
|
110
|
+
},
|
|
111
|
+
{
|
|
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
|
+
}
|
|
119
|
+
},
|
|
120
|
+
{
|
|
121
|
+
"kind": "field",
|
|
122
|
+
"name": "selected",
|
|
123
|
+
"privacy": "public",
|
|
124
|
+
"type": {
|
|
125
|
+
"text": "boolean"
|
|
126
|
+
},
|
|
127
|
+
"description": "True when item is selected.",
|
|
128
|
+
"attribute": "selected",
|
|
129
|
+
"inheritedFrom": {
|
|
130
|
+
"name": "ComboBoxItemMixin",
|
|
131
|
+
"package": "@vaadin/combo-box/src/vaadin-combo-box-item-mixin.js"
|
|
132
|
+
}
|
|
133
|
+
}
|
|
134
|
+
],
|
|
135
|
+
"mixins": [
|
|
136
|
+
{
|
|
137
|
+
"name": "ComboBoxItemMixin",
|
|
138
|
+
"package": "@vaadin/combo-box/src/vaadin-combo-box-item-mixin.js"
|
|
139
|
+
},
|
|
140
|
+
{
|
|
141
|
+
"name": "ThemableMixin",
|
|
142
|
+
"package": "@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js"
|
|
143
|
+
},
|
|
144
|
+
{
|
|
145
|
+
"name": "DirMixin",
|
|
146
|
+
"package": "@vaadin/component-base/src/dir-mixin.js"
|
|
147
|
+
},
|
|
148
|
+
{
|
|
149
|
+
"name": "PolylitMixin",
|
|
150
|
+
"package": "@vaadin/component-base/src/polylit-mixin.js"
|
|
151
|
+
},
|
|
152
|
+
{
|
|
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",
|
|
166
|
+
"type": {
|
|
167
|
+
"text": "boolean"
|
|
168
|
+
},
|
|
169
|
+
"description": "True when item is focused.",
|
|
170
|
+
"fieldName": "focused",
|
|
171
|
+
"inheritedFrom": {
|
|
172
|
+
"name": "ComboBoxItemMixin",
|
|
173
|
+
"package": "@vaadin/combo-box/src/vaadin-combo-box-item-mixin.js"
|
|
174
|
+
}
|
|
175
|
+
},
|
|
176
|
+
{
|
|
177
|
+
"name": "hidden",
|
|
178
|
+
"inheritedFrom": {
|
|
179
|
+
"name": "ComboBoxItemMixin",
|
|
180
|
+
"package": "@vaadin/combo-box/src/vaadin-combo-box-item-mixin.js"
|
|
181
|
+
}
|
|
182
|
+
},
|
|
183
|
+
{
|
|
184
|
+
"name": "index",
|
|
185
|
+
"type": {
|
|
186
|
+
"text": "number"
|
|
187
|
+
},
|
|
188
|
+
"description": "The index of the item.",
|
|
189
|
+
"fieldName": "index",
|
|
190
|
+
"inheritedFrom": {
|
|
191
|
+
"name": "ComboBoxItemMixin",
|
|
192
|
+
"package": "@vaadin/combo-box/src/vaadin-combo-box-item-mixin.js"
|
|
193
|
+
}
|
|
194
|
+
},
|
|
195
|
+
{
|
|
196
|
+
"name": "label",
|
|
197
|
+
"type": {
|
|
198
|
+
"text": "string"
|
|
199
|
+
},
|
|
200
|
+
"description": "The text to render in the item.",
|
|
201
|
+
"fieldName": "label",
|
|
202
|
+
"inheritedFrom": {
|
|
203
|
+
"name": "ComboBoxItemMixin",
|
|
204
|
+
"package": "@vaadin/combo-box/src/vaadin-combo-box-item-mixin.js"
|
|
205
|
+
}
|
|
206
|
+
},
|
|
207
|
+
{
|
|
208
|
+
"name": "renderer",
|
|
209
|
+
"type": {
|
|
210
|
+
"text": "function"
|
|
211
|
+
},
|
|
212
|
+
"description": "Custom function for rendering the item content.",
|
|
213
|
+
"fieldName": "renderer",
|
|
214
|
+
"inheritedFrom": {
|
|
215
|
+
"name": "ComboBoxItemMixin",
|
|
216
|
+
"package": "@vaadin/combo-box/src/vaadin-combo-box-item-mixin.js"
|
|
217
|
+
}
|
|
218
|
+
},
|
|
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
|
+
{
|
|
256
|
+
"kind": "field",
|
|
257
|
+
"name": "allowCustomValue",
|
|
258
|
+
"privacy": "public",
|
|
259
|
+
"type": {
|
|
260
|
+
"text": "boolean"
|
|
261
|
+
},
|
|
262
|
+
"description": "When true, the user can input a value that is not present in the items list.",
|
|
263
|
+
"attribute": "allow-custom-value"
|
|
264
|
+
},
|
|
265
|
+
{
|
|
266
|
+
"kind": "field",
|
|
267
|
+
"name": "autoExpandHorizontally",
|
|
268
|
+
"privacy": "public",
|
|
269
|
+
"type": {
|
|
270
|
+
"text": "boolean"
|
|
271
|
+
},
|
|
272
|
+
"description": "Set to true to auto expand horizontally, causing input field to\ngrow until max width is reached.",
|
|
273
|
+
"attribute": "auto-expand-horizontally"
|
|
274
|
+
},
|
|
275
|
+
{
|
|
276
|
+
"kind": "field",
|
|
277
|
+
"name": "autoExpandVertically",
|
|
278
|
+
"privacy": "public",
|
|
279
|
+
"type": {
|
|
280
|
+
"text": "boolean"
|
|
281
|
+
},
|
|
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
|
+
}
|
|
293
|
+
}
|
|
294
|
+
},
|
|
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
|
+
{
|
|
306
|
+
"kind": "field",
|
|
307
|
+
"name": "itemClassNameGenerator",
|
|
308
|
+
"privacy": "public",
|
|
309
|
+
"type": {
|
|
310
|
+
"text": "object"
|
|
311
|
+
},
|
|
312
|
+
"description": "A function used to generate CSS class names for dropdown\nitems and selected chips based on the item. The return\nvalue should be the generated class name as a string, or\nmultiple class names separated by whitespace characters.",
|
|
313
|
+
"attribute": "item-class-name-generator"
|
|
314
|
+
},
|
|
315
|
+
{
|
|
316
|
+
"kind": "field",
|
|
317
|
+
"name": "itemIdPath",
|
|
318
|
+
"privacy": "public",
|
|
319
|
+
"type": {
|
|
320
|
+
"text": "string"
|
|
321
|
+
},
|
|
322
|
+
"description": "Path for the id of the item, used to detect whether the item is selected.",
|
|
323
|
+
"attribute": "item-id-path"
|
|
324
|
+
},
|
|
325
|
+
{
|
|
326
|
+
"kind": "field",
|
|
327
|
+
"name": "keepFilter",
|
|
328
|
+
"privacy": "public",
|
|
329
|
+
"type": {
|
|
330
|
+
"text": "boolean"
|
|
331
|
+
},
|
|
332
|
+
"description": "When true, filter string isn't cleared after selecting an item.",
|
|
333
|
+
"attribute": "keep-filter"
|
|
334
|
+
},
|
|
335
|
+
{
|
|
336
|
+
"kind": "field",
|
|
337
|
+
"name": "loading",
|
|
338
|
+
"privacy": "public",
|
|
339
|
+
"type": {
|
|
340
|
+
"text": "boolean"
|
|
341
|
+
},
|
|
342
|
+
"description": "True when loading items from the data provider, false otherwise.",
|
|
343
|
+
"attribute": "loading"
|
|
344
|
+
},
|
|
345
|
+
{
|
|
346
|
+
"kind": "method",
|
|
347
|
+
"name": "open",
|
|
348
|
+
"description": "Opens the dropdown list."
|
|
349
|
+
},
|
|
350
|
+
{
|
|
351
|
+
"kind": "field",
|
|
352
|
+
"name": "placeholder",
|
|
353
|
+
"privacy": "public",
|
|
354
|
+
"type": {
|
|
355
|
+
"text": "string"
|
|
356
|
+
},
|
|
357
|
+
"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.",
|
|
358
|
+
"attribute": "placeholder"
|
|
359
|
+
},
|
|
360
|
+
{
|
|
361
|
+
"kind": "field",
|
|
362
|
+
"name": "readonly",
|
|
363
|
+
"privacy": "public",
|
|
364
|
+
"type": {
|
|
365
|
+
"text": "boolean"
|
|
366
|
+
},
|
|
367
|
+
"description": "When present, it specifies that the field is read-only.",
|
|
368
|
+
"attribute": "readonly"
|
|
369
|
+
},
|
|
370
|
+
{
|
|
371
|
+
"kind": "field",
|
|
372
|
+
"name": "renderer",
|
|
373
|
+
"privacy": "public",
|
|
374
|
+
"type": {
|
|
375
|
+
"text": "function"
|
|
376
|
+
},
|
|
377
|
+
"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.",
|
|
378
|
+
"attribute": "renderer"
|
|
379
|
+
},
|
|
380
|
+
{
|
|
381
|
+
"kind": "method",
|
|
382
|
+
"name": "requestContentUpdate",
|
|
383
|
+
"description": "Requests an update for the content of items.\nWhile performing the update, it invokes the renderer (passed in the `renderer` property) once an item.\n\nIt is not guaranteed that the update happens immediately (synchronously) after it is requested."
|
|
384
|
+
},
|
|
385
|
+
{
|
|
386
|
+
"kind": "field",
|
|
387
|
+
"name": "selectedItems",
|
|
388
|
+
"privacy": "public",
|
|
389
|
+
"type": {
|
|
390
|
+
"text": "array"
|
|
391
|
+
},
|
|
392
|
+
"description": "The list of selected items.\nNote: modifying the selected items creates a new array each time.",
|
|
393
|
+
"attribute": "selected-items"
|
|
394
|
+
},
|
|
395
|
+
{
|
|
396
|
+
"kind": "field",
|
|
397
|
+
"name": "selectedItemsOnTop",
|
|
398
|
+
"privacy": "public",
|
|
399
|
+
"type": {
|
|
400
|
+
"text": "boolean"
|
|
401
|
+
},
|
|
402
|
+
"description": "Set to true to group selected items at the top of the overlay.",
|
|
403
|
+
"attribute": "selected-items-on-top"
|
|
404
|
+
}
|
|
405
|
+
],
|
|
406
|
+
"events": [
|
|
407
|
+
{
|
|
408
|
+
"name": "change",
|
|
409
|
+
"type": {
|
|
410
|
+
"text": "CustomEvent"
|
|
411
|
+
}
|
|
412
|
+
},
|
|
413
|
+
{
|
|
414
|
+
"name": "custom-value-set",
|
|
415
|
+
"type": {
|
|
416
|
+
"text": "CustomEvent"
|
|
417
|
+
}
|
|
418
|
+
}
|
|
419
|
+
],
|
|
420
|
+
"attributes": [
|
|
421
|
+
{
|
|
422
|
+
"name": "allow-custom-value",
|
|
423
|
+
"type": {
|
|
424
|
+
"text": "boolean"
|
|
425
|
+
},
|
|
426
|
+
"description": "When true, the user can input a value that is not present in the items list.",
|
|
427
|
+
"fieldName": "allowCustomValue"
|
|
428
|
+
},
|
|
429
|
+
{
|
|
430
|
+
"name": "auto-expand-horizontally",
|
|
431
|
+
"type": {
|
|
432
|
+
"text": "boolean"
|
|
433
|
+
},
|
|
434
|
+
"description": "Set to true to auto expand horizontally, causing input field to\ngrow until max width is reached.",
|
|
435
|
+
"fieldName": "autoExpandHorizontally"
|
|
436
|
+
},
|
|
437
|
+
{
|
|
438
|
+
"name": "auto-expand-vertically",
|
|
439
|
+
"type": {
|
|
440
|
+
"text": "boolean"
|
|
441
|
+
},
|
|
442
|
+
"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.",
|
|
443
|
+
"fieldName": "autoExpandVertically"
|
|
444
|
+
},
|
|
445
|
+
{
|
|
446
|
+
"name": "item-id-path",
|
|
447
|
+
"type": {
|
|
448
|
+
"text": "string"
|
|
449
|
+
},
|
|
450
|
+
"description": "Path for the id of the item, used to detect whether the item is selected.",
|
|
451
|
+
"fieldName": "itemIdPath"
|
|
452
|
+
},
|
|
453
|
+
{
|
|
454
|
+
"name": "keep-filter",
|
|
455
|
+
"type": {
|
|
456
|
+
"text": "boolean"
|
|
457
|
+
},
|
|
458
|
+
"description": "When true, filter string isn't cleared after selecting an item.",
|
|
459
|
+
"fieldName": "keepFilter"
|
|
460
|
+
},
|
|
461
|
+
{
|
|
462
|
+
"name": "loading",
|
|
463
|
+
"type": {
|
|
464
|
+
"text": "boolean"
|
|
465
|
+
},
|
|
466
|
+
"description": "True when loading items from the data provider, false otherwise.",
|
|
467
|
+
"fieldName": "loading"
|
|
468
|
+
},
|
|
469
|
+
{
|
|
470
|
+
"name": "placeholder",
|
|
471
|
+
"type": {
|
|
472
|
+
"text": "string"
|
|
473
|
+
},
|
|
474
|
+
"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.",
|
|
475
|
+
"fieldName": "placeholder"
|
|
476
|
+
},
|
|
477
|
+
{
|
|
478
|
+
"name": "readonly",
|
|
479
|
+
"type": {
|
|
480
|
+
"text": "boolean"
|
|
481
|
+
},
|
|
482
|
+
"description": "When present, it specifies that the field is read-only.",
|
|
483
|
+
"fieldName": "readonly"
|
|
484
|
+
},
|
|
485
|
+
{
|
|
486
|
+
"name": "renderer",
|
|
487
|
+
"type": {
|
|
488
|
+
"text": "function"
|
|
489
|
+
},
|
|
490
|
+
"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.",
|
|
491
|
+
"fieldName": "renderer"
|
|
492
|
+
},
|
|
493
|
+
{
|
|
494
|
+
"name": "selected-items",
|
|
495
|
+
"type": {
|
|
496
|
+
"text": "array"
|
|
497
|
+
},
|
|
498
|
+
"description": "The list of selected items.\nNote: modifying the selected items creates a new array each time.",
|
|
499
|
+
"fieldName": "selectedItems"
|
|
500
|
+
},
|
|
501
|
+
{
|
|
502
|
+
"name": "selected-items-on-top",
|
|
503
|
+
"type": {
|
|
504
|
+
"text": "boolean"
|
|
505
|
+
},
|
|
506
|
+
"description": "Set to true to group selected items at the top of the overlay.",
|
|
507
|
+
"fieldName": "selectedItemsOnTop"
|
|
508
|
+
},
|
|
509
|
+
{
|
|
510
|
+
"name": "value",
|
|
511
|
+
"type": {
|
|
512
|
+
"text": "string"
|
|
513
|
+
},
|
|
514
|
+
"fieldName": "value"
|
|
515
|
+
}
|
|
516
|
+
],
|
|
517
|
+
"mixins": [
|
|
518
|
+
{
|
|
519
|
+
"name": "I18nMixin",
|
|
520
|
+
"package": "@vaadin/component-base/src/i18n-mixin.js"
|
|
521
|
+
}
|
|
522
|
+
],
|
|
523
|
+
"parameters": [
|
|
524
|
+
{
|
|
525
|
+
"name": "superClass"
|
|
526
|
+
}
|
|
527
|
+
]
|
|
528
|
+
}
|
|
529
|
+
],
|
|
530
|
+
"exports": [
|
|
531
|
+
{
|
|
532
|
+
"kind": "js",
|
|
533
|
+
"name": "MultiSelectComboBoxMixin",
|
|
534
|
+
"declaration": {
|
|
535
|
+
"name": "MultiSelectComboBoxMixin",
|
|
536
|
+
"module": "src/vaadin-multi-select-combo-box-mixin.js"
|
|
537
|
+
}
|
|
538
|
+
}
|
|
539
|
+
]
|
|
540
|
+
},
|
|
541
|
+
{
|
|
542
|
+
"kind": "javascript-module",
|
|
543
|
+
"path": "src/vaadin-multi-select-combo-box-overlay.js",
|
|
544
|
+
"declarations": [],
|
|
545
|
+
"exports": []
|
|
546
|
+
},
|
|
547
|
+
{
|
|
548
|
+
"kind": "javascript-module",
|
|
549
|
+
"path": "src/vaadin-multi-select-combo-box-scroller.js",
|
|
550
|
+
"declarations": [
|
|
551
|
+
{
|
|
552
|
+
"kind": "class",
|
|
553
|
+
"description": "An element used internally by `<vaadin-multi-select-combo-box>`. Not intended to be used separately.",
|
|
554
|
+
"name": "MultiSelectComboBoxScroller",
|
|
555
|
+
"members": [
|
|
556
|
+
{
|
|
557
|
+
"kind": "field",
|
|
558
|
+
"name": "focusedIndex",
|
|
559
|
+
"privacy": "public",
|
|
560
|
+
"type": {
|
|
561
|
+
"text": "number"
|
|
562
|
+
},
|
|
563
|
+
"description": "Index of an item that has focus outline and is scrolled into view.\nThe actual focus still remains in the input field.",
|
|
564
|
+
"attribute": "focused-index",
|
|
565
|
+
"inheritedFrom": {
|
|
566
|
+
"name": "ComboBoxScrollerMixin",
|
|
567
|
+
"package": "@vaadin/combo-box/src/vaadin-combo-box-scroller-mixin.js"
|
|
568
|
+
}
|
|
569
|
+
},
|
|
570
|
+
{
|
|
571
|
+
"kind": "field",
|
|
572
|
+
"name": "getItemLabel",
|
|
573
|
+
"privacy": "public",
|
|
574
|
+
"type": {
|
|
575
|
+
"text": "object"
|
|
576
|
+
},
|
|
577
|
+
"description": "Function used to set a label for every combo-box item.",
|
|
578
|
+
"attribute": "get-item-label",
|
|
579
|
+
"inheritedFrom": {
|
|
580
|
+
"name": "ComboBoxScrollerMixin",
|
|
581
|
+
"package": "@vaadin/combo-box/src/vaadin-combo-box-scroller-mixin.js"
|
|
582
|
+
}
|
|
583
|
+
},
|
|
584
|
+
{
|
|
585
|
+
"kind": "field",
|
|
586
|
+
"name": "itemClassNameGenerator",
|
|
587
|
+
"privacy": "public",
|
|
588
|
+
"type": {
|
|
589
|
+
"text": "object"
|
|
590
|
+
},
|
|
591
|
+
"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.",
|
|
592
|
+
"attribute": "item-class-name-generator",
|
|
593
|
+
"inheritedFrom": {
|
|
594
|
+
"name": "ComboBoxScrollerMixin",
|
|
595
|
+
"package": "@vaadin/combo-box/src/vaadin-combo-box-scroller-mixin.js"
|
|
596
|
+
}
|
|
597
|
+
},
|
|
598
|
+
{
|
|
599
|
+
"kind": "field",
|
|
600
|
+
"name": "itemIdPath",
|
|
601
|
+
"privacy": "public",
|
|
602
|
+
"type": {
|
|
603
|
+
"text": "string"
|
|
604
|
+
},
|
|
605
|
+
"description": "Path for the id of the item, used to detect whether the item is selected.",
|
|
606
|
+
"attribute": "item-id-path",
|
|
607
|
+
"inheritedFrom": {
|
|
608
|
+
"name": "ComboBoxScrollerMixin",
|
|
609
|
+
"package": "@vaadin/combo-box/src/vaadin-combo-box-scroller-mixin.js"
|
|
610
|
+
}
|
|
611
|
+
},
|
|
612
|
+
{
|
|
613
|
+
"kind": "field",
|
|
614
|
+
"name": "items",
|
|
615
|
+
"privacy": "public",
|
|
616
|
+
"type": {
|
|
617
|
+
"text": "array"
|
|
618
|
+
},
|
|
619
|
+
"description": "A full set of items to filter the visible options from.\nSet to an empty array when combo-box is not opened.",
|
|
620
|
+
"attribute": "items",
|
|
621
|
+
"inheritedFrom": {
|
|
622
|
+
"name": "ComboBoxScrollerMixin",
|
|
623
|
+
"package": "@vaadin/combo-box/src/vaadin-combo-box-scroller-mixin.js"
|
|
624
|
+
}
|
|
625
|
+
},
|
|
626
|
+
{
|
|
627
|
+
"kind": "field",
|
|
628
|
+
"name": "loading",
|
|
629
|
+
"privacy": "public",
|
|
630
|
+
"type": {
|
|
631
|
+
"text": "boolean"
|
|
632
|
+
},
|
|
633
|
+
"description": "Set to true while combo-box fetches new page from the data provider.",
|
|
634
|
+
"attribute": "loading",
|
|
635
|
+
"inheritedFrom": {
|
|
636
|
+
"name": "ComboBoxScrollerMixin",
|
|
637
|
+
"package": "@vaadin/combo-box/src/vaadin-combo-box-scroller-mixin.js"
|
|
638
|
+
}
|
|
639
|
+
},
|
|
640
|
+
{
|
|
641
|
+
"kind": "field",
|
|
642
|
+
"name": "opened",
|
|
643
|
+
"privacy": "public",
|
|
644
|
+
"type": {
|
|
645
|
+
"text": "boolean"
|
|
646
|
+
},
|
|
647
|
+
"description": "Whether the combo-box is currently opened or not. If set to false,\ncalling `scrollIntoView` does not have any effect.",
|
|
648
|
+
"attribute": "opened",
|
|
649
|
+
"inheritedFrom": {
|
|
650
|
+
"name": "ComboBoxScrollerMixin",
|
|
651
|
+
"package": "@vaadin/combo-box/src/vaadin-combo-box-scroller-mixin.js"
|
|
652
|
+
}
|
|
653
|
+
},
|
|
654
|
+
{
|
|
655
|
+
"kind": "field",
|
|
656
|
+
"name": "owner",
|
|
657
|
+
"privacy": "public",
|
|
658
|
+
"type": {
|
|
659
|
+
"text": "object"
|
|
660
|
+
},
|
|
661
|
+
"description": "Reference to the owner (combo-box owner), used by the item elements.",
|
|
662
|
+
"attribute": "owner",
|
|
663
|
+
"inheritedFrom": {
|
|
664
|
+
"name": "ComboBoxScrollerMixin",
|
|
665
|
+
"package": "@vaadin/combo-box/src/vaadin-combo-box-scroller-mixin.js"
|
|
666
|
+
}
|
|
667
|
+
},
|
|
668
|
+
{
|
|
669
|
+
"kind": "field",
|
|
670
|
+
"name": "renderer",
|
|
671
|
+
"privacy": "public",
|
|
672
|
+
"type": {
|
|
673
|
+
"text": "object"
|
|
674
|
+
},
|
|
675
|
+
"description": "Function used to render the content of every combo-box item.",
|
|
676
|
+
"attribute": "renderer",
|
|
677
|
+
"inheritedFrom": {
|
|
678
|
+
"name": "ComboBoxScrollerMixin",
|
|
679
|
+
"package": "@vaadin/combo-box/src/vaadin-combo-box-scroller-mixin.js"
|
|
680
|
+
}
|
|
681
|
+
},
|
|
682
|
+
{
|
|
683
|
+
"kind": "method",
|
|
684
|
+
"name": "requestContentUpdate",
|
|
685
|
+
"description": "Updates the virtualizer's size and items.",
|
|
686
|
+
"inheritedFrom": {
|
|
687
|
+
"name": "ComboBoxScrollerMixin",
|
|
688
|
+
"package": "@vaadin/combo-box/src/vaadin-combo-box-scroller-mixin.js"
|
|
689
|
+
}
|
|
690
|
+
},
|
|
691
|
+
{
|
|
692
|
+
"kind": "method",
|
|
693
|
+
"name": "scrollIntoView",
|
|
694
|
+
"parameters": [
|
|
695
|
+
{
|
|
696
|
+
"name": "index",
|
|
697
|
+
"type": {
|
|
698
|
+
"text": "number"
|
|
699
|
+
}
|
|
700
|
+
}
|
|
701
|
+
],
|
|
702
|
+
"description": "Scrolls an item at given index into view and adjusts `scrollTop`\nso that the element gets fully visible on Arrow Down key press.",
|
|
703
|
+
"inheritedFrom": {
|
|
704
|
+
"name": "ComboBoxScrollerMixin",
|
|
705
|
+
"package": "@vaadin/combo-box/src/vaadin-combo-box-scroller-mixin.js"
|
|
706
|
+
}
|
|
707
|
+
},
|
|
708
|
+
{
|
|
709
|
+
"kind": "field",
|
|
710
|
+
"name": "selectedItem",
|
|
711
|
+
"privacy": "public",
|
|
712
|
+
"type": {
|
|
713
|
+
"text": "object"
|
|
714
|
+
},
|
|
715
|
+
"description": "The selected item from the `items` array.",
|
|
716
|
+
"attribute": "selected-item",
|
|
717
|
+
"inheritedFrom": {
|
|
718
|
+
"name": "ComboBoxScrollerMixin",
|
|
719
|
+
"package": "@vaadin/combo-box/src/vaadin-combo-box-scroller-mixin.js"
|
|
720
|
+
}
|
|
721
|
+
},
|
|
722
|
+
{
|
|
723
|
+
"kind": "field",
|
|
724
|
+
"name": "theme",
|
|
725
|
+
"privacy": "public",
|
|
726
|
+
"type": {
|
|
727
|
+
"text": "string"
|
|
728
|
+
},
|
|
729
|
+
"description": "Used to propagate the `theme` attribute from the host element.",
|
|
730
|
+
"attribute": "theme",
|
|
731
|
+
"inheritedFrom": {
|
|
732
|
+
"name": "ComboBoxScrollerMixin",
|
|
733
|
+
"package": "@vaadin/combo-box/src/vaadin-combo-box-scroller-mixin.js"
|
|
734
|
+
}
|
|
735
|
+
}
|
|
736
|
+
],
|
|
737
|
+
"mixins": [
|
|
738
|
+
{
|
|
739
|
+
"name": "ComboBoxScrollerMixin",
|
|
740
|
+
"package": "@vaadin/combo-box/src/vaadin-combo-box-scroller-mixin.js"
|
|
741
|
+
},
|
|
742
|
+
{
|
|
743
|
+
"name": "PolylitMixin",
|
|
744
|
+
"package": "@vaadin/component-base/src/polylit-mixin.js"
|
|
745
|
+
}
|
|
746
|
+
],
|
|
747
|
+
"superclass": {
|
|
748
|
+
"name": "LitElement",
|
|
749
|
+
"package": "lit"
|
|
750
|
+
},
|
|
751
|
+
"tagName": "vaadin-multi-select-combo-box-scroller",
|
|
752
|
+
"customElement": true,
|
|
753
|
+
"attributes": [
|
|
754
|
+
{
|
|
755
|
+
"name": "focused-index",
|
|
756
|
+
"type": {
|
|
757
|
+
"text": "number"
|
|
758
|
+
},
|
|
759
|
+
"description": "Index of an item that has focus outline and is scrolled into view.\nThe actual focus still remains in the input field.",
|
|
760
|
+
"fieldName": "focusedIndex",
|
|
761
|
+
"inheritedFrom": {
|
|
762
|
+
"name": "ComboBoxScrollerMixin",
|
|
763
|
+
"package": "@vaadin/combo-box/src/vaadin-combo-box-scroller-mixin.js"
|
|
764
|
+
}
|
|
765
|
+
},
|
|
766
|
+
{
|
|
767
|
+
"name": "item-id-path",
|
|
768
|
+
"type": {
|
|
769
|
+
"text": "string"
|
|
770
|
+
},
|
|
771
|
+
"description": "Path for the id of the item, used to detect whether the item is selected.",
|
|
772
|
+
"fieldName": "itemIdPath",
|
|
773
|
+
"inheritedFrom": {
|
|
774
|
+
"name": "ComboBoxScrollerMixin",
|
|
775
|
+
"package": "@vaadin/combo-box/src/vaadin-combo-box-scroller-mixin.js"
|
|
776
|
+
}
|
|
777
|
+
},
|
|
778
|
+
{
|
|
779
|
+
"name": "items",
|
|
780
|
+
"type": {
|
|
781
|
+
"text": "array"
|
|
782
|
+
},
|
|
783
|
+
"description": "A full set of items to filter the visible options from.\nSet to an empty array when combo-box is not opened.",
|
|
784
|
+
"fieldName": "items",
|
|
785
|
+
"inheritedFrom": {
|
|
786
|
+
"name": "ComboBoxScrollerMixin",
|
|
787
|
+
"package": "@vaadin/combo-box/src/vaadin-combo-box-scroller-mixin.js"
|
|
788
|
+
}
|
|
789
|
+
},
|
|
790
|
+
{
|
|
791
|
+
"name": "loading",
|
|
792
|
+
"type": {
|
|
793
|
+
"text": "boolean"
|
|
794
|
+
},
|
|
795
|
+
"description": "Set to true while combo-box fetches new page from the data provider.",
|
|
796
|
+
"fieldName": "loading",
|
|
797
|
+
"inheritedFrom": {
|
|
798
|
+
"name": "ComboBoxScrollerMixin",
|
|
799
|
+
"package": "@vaadin/combo-box/src/vaadin-combo-box-scroller-mixin.js"
|
|
800
|
+
}
|
|
801
|
+
},
|
|
802
|
+
{
|
|
803
|
+
"name": "opened",
|
|
804
|
+
"type": {
|
|
805
|
+
"text": "boolean"
|
|
806
|
+
},
|
|
807
|
+
"description": "Whether the combo-box is currently opened or not. If set to false,\ncalling `scrollIntoView` does not have any effect.",
|
|
808
|
+
"fieldName": "opened",
|
|
809
|
+
"inheritedFrom": {
|
|
810
|
+
"name": "ComboBoxScrollerMixin",
|
|
811
|
+
"package": "@vaadin/combo-box/src/vaadin-combo-box-scroller-mixin.js"
|
|
812
|
+
}
|
|
813
|
+
},
|
|
814
|
+
{
|
|
815
|
+
"name": "theme",
|
|
816
|
+
"type": {
|
|
817
|
+
"text": "string"
|
|
818
|
+
},
|
|
819
|
+
"description": "Used to propagate the `theme` attribute from the host element.",
|
|
820
|
+
"fieldName": "theme",
|
|
821
|
+
"inheritedFrom": {
|
|
822
|
+
"name": "ComboBoxScrollerMixin",
|
|
823
|
+
"package": "@vaadin/combo-box/src/vaadin-combo-box-scroller-mixin.js"
|
|
824
|
+
}
|
|
825
|
+
}
|
|
826
|
+
],
|
|
827
|
+
"events": [
|
|
828
|
+
{
|
|
829
|
+
"name": "index-requested",
|
|
830
|
+
"type": {
|
|
831
|
+
"text": "CustomEvent"
|
|
832
|
+
},
|
|
833
|
+
"inheritedFrom": {
|
|
834
|
+
"name": "ComboBoxScrollerMixin",
|
|
835
|
+
"package": "@vaadin/combo-box/src/vaadin-combo-box-scroller-mixin.js"
|
|
836
|
+
}
|
|
837
|
+
},
|
|
838
|
+
{
|
|
839
|
+
"name": "selection-changed",
|
|
840
|
+
"type": {
|
|
841
|
+
"text": "CustomEvent"
|
|
842
|
+
},
|
|
843
|
+
"inheritedFrom": {
|
|
844
|
+
"name": "ComboBoxScrollerMixin",
|
|
845
|
+
"package": "@vaadin/combo-box/src/vaadin-combo-box-scroller-mixin.js"
|
|
846
|
+
}
|
|
847
|
+
}
|
|
848
|
+
]
|
|
849
|
+
}
|
|
850
|
+
],
|
|
851
|
+
"exports": [
|
|
852
|
+
{
|
|
853
|
+
"kind": "js",
|
|
854
|
+
"name": "MultiSelectComboBoxScroller",
|
|
855
|
+
"declaration": {
|
|
856
|
+
"name": "MultiSelectComboBoxScroller",
|
|
857
|
+
"module": "src/vaadin-multi-select-combo-box-scroller.js"
|
|
858
|
+
}
|
|
859
|
+
}
|
|
860
|
+
]
|
|
861
|
+
},
|
|
862
|
+
{
|
|
863
|
+
"kind": "javascript-module",
|
|
864
|
+
"path": "src/vaadin-multi-select-combo-box.js",
|
|
865
|
+
"declarations": [
|
|
866
|
+
{
|
|
867
|
+
"kind": "class",
|
|
868
|
+
"description": "`<vaadin-multi-select-combo-box>` is a web component that wraps `<vaadin-combo-box>` and extends\nits functionality to allow selecting multiple items, in addition to basic features.\n\n```html\n<vaadin-multi-select-combo-box id=\"comboBox\"></vaadin-multi-select-combo-box>\n```\n\n```js\nconst comboBox = document.querySelector('#comboBox');\ncomboBox.items = ['apple', 'banana', 'lemon', 'orange'];\ncomboBox.selectedItems = ['lemon', 'orange'];\n```\n\n### Styling\n\nThe following shadow DOM parts are available for styling:\n\nPart name | Description\n-----------------------|----------------\n`chips` | The element that wraps slotted chips for selected items\n`label` | The label element\n`input-field` | The element that wraps prefix, value and suffix\n`field-button` | Set on both clear and toggle buttons\n`clear-button` | The clear button\n`error-message` | The error message element\n`helper-text` | The helper text element wrapper\n`required-indicator` | The `required` state indicator element\n`toggle-button` | The toggle button\n`overlay` | The overlay container\n`content` | The overlay content\n`loader` | The loading indicator shown while loading items\n\nThe following state attributes are available for styling:\n\nAttribute | Description\n-----------------------|-----------------\n`disabled` | Set to a disabled element\n`has-value` | Set when the element has a value\n`has-label` | Set when the element has a label\n`has-helper` | Set when the element has helper text or slot\n`has-error-message` | Set when the element has an error message\n`has-tooltip` | Set when the element has a slotted tooltip\n`invalid` | Set when the element is invalid\n`focused` | Set when the element is focused\n`focus-ring` | Set when the element is keyboard focused\n`loading` | Set when loading items from the data provider\n`opened` | Set when the dropdown is open\n`readonly` | Set to a readonly element\n\nThe following custom CSS properties are available for styling:\n\nCustom property | Description | Default\n-----------------------------------------------------|----------------------------|--------\n`--vaadin-field-default-width` | Default width of the field | `12em`\n`--vaadin-multi-select-combo-box-overlay-width` | Width of the overlay | `auto`\n`--vaadin-multi-select-combo-box-overlay-max-height` | Max height of the overlay | `65vh`\n`--vaadin-multi-select-combo-box-input-min-width` | Min width of the input | `4em`\n\n### Internal components\n\nIn addition to `<vaadin-multi-select-combo-box>` itself, the following internal\ncomponents are themable:\n\n- `<vaadin-multi-select-combo-box-chip>`\n- `<vaadin-multi-select-combo-box-item>` - has the same API as `<vaadin-item>`.\n\nSee [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.",
|
|
869
|
+
"name": "MultiSelectComboBox",
|
|
870
|
+
"members": [
|
|
871
|
+
{
|
|
872
|
+
"kind": "field",
|
|
873
|
+
"name": "allowCustomValue",
|
|
874
|
+
"privacy": "public",
|
|
875
|
+
"type": {
|
|
876
|
+
"text": "boolean"
|
|
877
|
+
},
|
|
878
|
+
"description": "When true, the user can input a value that is not present in the items list.",
|
|
879
|
+
"attribute": "allow-custom-value",
|
|
880
|
+
"inheritedFrom": {
|
|
881
|
+
"name": "MultiSelectComboBoxMixin",
|
|
882
|
+
"module": "src/vaadin-multi-select-combo-box-mixin.js"
|
|
883
|
+
}
|
|
884
|
+
},
|
|
885
|
+
{
|
|
886
|
+
"kind": "field",
|
|
887
|
+
"name": "autoExpandHorizontally",
|
|
888
|
+
"privacy": "public",
|
|
889
|
+
"type": {
|
|
890
|
+
"text": "boolean"
|
|
891
|
+
},
|
|
892
|
+
"description": "Set to true to auto expand horizontally, causing input field to\ngrow until max width is reached.",
|
|
893
|
+
"attribute": "auto-expand-horizontally",
|
|
894
|
+
"inheritedFrom": {
|
|
895
|
+
"name": "MultiSelectComboBoxMixin",
|
|
896
|
+
"module": "src/vaadin-multi-select-combo-box-mixin.js"
|
|
897
|
+
}
|
|
898
|
+
},
|
|
899
|
+
{
|
|
900
|
+
"kind": "field",
|
|
901
|
+
"name": "autoExpandVertically",
|
|
902
|
+
"privacy": "public",
|
|
903
|
+
"type": {
|
|
904
|
+
"text": "boolean"
|
|
905
|
+
},
|
|
906
|
+
"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.",
|
|
907
|
+
"attribute": "auto-expand-vertically",
|
|
908
|
+
"inheritedFrom": {
|
|
909
|
+
"name": "MultiSelectComboBoxMixin",
|
|
910
|
+
"module": "src/vaadin-multi-select-combo-box-mixin.js"
|
|
911
|
+
}
|
|
912
|
+
},
|
|
913
|
+
{
|
|
914
|
+
"kind": "method",
|
|
915
|
+
"name": "checkValidity",
|
|
916
|
+
"description": "Returns true if the current input value satisfies all constraints (if any).",
|
|
917
|
+
"return": {
|
|
918
|
+
"type": {
|
|
919
|
+
"text": "boolean"
|
|
920
|
+
}
|
|
921
|
+
},
|
|
922
|
+
"inheritedFrom": {
|
|
923
|
+
"name": "MultiSelectComboBoxMixin",
|
|
924
|
+
"module": "src/vaadin-multi-select-combo-box-mixin.js"
|
|
925
|
+
}
|
|
926
|
+
},
|
|
927
|
+
{
|
|
928
|
+
"kind": "method",
|
|
929
|
+
"name": "clear",
|
|
930
|
+
"description": "Clears the selected items.",
|
|
931
|
+
"inheritedFrom": {
|
|
932
|
+
"name": "MultiSelectComboBoxMixin",
|
|
933
|
+
"module": "src/vaadin-multi-select-combo-box-mixin.js"
|
|
934
|
+
}
|
|
935
|
+
},
|
|
936
|
+
{
|
|
937
|
+
"kind": "method",
|
|
938
|
+
"name": "clearCache",
|
|
939
|
+
"description": "Clears the cached pages and reloads data from data provider when needed.",
|
|
940
|
+
"inheritedFrom": {
|
|
941
|
+
"name": "MultiSelectComboBoxMixin",
|
|
942
|
+
"module": "src/vaadin-multi-select-combo-box-mixin.js"
|
|
943
|
+
}
|
|
944
|
+
},
|
|
945
|
+
{
|
|
946
|
+
"kind": "field",
|
|
947
|
+
"name": "itemClassNameGenerator",
|
|
948
|
+
"privacy": "public",
|
|
949
|
+
"type": {
|
|
950
|
+
"text": "object"
|
|
951
|
+
},
|
|
952
|
+
"description": "A function used to generate CSS class names for dropdown\nitems and selected chips based on the item. The return\nvalue should be the generated class name as a string, or\nmultiple class names separated by whitespace characters.",
|
|
953
|
+
"attribute": "item-class-name-generator",
|
|
954
|
+
"inheritedFrom": {
|
|
955
|
+
"name": "MultiSelectComboBoxMixin",
|
|
956
|
+
"module": "src/vaadin-multi-select-combo-box-mixin.js"
|
|
957
|
+
}
|
|
958
|
+
},
|
|
959
|
+
{
|
|
960
|
+
"kind": "field",
|
|
961
|
+
"name": "itemIdPath",
|
|
962
|
+
"privacy": "public",
|
|
963
|
+
"type": {
|
|
964
|
+
"text": "string"
|
|
965
|
+
},
|
|
966
|
+
"description": "Path for the id of the item, used to detect whether the item is selected.",
|
|
967
|
+
"attribute": "item-id-path",
|
|
968
|
+
"inheritedFrom": {
|
|
969
|
+
"name": "MultiSelectComboBoxMixin",
|
|
970
|
+
"module": "src/vaadin-multi-select-combo-box-mixin.js"
|
|
971
|
+
}
|
|
972
|
+
},
|
|
973
|
+
{
|
|
974
|
+
"kind": "field",
|
|
975
|
+
"name": "keepFilter",
|
|
976
|
+
"privacy": "public",
|
|
977
|
+
"type": {
|
|
978
|
+
"text": "boolean"
|
|
979
|
+
},
|
|
980
|
+
"description": "When true, filter string isn't cleared after selecting an item.",
|
|
981
|
+
"attribute": "keep-filter",
|
|
982
|
+
"inheritedFrom": {
|
|
983
|
+
"name": "MultiSelectComboBoxMixin",
|
|
984
|
+
"module": "src/vaadin-multi-select-combo-box-mixin.js"
|
|
985
|
+
}
|
|
986
|
+
},
|
|
987
|
+
{
|
|
988
|
+
"kind": "field",
|
|
989
|
+
"name": "loading",
|
|
990
|
+
"privacy": "public",
|
|
991
|
+
"type": {
|
|
992
|
+
"text": "boolean"
|
|
993
|
+
},
|
|
994
|
+
"description": "True when loading items from the data provider, false otherwise.",
|
|
995
|
+
"attribute": "loading",
|
|
996
|
+
"inheritedFrom": {
|
|
997
|
+
"name": "MultiSelectComboBoxMixin",
|
|
998
|
+
"module": "src/vaadin-multi-select-combo-box-mixin.js"
|
|
999
|
+
}
|
|
1000
|
+
},
|
|
1001
|
+
{
|
|
1002
|
+
"kind": "method",
|
|
1003
|
+
"name": "open",
|
|
1004
|
+
"description": "Opens the dropdown list.",
|
|
1005
|
+
"inheritedFrom": {
|
|
1006
|
+
"name": "MultiSelectComboBoxMixin",
|
|
1007
|
+
"module": "src/vaadin-multi-select-combo-box-mixin.js"
|
|
1008
|
+
}
|
|
1009
|
+
},
|
|
1010
|
+
{
|
|
1011
|
+
"kind": "field",
|
|
1012
|
+
"name": "placeholder",
|
|
1013
|
+
"privacy": "public",
|
|
1014
|
+
"type": {
|
|
1015
|
+
"text": "string"
|
|
1016
|
+
},
|
|
1017
|
+
"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.",
|
|
1018
|
+
"attribute": "placeholder",
|
|
1019
|
+
"inheritedFrom": {
|
|
1020
|
+
"name": "MultiSelectComboBoxMixin",
|
|
1021
|
+
"module": "src/vaadin-multi-select-combo-box-mixin.js"
|
|
1022
|
+
}
|
|
1023
|
+
},
|
|
1024
|
+
{
|
|
1025
|
+
"kind": "field",
|
|
1026
|
+
"name": "readonly",
|
|
1027
|
+
"privacy": "public",
|
|
1028
|
+
"type": {
|
|
1029
|
+
"text": "boolean"
|
|
1030
|
+
},
|
|
1031
|
+
"description": "When present, it specifies that the field is read-only.",
|
|
1032
|
+
"attribute": "readonly",
|
|
1033
|
+
"inheritedFrom": {
|
|
1034
|
+
"name": "MultiSelectComboBoxMixin",
|
|
1035
|
+
"module": "src/vaadin-multi-select-combo-box-mixin.js"
|
|
1036
|
+
}
|
|
1037
|
+
},
|
|
1038
|
+
{
|
|
1039
|
+
"kind": "field",
|
|
1040
|
+
"name": "renderer",
|
|
1041
|
+
"privacy": "public",
|
|
1042
|
+
"type": {
|
|
1043
|
+
"text": "function"
|
|
1044
|
+
},
|
|
1045
|
+
"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.",
|
|
1046
|
+
"attribute": "renderer",
|
|
1047
|
+
"inheritedFrom": {
|
|
1048
|
+
"name": "MultiSelectComboBoxMixin",
|
|
1049
|
+
"module": "src/vaadin-multi-select-combo-box-mixin.js"
|
|
1050
|
+
}
|
|
1051
|
+
},
|
|
1052
|
+
{
|
|
1053
|
+
"kind": "method",
|
|
1054
|
+
"name": "requestContentUpdate",
|
|
1055
|
+
"description": "Requests an update for the content of items.\nWhile performing the update, it invokes the renderer (passed in the `renderer` property) once an item.\n\nIt is not guaranteed that the update happens immediately (synchronously) after it is requested.",
|
|
1056
|
+
"inheritedFrom": {
|
|
1057
|
+
"name": "MultiSelectComboBoxMixin",
|
|
1058
|
+
"module": "src/vaadin-multi-select-combo-box-mixin.js"
|
|
1059
|
+
}
|
|
1060
|
+
},
|
|
1061
|
+
{
|
|
1062
|
+
"kind": "field",
|
|
1063
|
+
"name": "selectedItems",
|
|
1064
|
+
"privacy": "public",
|
|
1065
|
+
"type": {
|
|
1066
|
+
"text": "array"
|
|
1067
|
+
},
|
|
1068
|
+
"description": "The list of selected items.\nNote: modifying the selected items creates a new array each time.",
|
|
1069
|
+
"attribute": "selected-items",
|
|
1070
|
+
"inheritedFrom": {
|
|
1071
|
+
"name": "MultiSelectComboBoxMixin",
|
|
1072
|
+
"module": "src/vaadin-multi-select-combo-box-mixin.js"
|
|
1073
|
+
}
|
|
1074
|
+
},
|
|
1075
|
+
{
|
|
1076
|
+
"kind": "field",
|
|
1077
|
+
"name": "selectedItemsOnTop",
|
|
1078
|
+
"privacy": "public",
|
|
1079
|
+
"type": {
|
|
1080
|
+
"text": "boolean"
|
|
1081
|
+
},
|
|
1082
|
+
"description": "Set to true to group selected items at the top of the overlay.",
|
|
1083
|
+
"attribute": "selected-items-on-top",
|
|
1084
|
+
"inheritedFrom": {
|
|
1085
|
+
"name": "MultiSelectComboBoxMixin",
|
|
1086
|
+
"module": "src/vaadin-multi-select-combo-box-mixin.js"
|
|
1087
|
+
}
|
|
1088
|
+
}
|
|
1089
|
+
],
|
|
1090
|
+
"events": [
|
|
1091
|
+
{
|
|
1092
|
+
"name": "change",
|
|
1093
|
+
"type": {
|
|
1094
|
+
"text": "CustomEvent"
|
|
1095
|
+
},
|
|
1096
|
+
"description": "Fired when the user commits a value change.",
|
|
1097
|
+
"inheritedFrom": {
|
|
1098
|
+
"name": "MultiSelectComboBoxMixin",
|
|
1099
|
+
"module": "src/vaadin-multi-select-combo-box-mixin.js"
|
|
1100
|
+
}
|
|
1101
|
+
},
|
|
1102
|
+
{
|
|
1103
|
+
"name": "custom-value-set",
|
|
1104
|
+
"type": {
|
|
1105
|
+
"text": "CustomEvent"
|
|
1106
|
+
},
|
|
1107
|
+
"description": "Fired when the user sets a custom value.",
|
|
1108
|
+
"inheritedFrom": {
|
|
1109
|
+
"name": "MultiSelectComboBoxMixin",
|
|
1110
|
+
"module": "src/vaadin-multi-select-combo-box-mixin.js"
|
|
1111
|
+
}
|
|
1112
|
+
},
|
|
1113
|
+
{
|
|
1114
|
+
"type": {
|
|
1115
|
+
"text": "CustomEvent"
|
|
1116
|
+
},
|
|
1117
|
+
"description": "Fired when the `filter` property changes.",
|
|
1118
|
+
"name": "filter-changed"
|
|
1119
|
+
},
|
|
1120
|
+
{
|
|
1121
|
+
"type": {
|
|
1122
|
+
"text": "CustomEvent"
|
|
1123
|
+
},
|
|
1124
|
+
"description": "Fired when the `invalid` property changes.",
|
|
1125
|
+
"name": "invalid-changed"
|
|
1126
|
+
},
|
|
1127
|
+
{
|
|
1128
|
+
"type": {
|
|
1129
|
+
"text": "CustomEvent"
|
|
1130
|
+
},
|
|
1131
|
+
"description": "Fired when the `opened` property changes.",
|
|
1132
|
+
"name": "opened-changed"
|
|
1133
|
+
},
|
|
1134
|
+
{
|
|
1135
|
+
"type": {
|
|
1136
|
+
"text": "CustomEvent"
|
|
1137
|
+
},
|
|
1138
|
+
"description": "Fired when the `selectedItems` property changes.",
|
|
1139
|
+
"name": "selected-items-changed"
|
|
1140
|
+
},
|
|
1141
|
+
{
|
|
1142
|
+
"type": {
|
|
1143
|
+
"text": "CustomEvent"
|
|
1144
|
+
},
|
|
1145
|
+
"description": "Fired whenever the field is validated.",
|
|
1146
|
+
"name": "validated"
|
|
1147
|
+
}
|
|
1148
|
+
],
|
|
1149
|
+
"mixins": [
|
|
1150
|
+
{
|
|
1151
|
+
"name": "MultiSelectComboBoxMixin",
|
|
1152
|
+
"module": "src/vaadin-multi-select-combo-box-mixin.js"
|
|
1153
|
+
},
|
|
1154
|
+
{
|
|
1155
|
+
"name": "ThemableMixin",
|
|
1156
|
+
"package": "@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js"
|
|
1157
|
+
},
|
|
1158
|
+
{
|
|
1159
|
+
"name": "ElementMixin",
|
|
1160
|
+
"package": "@vaadin/component-base/src/element-mixin.js"
|
|
1161
|
+
},
|
|
1162
|
+
{
|
|
1163
|
+
"name": "PolylitMixin",
|
|
1164
|
+
"package": "@vaadin/component-base/src/polylit-mixin.js"
|
|
1165
|
+
},
|
|
1166
|
+
{
|
|
1167
|
+
"name": "LumoInjectionMixin",
|
|
1168
|
+
"package": "@vaadin/vaadin-themable-mixin/lumo-injection-mixin.js"
|
|
1169
|
+
}
|
|
1170
|
+
],
|
|
1171
|
+
"superclass": {
|
|
1172
|
+
"name": "LitElement",
|
|
1173
|
+
"package": "lit"
|
|
1174
|
+
},
|
|
1175
|
+
"tagName": "vaadin-multi-select-combo-box",
|
|
1176
|
+
"customElement": true,
|
|
1177
|
+
"attributes": [
|
|
1178
|
+
{
|
|
1179
|
+
"name": "allow-custom-value",
|
|
1180
|
+
"type": {
|
|
1181
|
+
"text": "boolean"
|
|
1182
|
+
},
|
|
1183
|
+
"description": "When true, the user can input a value that is not present in the items list.",
|
|
1184
|
+
"fieldName": "allowCustomValue",
|
|
1185
|
+
"inheritedFrom": {
|
|
1186
|
+
"name": "MultiSelectComboBoxMixin",
|
|
1187
|
+
"module": "src/vaadin-multi-select-combo-box-mixin.js"
|
|
1188
|
+
}
|
|
1189
|
+
},
|
|
1190
|
+
{
|
|
1191
|
+
"name": "auto-expand-horizontally",
|
|
1192
|
+
"type": {
|
|
1193
|
+
"text": "boolean"
|
|
1194
|
+
},
|
|
1195
|
+
"description": "Set to true to auto expand horizontally, causing input field to\ngrow until max width is reached.",
|
|
1196
|
+
"fieldName": "autoExpandHorizontally",
|
|
1197
|
+
"inheritedFrom": {
|
|
1198
|
+
"name": "MultiSelectComboBoxMixin",
|
|
1199
|
+
"module": "src/vaadin-multi-select-combo-box-mixin.js"
|
|
1200
|
+
}
|
|
1201
|
+
},
|
|
1202
|
+
{
|
|
1203
|
+
"name": "auto-expand-vertically",
|
|
1204
|
+
"type": {
|
|
1205
|
+
"text": "boolean"
|
|
1206
|
+
},
|
|
1207
|
+
"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.",
|
|
1208
|
+
"fieldName": "autoExpandVertically",
|
|
1209
|
+
"inheritedFrom": {
|
|
1210
|
+
"name": "MultiSelectComboBoxMixin",
|
|
1211
|
+
"module": "src/vaadin-multi-select-combo-box-mixin.js"
|
|
1212
|
+
}
|
|
1213
|
+
},
|
|
1214
|
+
{
|
|
1215
|
+
"name": "item-id-path",
|
|
1216
|
+
"type": {
|
|
1217
|
+
"text": "string"
|
|
1218
|
+
},
|
|
1219
|
+
"description": "Path for the id of the item, used to detect whether the item is selected.",
|
|
1220
|
+
"fieldName": "itemIdPath",
|
|
1221
|
+
"inheritedFrom": {
|
|
1222
|
+
"name": "MultiSelectComboBoxMixin",
|
|
1223
|
+
"module": "src/vaadin-multi-select-combo-box-mixin.js"
|
|
1224
|
+
}
|
|
1225
|
+
},
|
|
1226
|
+
{
|
|
1227
|
+
"name": "keep-filter",
|
|
1228
|
+
"type": {
|
|
1229
|
+
"text": "boolean"
|
|
1230
|
+
},
|
|
1231
|
+
"description": "When true, filter string isn't cleared after selecting an item.",
|
|
1232
|
+
"fieldName": "keepFilter",
|
|
1233
|
+
"inheritedFrom": {
|
|
1234
|
+
"name": "MultiSelectComboBoxMixin",
|
|
1235
|
+
"module": "src/vaadin-multi-select-combo-box-mixin.js"
|
|
1236
|
+
}
|
|
1237
|
+
},
|
|
1238
|
+
{
|
|
1239
|
+
"name": "loading",
|
|
1240
|
+
"type": {
|
|
1241
|
+
"text": "boolean"
|
|
1242
|
+
},
|
|
1243
|
+
"description": "True when loading items from the data provider, false otherwise.",
|
|
1244
|
+
"fieldName": "loading",
|
|
1245
|
+
"inheritedFrom": {
|
|
1246
|
+
"name": "MultiSelectComboBoxMixin",
|
|
1247
|
+
"module": "src/vaadin-multi-select-combo-box-mixin.js"
|
|
1248
|
+
}
|
|
1249
|
+
},
|
|
1250
|
+
{
|
|
1251
|
+
"name": "placeholder",
|
|
1252
|
+
"type": {
|
|
1253
|
+
"text": "string"
|
|
1254
|
+
},
|
|
1255
|
+
"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.",
|
|
1256
|
+
"fieldName": "placeholder",
|
|
1257
|
+
"inheritedFrom": {
|
|
1258
|
+
"name": "MultiSelectComboBoxMixin",
|
|
1259
|
+
"module": "src/vaadin-multi-select-combo-box-mixin.js"
|
|
1260
|
+
}
|
|
1261
|
+
},
|
|
1262
|
+
{
|
|
1263
|
+
"name": "readonly",
|
|
1264
|
+
"type": {
|
|
1265
|
+
"text": "boolean"
|
|
1266
|
+
},
|
|
1267
|
+
"description": "When present, it specifies that the field is read-only.",
|
|
1268
|
+
"fieldName": "readonly",
|
|
1269
|
+
"inheritedFrom": {
|
|
1270
|
+
"name": "MultiSelectComboBoxMixin",
|
|
1271
|
+
"module": "src/vaadin-multi-select-combo-box-mixin.js"
|
|
1272
|
+
}
|
|
1273
|
+
},
|
|
1274
|
+
{
|
|
1275
|
+
"name": "renderer",
|
|
1276
|
+
"type": {
|
|
1277
|
+
"text": "function"
|
|
1278
|
+
},
|
|
1279
|
+
"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.",
|
|
1280
|
+
"fieldName": "renderer",
|
|
1281
|
+
"inheritedFrom": {
|
|
1282
|
+
"name": "MultiSelectComboBoxMixin",
|
|
1283
|
+
"module": "src/vaadin-multi-select-combo-box-mixin.js"
|
|
1284
|
+
}
|
|
1285
|
+
},
|
|
1286
|
+
{
|
|
1287
|
+
"name": "selected-items",
|
|
1288
|
+
"type": {
|
|
1289
|
+
"text": "array"
|
|
1290
|
+
},
|
|
1291
|
+
"description": "The list of selected items.\nNote: modifying the selected items creates a new array each time.",
|
|
1292
|
+
"fieldName": "selectedItems",
|
|
1293
|
+
"inheritedFrom": {
|
|
1294
|
+
"name": "MultiSelectComboBoxMixin",
|
|
1295
|
+
"module": "src/vaadin-multi-select-combo-box-mixin.js"
|
|
1296
|
+
}
|
|
1297
|
+
},
|
|
1298
|
+
{
|
|
1299
|
+
"name": "selected-items-on-top",
|
|
1300
|
+
"type": {
|
|
1301
|
+
"text": "boolean"
|
|
1302
|
+
},
|
|
1303
|
+
"description": "Set to true to group selected items at the top of the overlay.",
|
|
1304
|
+
"fieldName": "selectedItemsOnTop",
|
|
1305
|
+
"inheritedFrom": {
|
|
1306
|
+
"name": "MultiSelectComboBoxMixin",
|
|
1307
|
+
"module": "src/vaadin-multi-select-combo-box-mixin.js"
|
|
1308
|
+
}
|
|
1309
|
+
},
|
|
1310
|
+
{
|
|
1311
|
+
"name": "value",
|
|
1312
|
+
"type": {
|
|
1313
|
+
"text": "string"
|
|
1314
|
+
},
|
|
1315
|
+
"fieldName": "value",
|
|
1316
|
+
"inheritedFrom": {
|
|
1317
|
+
"name": "MultiSelectComboBoxMixin",
|
|
1318
|
+
"module": "src/vaadin-multi-select-combo-box-mixin.js"
|
|
1319
|
+
}
|
|
1320
|
+
}
|
|
1321
|
+
]
|
|
1322
|
+
}
|
|
1323
|
+
],
|
|
1324
|
+
"exports": [
|
|
1325
|
+
{
|
|
1326
|
+
"kind": "js",
|
|
1327
|
+
"name": "MultiSelectComboBox",
|
|
1328
|
+
"declaration": {
|
|
1329
|
+
"name": "MultiSelectComboBox",
|
|
1330
|
+
"module": "src/vaadin-multi-select-combo-box.js"
|
|
1331
|
+
}
|
|
1332
|
+
}
|
|
1333
|
+
]
|
|
1334
|
+
}
|
|
1335
|
+
]
|
|
1336
|
+
}
|