@vaadin/select 25.1.0-alpha6 → 25.1.0-alpha7
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 +2032 -0
- package/package.json +18 -16
- package/src/vaadin-select-base-mixin.js +8 -3
- package/src/vaadin-select-item.js +1 -1
- package/src/vaadin-select-list-box.js +1 -1
- package/src/vaadin-select-overlay.js +1 -1
- package/src/vaadin-select-value-button.js +1 -1
- package/src/vaadin-select.js +1 -1
- package/web-types.json +2 -2
- package/web-types.lit.json +2 -2
|
@@ -0,0 +1,2032 @@
|
|
|
1
|
+
{
|
|
2
|
+
"schemaVersion": "1.0.0",
|
|
3
|
+
"readme": "",
|
|
4
|
+
"modules": [
|
|
5
|
+
{
|
|
6
|
+
"kind": "javascript-module",
|
|
7
|
+
"path": "vaadin-select.js",
|
|
8
|
+
"declarations": [],
|
|
9
|
+
"exports": [
|
|
10
|
+
{
|
|
11
|
+
"kind": "js",
|
|
12
|
+
"name": "*",
|
|
13
|
+
"declaration": {
|
|
14
|
+
"name": "*",
|
|
15
|
+
"module": "src/vaadin-select.js"
|
|
16
|
+
}
|
|
17
|
+
}
|
|
18
|
+
]
|
|
19
|
+
},
|
|
20
|
+
{
|
|
21
|
+
"kind": "javascript-module",
|
|
22
|
+
"path": "src/vaadin-select-base-mixin.js",
|
|
23
|
+
"declarations": [
|
|
24
|
+
{
|
|
25
|
+
"kind": "mixin",
|
|
26
|
+
"description": "",
|
|
27
|
+
"name": "SelectBaseMixin",
|
|
28
|
+
"members": [
|
|
29
|
+
{
|
|
30
|
+
"kind": "field",
|
|
31
|
+
"name": "accessibleName",
|
|
32
|
+
"privacy": "public",
|
|
33
|
+
"type": {
|
|
34
|
+
"text": "string"
|
|
35
|
+
},
|
|
36
|
+
"description": "String used to label the component to screen reader users.",
|
|
37
|
+
"attribute": "accessible-name",
|
|
38
|
+
"inheritedFrom": {
|
|
39
|
+
"name": "FieldMixin",
|
|
40
|
+
"package": "@vaadin/field-base/src/field-mixin.js"
|
|
41
|
+
}
|
|
42
|
+
},
|
|
43
|
+
{
|
|
44
|
+
"kind": "field",
|
|
45
|
+
"name": "accessibleNameRef",
|
|
46
|
+
"privacy": "public",
|
|
47
|
+
"type": {
|
|
48
|
+
"text": "string"
|
|
49
|
+
},
|
|
50
|
+
"description": "Id of the element used as label of the component to screen reader users.",
|
|
51
|
+
"attribute": "accessible-name-ref",
|
|
52
|
+
"inheritedFrom": {
|
|
53
|
+
"name": "FieldMixin",
|
|
54
|
+
"package": "@vaadin/field-base/src/field-mixin.js"
|
|
55
|
+
}
|
|
56
|
+
},
|
|
57
|
+
{
|
|
58
|
+
"kind": "method",
|
|
59
|
+
"name": "checkValidity",
|
|
60
|
+
"description": "Returns true if the current value satisfies all constraints (if any)",
|
|
61
|
+
"return": {
|
|
62
|
+
"type": {
|
|
63
|
+
"text": "boolean"
|
|
64
|
+
}
|
|
65
|
+
}
|
|
66
|
+
},
|
|
67
|
+
{
|
|
68
|
+
"kind": "field",
|
|
69
|
+
"name": "errorMessage",
|
|
70
|
+
"privacy": "public",
|
|
71
|
+
"type": {
|
|
72
|
+
"text": "string"
|
|
73
|
+
},
|
|
74
|
+
"description": "Error to show when the field is invalid.",
|
|
75
|
+
"attribute": "error-message",
|
|
76
|
+
"inheritedFrom": {
|
|
77
|
+
"name": "FieldMixin",
|
|
78
|
+
"package": "@vaadin/field-base/src/field-mixin.js"
|
|
79
|
+
}
|
|
80
|
+
},
|
|
81
|
+
{
|
|
82
|
+
"kind": "field",
|
|
83
|
+
"name": "helperText",
|
|
84
|
+
"privacy": "public",
|
|
85
|
+
"type": {
|
|
86
|
+
"text": "string"
|
|
87
|
+
},
|
|
88
|
+
"description": "String used for the helper text.",
|
|
89
|
+
"attribute": "helper-text",
|
|
90
|
+
"inheritedFrom": {
|
|
91
|
+
"name": "FieldMixin",
|
|
92
|
+
"package": "@vaadin/field-base/src/field-mixin.js"
|
|
93
|
+
}
|
|
94
|
+
},
|
|
95
|
+
{
|
|
96
|
+
"kind": "field",
|
|
97
|
+
"name": "items",
|
|
98
|
+
"privacy": "public",
|
|
99
|
+
"type": {
|
|
100
|
+
"text": "!Array<!SelectItem>"
|
|
101
|
+
},
|
|
102
|
+
"description": "An array containing items that will be rendered as the options of the select.\n\n#### Example\n```js\nselect.items = [\n { label: 'Most recent first', value: 'recent' },\n { component: 'hr' },\n { label: 'Rating: low to high', value: 'rating-asc', className: 'asc' },\n { label: 'Rating: high to low', value: 'rating-desc', className: 'desc' },\n { component: 'hr' },\n { label: 'Price: low to high', value: 'price-asc', disabled: true },\n { label: 'Price: high to low', value: 'price-desc', disabled: true }\n];\n```\n\nNote: each item is rendered by default as the internal `<vaadin-select-item>` that is an extension of `<vaadin-item>`.\nTo render the item with a custom component, provide a tag name by the `component` property.",
|
|
103
|
+
"attribute": "items"
|
|
104
|
+
},
|
|
105
|
+
{
|
|
106
|
+
"kind": "field",
|
|
107
|
+
"name": "label",
|
|
108
|
+
"privacy": "public",
|
|
109
|
+
"type": {
|
|
110
|
+
"text": "string"
|
|
111
|
+
},
|
|
112
|
+
"description": "The label text for the input node.\nWhen no light dom defined via [slot=label], this value will be used.",
|
|
113
|
+
"attribute": "label",
|
|
114
|
+
"inheritedFrom": {
|
|
115
|
+
"name": "LabelMixin",
|
|
116
|
+
"package": "@vaadin/field-base/src/label-mixin.js"
|
|
117
|
+
}
|
|
118
|
+
},
|
|
119
|
+
{
|
|
120
|
+
"kind": "field",
|
|
121
|
+
"name": "name",
|
|
122
|
+
"privacy": "public",
|
|
123
|
+
"type": {
|
|
124
|
+
"text": "string"
|
|
125
|
+
},
|
|
126
|
+
"description": "The name of this element.",
|
|
127
|
+
"attribute": "name"
|
|
128
|
+
},
|
|
129
|
+
{
|
|
130
|
+
"kind": "field",
|
|
131
|
+
"name": "noVerticalOverlap",
|
|
132
|
+
"privacy": "public",
|
|
133
|
+
"type": {
|
|
134
|
+
"text": "boolean"
|
|
135
|
+
},
|
|
136
|
+
"description": "Defines whether the overlay should overlap the target element\nin the y-axis, or be positioned right above/below it.",
|
|
137
|
+
"attribute": "no-vertical-overlap"
|
|
138
|
+
},
|
|
139
|
+
{
|
|
140
|
+
"kind": "field",
|
|
141
|
+
"name": "opened",
|
|
142
|
+
"privacy": "public",
|
|
143
|
+
"type": {
|
|
144
|
+
"text": "boolean"
|
|
145
|
+
},
|
|
146
|
+
"description": "Set when the select is open",
|
|
147
|
+
"attribute": "opened"
|
|
148
|
+
},
|
|
149
|
+
{
|
|
150
|
+
"kind": "field",
|
|
151
|
+
"name": "placeholder",
|
|
152
|
+
"privacy": "public",
|
|
153
|
+
"type": {
|
|
154
|
+
"text": "string"
|
|
155
|
+
},
|
|
156
|
+
"description": "A hint to the user of what can be entered in the control.\nThe placeholder will be displayed in the case that there\nis no item selected, or the selected item has an empty\nstring label, or the selected item has no label and it's\nDOM content is empty.",
|
|
157
|
+
"attribute": "placeholder"
|
|
158
|
+
},
|
|
159
|
+
{
|
|
160
|
+
"kind": "field",
|
|
161
|
+
"name": "readonly",
|
|
162
|
+
"privacy": "public",
|
|
163
|
+
"type": {
|
|
164
|
+
"text": "boolean"
|
|
165
|
+
},
|
|
166
|
+
"description": "When present, it specifies that the element is read-only.",
|
|
167
|
+
"attribute": "readonly"
|
|
168
|
+
},
|
|
169
|
+
{
|
|
170
|
+
"kind": "field",
|
|
171
|
+
"name": "renderer",
|
|
172
|
+
"privacy": "public",
|
|
173
|
+
"type": {
|
|
174
|
+
"text": "!SelectRenderer | undefined"
|
|
175
|
+
},
|
|
176
|
+
"description": "Custom function for rendering the content of the `<vaadin-select>`.\nReceives two arguments:\n\n- `root` The internal container DOM element. Append your content to it.\n- `select` The reference to the `<vaadin-select>` element.",
|
|
177
|
+
"attribute": "renderer"
|
|
178
|
+
},
|
|
179
|
+
{
|
|
180
|
+
"kind": "method",
|
|
181
|
+
"name": "requestContentUpdate",
|
|
182
|
+
"description": "Requests an update for the content of the select.\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."
|
|
183
|
+
},
|
|
184
|
+
{
|
|
185
|
+
"kind": "field",
|
|
186
|
+
"name": "slotName",
|
|
187
|
+
"type": {
|
|
188
|
+
"text": "string"
|
|
189
|
+
},
|
|
190
|
+
"default": "'sr-label'"
|
|
191
|
+
},
|
|
192
|
+
{
|
|
193
|
+
"kind": "field",
|
|
194
|
+
"name": "value",
|
|
195
|
+
"privacy": "public",
|
|
196
|
+
"type": {
|
|
197
|
+
"text": "string"
|
|
198
|
+
},
|
|
199
|
+
"description": "The `value` property of the selected item, or an empty string\nif no item is selected.\nOn change or initialization, the component finds the item which matches the\nvalue and displays it.\nIf no value is provided to the component, it selects the first item without\nvalue or empty value.\nHint: If you do not want to select any item by default, you can either set all\nthe values of inner vaadin-items, or set the vaadin-select value to\nan inexistent value in the items list.",
|
|
200
|
+
"attribute": "value"
|
|
201
|
+
}
|
|
202
|
+
],
|
|
203
|
+
"events": [
|
|
204
|
+
{
|
|
205
|
+
"name": "change",
|
|
206
|
+
"type": {
|
|
207
|
+
"text": "CustomEvent"
|
|
208
|
+
}
|
|
209
|
+
}
|
|
210
|
+
],
|
|
211
|
+
"attributes": [
|
|
212
|
+
{
|
|
213
|
+
"name": "accessible-name",
|
|
214
|
+
"type": {
|
|
215
|
+
"text": "string"
|
|
216
|
+
},
|
|
217
|
+
"description": "String used to label the component to screen reader users.",
|
|
218
|
+
"fieldName": "accessibleName",
|
|
219
|
+
"inheritedFrom": {
|
|
220
|
+
"name": "FieldMixin",
|
|
221
|
+
"package": "@vaadin/field-base/src/field-mixin.js"
|
|
222
|
+
}
|
|
223
|
+
},
|
|
224
|
+
{
|
|
225
|
+
"name": "accessible-name-ref",
|
|
226
|
+
"type": {
|
|
227
|
+
"text": "string"
|
|
228
|
+
},
|
|
229
|
+
"description": "Id of the element used as label of the component to screen reader users.",
|
|
230
|
+
"fieldName": "accessibleNameRef",
|
|
231
|
+
"inheritedFrom": {
|
|
232
|
+
"name": "FieldMixin",
|
|
233
|
+
"package": "@vaadin/field-base/src/field-mixin.js"
|
|
234
|
+
}
|
|
235
|
+
},
|
|
236
|
+
{
|
|
237
|
+
"name": "error-message",
|
|
238
|
+
"type": {
|
|
239
|
+
"text": "string"
|
|
240
|
+
},
|
|
241
|
+
"description": "Error to show when the field is invalid.",
|
|
242
|
+
"fieldName": "errorMessage",
|
|
243
|
+
"inheritedFrom": {
|
|
244
|
+
"name": "FieldMixin",
|
|
245
|
+
"package": "@vaadin/field-base/src/field-mixin.js"
|
|
246
|
+
}
|
|
247
|
+
},
|
|
248
|
+
{
|
|
249
|
+
"name": "helper-text",
|
|
250
|
+
"type": {
|
|
251
|
+
"text": "string"
|
|
252
|
+
},
|
|
253
|
+
"description": "String used for the helper text.",
|
|
254
|
+
"fieldName": "helperText",
|
|
255
|
+
"inheritedFrom": {
|
|
256
|
+
"name": "FieldMixin",
|
|
257
|
+
"package": "@vaadin/field-base/src/field-mixin.js"
|
|
258
|
+
}
|
|
259
|
+
},
|
|
260
|
+
{
|
|
261
|
+
"name": "label",
|
|
262
|
+
"type": {
|
|
263
|
+
"text": "string"
|
|
264
|
+
},
|
|
265
|
+
"description": "The label text for the input node.\nWhen no light dom defined via [slot=label], this value will be used.",
|
|
266
|
+
"fieldName": "label",
|
|
267
|
+
"inheritedFrom": {
|
|
268
|
+
"name": "LabelMixin",
|
|
269
|
+
"package": "@vaadin/field-base/src/label-mixin.js"
|
|
270
|
+
}
|
|
271
|
+
},
|
|
272
|
+
{
|
|
273
|
+
"name": "name",
|
|
274
|
+
"type": {
|
|
275
|
+
"text": "string"
|
|
276
|
+
},
|
|
277
|
+
"description": "The name of this element.",
|
|
278
|
+
"fieldName": "name"
|
|
279
|
+
},
|
|
280
|
+
{
|
|
281
|
+
"name": "no-vertical-overlap",
|
|
282
|
+
"type": {
|
|
283
|
+
"text": "boolean"
|
|
284
|
+
},
|
|
285
|
+
"description": "Defines whether the overlay should overlap the target element\nin the y-axis, or be positioned right above/below it.",
|
|
286
|
+
"fieldName": "noVerticalOverlap"
|
|
287
|
+
},
|
|
288
|
+
{
|
|
289
|
+
"name": "opened",
|
|
290
|
+
"type": {
|
|
291
|
+
"text": "boolean"
|
|
292
|
+
},
|
|
293
|
+
"description": "Set when the select is open",
|
|
294
|
+
"fieldName": "opened"
|
|
295
|
+
},
|
|
296
|
+
{
|
|
297
|
+
"name": "placeholder",
|
|
298
|
+
"type": {
|
|
299
|
+
"text": "string"
|
|
300
|
+
},
|
|
301
|
+
"description": "A hint to the user of what can be entered in the control.\nThe placeholder will be displayed in the case that there\nis no item selected, or the selected item has an empty\nstring label, or the selected item has no label and it's\nDOM content is empty.",
|
|
302
|
+
"fieldName": "placeholder"
|
|
303
|
+
},
|
|
304
|
+
{
|
|
305
|
+
"name": "readonly",
|
|
306
|
+
"type": {
|
|
307
|
+
"text": "boolean"
|
|
308
|
+
},
|
|
309
|
+
"description": "When present, it specifies that the element is read-only.",
|
|
310
|
+
"fieldName": "readonly"
|
|
311
|
+
},
|
|
312
|
+
{
|
|
313
|
+
"name": "renderer",
|
|
314
|
+
"type": {
|
|
315
|
+
"text": "!SelectRenderer | undefined"
|
|
316
|
+
},
|
|
317
|
+
"description": "Custom function for rendering the content of the `<vaadin-select>`.\nReceives two arguments:\n\n- `root` The internal container DOM element. Append your content to it.\n- `select` The reference to the `<vaadin-select>` element.",
|
|
318
|
+
"fieldName": "renderer"
|
|
319
|
+
},
|
|
320
|
+
{
|
|
321
|
+
"name": "value",
|
|
322
|
+
"type": {
|
|
323
|
+
"text": "string"
|
|
324
|
+
},
|
|
325
|
+
"description": "The `value` property of the selected item, or an empty string\nif no item is selected.\nOn change or initialization, the component finds the item which matches the\nvalue and displays it.\nIf no value is provided to the component, it selects the first item without\nvalue or empty value.\nHint: If you do not want to select any item by default, you can either set all\nthe values of inner vaadin-items, or set the vaadin-select value to\nan inexistent value in the items list.",
|
|
326
|
+
"fieldName": "value"
|
|
327
|
+
}
|
|
328
|
+
],
|
|
329
|
+
"mixins": [
|
|
330
|
+
{
|
|
331
|
+
"name": "DelegateFocusMixin",
|
|
332
|
+
"package": "@vaadin/a11y-base/src/delegate-focus-mixin.js"
|
|
333
|
+
},
|
|
334
|
+
{
|
|
335
|
+
"name": "DelegateStateMixin",
|
|
336
|
+
"package": "@vaadin/component-base/src/delegate-state-mixin.js"
|
|
337
|
+
},
|
|
338
|
+
{
|
|
339
|
+
"name": "KeyboardMixin",
|
|
340
|
+
"package": "@vaadin/a11y-base/src/keyboard-mixin.js"
|
|
341
|
+
},
|
|
342
|
+
{
|
|
343
|
+
"name": "FieldMixin",
|
|
344
|
+
"package": "@vaadin/field-base/src/field-mixin.js"
|
|
345
|
+
}
|
|
346
|
+
],
|
|
347
|
+
"parameters": [
|
|
348
|
+
{
|
|
349
|
+
"name": "superClass"
|
|
350
|
+
}
|
|
351
|
+
]
|
|
352
|
+
}
|
|
353
|
+
],
|
|
354
|
+
"exports": [
|
|
355
|
+
{
|
|
356
|
+
"kind": "js",
|
|
357
|
+
"name": "SelectBaseMixin",
|
|
358
|
+
"declaration": {
|
|
359
|
+
"name": "SelectBaseMixin",
|
|
360
|
+
"module": "src/vaadin-select-base-mixin.js"
|
|
361
|
+
}
|
|
362
|
+
}
|
|
363
|
+
]
|
|
364
|
+
},
|
|
365
|
+
{
|
|
366
|
+
"kind": "javascript-module",
|
|
367
|
+
"path": "src/vaadin-select-item.js",
|
|
368
|
+
"declarations": [
|
|
369
|
+
{
|
|
370
|
+
"kind": "class",
|
|
371
|
+
"description": "An element used internally by `<vaadin-select>`. Not intended to be used separately.",
|
|
372
|
+
"name": "SelectItem",
|
|
373
|
+
"members": [
|
|
374
|
+
{
|
|
375
|
+
"kind": "field",
|
|
376
|
+
"name": "selected",
|
|
377
|
+
"privacy": "public",
|
|
378
|
+
"type": {
|
|
379
|
+
"text": "boolean"
|
|
380
|
+
},
|
|
381
|
+
"description": "If true, the item is in selected state.",
|
|
382
|
+
"attribute": "selected",
|
|
383
|
+
"inheritedFrom": {
|
|
384
|
+
"name": "ItemMixin",
|
|
385
|
+
"package": "@vaadin/item/src/vaadin-item-mixin.js"
|
|
386
|
+
}
|
|
387
|
+
},
|
|
388
|
+
{
|
|
389
|
+
"kind": "field",
|
|
390
|
+
"name": "value",
|
|
391
|
+
"return": {
|
|
392
|
+
"type": {
|
|
393
|
+
"text": "string"
|
|
394
|
+
}
|
|
395
|
+
},
|
|
396
|
+
"parameters": [
|
|
397
|
+
{
|
|
398
|
+
"name": "value",
|
|
399
|
+
"type": {
|
|
400
|
+
"text": "string"
|
|
401
|
+
}
|
|
402
|
+
}
|
|
403
|
+
],
|
|
404
|
+
"inheritedFrom": {
|
|
405
|
+
"name": "ItemMixin",
|
|
406
|
+
"package": "@vaadin/item/src/vaadin-item-mixin.js"
|
|
407
|
+
}
|
|
408
|
+
}
|
|
409
|
+
],
|
|
410
|
+
"attributes": [
|
|
411
|
+
{
|
|
412
|
+
"name": "role",
|
|
413
|
+
"type": {
|
|
414
|
+
"text": "string"
|
|
415
|
+
},
|
|
416
|
+
"description": "Use property instead of setting an attribute in `ready()`\nfor cloning the selected item attached to the value button:\nin this case, `role` attribute is removed synchronously, and\nusing `ready()` would incorrectly restore the attribute.",
|
|
417
|
+
"fieldName": "role"
|
|
418
|
+
},
|
|
419
|
+
{
|
|
420
|
+
"name": "selected",
|
|
421
|
+
"type": {
|
|
422
|
+
"text": "boolean"
|
|
423
|
+
},
|
|
424
|
+
"description": "If true, the item is in selected state.",
|
|
425
|
+
"fieldName": "selected",
|
|
426
|
+
"inheritedFrom": {
|
|
427
|
+
"name": "ItemMixin",
|
|
428
|
+
"package": "@vaadin/item/src/vaadin-item-mixin.js"
|
|
429
|
+
}
|
|
430
|
+
}
|
|
431
|
+
],
|
|
432
|
+
"mixins": [
|
|
433
|
+
{
|
|
434
|
+
"name": "ItemMixin",
|
|
435
|
+
"package": "@vaadin/item/src/vaadin-item-mixin.js"
|
|
436
|
+
},
|
|
437
|
+
{
|
|
438
|
+
"name": "ThemableMixin",
|
|
439
|
+
"package": "@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js"
|
|
440
|
+
},
|
|
441
|
+
{
|
|
442
|
+
"name": "DirMixin",
|
|
443
|
+
"package": "@vaadin/component-base/src/dir-mixin.js"
|
|
444
|
+
},
|
|
445
|
+
{
|
|
446
|
+
"name": "PolylitMixin",
|
|
447
|
+
"package": "@vaadin/component-base/src/polylit-mixin.js"
|
|
448
|
+
},
|
|
449
|
+
{
|
|
450
|
+
"name": "LumoInjectionMixin",
|
|
451
|
+
"package": "@vaadin/vaadin-themable-mixin/lumo-injection-mixin.js"
|
|
452
|
+
}
|
|
453
|
+
],
|
|
454
|
+
"superclass": {
|
|
455
|
+
"name": "LitElement",
|
|
456
|
+
"package": "lit"
|
|
457
|
+
},
|
|
458
|
+
"tagName": "vaadin-select-item",
|
|
459
|
+
"customElement": true,
|
|
460
|
+
"events": []
|
|
461
|
+
}
|
|
462
|
+
],
|
|
463
|
+
"exports": [
|
|
464
|
+
{
|
|
465
|
+
"kind": "js",
|
|
466
|
+
"name": "SelectItem",
|
|
467
|
+
"declaration": {
|
|
468
|
+
"name": "SelectItem",
|
|
469
|
+
"module": "src/vaadin-select-item.js"
|
|
470
|
+
}
|
|
471
|
+
}
|
|
472
|
+
]
|
|
473
|
+
},
|
|
474
|
+
{
|
|
475
|
+
"kind": "javascript-module",
|
|
476
|
+
"path": "src/vaadin-select-list-box.js",
|
|
477
|
+
"declarations": [
|
|
478
|
+
{
|
|
479
|
+
"kind": "class",
|
|
480
|
+
"description": "An element used internally by `<vaadin-select>`. Not intended to be used separately.",
|
|
481
|
+
"name": "SelectListBox",
|
|
482
|
+
"members": [
|
|
483
|
+
{
|
|
484
|
+
"kind": "field",
|
|
485
|
+
"name": "disabled",
|
|
486
|
+
"privacy": "public",
|
|
487
|
+
"type": {
|
|
488
|
+
"text": "boolean"
|
|
489
|
+
},
|
|
490
|
+
"description": "If true, the user cannot interact with this element.\nWhen the element is disabled, the selected item is\nnot updated when `selected` property is changed.",
|
|
491
|
+
"attribute": "disabled",
|
|
492
|
+
"inheritedFrom": {
|
|
493
|
+
"name": "ListMixin",
|
|
494
|
+
"package": "@vaadin/a11y-base/src/list-mixin.js"
|
|
495
|
+
}
|
|
496
|
+
},
|
|
497
|
+
{
|
|
498
|
+
"kind": "field",
|
|
499
|
+
"name": "items",
|
|
500
|
+
"privacy": "public",
|
|
501
|
+
"type": {
|
|
502
|
+
"text": "!Array<!Element> | undefined"
|
|
503
|
+
},
|
|
504
|
+
"description": "A read-only list of items from which a selection can be made.\nIt is populated from the elements passed to the light DOM,\nand updated dynamically when adding or removing items.",
|
|
505
|
+
"attribute": "items",
|
|
506
|
+
"inheritedFrom": {
|
|
507
|
+
"name": "ListMixin",
|
|
508
|
+
"package": "@vaadin/a11y-base/src/list-mixin.js"
|
|
509
|
+
}
|
|
510
|
+
},
|
|
511
|
+
{
|
|
512
|
+
"kind": "field",
|
|
513
|
+
"name": "orientation",
|
|
514
|
+
"privacy": "public",
|
|
515
|
+
"type": {
|
|
516
|
+
"text": "!ListOrientation"
|
|
517
|
+
},
|
|
518
|
+
"description": "Define how items are disposed in the dom.\nPossible values are: `horizontal|vertical`.\nIt also changes navigation keys from left/right to up/down.",
|
|
519
|
+
"attribute": "orientation",
|
|
520
|
+
"inheritedFrom": {
|
|
521
|
+
"name": "ListMixin",
|
|
522
|
+
"package": "@vaadin/a11y-base/src/list-mixin.js"
|
|
523
|
+
}
|
|
524
|
+
},
|
|
525
|
+
{
|
|
526
|
+
"kind": "field",
|
|
527
|
+
"name": "selected",
|
|
528
|
+
"privacy": "public",
|
|
529
|
+
"type": {
|
|
530
|
+
"text": "number"
|
|
531
|
+
},
|
|
532
|
+
"description": "The index of the item selected in the items array.\nNote: Not updated when used in `multiple` selection mode.",
|
|
533
|
+
"attribute": "selected",
|
|
534
|
+
"inheritedFrom": {
|
|
535
|
+
"name": "ListMixin",
|
|
536
|
+
"package": "@vaadin/a11y-base/src/list-mixin.js"
|
|
537
|
+
}
|
|
538
|
+
}
|
|
539
|
+
],
|
|
540
|
+
"attributes": [
|
|
541
|
+
{
|
|
542
|
+
"name": "disabled",
|
|
543
|
+
"type": {
|
|
544
|
+
"text": "boolean"
|
|
545
|
+
},
|
|
546
|
+
"description": "If true, the user cannot interact with this element.\nWhen the element is disabled, the selected item is\nnot updated when `selected` property is changed.",
|
|
547
|
+
"fieldName": "disabled",
|
|
548
|
+
"inheritedFrom": {
|
|
549
|
+
"name": "ListMixin",
|
|
550
|
+
"package": "@vaadin/a11y-base/src/list-mixin.js"
|
|
551
|
+
}
|
|
552
|
+
},
|
|
553
|
+
{
|
|
554
|
+
"name": "orientation",
|
|
555
|
+
"type": {
|
|
556
|
+
"text": "!ListOrientation"
|
|
557
|
+
},
|
|
558
|
+
"description": "Define how items are disposed in the dom.\nPossible values are: `horizontal|vertical`.\nIt also changes navigation keys from left/right to up/down.",
|
|
559
|
+
"fieldName": "orientation",
|
|
560
|
+
"inheritedFrom": {
|
|
561
|
+
"name": "ListMixin",
|
|
562
|
+
"package": "@vaadin/a11y-base/src/list-mixin.js"
|
|
563
|
+
}
|
|
564
|
+
},
|
|
565
|
+
{
|
|
566
|
+
"name": "selected",
|
|
567
|
+
"type": {
|
|
568
|
+
"text": "number"
|
|
569
|
+
},
|
|
570
|
+
"description": "The index of the item selected in the items array.\nNote: Not updated when used in `multiple` selection mode.",
|
|
571
|
+
"fieldName": "selected",
|
|
572
|
+
"inheritedFrom": {
|
|
573
|
+
"name": "ListMixin",
|
|
574
|
+
"package": "@vaadin/a11y-base/src/list-mixin.js"
|
|
575
|
+
}
|
|
576
|
+
}
|
|
577
|
+
],
|
|
578
|
+
"mixins": [
|
|
579
|
+
{
|
|
580
|
+
"name": "ListMixin",
|
|
581
|
+
"package": "@vaadin/a11y-base/src/list-mixin.js"
|
|
582
|
+
},
|
|
583
|
+
{
|
|
584
|
+
"name": "ThemableMixin",
|
|
585
|
+
"package": "@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js"
|
|
586
|
+
},
|
|
587
|
+
{
|
|
588
|
+
"name": "DirMixin",
|
|
589
|
+
"package": "@vaadin/component-base/src/dir-mixin.js"
|
|
590
|
+
},
|
|
591
|
+
{
|
|
592
|
+
"name": "PolylitMixin",
|
|
593
|
+
"package": "@vaadin/component-base/src/polylit-mixin.js"
|
|
594
|
+
},
|
|
595
|
+
{
|
|
596
|
+
"name": "LumoInjectionMixin",
|
|
597
|
+
"package": "@vaadin/vaadin-themable-mixin/lumo-injection-mixin.js"
|
|
598
|
+
}
|
|
599
|
+
],
|
|
600
|
+
"superclass": {
|
|
601
|
+
"name": "LitElement",
|
|
602
|
+
"package": "lit"
|
|
603
|
+
},
|
|
604
|
+
"tagName": "vaadin-select-list-box",
|
|
605
|
+
"customElement": true,
|
|
606
|
+
"events": []
|
|
607
|
+
}
|
|
608
|
+
],
|
|
609
|
+
"exports": [
|
|
610
|
+
{
|
|
611
|
+
"kind": "js",
|
|
612
|
+
"name": "SelectListBox",
|
|
613
|
+
"declaration": {
|
|
614
|
+
"name": "SelectListBox",
|
|
615
|
+
"module": "src/vaadin-select-list-box.js"
|
|
616
|
+
}
|
|
617
|
+
}
|
|
618
|
+
]
|
|
619
|
+
},
|
|
620
|
+
{
|
|
621
|
+
"kind": "javascript-module",
|
|
622
|
+
"path": "src/vaadin-select-overlay-mixin.js",
|
|
623
|
+
"declarations": [
|
|
624
|
+
{
|
|
625
|
+
"kind": "mixin",
|
|
626
|
+
"description": "",
|
|
627
|
+
"name": "SelectOverlayMixin",
|
|
628
|
+
"members": [
|
|
629
|
+
{
|
|
630
|
+
"kind": "method",
|
|
631
|
+
"name": "bringToFront",
|
|
632
|
+
"description": "Brings the overlay as visually the frontmost one.",
|
|
633
|
+
"inheritedFrom": {
|
|
634
|
+
"name": "OverlayStackMixin",
|
|
635
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-stack-mixin.js"
|
|
636
|
+
}
|
|
637
|
+
},
|
|
638
|
+
{
|
|
639
|
+
"kind": "method",
|
|
640
|
+
"name": "close",
|
|
641
|
+
"parameters": [
|
|
642
|
+
{
|
|
643
|
+
"name": "sourceEvent",
|
|
644
|
+
"type": {
|
|
645
|
+
"text": "Event="
|
|
646
|
+
}
|
|
647
|
+
}
|
|
648
|
+
],
|
|
649
|
+
"inheritedFrom": {
|
|
650
|
+
"name": "OverlayMixin",
|
|
651
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
652
|
+
}
|
|
653
|
+
},
|
|
654
|
+
{
|
|
655
|
+
"kind": "field",
|
|
656
|
+
"name": "focusTrap",
|
|
657
|
+
"privacy": "public",
|
|
658
|
+
"type": {
|
|
659
|
+
"text": "boolean"
|
|
660
|
+
},
|
|
661
|
+
"description": "When true, opening the overlay moves focus to the first focusable child,\nor to the overlay part with tabindex if there are no focusable children.",
|
|
662
|
+
"attribute": "focus-trap",
|
|
663
|
+
"inheritedFrom": {
|
|
664
|
+
"name": "OverlayFocusMixin",
|
|
665
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-focus-mixin.js"
|
|
666
|
+
}
|
|
667
|
+
},
|
|
668
|
+
{
|
|
669
|
+
"kind": "field",
|
|
670
|
+
"name": "hidden",
|
|
671
|
+
"privacy": "public",
|
|
672
|
+
"type": {
|
|
673
|
+
"text": "boolean"
|
|
674
|
+
},
|
|
675
|
+
"description": "When set to true, the overlay is hidden. This also closes the overlay\nimmediately in case there is a closing animation in progress.",
|
|
676
|
+
"attribute": "hidden",
|
|
677
|
+
"inheritedFrom": {
|
|
678
|
+
"name": "OverlayMixin",
|
|
679
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
680
|
+
}
|
|
681
|
+
},
|
|
682
|
+
{
|
|
683
|
+
"kind": "field",
|
|
684
|
+
"name": "horizontalAlign",
|
|
685
|
+
"privacy": "public",
|
|
686
|
+
"type": {
|
|
687
|
+
"text": "string"
|
|
688
|
+
},
|
|
689
|
+
"description": "When `positionTarget` is set, this property defines whether to align the overlay's\nleft or right side to the target element by default.\nPossible values are `start` and `end`.\nRTL is taken into account when interpreting the value.\nThe overlay is automatically flipped to the opposite side when it doesn't fit into\nthe default side defined by this property.",
|
|
690
|
+
"attribute": "horizontal-align",
|
|
691
|
+
"inheritedFrom": {
|
|
692
|
+
"name": "PositionMixin",
|
|
693
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-position-mixin.js"
|
|
694
|
+
}
|
|
695
|
+
},
|
|
696
|
+
{
|
|
697
|
+
"kind": "field",
|
|
698
|
+
"name": "model",
|
|
699
|
+
"privacy": "public",
|
|
700
|
+
"type": {
|
|
701
|
+
"text": "object"
|
|
702
|
+
},
|
|
703
|
+
"description": "Object with properties that is passed to `renderer` function",
|
|
704
|
+
"attribute": "model",
|
|
705
|
+
"inheritedFrom": {
|
|
706
|
+
"name": "OverlayMixin",
|
|
707
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
708
|
+
}
|
|
709
|
+
},
|
|
710
|
+
{
|
|
711
|
+
"kind": "field",
|
|
712
|
+
"name": "modeless",
|
|
713
|
+
"privacy": "public",
|
|
714
|
+
"type": {
|
|
715
|
+
"text": "boolean"
|
|
716
|
+
},
|
|
717
|
+
"description": "When true the overlay won't disable the main content, showing\nit doesn't change the functionality of the user interface.",
|
|
718
|
+
"attribute": "modeless",
|
|
719
|
+
"inheritedFrom": {
|
|
720
|
+
"name": "OverlayMixin",
|
|
721
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
722
|
+
}
|
|
723
|
+
},
|
|
724
|
+
{
|
|
725
|
+
"kind": "field",
|
|
726
|
+
"name": "noHorizontalOverlap",
|
|
727
|
+
"privacy": "public",
|
|
728
|
+
"type": {
|
|
729
|
+
"text": "boolean"
|
|
730
|
+
},
|
|
731
|
+
"description": "When `positionTarget` is set, this property defines whether the overlay should overlap\nthe target element in the x-axis, or be positioned right next to it.",
|
|
732
|
+
"attribute": "no-horizontal-overlap",
|
|
733
|
+
"inheritedFrom": {
|
|
734
|
+
"name": "PositionMixin",
|
|
735
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-position-mixin.js"
|
|
736
|
+
}
|
|
737
|
+
},
|
|
738
|
+
{
|
|
739
|
+
"kind": "field",
|
|
740
|
+
"name": "noVerticalOverlap",
|
|
741
|
+
"privacy": "public",
|
|
742
|
+
"type": {
|
|
743
|
+
"text": "boolean"
|
|
744
|
+
},
|
|
745
|
+
"description": "When `positionTarget` is set, this property defines whether the overlay should overlap\nthe target element in the y-axis, or be positioned right above/below it.",
|
|
746
|
+
"attribute": "no-vertical-overlap",
|
|
747
|
+
"inheritedFrom": {
|
|
748
|
+
"name": "PositionMixin",
|
|
749
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-position-mixin.js"
|
|
750
|
+
}
|
|
751
|
+
},
|
|
752
|
+
{
|
|
753
|
+
"kind": "field",
|
|
754
|
+
"name": "opened",
|
|
755
|
+
"privacy": "public",
|
|
756
|
+
"type": {
|
|
757
|
+
"text": "boolean"
|
|
758
|
+
},
|
|
759
|
+
"description": "When true, the overlay is visible and attached to body.",
|
|
760
|
+
"attribute": "opened",
|
|
761
|
+
"inheritedFrom": {
|
|
762
|
+
"name": "OverlayMixin",
|
|
763
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
764
|
+
}
|
|
765
|
+
},
|
|
766
|
+
{
|
|
767
|
+
"kind": "field",
|
|
768
|
+
"name": "owner",
|
|
769
|
+
"privacy": "public",
|
|
770
|
+
"type": {
|
|
771
|
+
"text": "HTMLElement"
|
|
772
|
+
},
|
|
773
|
+
"description": "Owner element passed with renderer function",
|
|
774
|
+
"attribute": "owner",
|
|
775
|
+
"inheritedFrom": {
|
|
776
|
+
"name": "OverlayMixin",
|
|
777
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
778
|
+
}
|
|
779
|
+
},
|
|
780
|
+
{
|
|
781
|
+
"kind": "field",
|
|
782
|
+
"name": "positionTarget",
|
|
783
|
+
"privacy": "public",
|
|
784
|
+
"type": {
|
|
785
|
+
"text": "object"
|
|
786
|
+
},
|
|
787
|
+
"description": "The element next to which this overlay should be aligned.\nThe position of the overlay relative to the positionTarget can be adjusted\nwith properties `horizontalAlign`, `verticalAlign`, `noHorizontalOverlap`\nand `noVerticalOverlap`.",
|
|
788
|
+
"attribute": "position-target",
|
|
789
|
+
"inheritedFrom": {
|
|
790
|
+
"name": "PositionMixin",
|
|
791
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-position-mixin.js"
|
|
792
|
+
}
|
|
793
|
+
},
|
|
794
|
+
{
|
|
795
|
+
"kind": "field",
|
|
796
|
+
"name": "renderer",
|
|
797
|
+
"privacy": "public",
|
|
798
|
+
"type": {
|
|
799
|
+
"text": "OverlayRenderer | null | undefined"
|
|
800
|
+
},
|
|
801
|
+
"description": "Custom function for rendering the content of the overlay.\nReceives three arguments:\n\n- `root` The root container DOM element. Append your content to it.\n- `owner` The host element of the renderer function.\n- `model` The object with the properties related with rendering.",
|
|
802
|
+
"attribute": "renderer",
|
|
803
|
+
"inheritedFrom": {
|
|
804
|
+
"name": "OverlayMixin",
|
|
805
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
806
|
+
}
|
|
807
|
+
},
|
|
808
|
+
{
|
|
809
|
+
"kind": "method",
|
|
810
|
+
"name": "requestContentUpdate",
|
|
811
|
+
"description": "Requests an update for the content of the overlay.\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.",
|
|
812
|
+
"inheritedFrom": {
|
|
813
|
+
"name": "OverlayMixin",
|
|
814
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
815
|
+
}
|
|
816
|
+
},
|
|
817
|
+
{
|
|
818
|
+
"kind": "field",
|
|
819
|
+
"name": "requiredVerticalSpace",
|
|
820
|
+
"privacy": "public",
|
|
821
|
+
"type": {
|
|
822
|
+
"text": "number"
|
|
823
|
+
},
|
|
824
|
+
"description": "If the overlay content has no intrinsic height, this property can be used to set\nthe minimum vertical space (in pixels) required by the overlay. Setting a value to\nthe property effectively disables the content measurement in favor of using this\nfixed value for determining the open direction.",
|
|
825
|
+
"attribute": "required-vertical-space",
|
|
826
|
+
"inheritedFrom": {
|
|
827
|
+
"name": "PositionMixin",
|
|
828
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-position-mixin.js"
|
|
829
|
+
}
|
|
830
|
+
},
|
|
831
|
+
{
|
|
832
|
+
"kind": "field",
|
|
833
|
+
"name": "restoreFocusNode",
|
|
834
|
+
"privacy": "public",
|
|
835
|
+
"type": {
|
|
836
|
+
"text": "HTMLElement"
|
|
837
|
+
},
|
|
838
|
+
"description": "Set to specify the element which should be focused on overlay close,\nif `restoreFocusOnClose` is set to true.",
|
|
839
|
+
"attribute": "restore-focus-node",
|
|
840
|
+
"inheritedFrom": {
|
|
841
|
+
"name": "OverlayFocusMixin",
|
|
842
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-focus-mixin.js"
|
|
843
|
+
}
|
|
844
|
+
},
|
|
845
|
+
{
|
|
846
|
+
"kind": "field",
|
|
847
|
+
"name": "restoreFocusOnClose",
|
|
848
|
+
"privacy": "public",
|
|
849
|
+
"type": {
|
|
850
|
+
"text": "boolean"
|
|
851
|
+
},
|
|
852
|
+
"description": "Set to true to enable restoring of focus when overlay is closed.",
|
|
853
|
+
"attribute": "restore-focus-on-close",
|
|
854
|
+
"inheritedFrom": {
|
|
855
|
+
"name": "OverlayFocusMixin",
|
|
856
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-focus-mixin.js"
|
|
857
|
+
}
|
|
858
|
+
},
|
|
859
|
+
{
|
|
860
|
+
"kind": "method",
|
|
861
|
+
"name": "setBounds",
|
|
862
|
+
"parameters": [
|
|
863
|
+
{
|
|
864
|
+
"name": "bounds",
|
|
865
|
+
"type": {
|
|
866
|
+
"text": "!OverlayBoundsParam"
|
|
867
|
+
}
|
|
868
|
+
},
|
|
869
|
+
{
|
|
870
|
+
"name": "absolute",
|
|
871
|
+
"default": "true",
|
|
872
|
+
"type": {
|
|
873
|
+
"text": "boolean"
|
|
874
|
+
}
|
|
875
|
+
}
|
|
876
|
+
],
|
|
877
|
+
"description": "Updates the coordinates of the overlay.",
|
|
878
|
+
"inheritedFrom": {
|
|
879
|
+
"name": "OverlayMixin",
|
|
880
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
881
|
+
}
|
|
882
|
+
},
|
|
883
|
+
{
|
|
884
|
+
"kind": "field",
|
|
885
|
+
"name": "verticalAlign",
|
|
886
|
+
"privacy": "public",
|
|
887
|
+
"type": {
|
|
888
|
+
"text": "string"
|
|
889
|
+
},
|
|
890
|
+
"description": "When `positionTarget` is set, this property defines whether to align the overlay's\ntop or bottom side to the target element by default.\nPossible values are `top` and `bottom`.\nThe overlay is automatically flipped to the opposite side when it doesn't fit into\nthe default side defined by this property.",
|
|
891
|
+
"attribute": "vertical-align",
|
|
892
|
+
"inheritedFrom": {
|
|
893
|
+
"name": "PositionMixin",
|
|
894
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-position-mixin.js"
|
|
895
|
+
}
|
|
896
|
+
},
|
|
897
|
+
{
|
|
898
|
+
"kind": "field",
|
|
899
|
+
"name": "withBackdrop",
|
|
900
|
+
"privacy": "public",
|
|
901
|
+
"type": {
|
|
902
|
+
"text": "boolean"
|
|
903
|
+
},
|
|
904
|
+
"description": "When true the overlay has backdrop on top of content when opened.",
|
|
905
|
+
"attribute": "with-backdrop",
|
|
906
|
+
"inheritedFrom": {
|
|
907
|
+
"name": "OverlayMixin",
|
|
908
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
909
|
+
}
|
|
910
|
+
}
|
|
911
|
+
],
|
|
912
|
+
"mixins": [
|
|
913
|
+
{
|
|
914
|
+
"name": "PositionMixin",
|
|
915
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-position-mixin.js"
|
|
916
|
+
},
|
|
917
|
+
{
|
|
918
|
+
"name": "OverlayMixin",
|
|
919
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
920
|
+
},
|
|
921
|
+
{
|
|
922
|
+
"name": "DirMixin",
|
|
923
|
+
"package": "@vaadin/component-base/src/dir-mixin.js"
|
|
924
|
+
}
|
|
925
|
+
],
|
|
926
|
+
"parameters": [
|
|
927
|
+
{
|
|
928
|
+
"name": "superClass"
|
|
929
|
+
}
|
|
930
|
+
],
|
|
931
|
+
"attributes": [
|
|
932
|
+
{
|
|
933
|
+
"name": "focus-trap",
|
|
934
|
+
"type": {
|
|
935
|
+
"text": "boolean"
|
|
936
|
+
},
|
|
937
|
+
"description": "When true, opening the overlay moves focus to the first focusable child,\nor to the overlay part with tabindex if there are no focusable children.",
|
|
938
|
+
"fieldName": "focusTrap",
|
|
939
|
+
"inheritedFrom": {
|
|
940
|
+
"name": "OverlayFocusMixin",
|
|
941
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-focus-mixin.js"
|
|
942
|
+
}
|
|
943
|
+
},
|
|
944
|
+
{
|
|
945
|
+
"name": "hidden",
|
|
946
|
+
"type": {
|
|
947
|
+
"text": "boolean"
|
|
948
|
+
},
|
|
949
|
+
"description": "When set to true, the overlay is hidden. This also closes the overlay\nimmediately in case there is a closing animation in progress.",
|
|
950
|
+
"fieldName": "hidden",
|
|
951
|
+
"inheritedFrom": {
|
|
952
|
+
"name": "OverlayMixin",
|
|
953
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
954
|
+
}
|
|
955
|
+
},
|
|
956
|
+
{
|
|
957
|
+
"name": "horizontal-align",
|
|
958
|
+
"type": {
|
|
959
|
+
"text": "string"
|
|
960
|
+
},
|
|
961
|
+
"description": "When `positionTarget` is set, this property defines whether to align the overlay's\nleft or right side to the target element by default.\nPossible values are `start` and `end`.\nRTL is taken into account when interpreting the value.\nThe overlay is automatically flipped to the opposite side when it doesn't fit into\nthe default side defined by this property.",
|
|
962
|
+
"fieldName": "horizontalAlign",
|
|
963
|
+
"inheritedFrom": {
|
|
964
|
+
"name": "PositionMixin",
|
|
965
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-position-mixin.js"
|
|
966
|
+
}
|
|
967
|
+
},
|
|
968
|
+
{
|
|
969
|
+
"name": "modeless",
|
|
970
|
+
"type": {
|
|
971
|
+
"text": "boolean"
|
|
972
|
+
},
|
|
973
|
+
"description": "When true the overlay won't disable the main content, showing\nit doesn't change the functionality of the user interface.",
|
|
974
|
+
"fieldName": "modeless",
|
|
975
|
+
"inheritedFrom": {
|
|
976
|
+
"name": "OverlayMixin",
|
|
977
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
978
|
+
}
|
|
979
|
+
},
|
|
980
|
+
{
|
|
981
|
+
"name": "no-horizontal-overlap",
|
|
982
|
+
"type": {
|
|
983
|
+
"text": "boolean"
|
|
984
|
+
},
|
|
985
|
+
"description": "When `positionTarget` is set, this property defines whether the overlay should overlap\nthe target element in the x-axis, or be positioned right next to it.",
|
|
986
|
+
"fieldName": "noHorizontalOverlap",
|
|
987
|
+
"inheritedFrom": {
|
|
988
|
+
"name": "PositionMixin",
|
|
989
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-position-mixin.js"
|
|
990
|
+
}
|
|
991
|
+
},
|
|
992
|
+
{
|
|
993
|
+
"name": "no-vertical-overlap",
|
|
994
|
+
"type": {
|
|
995
|
+
"text": "boolean"
|
|
996
|
+
},
|
|
997
|
+
"description": "When `positionTarget` is set, this property defines whether the overlay should overlap\nthe target element in the y-axis, or be positioned right above/below it.",
|
|
998
|
+
"fieldName": "noVerticalOverlap",
|
|
999
|
+
"inheritedFrom": {
|
|
1000
|
+
"name": "PositionMixin",
|
|
1001
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-position-mixin.js"
|
|
1002
|
+
}
|
|
1003
|
+
},
|
|
1004
|
+
{
|
|
1005
|
+
"name": "opened",
|
|
1006
|
+
"type": {
|
|
1007
|
+
"text": "boolean"
|
|
1008
|
+
},
|
|
1009
|
+
"description": "When true, the overlay is visible and attached to body.",
|
|
1010
|
+
"fieldName": "opened",
|
|
1011
|
+
"inheritedFrom": {
|
|
1012
|
+
"name": "OverlayMixin",
|
|
1013
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
1014
|
+
}
|
|
1015
|
+
},
|
|
1016
|
+
{
|
|
1017
|
+
"name": "owner",
|
|
1018
|
+
"type": {
|
|
1019
|
+
"text": "HTMLElement"
|
|
1020
|
+
},
|
|
1021
|
+
"description": "Owner element passed with renderer function",
|
|
1022
|
+
"fieldName": "owner",
|
|
1023
|
+
"inheritedFrom": {
|
|
1024
|
+
"name": "OverlayMixin",
|
|
1025
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
1026
|
+
}
|
|
1027
|
+
},
|
|
1028
|
+
{
|
|
1029
|
+
"name": "renderer",
|
|
1030
|
+
"type": {
|
|
1031
|
+
"text": "OverlayRenderer | null | undefined"
|
|
1032
|
+
},
|
|
1033
|
+
"description": "Custom function for rendering the content of the overlay.\nReceives three arguments:\n\n- `root` The root container DOM element. Append your content to it.\n- `owner` The host element of the renderer function.\n- `model` The object with the properties related with rendering.",
|
|
1034
|
+
"fieldName": "renderer",
|
|
1035
|
+
"inheritedFrom": {
|
|
1036
|
+
"name": "OverlayMixin",
|
|
1037
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
1038
|
+
}
|
|
1039
|
+
},
|
|
1040
|
+
{
|
|
1041
|
+
"name": "required-vertical-space",
|
|
1042
|
+
"type": {
|
|
1043
|
+
"text": "number"
|
|
1044
|
+
},
|
|
1045
|
+
"description": "If the overlay content has no intrinsic height, this property can be used to set\nthe minimum vertical space (in pixels) required by the overlay. Setting a value to\nthe property effectively disables the content measurement in favor of using this\nfixed value for determining the open direction.",
|
|
1046
|
+
"fieldName": "requiredVerticalSpace",
|
|
1047
|
+
"inheritedFrom": {
|
|
1048
|
+
"name": "PositionMixin",
|
|
1049
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-position-mixin.js"
|
|
1050
|
+
}
|
|
1051
|
+
},
|
|
1052
|
+
{
|
|
1053
|
+
"name": "restore-focus-node",
|
|
1054
|
+
"type": {
|
|
1055
|
+
"text": "HTMLElement"
|
|
1056
|
+
},
|
|
1057
|
+
"description": "Set to specify the element which should be focused on overlay close,\nif `restoreFocusOnClose` is set to true.",
|
|
1058
|
+
"fieldName": "restoreFocusNode",
|
|
1059
|
+
"inheritedFrom": {
|
|
1060
|
+
"name": "OverlayFocusMixin",
|
|
1061
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-focus-mixin.js"
|
|
1062
|
+
}
|
|
1063
|
+
},
|
|
1064
|
+
{
|
|
1065
|
+
"name": "restore-focus-on-close",
|
|
1066
|
+
"type": {
|
|
1067
|
+
"text": "boolean"
|
|
1068
|
+
},
|
|
1069
|
+
"description": "Set to true to enable restoring of focus when overlay is closed.",
|
|
1070
|
+
"fieldName": "restoreFocusOnClose",
|
|
1071
|
+
"inheritedFrom": {
|
|
1072
|
+
"name": "OverlayFocusMixin",
|
|
1073
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-focus-mixin.js"
|
|
1074
|
+
}
|
|
1075
|
+
},
|
|
1076
|
+
{
|
|
1077
|
+
"name": "vertical-align",
|
|
1078
|
+
"type": {
|
|
1079
|
+
"text": "string"
|
|
1080
|
+
},
|
|
1081
|
+
"description": "When `positionTarget` is set, this property defines whether to align the overlay's\ntop or bottom side to the target element by default.\nPossible values are `top` and `bottom`.\nThe overlay is automatically flipped to the opposite side when it doesn't fit into\nthe default side defined by this property.",
|
|
1082
|
+
"fieldName": "verticalAlign",
|
|
1083
|
+
"inheritedFrom": {
|
|
1084
|
+
"name": "PositionMixin",
|
|
1085
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-position-mixin.js"
|
|
1086
|
+
}
|
|
1087
|
+
},
|
|
1088
|
+
{
|
|
1089
|
+
"name": "with-backdrop",
|
|
1090
|
+
"type": {
|
|
1091
|
+
"text": "boolean"
|
|
1092
|
+
},
|
|
1093
|
+
"description": "When true the overlay has backdrop on top of content when opened.",
|
|
1094
|
+
"fieldName": "withBackdrop",
|
|
1095
|
+
"inheritedFrom": {
|
|
1096
|
+
"name": "OverlayMixin",
|
|
1097
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
1098
|
+
}
|
|
1099
|
+
}
|
|
1100
|
+
],
|
|
1101
|
+
"events": [
|
|
1102
|
+
{
|
|
1103
|
+
"name": "vaadin-overlay-closed",
|
|
1104
|
+
"type": {
|
|
1105
|
+
"text": "CustomEvent"
|
|
1106
|
+
},
|
|
1107
|
+
"inheritedFrom": {
|
|
1108
|
+
"name": "OverlayMixin",
|
|
1109
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
1110
|
+
}
|
|
1111
|
+
},
|
|
1112
|
+
{
|
|
1113
|
+
"name": "vaadin-overlay-closing",
|
|
1114
|
+
"type": {
|
|
1115
|
+
"text": "CustomEvent"
|
|
1116
|
+
},
|
|
1117
|
+
"inheritedFrom": {
|
|
1118
|
+
"name": "OverlayMixin",
|
|
1119
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
1120
|
+
}
|
|
1121
|
+
}
|
|
1122
|
+
]
|
|
1123
|
+
}
|
|
1124
|
+
],
|
|
1125
|
+
"exports": [
|
|
1126
|
+
{
|
|
1127
|
+
"kind": "js",
|
|
1128
|
+
"name": "SelectOverlayMixin",
|
|
1129
|
+
"declaration": {
|
|
1130
|
+
"name": "SelectOverlayMixin",
|
|
1131
|
+
"module": "src/vaadin-select-overlay-mixin.js"
|
|
1132
|
+
}
|
|
1133
|
+
}
|
|
1134
|
+
]
|
|
1135
|
+
},
|
|
1136
|
+
{
|
|
1137
|
+
"kind": "javascript-module",
|
|
1138
|
+
"path": "src/vaadin-select-overlay.js",
|
|
1139
|
+
"declarations": [
|
|
1140
|
+
{
|
|
1141
|
+
"kind": "class",
|
|
1142
|
+
"description": "An element used internally by `<vaadin-select>`. Not intended to be used separately.",
|
|
1143
|
+
"name": "SelectOverlay",
|
|
1144
|
+
"members": [
|
|
1145
|
+
{
|
|
1146
|
+
"kind": "method",
|
|
1147
|
+
"name": "close",
|
|
1148
|
+
"parameters": [
|
|
1149
|
+
{
|
|
1150
|
+
"name": "sourceEvent",
|
|
1151
|
+
"type": {
|
|
1152
|
+
"text": "Event="
|
|
1153
|
+
}
|
|
1154
|
+
}
|
|
1155
|
+
],
|
|
1156
|
+
"inheritedFrom": {
|
|
1157
|
+
"name": "OverlayMixin",
|
|
1158
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
1159
|
+
}
|
|
1160
|
+
},
|
|
1161
|
+
{
|
|
1162
|
+
"kind": "field",
|
|
1163
|
+
"name": "hidden",
|
|
1164
|
+
"privacy": "public",
|
|
1165
|
+
"type": {
|
|
1166
|
+
"text": "boolean"
|
|
1167
|
+
},
|
|
1168
|
+
"description": "When set to true, the overlay is hidden. This also closes the overlay\nimmediately in case there is a closing animation in progress.",
|
|
1169
|
+
"attribute": "hidden",
|
|
1170
|
+
"inheritedFrom": {
|
|
1171
|
+
"name": "OverlayMixin",
|
|
1172
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
1173
|
+
}
|
|
1174
|
+
},
|
|
1175
|
+
{
|
|
1176
|
+
"kind": "field",
|
|
1177
|
+
"name": "horizontalAlign",
|
|
1178
|
+
"privacy": "public",
|
|
1179
|
+
"type": {
|
|
1180
|
+
"text": "string"
|
|
1181
|
+
},
|
|
1182
|
+
"description": "When `positionTarget` is set, this property defines whether to align the overlay's\nleft or right side to the target element by default.\nPossible values are `start` and `end`.\nRTL is taken into account when interpreting the value.\nThe overlay is automatically flipped to the opposite side when it doesn't fit into\nthe default side defined by this property.",
|
|
1183
|
+
"attribute": "horizontal-align",
|
|
1184
|
+
"inheritedFrom": {
|
|
1185
|
+
"name": "PositionMixin",
|
|
1186
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-position-mixin.js"
|
|
1187
|
+
}
|
|
1188
|
+
},
|
|
1189
|
+
{
|
|
1190
|
+
"kind": "field",
|
|
1191
|
+
"name": "model",
|
|
1192
|
+
"privacy": "public",
|
|
1193
|
+
"type": {
|
|
1194
|
+
"text": "object"
|
|
1195
|
+
},
|
|
1196
|
+
"description": "Object with properties that is passed to `renderer` function",
|
|
1197
|
+
"attribute": "model",
|
|
1198
|
+
"inheritedFrom": {
|
|
1199
|
+
"name": "OverlayMixin",
|
|
1200
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
1201
|
+
}
|
|
1202
|
+
},
|
|
1203
|
+
{
|
|
1204
|
+
"kind": "field",
|
|
1205
|
+
"name": "modeless",
|
|
1206
|
+
"privacy": "public",
|
|
1207
|
+
"type": {
|
|
1208
|
+
"text": "boolean"
|
|
1209
|
+
},
|
|
1210
|
+
"description": "When true the overlay won't disable the main content, showing\nit doesn't change the functionality of the user interface.",
|
|
1211
|
+
"attribute": "modeless",
|
|
1212
|
+
"inheritedFrom": {
|
|
1213
|
+
"name": "OverlayMixin",
|
|
1214
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
1215
|
+
}
|
|
1216
|
+
},
|
|
1217
|
+
{
|
|
1218
|
+
"kind": "field",
|
|
1219
|
+
"name": "noHorizontalOverlap",
|
|
1220
|
+
"privacy": "public",
|
|
1221
|
+
"type": {
|
|
1222
|
+
"text": "boolean"
|
|
1223
|
+
},
|
|
1224
|
+
"description": "When `positionTarget` is set, this property defines whether the overlay should overlap\nthe target element in the x-axis, or be positioned right next to it.",
|
|
1225
|
+
"attribute": "no-horizontal-overlap",
|
|
1226
|
+
"inheritedFrom": {
|
|
1227
|
+
"name": "PositionMixin",
|
|
1228
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-position-mixin.js"
|
|
1229
|
+
}
|
|
1230
|
+
},
|
|
1231
|
+
{
|
|
1232
|
+
"kind": "field",
|
|
1233
|
+
"name": "noVerticalOverlap",
|
|
1234
|
+
"privacy": "public",
|
|
1235
|
+
"type": {
|
|
1236
|
+
"text": "boolean"
|
|
1237
|
+
},
|
|
1238
|
+
"description": "When `positionTarget` is set, this property defines whether the overlay should overlap\nthe target element in the y-axis, or be positioned right above/below it.",
|
|
1239
|
+
"attribute": "no-vertical-overlap",
|
|
1240
|
+
"inheritedFrom": {
|
|
1241
|
+
"name": "PositionMixin",
|
|
1242
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-position-mixin.js"
|
|
1243
|
+
}
|
|
1244
|
+
},
|
|
1245
|
+
{
|
|
1246
|
+
"kind": "field",
|
|
1247
|
+
"name": "opened",
|
|
1248
|
+
"privacy": "public",
|
|
1249
|
+
"type": {
|
|
1250
|
+
"text": "boolean"
|
|
1251
|
+
},
|
|
1252
|
+
"description": "When true, the overlay is visible and attached to body.",
|
|
1253
|
+
"attribute": "opened",
|
|
1254
|
+
"inheritedFrom": {
|
|
1255
|
+
"name": "OverlayMixin",
|
|
1256
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
1257
|
+
}
|
|
1258
|
+
},
|
|
1259
|
+
{
|
|
1260
|
+
"kind": "field",
|
|
1261
|
+
"name": "owner",
|
|
1262
|
+
"privacy": "public",
|
|
1263
|
+
"type": {
|
|
1264
|
+
"text": "HTMLElement"
|
|
1265
|
+
},
|
|
1266
|
+
"description": "Owner element passed with renderer function",
|
|
1267
|
+
"attribute": "owner",
|
|
1268
|
+
"inheritedFrom": {
|
|
1269
|
+
"name": "OverlayMixin",
|
|
1270
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
1271
|
+
}
|
|
1272
|
+
},
|
|
1273
|
+
{
|
|
1274
|
+
"kind": "field",
|
|
1275
|
+
"name": "positionTarget",
|
|
1276
|
+
"privacy": "public",
|
|
1277
|
+
"type": {
|
|
1278
|
+
"text": "object"
|
|
1279
|
+
},
|
|
1280
|
+
"description": "The element next to which this overlay should be aligned.\nThe position of the overlay relative to the positionTarget can be adjusted\nwith properties `horizontalAlign`, `verticalAlign`, `noHorizontalOverlap`\nand `noVerticalOverlap`.",
|
|
1281
|
+
"attribute": "position-target",
|
|
1282
|
+
"inheritedFrom": {
|
|
1283
|
+
"name": "PositionMixin",
|
|
1284
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-position-mixin.js"
|
|
1285
|
+
}
|
|
1286
|
+
},
|
|
1287
|
+
{
|
|
1288
|
+
"kind": "field",
|
|
1289
|
+
"name": "renderer",
|
|
1290
|
+
"privacy": "public",
|
|
1291
|
+
"type": {
|
|
1292
|
+
"text": "OverlayRenderer | null | undefined"
|
|
1293
|
+
},
|
|
1294
|
+
"description": "Custom function for rendering the content of the overlay.\nReceives three arguments:\n\n- `root` The root container DOM element. Append your content to it.\n- `owner` The host element of the renderer function.\n- `model` The object with the properties related with rendering.",
|
|
1295
|
+
"attribute": "renderer",
|
|
1296
|
+
"inheritedFrom": {
|
|
1297
|
+
"name": "OverlayMixin",
|
|
1298
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
1299
|
+
}
|
|
1300
|
+
},
|
|
1301
|
+
{
|
|
1302
|
+
"kind": "method",
|
|
1303
|
+
"name": "requestContentUpdate",
|
|
1304
|
+
"description": "Requests an update for the content of the overlay.\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.",
|
|
1305
|
+
"inheritedFrom": {
|
|
1306
|
+
"name": "OverlayMixin",
|
|
1307
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
1308
|
+
}
|
|
1309
|
+
},
|
|
1310
|
+
{
|
|
1311
|
+
"kind": "field",
|
|
1312
|
+
"name": "requiredVerticalSpace",
|
|
1313
|
+
"privacy": "public",
|
|
1314
|
+
"type": {
|
|
1315
|
+
"text": "number"
|
|
1316
|
+
},
|
|
1317
|
+
"description": "If the overlay content has no intrinsic height, this property can be used to set\nthe minimum vertical space (in pixels) required by the overlay. Setting a value to\nthe property effectively disables the content measurement in favor of using this\nfixed value for determining the open direction.",
|
|
1318
|
+
"attribute": "required-vertical-space",
|
|
1319
|
+
"inheritedFrom": {
|
|
1320
|
+
"name": "PositionMixin",
|
|
1321
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-position-mixin.js"
|
|
1322
|
+
}
|
|
1323
|
+
},
|
|
1324
|
+
{
|
|
1325
|
+
"kind": "method",
|
|
1326
|
+
"name": "setBounds",
|
|
1327
|
+
"parameters": [
|
|
1328
|
+
{
|
|
1329
|
+
"name": "bounds",
|
|
1330
|
+
"type": {
|
|
1331
|
+
"text": "!OverlayBoundsParam"
|
|
1332
|
+
}
|
|
1333
|
+
},
|
|
1334
|
+
{
|
|
1335
|
+
"name": "absolute",
|
|
1336
|
+
"default": "true",
|
|
1337
|
+
"type": {
|
|
1338
|
+
"text": "boolean"
|
|
1339
|
+
}
|
|
1340
|
+
}
|
|
1341
|
+
],
|
|
1342
|
+
"description": "Updates the coordinates of the overlay.",
|
|
1343
|
+
"inheritedFrom": {
|
|
1344
|
+
"name": "OverlayMixin",
|
|
1345
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
1346
|
+
}
|
|
1347
|
+
},
|
|
1348
|
+
{
|
|
1349
|
+
"kind": "field",
|
|
1350
|
+
"name": "verticalAlign",
|
|
1351
|
+
"privacy": "public",
|
|
1352
|
+
"type": {
|
|
1353
|
+
"text": "string"
|
|
1354
|
+
},
|
|
1355
|
+
"description": "When `positionTarget` is set, this property defines whether to align the overlay's\ntop or bottom side to the target element by default.\nPossible values are `top` and `bottom`.\nThe overlay is automatically flipped to the opposite side when it doesn't fit into\nthe default side defined by this property.",
|
|
1356
|
+
"attribute": "vertical-align",
|
|
1357
|
+
"inheritedFrom": {
|
|
1358
|
+
"name": "PositionMixin",
|
|
1359
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-position-mixin.js"
|
|
1360
|
+
}
|
|
1361
|
+
},
|
|
1362
|
+
{
|
|
1363
|
+
"kind": "field",
|
|
1364
|
+
"name": "withBackdrop",
|
|
1365
|
+
"privacy": "public",
|
|
1366
|
+
"type": {
|
|
1367
|
+
"text": "boolean"
|
|
1368
|
+
},
|
|
1369
|
+
"description": "When true the overlay has backdrop on top of content when opened.",
|
|
1370
|
+
"attribute": "with-backdrop",
|
|
1371
|
+
"inheritedFrom": {
|
|
1372
|
+
"name": "OverlayMixin",
|
|
1373
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
1374
|
+
}
|
|
1375
|
+
}
|
|
1376
|
+
],
|
|
1377
|
+
"mixins": [
|
|
1378
|
+
{
|
|
1379
|
+
"name": "SelectOverlayMixin",
|
|
1380
|
+
"module": "src/vaadin-select-overlay-mixin.js"
|
|
1381
|
+
},
|
|
1382
|
+
{
|
|
1383
|
+
"name": "ThemableMixin",
|
|
1384
|
+
"package": "@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js"
|
|
1385
|
+
},
|
|
1386
|
+
{
|
|
1387
|
+
"name": "PolylitMixin",
|
|
1388
|
+
"package": "@vaadin/component-base/src/polylit-mixin.js"
|
|
1389
|
+
},
|
|
1390
|
+
{
|
|
1391
|
+
"name": "LumoInjectionMixin",
|
|
1392
|
+
"package": "@vaadin/vaadin-themable-mixin/lumo-injection-mixin.js"
|
|
1393
|
+
}
|
|
1394
|
+
],
|
|
1395
|
+
"superclass": {
|
|
1396
|
+
"name": "LitElement",
|
|
1397
|
+
"package": "lit"
|
|
1398
|
+
},
|
|
1399
|
+
"tagName": "vaadin-select-overlay",
|
|
1400
|
+
"customElement": true,
|
|
1401
|
+
"attributes": [
|
|
1402
|
+
{
|
|
1403
|
+
"name": "hidden",
|
|
1404
|
+
"type": {
|
|
1405
|
+
"text": "boolean"
|
|
1406
|
+
},
|
|
1407
|
+
"description": "When set to true, the overlay is hidden. This also closes the overlay\nimmediately in case there is a closing animation in progress.",
|
|
1408
|
+
"fieldName": "hidden",
|
|
1409
|
+
"inheritedFrom": {
|
|
1410
|
+
"name": "OverlayMixin",
|
|
1411
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
1412
|
+
}
|
|
1413
|
+
},
|
|
1414
|
+
{
|
|
1415
|
+
"name": "horizontal-align",
|
|
1416
|
+
"type": {
|
|
1417
|
+
"text": "string"
|
|
1418
|
+
},
|
|
1419
|
+
"description": "When `positionTarget` is set, this property defines whether to align the overlay's\nleft or right side to the target element by default.\nPossible values are `start` and `end`.\nRTL is taken into account when interpreting the value.\nThe overlay is automatically flipped to the opposite side when it doesn't fit into\nthe default side defined by this property.",
|
|
1420
|
+
"fieldName": "horizontalAlign",
|
|
1421
|
+
"inheritedFrom": {
|
|
1422
|
+
"name": "PositionMixin",
|
|
1423
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-position-mixin.js"
|
|
1424
|
+
}
|
|
1425
|
+
},
|
|
1426
|
+
{
|
|
1427
|
+
"name": "modeless",
|
|
1428
|
+
"type": {
|
|
1429
|
+
"text": "boolean"
|
|
1430
|
+
},
|
|
1431
|
+
"description": "When true the overlay won't disable the main content, showing\nit doesn't change the functionality of the user interface.",
|
|
1432
|
+
"fieldName": "modeless",
|
|
1433
|
+
"inheritedFrom": {
|
|
1434
|
+
"name": "OverlayMixin",
|
|
1435
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
1436
|
+
}
|
|
1437
|
+
},
|
|
1438
|
+
{
|
|
1439
|
+
"name": "no-horizontal-overlap",
|
|
1440
|
+
"type": {
|
|
1441
|
+
"text": "boolean"
|
|
1442
|
+
},
|
|
1443
|
+
"description": "When `positionTarget` is set, this property defines whether the overlay should overlap\nthe target element in the x-axis, or be positioned right next to it.",
|
|
1444
|
+
"fieldName": "noHorizontalOverlap",
|
|
1445
|
+
"inheritedFrom": {
|
|
1446
|
+
"name": "PositionMixin",
|
|
1447
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-position-mixin.js"
|
|
1448
|
+
}
|
|
1449
|
+
},
|
|
1450
|
+
{
|
|
1451
|
+
"name": "no-vertical-overlap",
|
|
1452
|
+
"type": {
|
|
1453
|
+
"text": "boolean"
|
|
1454
|
+
},
|
|
1455
|
+
"description": "When `positionTarget` is set, this property defines whether the overlay should overlap\nthe target element in the y-axis, or be positioned right above/below it.",
|
|
1456
|
+
"fieldName": "noVerticalOverlap",
|
|
1457
|
+
"inheritedFrom": {
|
|
1458
|
+
"name": "PositionMixin",
|
|
1459
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-position-mixin.js"
|
|
1460
|
+
}
|
|
1461
|
+
},
|
|
1462
|
+
{
|
|
1463
|
+
"name": "opened",
|
|
1464
|
+
"type": {
|
|
1465
|
+
"text": "boolean"
|
|
1466
|
+
},
|
|
1467
|
+
"description": "When true, the overlay is visible and attached to body.",
|
|
1468
|
+
"fieldName": "opened",
|
|
1469
|
+
"inheritedFrom": {
|
|
1470
|
+
"name": "OverlayMixin",
|
|
1471
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
1472
|
+
}
|
|
1473
|
+
},
|
|
1474
|
+
{
|
|
1475
|
+
"name": "owner",
|
|
1476
|
+
"type": {
|
|
1477
|
+
"text": "HTMLElement"
|
|
1478
|
+
},
|
|
1479
|
+
"description": "Owner element passed with renderer function",
|
|
1480
|
+
"fieldName": "owner",
|
|
1481
|
+
"inheritedFrom": {
|
|
1482
|
+
"name": "OverlayMixin",
|
|
1483
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
1484
|
+
}
|
|
1485
|
+
},
|
|
1486
|
+
{
|
|
1487
|
+
"name": "renderer",
|
|
1488
|
+
"type": {
|
|
1489
|
+
"text": "OverlayRenderer | null | undefined"
|
|
1490
|
+
},
|
|
1491
|
+
"description": "Custom function for rendering the content of the overlay.\nReceives three arguments:\n\n- `root` The root container DOM element. Append your content to it.\n- `owner` The host element of the renderer function.\n- `model` The object with the properties related with rendering.",
|
|
1492
|
+
"fieldName": "renderer",
|
|
1493
|
+
"inheritedFrom": {
|
|
1494
|
+
"name": "OverlayMixin",
|
|
1495
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
1496
|
+
}
|
|
1497
|
+
},
|
|
1498
|
+
{
|
|
1499
|
+
"name": "required-vertical-space",
|
|
1500
|
+
"type": {
|
|
1501
|
+
"text": "number"
|
|
1502
|
+
},
|
|
1503
|
+
"description": "If the overlay content has no intrinsic height, this property can be used to set\nthe minimum vertical space (in pixels) required by the overlay. Setting a value to\nthe property effectively disables the content measurement in favor of using this\nfixed value for determining the open direction.",
|
|
1504
|
+
"fieldName": "requiredVerticalSpace",
|
|
1505
|
+
"inheritedFrom": {
|
|
1506
|
+
"name": "PositionMixin",
|
|
1507
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-position-mixin.js"
|
|
1508
|
+
}
|
|
1509
|
+
},
|
|
1510
|
+
{
|
|
1511
|
+
"name": "vertical-align",
|
|
1512
|
+
"type": {
|
|
1513
|
+
"text": "string"
|
|
1514
|
+
},
|
|
1515
|
+
"description": "When `positionTarget` is set, this property defines whether to align the overlay's\ntop or bottom side to the target element by default.\nPossible values are `top` and `bottom`.\nThe overlay is automatically flipped to the opposite side when it doesn't fit into\nthe default side defined by this property.",
|
|
1516
|
+
"fieldName": "verticalAlign",
|
|
1517
|
+
"inheritedFrom": {
|
|
1518
|
+
"name": "PositionMixin",
|
|
1519
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-position-mixin.js"
|
|
1520
|
+
}
|
|
1521
|
+
},
|
|
1522
|
+
{
|
|
1523
|
+
"name": "with-backdrop",
|
|
1524
|
+
"type": {
|
|
1525
|
+
"text": "boolean"
|
|
1526
|
+
},
|
|
1527
|
+
"description": "When true the overlay has backdrop on top of content when opened.",
|
|
1528
|
+
"fieldName": "withBackdrop",
|
|
1529
|
+
"inheritedFrom": {
|
|
1530
|
+
"name": "OverlayMixin",
|
|
1531
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
1532
|
+
}
|
|
1533
|
+
}
|
|
1534
|
+
],
|
|
1535
|
+
"events": [
|
|
1536
|
+
{
|
|
1537
|
+
"name": "vaadin-overlay-closed",
|
|
1538
|
+
"type": {
|
|
1539
|
+
"text": "CustomEvent"
|
|
1540
|
+
},
|
|
1541
|
+
"inheritedFrom": {
|
|
1542
|
+
"name": "OverlayMixin",
|
|
1543
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
1544
|
+
}
|
|
1545
|
+
},
|
|
1546
|
+
{
|
|
1547
|
+
"name": "vaadin-overlay-closing",
|
|
1548
|
+
"type": {
|
|
1549
|
+
"text": "CustomEvent"
|
|
1550
|
+
},
|
|
1551
|
+
"inheritedFrom": {
|
|
1552
|
+
"name": "OverlayMixin",
|
|
1553
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
1554
|
+
}
|
|
1555
|
+
}
|
|
1556
|
+
]
|
|
1557
|
+
}
|
|
1558
|
+
],
|
|
1559
|
+
"exports": [
|
|
1560
|
+
{
|
|
1561
|
+
"kind": "js",
|
|
1562
|
+
"name": "SelectOverlay",
|
|
1563
|
+
"declaration": {
|
|
1564
|
+
"name": "SelectOverlay",
|
|
1565
|
+
"module": "src/vaadin-select-overlay.js"
|
|
1566
|
+
}
|
|
1567
|
+
}
|
|
1568
|
+
]
|
|
1569
|
+
},
|
|
1570
|
+
{
|
|
1571
|
+
"kind": "javascript-module",
|
|
1572
|
+
"path": "src/vaadin-select-value-button.js",
|
|
1573
|
+
"declarations": [],
|
|
1574
|
+
"exports": []
|
|
1575
|
+
},
|
|
1576
|
+
{
|
|
1577
|
+
"kind": "javascript-module",
|
|
1578
|
+
"path": "src/vaadin-select.js",
|
|
1579
|
+
"declarations": [
|
|
1580
|
+
{
|
|
1581
|
+
"kind": "class",
|
|
1582
|
+
"description": "`<vaadin-select>` is a Web Component for selecting values from a list of items.\n\n### Items\n\nUse the `items` property to define possible options for the select:\n\n```html\n<vaadin-select id=\"select\"></vaadin-select>\n```\n```js\nconst select = document.querySelector('#select');\nselect.items = [\n { label: 'Most recent first', value: 'recent' },\n { component: 'hr' },\n { label: 'Rating: low to high', value: 'rating-asc', className: 'asc' },\n { label: 'Rating: high to low', value: 'rating-desc', className: 'desc' },\n { component: 'hr' },\n { label: 'Price: low to high', value: 'price-asc', disabled: true },\n { label: 'Price: high to low', value: 'price-desc', disabled: true }\n];\n```\n\n### Rendering\n\nAlternatively, the content of the select can be populated by using the renderer callback function.\n\nThe renderer function provides `root`, `select` arguments.\nGenerate DOM content, append it to the `root` element and control the state\nof the host element by accessing `select`.\n\n```js\nconst select = document.querySelector('#select');\nselect.renderer = function(root, select) {\n const listBox = document.createElement('vaadin-list-box');\n // append 3 <vaadin-item> elements\n ['Jose', 'Manolo', 'Pedro'].forEach(function(name) {\n const item = document.createElement('vaadin-item');\n item.textContent = name;\n item.setAttribute('label', name)\n listBox.appendChild(item);\n });\n\n // update the content\n root.appendChild(listBox);\n};\n```\n\nRenderer is called on initialization of new select and on its opening.\nDOM generated during the renderer call can be reused\nin the next renderer call and will be provided with the `root` argument.\nOn first call it will be empty.\n\n* Hint: By setting the `label` property of inner vaadin-items you will\nbe able to change the visual representation of the selected value in the input part.\n\n### Styling\n\nThe following custom properties are available for styling:\n\nCustom property | Description | Default\n---------------------------------|-----------------------------|--------\n`--vaadin-field-default-width` | Default width of the field | `12em`\n`--vaadin-select-overlay-width` | Width of the overlay |\n\nThe following shadow DOM parts are available for styling:\n\nPart name | Description\n---------------------|----------------\n`label` | The label element\n`input-field` | The element that wraps prefix, value and toggle button\n`field-button` | Set on the toggle 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`backdrop` | Backdrop of the overlay\n`overlay` | The overlay container\n`content` | The overlay content\n\nThe following state attributes are available for styling:\n\nAttribute | Description\n---------------------|---------------------------------\n`disabled` | Set when the element is disabled\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`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`readonly` | Set when the element is readonly\n`opened` | Set when the overlay is opened\n`phone` | Set when the overlay is shown in phone mode\n\n### Internal components\n\nIn addition to `<vaadin-select>` itself, the following internal\ncomponents are themable:\n\n- `<vaadin-select-value-button>` - has the same API as [`<vaadin-button>`](#/elements/vaadin-button).\n- `<vaadin-select-list-box>` - has the same API as [`<vaadin-list-box>`](#/elements/vaadin-list-box).\n- `<vaadin-select-item>` - has the same API as [`<vaadin-item>`](#/elements/vaadin-item).\n\nSee [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.",
|
|
1583
|
+
"name": "Select",
|
|
1584
|
+
"members": [
|
|
1585
|
+
{
|
|
1586
|
+
"kind": "field",
|
|
1587
|
+
"name": "accessibleName",
|
|
1588
|
+
"privacy": "public",
|
|
1589
|
+
"type": {
|
|
1590
|
+
"text": "string"
|
|
1591
|
+
},
|
|
1592
|
+
"description": "String used to label the component to screen reader users.",
|
|
1593
|
+
"attribute": "accessible-name",
|
|
1594
|
+
"inheritedFrom": {
|
|
1595
|
+
"name": "FieldMixin",
|
|
1596
|
+
"package": "@vaadin/field-base/src/field-mixin.js"
|
|
1597
|
+
}
|
|
1598
|
+
},
|
|
1599
|
+
{
|
|
1600
|
+
"kind": "field",
|
|
1601
|
+
"name": "accessibleNameRef",
|
|
1602
|
+
"privacy": "public",
|
|
1603
|
+
"type": {
|
|
1604
|
+
"text": "string"
|
|
1605
|
+
},
|
|
1606
|
+
"description": "Id of the element used as label of the component to screen reader users.",
|
|
1607
|
+
"attribute": "accessible-name-ref",
|
|
1608
|
+
"inheritedFrom": {
|
|
1609
|
+
"name": "FieldMixin",
|
|
1610
|
+
"package": "@vaadin/field-base/src/field-mixin.js"
|
|
1611
|
+
}
|
|
1612
|
+
},
|
|
1613
|
+
{
|
|
1614
|
+
"kind": "method",
|
|
1615
|
+
"name": "checkValidity",
|
|
1616
|
+
"description": "Returns true if the current value satisfies all constraints (if any)",
|
|
1617
|
+
"return": {
|
|
1618
|
+
"type": {
|
|
1619
|
+
"text": "boolean"
|
|
1620
|
+
}
|
|
1621
|
+
},
|
|
1622
|
+
"inheritedFrom": {
|
|
1623
|
+
"name": "SelectBaseMixin",
|
|
1624
|
+
"module": "src/vaadin-select-base-mixin.js"
|
|
1625
|
+
}
|
|
1626
|
+
},
|
|
1627
|
+
{
|
|
1628
|
+
"kind": "field",
|
|
1629
|
+
"name": "errorMessage",
|
|
1630
|
+
"privacy": "public",
|
|
1631
|
+
"type": {
|
|
1632
|
+
"text": "string"
|
|
1633
|
+
},
|
|
1634
|
+
"description": "Error to show when the field is invalid.",
|
|
1635
|
+
"attribute": "error-message",
|
|
1636
|
+
"inheritedFrom": {
|
|
1637
|
+
"name": "FieldMixin",
|
|
1638
|
+
"package": "@vaadin/field-base/src/field-mixin.js"
|
|
1639
|
+
}
|
|
1640
|
+
},
|
|
1641
|
+
{
|
|
1642
|
+
"kind": "field",
|
|
1643
|
+
"name": "helperText",
|
|
1644
|
+
"privacy": "public",
|
|
1645
|
+
"type": {
|
|
1646
|
+
"text": "string"
|
|
1647
|
+
},
|
|
1648
|
+
"description": "String used for the helper text.",
|
|
1649
|
+
"attribute": "helper-text",
|
|
1650
|
+
"inheritedFrom": {
|
|
1651
|
+
"name": "FieldMixin",
|
|
1652
|
+
"package": "@vaadin/field-base/src/field-mixin.js"
|
|
1653
|
+
}
|
|
1654
|
+
},
|
|
1655
|
+
{
|
|
1656
|
+
"kind": "field",
|
|
1657
|
+
"name": "items",
|
|
1658
|
+
"privacy": "public",
|
|
1659
|
+
"type": {
|
|
1660
|
+
"text": "!Array<!SelectItem>"
|
|
1661
|
+
},
|
|
1662
|
+
"description": "An array containing items that will be rendered as the options of the select.\n\n#### Example\n```js\nselect.items = [\n { label: 'Most recent first', value: 'recent' },\n { component: 'hr' },\n { label: 'Rating: low to high', value: 'rating-asc', className: 'asc' },\n { label: 'Rating: high to low', value: 'rating-desc', className: 'desc' },\n { component: 'hr' },\n { label: 'Price: low to high', value: 'price-asc', disabled: true },\n { label: 'Price: high to low', value: 'price-desc', disabled: true }\n];\n```\n\nNote: each item is rendered by default as the internal `<vaadin-select-item>` that is an extension of `<vaadin-item>`.\nTo render the item with a custom component, provide a tag name by the `component` property.",
|
|
1663
|
+
"attribute": "items",
|
|
1664
|
+
"inheritedFrom": {
|
|
1665
|
+
"name": "SelectBaseMixin",
|
|
1666
|
+
"module": "src/vaadin-select-base-mixin.js"
|
|
1667
|
+
}
|
|
1668
|
+
},
|
|
1669
|
+
{
|
|
1670
|
+
"kind": "field",
|
|
1671
|
+
"name": "label",
|
|
1672
|
+
"privacy": "public",
|
|
1673
|
+
"type": {
|
|
1674
|
+
"text": "string"
|
|
1675
|
+
},
|
|
1676
|
+
"description": "The label text for the input node.\nWhen no light dom defined via [slot=label], this value will be used.",
|
|
1677
|
+
"attribute": "label",
|
|
1678
|
+
"inheritedFrom": {
|
|
1679
|
+
"name": "LabelMixin",
|
|
1680
|
+
"package": "@vaadin/field-base/src/label-mixin.js"
|
|
1681
|
+
}
|
|
1682
|
+
},
|
|
1683
|
+
{
|
|
1684
|
+
"kind": "field",
|
|
1685
|
+
"name": "name",
|
|
1686
|
+
"privacy": "public",
|
|
1687
|
+
"type": {
|
|
1688
|
+
"text": "string"
|
|
1689
|
+
},
|
|
1690
|
+
"description": "The name of this element.",
|
|
1691
|
+
"attribute": "name",
|
|
1692
|
+
"inheritedFrom": {
|
|
1693
|
+
"name": "SelectBaseMixin",
|
|
1694
|
+
"module": "src/vaadin-select-base-mixin.js"
|
|
1695
|
+
}
|
|
1696
|
+
},
|
|
1697
|
+
{
|
|
1698
|
+
"kind": "field",
|
|
1699
|
+
"name": "noVerticalOverlap",
|
|
1700
|
+
"privacy": "public",
|
|
1701
|
+
"type": {
|
|
1702
|
+
"text": "boolean"
|
|
1703
|
+
},
|
|
1704
|
+
"description": "Defines whether the overlay should overlap the target element\nin the y-axis, or be positioned right above/below it.",
|
|
1705
|
+
"attribute": "no-vertical-overlap",
|
|
1706
|
+
"inheritedFrom": {
|
|
1707
|
+
"name": "SelectBaseMixin",
|
|
1708
|
+
"module": "src/vaadin-select-base-mixin.js"
|
|
1709
|
+
}
|
|
1710
|
+
},
|
|
1711
|
+
{
|
|
1712
|
+
"kind": "field",
|
|
1713
|
+
"name": "opened",
|
|
1714
|
+
"privacy": "public",
|
|
1715
|
+
"type": {
|
|
1716
|
+
"text": "boolean"
|
|
1717
|
+
},
|
|
1718
|
+
"description": "Set when the select is open",
|
|
1719
|
+
"attribute": "opened",
|
|
1720
|
+
"inheritedFrom": {
|
|
1721
|
+
"name": "SelectBaseMixin",
|
|
1722
|
+
"module": "src/vaadin-select-base-mixin.js"
|
|
1723
|
+
}
|
|
1724
|
+
},
|
|
1725
|
+
{
|
|
1726
|
+
"kind": "field",
|
|
1727
|
+
"name": "placeholder",
|
|
1728
|
+
"privacy": "public",
|
|
1729
|
+
"type": {
|
|
1730
|
+
"text": "string"
|
|
1731
|
+
},
|
|
1732
|
+
"description": "A hint to the user of what can be entered in the control.\nThe placeholder will be displayed in the case that there\nis no item selected, or the selected item has an empty\nstring label, or the selected item has no label and it's\nDOM content is empty.",
|
|
1733
|
+
"attribute": "placeholder",
|
|
1734
|
+
"inheritedFrom": {
|
|
1735
|
+
"name": "SelectBaseMixin",
|
|
1736
|
+
"module": "src/vaadin-select-base-mixin.js"
|
|
1737
|
+
}
|
|
1738
|
+
},
|
|
1739
|
+
{
|
|
1740
|
+
"kind": "field",
|
|
1741
|
+
"name": "readonly",
|
|
1742
|
+
"privacy": "public",
|
|
1743
|
+
"type": {
|
|
1744
|
+
"text": "boolean"
|
|
1745
|
+
},
|
|
1746
|
+
"description": "When present, it specifies that the element is read-only.",
|
|
1747
|
+
"attribute": "readonly",
|
|
1748
|
+
"inheritedFrom": {
|
|
1749
|
+
"name": "SelectBaseMixin",
|
|
1750
|
+
"module": "src/vaadin-select-base-mixin.js"
|
|
1751
|
+
}
|
|
1752
|
+
},
|
|
1753
|
+
{
|
|
1754
|
+
"kind": "field",
|
|
1755
|
+
"name": "renderer",
|
|
1756
|
+
"privacy": "public",
|
|
1757
|
+
"type": {
|
|
1758
|
+
"text": "!SelectRenderer | undefined"
|
|
1759
|
+
},
|
|
1760
|
+
"description": "Custom function for rendering the content of the `<vaadin-select>`.\nReceives two arguments:\n\n- `root` The internal container DOM element. Append your content to it.\n- `select` The reference to the `<vaadin-select>` element.",
|
|
1761
|
+
"attribute": "renderer",
|
|
1762
|
+
"inheritedFrom": {
|
|
1763
|
+
"name": "SelectBaseMixin",
|
|
1764
|
+
"module": "src/vaadin-select-base-mixin.js"
|
|
1765
|
+
}
|
|
1766
|
+
},
|
|
1767
|
+
{
|
|
1768
|
+
"kind": "method",
|
|
1769
|
+
"name": "requestContentUpdate",
|
|
1770
|
+
"description": "Requests an update for the content of the select.\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.",
|
|
1771
|
+
"inheritedFrom": {
|
|
1772
|
+
"name": "SelectBaseMixin",
|
|
1773
|
+
"module": "src/vaadin-select-base-mixin.js"
|
|
1774
|
+
}
|
|
1775
|
+
},
|
|
1776
|
+
{
|
|
1777
|
+
"kind": "field",
|
|
1778
|
+
"name": "slotName",
|
|
1779
|
+
"type": {
|
|
1780
|
+
"text": "string"
|
|
1781
|
+
},
|
|
1782
|
+
"default": "'sr-label'",
|
|
1783
|
+
"inheritedFrom": {
|
|
1784
|
+
"name": "SelectBaseMixin",
|
|
1785
|
+
"module": "src/vaadin-select-base-mixin.js"
|
|
1786
|
+
}
|
|
1787
|
+
},
|
|
1788
|
+
{
|
|
1789
|
+
"kind": "field",
|
|
1790
|
+
"name": "value",
|
|
1791
|
+
"privacy": "public",
|
|
1792
|
+
"type": {
|
|
1793
|
+
"text": "string"
|
|
1794
|
+
},
|
|
1795
|
+
"description": "The `value` property of the selected item, or an empty string\nif no item is selected.\nOn change or initialization, the component finds the item which matches the\nvalue and displays it.\nIf no value is provided to the component, it selects the first item without\nvalue or empty value.\nHint: If you do not want to select any item by default, you can either set all\nthe values of inner vaadin-items, or set the vaadin-select value to\nan inexistent value in the items list.",
|
|
1796
|
+
"attribute": "value",
|
|
1797
|
+
"inheritedFrom": {
|
|
1798
|
+
"name": "SelectBaseMixin",
|
|
1799
|
+
"module": "src/vaadin-select-base-mixin.js"
|
|
1800
|
+
}
|
|
1801
|
+
}
|
|
1802
|
+
],
|
|
1803
|
+
"events": [
|
|
1804
|
+
{
|
|
1805
|
+
"name": "change",
|
|
1806
|
+
"type": {
|
|
1807
|
+
"text": "CustomEvent"
|
|
1808
|
+
},
|
|
1809
|
+
"description": "Fired when the user commits a value change.",
|
|
1810
|
+
"inheritedFrom": {
|
|
1811
|
+
"name": "SelectBaseMixin",
|
|
1812
|
+
"module": "src/vaadin-select-base-mixin.js"
|
|
1813
|
+
}
|
|
1814
|
+
},
|
|
1815
|
+
{
|
|
1816
|
+
"type": {
|
|
1817
|
+
"text": "CustomEvent"
|
|
1818
|
+
},
|
|
1819
|
+
"description": "Fired when the `invalid` property changes.",
|
|
1820
|
+
"name": "invalid-changed"
|
|
1821
|
+
},
|
|
1822
|
+
{
|
|
1823
|
+
"type": {
|
|
1824
|
+
"text": "CustomEvent"
|
|
1825
|
+
},
|
|
1826
|
+
"description": "Fired when the `opened` property changes.",
|
|
1827
|
+
"name": "opened-changed"
|
|
1828
|
+
},
|
|
1829
|
+
{
|
|
1830
|
+
"type": {
|
|
1831
|
+
"text": "CustomEvent"
|
|
1832
|
+
},
|
|
1833
|
+
"description": "Fired whenever the field is validated.",
|
|
1834
|
+
"name": "validated"
|
|
1835
|
+
},
|
|
1836
|
+
{
|
|
1837
|
+
"type": {
|
|
1838
|
+
"text": "CustomEvent"
|
|
1839
|
+
},
|
|
1840
|
+
"description": "Fired when the `value` property changes.",
|
|
1841
|
+
"name": "value-changed"
|
|
1842
|
+
}
|
|
1843
|
+
],
|
|
1844
|
+
"mixins": [
|
|
1845
|
+
{
|
|
1846
|
+
"name": "SelectBaseMixin",
|
|
1847
|
+
"module": "src/vaadin-select-base-mixin.js"
|
|
1848
|
+
},
|
|
1849
|
+
{
|
|
1850
|
+
"name": "ElementMixin",
|
|
1851
|
+
"package": "@vaadin/component-base/src/element-mixin.js"
|
|
1852
|
+
},
|
|
1853
|
+
{
|
|
1854
|
+
"name": "ThemableMixin",
|
|
1855
|
+
"package": "@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js"
|
|
1856
|
+
},
|
|
1857
|
+
{
|
|
1858
|
+
"name": "PolylitMixin",
|
|
1859
|
+
"package": "@vaadin/component-base/src/polylit-mixin.js"
|
|
1860
|
+
},
|
|
1861
|
+
{
|
|
1862
|
+
"name": "LumoInjectionMixin",
|
|
1863
|
+
"package": "@vaadin/vaadin-themable-mixin/lumo-injection-mixin.js"
|
|
1864
|
+
}
|
|
1865
|
+
],
|
|
1866
|
+
"superclass": {
|
|
1867
|
+
"name": "LitElement",
|
|
1868
|
+
"package": "lit"
|
|
1869
|
+
},
|
|
1870
|
+
"tagName": "vaadin-select",
|
|
1871
|
+
"customElement": true,
|
|
1872
|
+
"attributes": [
|
|
1873
|
+
{
|
|
1874
|
+
"name": "accessible-name",
|
|
1875
|
+
"type": {
|
|
1876
|
+
"text": "string"
|
|
1877
|
+
},
|
|
1878
|
+
"description": "String used to label the component to screen reader users.",
|
|
1879
|
+
"fieldName": "accessibleName",
|
|
1880
|
+
"inheritedFrom": {
|
|
1881
|
+
"name": "FieldMixin",
|
|
1882
|
+
"package": "@vaadin/field-base/src/field-mixin.js"
|
|
1883
|
+
}
|
|
1884
|
+
},
|
|
1885
|
+
{
|
|
1886
|
+
"name": "accessible-name-ref",
|
|
1887
|
+
"type": {
|
|
1888
|
+
"text": "string"
|
|
1889
|
+
},
|
|
1890
|
+
"description": "Id of the element used as label of the component to screen reader users.",
|
|
1891
|
+
"fieldName": "accessibleNameRef",
|
|
1892
|
+
"inheritedFrom": {
|
|
1893
|
+
"name": "FieldMixin",
|
|
1894
|
+
"package": "@vaadin/field-base/src/field-mixin.js"
|
|
1895
|
+
}
|
|
1896
|
+
},
|
|
1897
|
+
{
|
|
1898
|
+
"name": "error-message",
|
|
1899
|
+
"type": {
|
|
1900
|
+
"text": "string"
|
|
1901
|
+
},
|
|
1902
|
+
"description": "Error to show when the field is invalid.",
|
|
1903
|
+
"fieldName": "errorMessage",
|
|
1904
|
+
"inheritedFrom": {
|
|
1905
|
+
"name": "FieldMixin",
|
|
1906
|
+
"package": "@vaadin/field-base/src/field-mixin.js"
|
|
1907
|
+
}
|
|
1908
|
+
},
|
|
1909
|
+
{
|
|
1910
|
+
"name": "helper-text",
|
|
1911
|
+
"type": {
|
|
1912
|
+
"text": "string"
|
|
1913
|
+
},
|
|
1914
|
+
"description": "String used for the helper text.",
|
|
1915
|
+
"fieldName": "helperText",
|
|
1916
|
+
"inheritedFrom": {
|
|
1917
|
+
"name": "FieldMixin",
|
|
1918
|
+
"package": "@vaadin/field-base/src/field-mixin.js"
|
|
1919
|
+
}
|
|
1920
|
+
},
|
|
1921
|
+
{
|
|
1922
|
+
"name": "label",
|
|
1923
|
+
"type": {
|
|
1924
|
+
"text": "string"
|
|
1925
|
+
},
|
|
1926
|
+
"description": "The label text for the input node.\nWhen no light dom defined via [slot=label], this value will be used.",
|
|
1927
|
+
"fieldName": "label",
|
|
1928
|
+
"inheritedFrom": {
|
|
1929
|
+
"name": "LabelMixin",
|
|
1930
|
+
"package": "@vaadin/field-base/src/label-mixin.js"
|
|
1931
|
+
}
|
|
1932
|
+
},
|
|
1933
|
+
{
|
|
1934
|
+
"name": "name",
|
|
1935
|
+
"type": {
|
|
1936
|
+
"text": "string"
|
|
1937
|
+
},
|
|
1938
|
+
"description": "The name of this element.",
|
|
1939
|
+
"fieldName": "name",
|
|
1940
|
+
"inheritedFrom": {
|
|
1941
|
+
"name": "SelectBaseMixin",
|
|
1942
|
+
"module": "src/vaadin-select-base-mixin.js"
|
|
1943
|
+
}
|
|
1944
|
+
},
|
|
1945
|
+
{
|
|
1946
|
+
"name": "no-vertical-overlap",
|
|
1947
|
+
"type": {
|
|
1948
|
+
"text": "boolean"
|
|
1949
|
+
},
|
|
1950
|
+
"description": "Defines whether the overlay should overlap the target element\nin the y-axis, or be positioned right above/below it.",
|
|
1951
|
+
"fieldName": "noVerticalOverlap",
|
|
1952
|
+
"inheritedFrom": {
|
|
1953
|
+
"name": "SelectBaseMixin",
|
|
1954
|
+
"module": "src/vaadin-select-base-mixin.js"
|
|
1955
|
+
}
|
|
1956
|
+
},
|
|
1957
|
+
{
|
|
1958
|
+
"name": "opened",
|
|
1959
|
+
"type": {
|
|
1960
|
+
"text": "boolean"
|
|
1961
|
+
},
|
|
1962
|
+
"description": "Set when the select is open",
|
|
1963
|
+
"fieldName": "opened",
|
|
1964
|
+
"inheritedFrom": {
|
|
1965
|
+
"name": "SelectBaseMixin",
|
|
1966
|
+
"module": "src/vaadin-select-base-mixin.js"
|
|
1967
|
+
}
|
|
1968
|
+
},
|
|
1969
|
+
{
|
|
1970
|
+
"name": "placeholder",
|
|
1971
|
+
"type": {
|
|
1972
|
+
"text": "string"
|
|
1973
|
+
},
|
|
1974
|
+
"description": "A hint to the user of what can be entered in the control.\nThe placeholder will be displayed in the case that there\nis no item selected, or the selected item has an empty\nstring label, or the selected item has no label and it's\nDOM content is empty.",
|
|
1975
|
+
"fieldName": "placeholder",
|
|
1976
|
+
"inheritedFrom": {
|
|
1977
|
+
"name": "SelectBaseMixin",
|
|
1978
|
+
"module": "src/vaadin-select-base-mixin.js"
|
|
1979
|
+
}
|
|
1980
|
+
},
|
|
1981
|
+
{
|
|
1982
|
+
"name": "readonly",
|
|
1983
|
+
"type": {
|
|
1984
|
+
"text": "boolean"
|
|
1985
|
+
},
|
|
1986
|
+
"description": "When present, it specifies that the element is read-only.",
|
|
1987
|
+
"fieldName": "readonly",
|
|
1988
|
+
"inheritedFrom": {
|
|
1989
|
+
"name": "SelectBaseMixin",
|
|
1990
|
+
"module": "src/vaadin-select-base-mixin.js"
|
|
1991
|
+
}
|
|
1992
|
+
},
|
|
1993
|
+
{
|
|
1994
|
+
"name": "renderer",
|
|
1995
|
+
"type": {
|
|
1996
|
+
"text": "!SelectRenderer | undefined"
|
|
1997
|
+
},
|
|
1998
|
+
"description": "Custom function for rendering the content of the `<vaadin-select>`.\nReceives two arguments:\n\n- `root` The internal container DOM element. Append your content to it.\n- `select` The reference to the `<vaadin-select>` element.",
|
|
1999
|
+
"fieldName": "renderer",
|
|
2000
|
+
"inheritedFrom": {
|
|
2001
|
+
"name": "SelectBaseMixin",
|
|
2002
|
+
"module": "src/vaadin-select-base-mixin.js"
|
|
2003
|
+
}
|
|
2004
|
+
},
|
|
2005
|
+
{
|
|
2006
|
+
"name": "value",
|
|
2007
|
+
"type": {
|
|
2008
|
+
"text": "string"
|
|
2009
|
+
},
|
|
2010
|
+
"description": "The `value` property of the selected item, or an empty string\nif no item is selected.\nOn change or initialization, the component finds the item which matches the\nvalue and displays it.\nIf no value is provided to the component, it selects the first item without\nvalue or empty value.\nHint: If you do not want to select any item by default, you can either set all\nthe values of inner vaadin-items, or set the vaadin-select value to\nan inexistent value in the items list.",
|
|
2011
|
+
"fieldName": "value",
|
|
2012
|
+
"inheritedFrom": {
|
|
2013
|
+
"name": "SelectBaseMixin",
|
|
2014
|
+
"module": "src/vaadin-select-base-mixin.js"
|
|
2015
|
+
}
|
|
2016
|
+
}
|
|
2017
|
+
]
|
|
2018
|
+
}
|
|
2019
|
+
],
|
|
2020
|
+
"exports": [
|
|
2021
|
+
{
|
|
2022
|
+
"kind": "js",
|
|
2023
|
+
"name": "Select",
|
|
2024
|
+
"declaration": {
|
|
2025
|
+
"name": "Select",
|
|
2026
|
+
"module": "src/vaadin-select.js"
|
|
2027
|
+
}
|
|
2028
|
+
}
|
|
2029
|
+
]
|
|
2030
|
+
}
|
|
2031
|
+
]
|
|
2032
|
+
}
|