@vaadin/select 25.3.0-dev.3a3c2d7d2a → 25.3.0
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 +451 -42
- package/package.json +16 -16
- package/src/lit/renderer-directives.d.ts +1 -0
- package/src/lit/renderer-directives.js +1 -0
- package/src/vaadin-select-base-mixin.d.ts +6 -2
- package/src/vaadin-select-base-mixin.js +82 -74
- package/src/vaadin-select-item.d.ts +44 -2
- package/src/vaadin-select-item.js +35 -2
- package/src/vaadin-select-list-box.d.ts +20 -1
- package/src/vaadin-select-list-box.js +21 -2
- package/src/vaadin-select-overlay-mixin.js +20 -9
- package/src/vaadin-select-overlay.js +4 -1
- package/src/vaadin-select-value-button.js +2 -1
- package/src/vaadin-select.d.ts +71 -16
- package/src/vaadin-select.js +68 -17
- package/vaadin-select-item.d.ts +1 -0
- package/vaadin-select-item.js +2 -0
- package/vaadin-select-list-box.d.ts +1 -0
- package/vaadin-select-list-box.js +2 -0
- package/web-types.json +156 -10
- package/web-types.lit.json +67 -4
package/custom-elements.json
CHANGED
|
@@ -17,6 +17,36 @@
|
|
|
17
17
|
}
|
|
18
18
|
]
|
|
19
19
|
},
|
|
20
|
+
{
|
|
21
|
+
"kind": "javascript-module",
|
|
22
|
+
"path": "vaadin-select-list-box.js",
|
|
23
|
+
"declarations": [],
|
|
24
|
+
"exports": [
|
|
25
|
+
{
|
|
26
|
+
"kind": "js",
|
|
27
|
+
"name": "*",
|
|
28
|
+
"declaration": {
|
|
29
|
+
"name": "*",
|
|
30
|
+
"module": "src/vaadin-select-list-box.js"
|
|
31
|
+
}
|
|
32
|
+
}
|
|
33
|
+
]
|
|
34
|
+
},
|
|
35
|
+
{
|
|
36
|
+
"kind": "javascript-module",
|
|
37
|
+
"path": "vaadin-select-item.js",
|
|
38
|
+
"declarations": [],
|
|
39
|
+
"exports": [
|
|
40
|
+
{
|
|
41
|
+
"kind": "js",
|
|
42
|
+
"name": "*",
|
|
43
|
+
"declaration": {
|
|
44
|
+
"name": "*",
|
|
45
|
+
"module": "src/vaadin-select-item.js"
|
|
46
|
+
}
|
|
47
|
+
}
|
|
48
|
+
]
|
|
49
|
+
},
|
|
20
50
|
{
|
|
21
51
|
"kind": "javascript-module",
|
|
22
52
|
"path": "src/vaadin-select-base-mixin.js",
|
|
@@ -26,6 +56,20 @@
|
|
|
26
56
|
"description": "",
|
|
27
57
|
"name": "SelectBaseMixin",
|
|
28
58
|
"members": [
|
|
59
|
+
{
|
|
60
|
+
"kind": "field",
|
|
61
|
+
"name": "accessibleDescriptionRef",
|
|
62
|
+
"privacy": "public",
|
|
63
|
+
"type": {
|
|
64
|
+
"text": "string"
|
|
65
|
+
},
|
|
66
|
+
"description": "A space-separated list of IDs referencing the elements that\ndescribe the component for screen reader users. The referenced\nelements are announced in addition to the helper text and\nthe error message.",
|
|
67
|
+
"attribute": "accessible-description-ref",
|
|
68
|
+
"inheritedFrom": {
|
|
69
|
+
"name": "FieldMixin",
|
|
70
|
+
"package": "@vaadin/field-base/src/field-mixin.js"
|
|
71
|
+
}
|
|
72
|
+
},
|
|
29
73
|
{
|
|
30
74
|
"kind": "field",
|
|
31
75
|
"name": "accessibleName",
|
|
@@ -33,7 +77,7 @@
|
|
|
33
77
|
"type": {
|
|
34
78
|
"text": "string"
|
|
35
79
|
},
|
|
36
|
-
"description": "String used to label the component
|
|
80
|
+
"description": "String used to label the component for screen reader users.",
|
|
37
81
|
"attribute": "accessible-name",
|
|
38
82
|
"inheritedFrom": {
|
|
39
83
|
"name": "FieldMixin",
|
|
@@ -47,7 +91,7 @@
|
|
|
47
91
|
"type": {
|
|
48
92
|
"text": "string"
|
|
49
93
|
},
|
|
50
|
-
"description": "
|
|
94
|
+
"description": "A space-separated list of IDs referencing the elements that\nlabel the component for screen reader users.",
|
|
51
95
|
"attribute": "accessible-name-ref",
|
|
52
96
|
"inheritedFrom": {
|
|
53
97
|
"name": "FieldMixin",
|
|
@@ -143,7 +187,7 @@
|
|
|
143
187
|
"name": "items",
|
|
144
188
|
"privacy": "public",
|
|
145
189
|
"type": {
|
|
146
|
-
"text": "!Array<!
|
|
190
|
+
"text": "!Array<!SelectItemData>"
|
|
147
191
|
},
|
|
148
192
|
"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.",
|
|
149
193
|
"attribute": "items"
|
|
@@ -234,12 +278,14 @@
|
|
|
234
278
|
"text": "!SelectRenderer | undefined"
|
|
235
279
|
},
|
|
236
280
|
"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.",
|
|
281
|
+
"deprecated": "Use a slotted `<vaadin-select-list-box>` or the `items` property instead",
|
|
237
282
|
"attribute": "renderer"
|
|
238
283
|
},
|
|
239
284
|
{
|
|
240
285
|
"kind": "method",
|
|
241
286
|
"name": "requestContentUpdate",
|
|
242
|
-
"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."
|
|
287
|
+
"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.",
|
|
288
|
+
"deprecated": "This method is deprecated and will be removed in Vaadin 26"
|
|
243
289
|
},
|
|
244
290
|
{
|
|
245
291
|
"kind": "field",
|
|
@@ -299,12 +345,24 @@
|
|
|
299
345
|
}
|
|
300
346
|
],
|
|
301
347
|
"attributes": [
|
|
348
|
+
{
|
|
349
|
+
"name": "accessible-description-ref",
|
|
350
|
+
"type": {
|
|
351
|
+
"text": "string"
|
|
352
|
+
},
|
|
353
|
+
"description": "A space-separated list of IDs referencing the elements that\ndescribe the component for screen reader users. The referenced\nelements are announced in addition to the helper text and\nthe error message.",
|
|
354
|
+
"fieldName": "accessibleDescriptionRef",
|
|
355
|
+
"inheritedFrom": {
|
|
356
|
+
"name": "FieldMixin",
|
|
357
|
+
"package": "@vaadin/field-base/src/field-mixin.js"
|
|
358
|
+
}
|
|
359
|
+
},
|
|
302
360
|
{
|
|
303
361
|
"name": "accessible-name",
|
|
304
362
|
"type": {
|
|
305
363
|
"text": "string"
|
|
306
364
|
},
|
|
307
|
-
"description": "String used to label the component
|
|
365
|
+
"description": "String used to label the component for screen reader users.",
|
|
308
366
|
"fieldName": "accessibleName",
|
|
309
367
|
"inheritedFrom": {
|
|
310
368
|
"name": "FieldMixin",
|
|
@@ -316,7 +374,7 @@
|
|
|
316
374
|
"type": {
|
|
317
375
|
"text": "string"
|
|
318
376
|
},
|
|
319
|
-
"description": "
|
|
377
|
+
"description": "A space-separated list of IDs referencing the elements that\nlabel the component for screen reader users.",
|
|
320
378
|
"fieldName": "accessibleNameRef",
|
|
321
379
|
"inheritedFrom": {
|
|
322
380
|
"name": "FieldMixin",
|
|
@@ -453,6 +511,7 @@
|
|
|
453
511
|
"text": "!SelectRenderer | undefined"
|
|
454
512
|
},
|
|
455
513
|
"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.",
|
|
514
|
+
"deprecated": "Use a slotted `<vaadin-select-list-box>` or the `items` property instead",
|
|
456
515
|
"fieldName": "renderer"
|
|
457
516
|
},
|
|
458
517
|
{
|
|
@@ -512,6 +571,294 @@
|
|
|
512
571
|
}
|
|
513
572
|
]
|
|
514
573
|
},
|
|
574
|
+
{
|
|
575
|
+
"kind": "javascript-module",
|
|
576
|
+
"path": "src/vaadin-select-item.js",
|
|
577
|
+
"declarations": [
|
|
578
|
+
{
|
|
579
|
+
"kind": "class",
|
|
580
|
+
"description": "`<vaadin-select-item>` is a Web Component for creating `<vaadin-select>` items.\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 slot\n\nThe following state attributes are available for styling:\n\nAttribute | Description\n-------------|-------------\n`active` | Set when the item is pressed down, either with mouse, touch or the keyboard.\n`disabled` | Set when the item is disabled.\n`focus-ring` | Set when the item is focused using the keyboard.\n`focused` | Set when the item is focused.\n`selected` | Set when the item is selected\n\nThe following custom CSS properties are available for styling:\n\nCustom CSS property |\n:----------------------------------|\n| `--vaadin-item-border-radius` |\n| `--vaadin-item-checkmark-color` |\n| `--vaadin-item-gap` |\n| `--vaadin-item-height` |\n| `--vaadin-item-padding` |\n| `--vaadin-item-text-align` |\n\nSee [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.",
|
|
581
|
+
"name": "SelectItem",
|
|
582
|
+
"members": [
|
|
583
|
+
{
|
|
584
|
+
"kind": "field",
|
|
585
|
+
"name": "disabled",
|
|
586
|
+
"privacy": "public",
|
|
587
|
+
"type": {
|
|
588
|
+
"text": "boolean"
|
|
589
|
+
},
|
|
590
|
+
"description": "If true, the user cannot interact with this element.",
|
|
591
|
+
"attribute": "disabled",
|
|
592
|
+
"inheritedFrom": {
|
|
593
|
+
"name": "DisabledMixin",
|
|
594
|
+
"package": "@vaadin/a11y-base/src/disabled-mixin.js"
|
|
595
|
+
}
|
|
596
|
+
},
|
|
597
|
+
{
|
|
598
|
+
"type": {
|
|
599
|
+
"text": "string"
|
|
600
|
+
},
|
|
601
|
+
"description": "String that can be set to visually represent the selected item in `vaadin-select`.",
|
|
602
|
+
"name": "label",
|
|
603
|
+
"kind": "field"
|
|
604
|
+
},
|
|
605
|
+
{
|
|
606
|
+
"kind": "field",
|
|
607
|
+
"name": "selected",
|
|
608
|
+
"privacy": "public",
|
|
609
|
+
"type": {
|
|
610
|
+
"text": "boolean"
|
|
611
|
+
},
|
|
612
|
+
"description": "If true, the item is in selected state.",
|
|
613
|
+
"attribute": "selected",
|
|
614
|
+
"inheritedFrom": {
|
|
615
|
+
"name": "ItemMixin",
|
|
616
|
+
"package": "@vaadin/item/src/vaadin-item-mixin.js"
|
|
617
|
+
}
|
|
618
|
+
},
|
|
619
|
+
{
|
|
620
|
+
"kind": "field",
|
|
621
|
+
"name": "value",
|
|
622
|
+
"description": "Submittable string value. The default value is the trimmed text content of the element.",
|
|
623
|
+
"type": {
|
|
624
|
+
"text": "string"
|
|
625
|
+
},
|
|
626
|
+
"inheritedFrom": {
|
|
627
|
+
"name": "ItemMixin",
|
|
628
|
+
"package": "@vaadin/item/src/vaadin-item-mixin.js"
|
|
629
|
+
}
|
|
630
|
+
}
|
|
631
|
+
],
|
|
632
|
+
"attributes": [
|
|
633
|
+
{
|
|
634
|
+
"name": "disabled",
|
|
635
|
+
"type": {
|
|
636
|
+
"text": "boolean"
|
|
637
|
+
},
|
|
638
|
+
"description": "If true, the user cannot interact with this element.",
|
|
639
|
+
"fieldName": "disabled",
|
|
640
|
+
"inheritedFrom": {
|
|
641
|
+
"name": "DisabledMixin",
|
|
642
|
+
"package": "@vaadin/a11y-base/src/disabled-mixin.js"
|
|
643
|
+
}
|
|
644
|
+
},
|
|
645
|
+
{
|
|
646
|
+
"name": "selected",
|
|
647
|
+
"type": {
|
|
648
|
+
"text": "boolean"
|
|
649
|
+
},
|
|
650
|
+
"description": "If true, the item is in selected state.",
|
|
651
|
+
"fieldName": "selected",
|
|
652
|
+
"inheritedFrom": {
|
|
653
|
+
"name": "ItemMixin",
|
|
654
|
+
"package": "@vaadin/item/src/vaadin-item-mixin.js"
|
|
655
|
+
}
|
|
656
|
+
},
|
|
657
|
+
{
|
|
658
|
+
"type": {
|
|
659
|
+
"text": "string"
|
|
660
|
+
},
|
|
661
|
+
"description": "The theme variants to apply to the component.",
|
|
662
|
+
"name": "theme"
|
|
663
|
+
}
|
|
664
|
+
],
|
|
665
|
+
"mixins": [
|
|
666
|
+
{
|
|
667
|
+
"name": "ItemMixin",
|
|
668
|
+
"package": "@vaadin/item/src/vaadin-item-mixin.js"
|
|
669
|
+
},
|
|
670
|
+
{
|
|
671
|
+
"name": "ThemableMixin",
|
|
672
|
+
"package": "@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js"
|
|
673
|
+
},
|
|
674
|
+
{
|
|
675
|
+
"name": "DirMixin",
|
|
676
|
+
"package": "@vaadin/component-base/src/dir-mixin.js"
|
|
677
|
+
},
|
|
678
|
+
{
|
|
679
|
+
"name": "PolylitMixin",
|
|
680
|
+
"package": "@vaadin/component-base/src/polylit-mixin.js"
|
|
681
|
+
},
|
|
682
|
+
{
|
|
683
|
+
"name": "LumoInjectionMixin",
|
|
684
|
+
"package": "@vaadin/vaadin-themable-mixin/lumo-injection-mixin.js"
|
|
685
|
+
}
|
|
686
|
+
],
|
|
687
|
+
"superclass": {
|
|
688
|
+
"name": "LitElement",
|
|
689
|
+
"package": "lit"
|
|
690
|
+
},
|
|
691
|
+
"tagName": "vaadin-select-item",
|
|
692
|
+
"customElement": true,
|
|
693
|
+
"events": []
|
|
694
|
+
}
|
|
695
|
+
],
|
|
696
|
+
"exports": [
|
|
697
|
+
{
|
|
698
|
+
"kind": "js",
|
|
699
|
+
"name": "SelectItem",
|
|
700
|
+
"declaration": {
|
|
701
|
+
"name": "SelectItem",
|
|
702
|
+
"module": "src/vaadin-select-item.js"
|
|
703
|
+
}
|
|
704
|
+
}
|
|
705
|
+
]
|
|
706
|
+
},
|
|
707
|
+
{
|
|
708
|
+
"kind": "javascript-module",
|
|
709
|
+
"path": "src/vaadin-select-list-box.js",
|
|
710
|
+
"declarations": [
|
|
711
|
+
{
|
|
712
|
+
"kind": "class",
|
|
713
|
+
"description": "`<vaadin-select-list-box>` is a Web Component for wrapping `<vaadin-select>` items.\n\n```html\n<vaadin-select>\n <vaadin-select-list-box slot=\"overlay\">\n <vaadin-select-item value=\"foo\">Foo</vaadin-select-item>\n <vaadin-select-item value=\"bar\">Bar</vaadin-select-item>\n </vaadin-select-list-box>\n</vaadin-select>\n```\n\n### Styling\n\nThe following shadow DOM parts are available for styling:\n\nPart name | Description\n------------------|------------------------\n`items` | The items container\n\nSee [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.",
|
|
714
|
+
"name": "SelectListBox",
|
|
715
|
+
"members": [
|
|
716
|
+
{
|
|
717
|
+
"kind": "field",
|
|
718
|
+
"name": "disabled",
|
|
719
|
+
"privacy": "public",
|
|
720
|
+
"type": {
|
|
721
|
+
"text": "boolean"
|
|
722
|
+
},
|
|
723
|
+
"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.",
|
|
724
|
+
"attribute": "disabled",
|
|
725
|
+
"inheritedFrom": {
|
|
726
|
+
"name": "ListMixin",
|
|
727
|
+
"package": "@vaadin/a11y-base/src/list-mixin.js"
|
|
728
|
+
}
|
|
729
|
+
},
|
|
730
|
+
{
|
|
731
|
+
"kind": "field",
|
|
732
|
+
"name": "items",
|
|
733
|
+
"privacy": "public",
|
|
734
|
+
"type": {
|
|
735
|
+
"text": "!Array<!Element> | undefined"
|
|
736
|
+
},
|
|
737
|
+
"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.",
|
|
738
|
+
"attribute": "items",
|
|
739
|
+
"readonly": true,
|
|
740
|
+
"inheritedFrom": {
|
|
741
|
+
"name": "ListMixin",
|
|
742
|
+
"package": "@vaadin/a11y-base/src/list-mixin.js"
|
|
743
|
+
}
|
|
744
|
+
},
|
|
745
|
+
{
|
|
746
|
+
"kind": "field",
|
|
747
|
+
"name": "orientation",
|
|
748
|
+
"privacy": "public",
|
|
749
|
+
"type": {
|
|
750
|
+
"text": "string"
|
|
751
|
+
},
|
|
752
|
+
"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.",
|
|
753
|
+
"attribute": "orientation",
|
|
754
|
+
"readonly": true,
|
|
755
|
+
"inheritedFrom": {
|
|
756
|
+
"name": "ListMixin",
|
|
757
|
+
"package": "@vaadin/a11y-base/src/list-mixin.js"
|
|
758
|
+
}
|
|
759
|
+
},
|
|
760
|
+
{
|
|
761
|
+
"kind": "field",
|
|
762
|
+
"name": "selected",
|
|
763
|
+
"privacy": "public",
|
|
764
|
+
"type": {
|
|
765
|
+
"text": "number"
|
|
766
|
+
},
|
|
767
|
+
"description": "The index of the item selected in the items array.\nNote: Not updated when used in `multiple` selection mode.",
|
|
768
|
+
"attribute": "selected",
|
|
769
|
+
"inheritedFrom": {
|
|
770
|
+
"name": "ListMixin",
|
|
771
|
+
"package": "@vaadin/a11y-base/src/list-mixin.js"
|
|
772
|
+
}
|
|
773
|
+
}
|
|
774
|
+
],
|
|
775
|
+
"attributes": [
|
|
776
|
+
{
|
|
777
|
+
"name": "disabled",
|
|
778
|
+
"type": {
|
|
779
|
+
"text": "boolean"
|
|
780
|
+
},
|
|
781
|
+
"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.",
|
|
782
|
+
"fieldName": "disabled",
|
|
783
|
+
"inheritedFrom": {
|
|
784
|
+
"name": "ListMixin",
|
|
785
|
+
"package": "@vaadin/a11y-base/src/list-mixin.js"
|
|
786
|
+
}
|
|
787
|
+
},
|
|
788
|
+
{
|
|
789
|
+
"name": "orientation",
|
|
790
|
+
"type": {
|
|
791
|
+
"text": "string"
|
|
792
|
+
},
|
|
793
|
+
"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.",
|
|
794
|
+
"fieldName": "orientation",
|
|
795
|
+
"inheritedFrom": {
|
|
796
|
+
"name": "ListMixin",
|
|
797
|
+
"package": "@vaadin/a11y-base/src/list-mixin.js"
|
|
798
|
+
}
|
|
799
|
+
},
|
|
800
|
+
{
|
|
801
|
+
"name": "selected",
|
|
802
|
+
"type": {
|
|
803
|
+
"text": "number"
|
|
804
|
+
},
|
|
805
|
+
"description": "The index of the item selected in the items array.\nNote: Not updated when used in `multiple` selection mode.",
|
|
806
|
+
"fieldName": "selected",
|
|
807
|
+
"inheritedFrom": {
|
|
808
|
+
"name": "ListMixin",
|
|
809
|
+
"package": "@vaadin/a11y-base/src/list-mixin.js"
|
|
810
|
+
}
|
|
811
|
+
},
|
|
812
|
+
{
|
|
813
|
+
"type": {
|
|
814
|
+
"text": "string"
|
|
815
|
+
},
|
|
816
|
+
"description": "The theme variants to apply to the component.",
|
|
817
|
+
"name": "theme"
|
|
818
|
+
}
|
|
819
|
+
],
|
|
820
|
+
"mixins": [
|
|
821
|
+
{
|
|
822
|
+
"name": "ListMixin",
|
|
823
|
+
"package": "@vaadin/a11y-base/src/list-mixin.js"
|
|
824
|
+
},
|
|
825
|
+
{
|
|
826
|
+
"name": "ThemableMixin",
|
|
827
|
+
"package": "@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js"
|
|
828
|
+
},
|
|
829
|
+
{
|
|
830
|
+
"name": "DirMixin",
|
|
831
|
+
"package": "@vaadin/component-base/src/dir-mixin.js"
|
|
832
|
+
},
|
|
833
|
+
{
|
|
834
|
+
"name": "PolylitMixin",
|
|
835
|
+
"package": "@vaadin/component-base/src/polylit-mixin.js"
|
|
836
|
+
},
|
|
837
|
+
{
|
|
838
|
+
"name": "LumoInjectionMixin",
|
|
839
|
+
"package": "@vaadin/vaadin-themable-mixin/lumo-injection-mixin.js"
|
|
840
|
+
}
|
|
841
|
+
],
|
|
842
|
+
"superclass": {
|
|
843
|
+
"name": "LitElement",
|
|
844
|
+
"package": "lit"
|
|
845
|
+
},
|
|
846
|
+
"tagName": "vaadin-select-list-box",
|
|
847
|
+
"customElement": true,
|
|
848
|
+
"events": []
|
|
849
|
+
}
|
|
850
|
+
],
|
|
851
|
+
"exports": [
|
|
852
|
+
{
|
|
853
|
+
"kind": "js",
|
|
854
|
+
"name": "SelectListBox",
|
|
855
|
+
"declaration": {
|
|
856
|
+
"name": "SelectListBox",
|
|
857
|
+
"module": "src/vaadin-select-list-box.js"
|
|
858
|
+
}
|
|
859
|
+
}
|
|
860
|
+
]
|
|
861
|
+
},
|
|
515
862
|
{
|
|
516
863
|
"kind": "javascript-module",
|
|
517
864
|
"path": "src/vaadin-select-overlay-mixin.js",
|
|
@@ -521,6 +868,20 @@
|
|
|
521
868
|
"description": "",
|
|
522
869
|
"name": "SelectOverlayMixin",
|
|
523
870
|
"members": [
|
|
871
|
+
{
|
|
872
|
+
"kind": "field",
|
|
873
|
+
"name": "autofocus",
|
|
874
|
+
"privacy": "public",
|
|
875
|
+
"type": {
|
|
876
|
+
"text": "boolean"
|
|
877
|
+
},
|
|
878
|
+
"description": "Set to true to move focus into the overlay automatically on open.\n\nFocus moves to the first tabbable element in the tab order. This\ncan be the overlay itself if it has `tabindex` attribute set to `0`\non the host element or the `overlay` shadow DOM part.",
|
|
879
|
+
"attribute": "autofocus",
|
|
880
|
+
"inheritedFrom": {
|
|
881
|
+
"name": "OverlayFocusMixin",
|
|
882
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-focus-mixin.js"
|
|
883
|
+
}
|
|
884
|
+
},
|
|
524
885
|
{
|
|
525
886
|
"kind": "method",
|
|
526
887
|
"name": "bringToFront",
|
|
@@ -553,7 +914,7 @@
|
|
|
553
914
|
"type": {
|
|
554
915
|
"text": "boolean"
|
|
555
916
|
},
|
|
556
|
-
"description": "
|
|
917
|
+
"description": "Set to true to move focus into the overlay automatically on open\nand keep it inside: Tab and Shift+Tab cycle through the overlay's\ncontent until the overlay is closed.\n\nFocus moves to the first tabbable element in the tab order. This\ncan be the overlay itself if it has `tabindex` attribute set to `0`\non the host element or the `overlay` shadow DOM part.",
|
|
557
918
|
"attribute": "focus-trap",
|
|
558
919
|
"inheritedFrom": {
|
|
559
920
|
"name": "OverlayFocusMixin",
|
|
@@ -824,12 +1185,24 @@
|
|
|
824
1185
|
}
|
|
825
1186
|
],
|
|
826
1187
|
"attributes": [
|
|
1188
|
+
{
|
|
1189
|
+
"name": "autofocus",
|
|
1190
|
+
"type": {
|
|
1191
|
+
"text": "boolean"
|
|
1192
|
+
},
|
|
1193
|
+
"description": "Set to true to move focus into the overlay automatically on open.\n\nFocus moves to the first tabbable element in the tab order. This\ncan be the overlay itself if it has `tabindex` attribute set to `0`\non the host element or the `overlay` shadow DOM part.",
|
|
1194
|
+
"fieldName": "autofocus",
|
|
1195
|
+
"inheritedFrom": {
|
|
1196
|
+
"name": "OverlayFocusMixin",
|
|
1197
|
+
"package": "@vaadin/overlay/src/vaadin-overlay-focus-mixin.js"
|
|
1198
|
+
}
|
|
1199
|
+
},
|
|
827
1200
|
{
|
|
828
1201
|
"name": "focus-trap",
|
|
829
1202
|
"type": {
|
|
830
1203
|
"text": "boolean"
|
|
831
1204
|
},
|
|
832
|
-
"description": "
|
|
1205
|
+
"description": "Set to true to move focus into the overlay automatically on open\nand keep it inside: Tab and Shift+Tab cycle through the overlay's\ncontent until the overlay is closed.\n\nFocus moves to the first tabbable element in the tab order. This\ncan be the overlay itself if it has `tabindex` attribute set to `0`\non the host element or the `overlay` shadow DOM part.",
|
|
833
1206
|
"fieldName": "focusTrap",
|
|
834
1207
|
"inheritedFrom": {
|
|
835
1208
|
"name": "OverlayFocusMixin",
|
|
@@ -1034,9 +1407,23 @@
|
|
|
1034
1407
|
"declarations": [
|
|
1035
1408
|
{
|
|
1036
1409
|
"kind": "class",
|
|
1037
|
-
"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
|
|
1410
|
+
"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 a slotted `<vaadin-select-list-box>`\nwith `<vaadin-select-item>` children:\n\n```html\n<vaadin-select>\n <vaadin-select-list-box slot=\"overlay\">\n <vaadin-select-item value=\"recent\">Most recent first</vaadin-select-item>\n <vaadin-select-item value=\"rating-asc\">Rating: low to high</vaadin-select-item>\n <vaadin-select-item value=\"rating-desc\">Rating: high to low</vaadin-select-item>\n </vaadin-select-list-box>\n</vaadin-select>\n```\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#### Renderer (deprecated)\n\nThe content of the select can also be populated by using the renderer callback function, although\nthis approach is deprecated in favor of the `items` property or a slotted `<vaadin-select-list-box>`.\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### Styling\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\nThe following custom CSS properties are available for styling:\n\nCustom CSS property |\n:--------------------------------------------------|\n| `--vaadin-field-default-width` |\n| `--vaadin-input-field-background` |\n| `--vaadin-input-field-border-color` |\n| `--vaadin-input-field-border-radius` |\n| `--vaadin-input-field-border-width` |\n| `--vaadin-input-field-bottom-end-radius` |\n| `--vaadin-input-field-bottom-start-radius` |\n| `--vaadin-input-field-button-text-color` |\n| `--vaadin-input-field-container-gap` |\n| `--vaadin-input-field-disabled-background` |\n| `--vaadin-input-field-disabled-text-color` |\n| `--vaadin-input-field-error-color` |\n| `--vaadin-input-field-error-font-size` |\n| `--vaadin-input-field-error-font-weight` |\n| `--vaadin-input-field-error-line-height` |\n| `--vaadin-input-field-gap` |\n| `--vaadin-input-field-helper-color` |\n| `--vaadin-input-field-helper-font-size` |\n| `--vaadin-input-field-helper-font-weight` |\n| `--vaadin-input-field-helper-line-height` |\n| `--vaadin-input-field-label-color` |\n| `--vaadin-input-field-label-font-size` |\n| `--vaadin-input-field-label-font-weight` |\n| `--vaadin-input-field-label-line-height` |\n| `--vaadin-input-field-padding` |\n| `--vaadin-input-field-placeholder-color` |\n| `--vaadin-input-field-required-indicator` |\n| `--vaadin-input-field-required-indicator-color` |\n| `--vaadin-input-field-top-end-radius` |\n| `--vaadin-input-field-top-start-radius` |\n| `--vaadin-input-field-value-color` |\n| `--vaadin-input-field-value-font-size` |\n| `--vaadin-input-field-value-font-weight` |\n| `--vaadin-input-field-value-line-height` |\n| `--vaadin-item-overlay-padding` |\n| `--vaadin-select-overlay-width` |\n\n### Internal components\n\nIn addition to `<vaadin-select>` itself, the following internal components are used\nand themable:\n\n- `<vaadin-select-value-button>` - has the same API as [`<vaadin-button>`](#/elements/vaadin-button).\n- [`<vaadin-select-list-box>`](#/elements/vaadin-select-list-box) - a list-box element.\n- [`<vaadin-select-item>`](#/elements/vaadin-select-item) - an item element.\n\nSee [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.",
|
|
1038
1411
|
"name": "Select",
|
|
1039
1412
|
"members": [
|
|
1413
|
+
{
|
|
1414
|
+
"kind": "field",
|
|
1415
|
+
"name": "accessibleDescriptionRef",
|
|
1416
|
+
"privacy": "public",
|
|
1417
|
+
"type": {
|
|
1418
|
+
"text": "string"
|
|
1419
|
+
},
|
|
1420
|
+
"description": "A space-separated list of IDs referencing the elements that\ndescribe the component for screen reader users. The referenced\nelements are announced in addition to the helper text and\nthe error message.",
|
|
1421
|
+
"attribute": "accessible-description-ref",
|
|
1422
|
+
"inheritedFrom": {
|
|
1423
|
+
"name": "FieldMixin",
|
|
1424
|
+
"package": "@vaadin/field-base/src/field-mixin.js"
|
|
1425
|
+
}
|
|
1426
|
+
},
|
|
1040
1427
|
{
|
|
1041
1428
|
"kind": "field",
|
|
1042
1429
|
"name": "accessibleName",
|
|
@@ -1044,7 +1431,7 @@
|
|
|
1044
1431
|
"type": {
|
|
1045
1432
|
"text": "string"
|
|
1046
1433
|
},
|
|
1047
|
-
"description": "String used to label the component
|
|
1434
|
+
"description": "String used to label the component for screen reader users.",
|
|
1048
1435
|
"attribute": "accessible-name",
|
|
1049
1436
|
"inheritedFrom": {
|
|
1050
1437
|
"name": "FieldMixin",
|
|
@@ -1058,7 +1445,7 @@
|
|
|
1058
1445
|
"type": {
|
|
1059
1446
|
"text": "string"
|
|
1060
1447
|
},
|
|
1061
|
-
"description": "
|
|
1448
|
+
"description": "A space-separated list of IDs referencing the elements that\nlabel the component for screen reader users.",
|
|
1062
1449
|
"attribute": "accessible-name-ref",
|
|
1063
1450
|
"inheritedFrom": {
|
|
1064
1451
|
"name": "FieldMixin",
|
|
@@ -1154,7 +1541,7 @@
|
|
|
1154
1541
|
"name": "items",
|
|
1155
1542
|
"privacy": "public",
|
|
1156
1543
|
"type": {
|
|
1157
|
-
"text": "!Array<!
|
|
1544
|
+
"text": "!Array<!SelectItemData>"
|
|
1158
1545
|
},
|
|
1159
1546
|
"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.",
|
|
1160
1547
|
"attribute": "items",
|
|
@@ -1269,6 +1656,7 @@
|
|
|
1269
1656
|
"text": "!SelectRenderer | undefined"
|
|
1270
1657
|
},
|
|
1271
1658
|
"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.",
|
|
1659
|
+
"deprecated": "Use a slotted `<vaadin-select-list-box>` or the `items` property instead",
|
|
1272
1660
|
"attribute": "renderer",
|
|
1273
1661
|
"inheritedFrom": {
|
|
1274
1662
|
"name": "SelectBaseMixin",
|
|
@@ -1279,6 +1667,7 @@
|
|
|
1279
1667
|
"kind": "method",
|
|
1280
1668
|
"name": "requestContentUpdate",
|
|
1281
1669
|
"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.",
|
|
1670
|
+
"deprecated": "This method is deprecated and will be removed in Vaadin 26",
|
|
1282
1671
|
"inheritedFrom": {
|
|
1283
1672
|
"name": "SelectBaseMixin",
|
|
1284
1673
|
"module": "src/vaadin-select-base-mixin.js"
|
|
@@ -1372,41 +1761,25 @@
|
|
|
1372
1761
|
"name": "value-changed"
|
|
1373
1762
|
}
|
|
1374
1763
|
],
|
|
1375
|
-
"
|
|
1376
|
-
{
|
|
1377
|
-
"name": "SelectBaseMixin",
|
|
1378
|
-
"module": "src/vaadin-select-base-mixin.js"
|
|
1379
|
-
},
|
|
1380
|
-
{
|
|
1381
|
-
"name": "ElementMixin",
|
|
1382
|
-
"package": "@vaadin/component-base/src/element-mixin.js"
|
|
1383
|
-
},
|
|
1384
|
-
{
|
|
1385
|
-
"name": "ThemableMixin",
|
|
1386
|
-
"package": "@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js"
|
|
1387
|
-
},
|
|
1764
|
+
"attributes": [
|
|
1388
1765
|
{
|
|
1389
|
-
"name": "
|
|
1390
|
-
"
|
|
1766
|
+
"name": "accessible-description-ref",
|
|
1767
|
+
"type": {
|
|
1768
|
+
"text": "string"
|
|
1769
|
+
},
|
|
1770
|
+
"description": "A space-separated list of IDs referencing the elements that\ndescribe the component for screen reader users. The referenced\nelements are announced in addition to the helper text and\nthe error message.",
|
|
1771
|
+
"fieldName": "accessibleDescriptionRef",
|
|
1772
|
+
"inheritedFrom": {
|
|
1773
|
+
"name": "FieldMixin",
|
|
1774
|
+
"package": "@vaadin/field-base/src/field-mixin.js"
|
|
1775
|
+
}
|
|
1391
1776
|
},
|
|
1392
|
-
{
|
|
1393
|
-
"name": "LumoInjectionMixin",
|
|
1394
|
-
"package": "@vaadin/vaadin-themable-mixin/lumo-injection-mixin.js"
|
|
1395
|
-
}
|
|
1396
|
-
],
|
|
1397
|
-
"superclass": {
|
|
1398
|
-
"name": "LitElement",
|
|
1399
|
-
"package": "lit"
|
|
1400
|
-
},
|
|
1401
|
-
"tagName": "vaadin-select",
|
|
1402
|
-
"customElement": true,
|
|
1403
|
-
"attributes": [
|
|
1404
1777
|
{
|
|
1405
1778
|
"name": "accessible-name",
|
|
1406
1779
|
"type": {
|
|
1407
1780
|
"text": "string"
|
|
1408
1781
|
},
|
|
1409
|
-
"description": "String used to label the component
|
|
1782
|
+
"description": "String used to label the component for screen reader users.",
|
|
1410
1783
|
"fieldName": "accessibleName",
|
|
1411
1784
|
"inheritedFrom": {
|
|
1412
1785
|
"name": "FieldMixin",
|
|
@@ -1418,7 +1791,7 @@
|
|
|
1418
1791
|
"type": {
|
|
1419
1792
|
"text": "string"
|
|
1420
1793
|
},
|
|
1421
|
-
"description": "
|
|
1794
|
+
"description": "A space-separated list of IDs referencing the elements that\nlabel the component for screen reader users.",
|
|
1422
1795
|
"fieldName": "accessibleNameRef",
|
|
1423
1796
|
"inheritedFrom": {
|
|
1424
1797
|
"name": "FieldMixin",
|
|
@@ -1575,6 +1948,7 @@
|
|
|
1575
1948
|
"text": "!SelectRenderer | undefined"
|
|
1576
1949
|
},
|
|
1577
1950
|
"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.",
|
|
1951
|
+
"deprecated": "Use a slotted `<vaadin-select-list-box>` or the `items` property instead",
|
|
1578
1952
|
"fieldName": "renderer",
|
|
1579
1953
|
"inheritedFrom": {
|
|
1580
1954
|
"name": "SelectBaseMixin",
|
|
@@ -1593,6 +1967,13 @@
|
|
|
1593
1967
|
"package": "@vaadin/field-base/src/validate-mixin.js"
|
|
1594
1968
|
}
|
|
1595
1969
|
},
|
|
1970
|
+
{
|
|
1971
|
+
"type": {
|
|
1972
|
+
"text": "string"
|
|
1973
|
+
},
|
|
1974
|
+
"description": "The theme variants to apply to the component.",
|
|
1975
|
+
"name": "theme"
|
|
1976
|
+
},
|
|
1596
1977
|
{
|
|
1597
1978
|
"name": "value",
|
|
1598
1979
|
"type": {
|
|
@@ -1605,7 +1986,35 @@
|
|
|
1605
1986
|
"module": "src/vaadin-select-base-mixin.js"
|
|
1606
1987
|
}
|
|
1607
1988
|
}
|
|
1608
|
-
]
|
|
1989
|
+
],
|
|
1990
|
+
"mixins": [
|
|
1991
|
+
{
|
|
1992
|
+
"name": "SelectBaseMixin",
|
|
1993
|
+
"module": "src/vaadin-select-base-mixin.js"
|
|
1994
|
+
},
|
|
1995
|
+
{
|
|
1996
|
+
"name": "ElementMixin",
|
|
1997
|
+
"package": "@vaadin/component-base/src/element-mixin.js"
|
|
1998
|
+
},
|
|
1999
|
+
{
|
|
2000
|
+
"name": "ThemableMixin",
|
|
2001
|
+
"package": "@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js"
|
|
2002
|
+
},
|
|
2003
|
+
{
|
|
2004
|
+
"name": "PolylitMixin",
|
|
2005
|
+
"package": "@vaadin/component-base/src/polylit-mixin.js"
|
|
2006
|
+
},
|
|
2007
|
+
{
|
|
2008
|
+
"name": "LumoInjectionMixin",
|
|
2009
|
+
"package": "@vaadin/vaadin-themable-mixin/lumo-injection-mixin.js"
|
|
2010
|
+
}
|
|
2011
|
+
],
|
|
2012
|
+
"superclass": {
|
|
2013
|
+
"name": "LitElement",
|
|
2014
|
+
"package": "lit"
|
|
2015
|
+
},
|
|
2016
|
+
"tagName": "vaadin-select",
|
|
2017
|
+
"customElement": true
|
|
1609
2018
|
}
|
|
1610
2019
|
],
|
|
1611
2020
|
"exports": [
|