@vaadin/checkbox-group 25.3.0-alpha8 → 25.3.0-alpha9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/custom-elements.json +60 -8
  2. package/package.json +11 -11
  3. package/web-types.json +23 -5
  4. package/web-types.lit.json +10 -3
package/custom-elements.json CHANGED
@@ -26,6 +26,20 @@
26
26
  "description": "A mixin providing common checkbox-group functionality.",
27
27
  "name": "CheckboxGroupMixin",
28
28
  "members": [
29
+ {
30
+ "kind": "field",
31
+ "name": "accessibleDescriptionRef",
32
+ "privacy": "public",
33
+ "type": {
34
+ "text": "string"
35
+ },
36
+ "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.",
37
+ "attribute": "accessible-description-ref",
38
+ "inheritedFrom": {
39
+ "name": "FieldMixin",
40
+ "package": "@vaadin/field-base/src/field-mixin.js"
41
+ }
42
+ },
29
43
  {
30
44
  "kind": "field",
31
45
  "name": "accessibleName",
@@ -33,7 +47,7 @@
33
47
  "type": {
34
48
  "text": "string"
35
49
  },
36
- "description": "String used to label the component to screen reader users.",
50
+ "description": "String used to label the component for screen reader users.",
37
51
  "attribute": "accessible-name",
38
52
  "inheritedFrom": {
39
53
  "name": "FieldMixin",
@@ -47,7 +61,7 @@
47
61
  "type": {
48
62
  "text": "string"
49
63
  },
50
- "description": "Id of the element used as label of the component to screen reader users.",
64
+ "description": "A space-separated list of IDs referencing the elements that\nlabel the component for screen reader users.",
51
65
  "attribute": "accessible-name-ref",
52
66
  "inheritedFrom": {
53
67
  "name": "FieldMixin",
@@ -202,12 +216,24 @@
202
216
  }
203
217
  ],
204
218
  "attributes": [
219
+ {
220
+ "name": "accessible-description-ref",
221
+ "type": {
222
+ "text": "string"
223
+ },
224
+ "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.",
225
+ "fieldName": "accessibleDescriptionRef",
226
+ "inheritedFrom": {
227
+ "name": "FieldMixin",
228
+ "package": "@vaadin/field-base/src/field-mixin.js"
229
+ }
230
+ },
205
231
  {
206
232
  "name": "accessible-name",
207
233
  "type": {
208
234
  "text": "string"
209
235
  },
210
- "description": "String used to label the component to screen reader users.",
236
+ "description": "String used to label the component for screen reader users.",
211
237
  "fieldName": "accessibleName",
212
238
  "inheritedFrom": {
213
239
  "name": "FieldMixin",
@@ -219,7 +245,7 @@
219
245
  "type": {
220
246
  "text": "string"
221
247
  },
222
- "description": "Id of the element used as label of the component to screen reader users.",
248
+ "description": "A space-separated list of IDs referencing the elements that\nlabel the component for screen reader users.",
223
249
  "fieldName": "accessibleNameRef",
224
250
  "inheritedFrom": {
225
251
  "name": "FieldMixin",
@@ -380,6 +406,20 @@
380
406
  "description": "`<vaadin-checkbox-group>` is a web component that allows the user to choose several items from a group of binary choices.\n\n```html\n<vaadin-checkbox-group label=\"Export data\">\n <vaadin-checkbox value=\"0\" label=\"Order ID\"></vaadin-checkbox>\n <vaadin-checkbox value=\"1\" label=\"Product name\"></vaadin-checkbox>\n <vaadin-checkbox value=\"2\" label=\"Customer\"></vaadin-checkbox>\n <vaadin-checkbox value=\"3\" label=\"Status\"></vaadin-checkbox>\n</vaadin-checkbox-group>\n```\n\n### Styling\n\nThe following shadow DOM parts are available for styling:\n\nPart name | Description\n---------------------|----------------\n`label` | The slotted label element wrapper\n`group-field` | The checkbox elements wrapper\n`helper-text` | The slotted helper text element wrapper\n`error-message` | The slotted error message element wrapper\n`required-indicator` | The `required` state indicator element\n\nThe following state attributes are available for styling:\n\nAttribute | Description\n--------------------|---------------------------------\n`disabled` | Set when the element is disabled\n`readonly` | Set when the element is readonly\n`invalid` | Set when the element is invalid\n`focused` | Set when the element is focused\n`has-label` | Set when the element has a label\n`has-value` | Set when the element has a value\n`has-helper` | Set when the element has helper text\n`has-error-message` | Set when the element has an error message\n`has-tooltip` | Set when the element has a slotted tooltip\n\nThe following custom CSS properties are available for styling:\n\nCustom CSS property |\n:--------------------------------------------------|\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-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-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-required-indicator-color` |\n| `--vaadin-input-field-required-indicator` |\n\nSee [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.",
381
407
  "name": "CheckboxGroup",
382
408
  "members": [
409
+ {
410
+ "kind": "field",
411
+ "name": "accessibleDescriptionRef",
412
+ "privacy": "public",
413
+ "type": {
414
+ "text": "string"
415
+ },
416
+ "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.",
417
+ "attribute": "accessible-description-ref",
418
+ "inheritedFrom": {
419
+ "name": "FieldMixin",
420
+ "package": "@vaadin/field-base/src/field-mixin.js"
421
+ }
422
+ },
383
423
  {
384
424
  "kind": "field",
385
425
  "name": "accessibleName",
@@ -387,7 +427,7 @@
387
427
  "type": {
388
428
  "text": "string"
389
429
  },
390
- "description": "String used to label the component to screen reader users.",
430
+ "description": "String used to label the component for screen reader users.",
391
431
  "attribute": "accessible-name",
392
432
  "inheritedFrom": {
393
433
  "name": "FieldMixin",
@@ -401,7 +441,7 @@
401
441
  "type": {
402
442
  "text": "string"
403
443
  },
404
- "description": "Id of the element used as label of the component to screen reader users.",
444
+ "description": "A space-separated list of IDs referencing the elements that\nlabel the component for screen reader users.",
405
445
  "attribute": "accessible-name-ref",
406
446
  "inheritedFrom": {
407
447
  "name": "FieldMixin",
@@ -587,12 +627,24 @@
587
627
  }
588
628
  ],
589
629
  "attributes": [
630
+ {
631
+ "name": "accessible-description-ref",
632
+ "type": {
633
+ "text": "string"
634
+ },
635
+ "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.",
636
+ "fieldName": "accessibleDescriptionRef",
637
+ "inheritedFrom": {
638
+ "name": "FieldMixin",
639
+ "package": "@vaadin/field-base/src/field-mixin.js"
640
+ }
641
+ },
590
642
  {
591
643
  "name": "accessible-name",
592
644
  "type": {
593
645
  "text": "string"
594
646
  },
595
- "description": "String used to label the component to screen reader users.",
647
+ "description": "String used to label the component for screen reader users.",
596
648
  "fieldName": "accessibleName",
597
649
  "inheritedFrom": {
598
650
  "name": "FieldMixin",
@@ -604,7 +656,7 @@
604
656
  "type": {
605
657
  "text": "string"
606
658
  },
607
- "description": "Id of the element used as label of the component to screen reader users.",
659
+ "description": "A space-separated list of IDs referencing the elements that\nlabel the component for screen reader users.",
608
660
  "fieldName": "accessibleNameRef",
609
661
  "inheritedFrom": {
610
662
  "name": "FieldMixin",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vaadin/checkbox-group",
3
- "version": "25.3.0-alpha8",
3
+ "version": "25.3.0-alpha9",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },
@@ -35,19 +35,19 @@
35
35
  ],
36
36
  "dependencies": {
37
37
  "@open-wc/dedupe-mixin": "^1.3.0",
38
- "@vaadin/a11y-base": "25.3.0-alpha8",
39
- "@vaadin/checkbox": "25.3.0-alpha8",
40
- "@vaadin/component-base": "25.3.0-alpha8",
41
- "@vaadin/field-base": "25.3.0-alpha8",
42
- "@vaadin/vaadin-themable-mixin": "25.3.0-alpha8",
38
+ "@vaadin/a11y-base": "25.3.0-alpha9",
39
+ "@vaadin/checkbox": "25.3.0-alpha9",
40
+ "@vaadin/component-base": "25.3.0-alpha9",
41
+ "@vaadin/field-base": "25.3.0-alpha9",
42
+ "@vaadin/vaadin-themable-mixin": "25.3.0-alpha9",
43
43
  "lit": "^3.0.0"
44
44
  },
45
45
  "devDependencies": {
46
- "@vaadin/aura": "25.3.0-alpha8",
47
- "@vaadin/chai-plugins": "25.3.0-alpha8",
48
- "@vaadin/test-runner-commands": "25.3.0-alpha8",
46
+ "@vaadin/aura": "25.3.0-alpha9",
47
+ "@vaadin/chai-plugins": "25.3.0-alpha9",
48
+ "@vaadin/test-runner-commands": "25.3.0-alpha9",
49
49
  "@vaadin/testing-helpers": "^2.0.0",
50
- "@vaadin/vaadin-lumo-styles": "25.3.0-alpha8",
50
+ "@vaadin/vaadin-lumo-styles": "25.3.0-alpha9",
51
51
  "sinon": "^22.0.0"
52
52
  },
53
53
  "customElements": "custom-elements.json",
@@ -55,5 +55,5 @@
55
55
  "web-types.json",
56
56
  "web-types.lit.json"
57
57
  ],
58
- "gitHead": "ccbb4aaffb63c745c6da0426b532d4d05e47af29"
58
+ "gitHead": "cb915ebde095ec5b94a87af93dd4530f51984c52"
59
59
  }
package/web-types.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "$schema": "https://json.schemastore.org/web-types",
3
3
  "name": "@vaadin/checkbox-group",
4
- "version": "25.3.0-alpha8",
4
+ "version": "25.3.0-alpha9",
5
5
  "description-markup": "markdown",
6
6
  "contributions": {
7
7
  "html": {
@@ -10,9 +10,18 @@
10
10
  "name": "vaadin-checkbox-group",
11
11
  "description": "`<vaadin-checkbox-group>` is a web component that allows the user to choose several items from a group of binary choices.\n\n```html\n<vaadin-checkbox-group label=\"Export data\">\n <vaadin-checkbox value=\"0\" label=\"Order ID\"></vaadin-checkbox>\n <vaadin-checkbox value=\"1\" label=\"Product name\"></vaadin-checkbox>\n <vaadin-checkbox value=\"2\" label=\"Customer\"></vaadin-checkbox>\n <vaadin-checkbox value=\"3\" label=\"Status\"></vaadin-checkbox>\n</vaadin-checkbox-group>\n```\n\n### Styling\n\nThe following shadow DOM parts are available for styling:\n\nPart name | Description\n---------------------|----------------\n`label` | The slotted label element wrapper\n`group-field` | The checkbox elements wrapper\n`helper-text` | The slotted helper text element wrapper\n`error-message` | The slotted error message element wrapper\n`required-indicator` | The `required` state indicator element\n\nThe following state attributes are available for styling:\n\nAttribute | Description\n--------------------|---------------------------------\n`disabled` | Set when the element is disabled\n`readonly` | Set when the element is readonly\n`invalid` | Set when the element is invalid\n`focused` | Set when the element is focused\n`has-label` | Set when the element has a label\n`has-value` | Set when the element has a value\n`has-helper` | Set when the element has helper text\n`has-error-message` | Set when the element has an error message\n`has-tooltip` | Set when the element has a slotted tooltip\n\nThe following custom CSS properties are available for styling:\n\nCustom CSS property |\n:--------------------------------------------------|\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-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-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-required-indicator-color` |\n| `--vaadin-input-field-required-indicator` |\n\nSee [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.",
12
12
  "attributes": [
13
+ {
14
+ "name": "accessible-description-ref",
15
+ "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.",
16
+ "value": {
17
+ "type": [
18
+ "string"
19
+ ]
20
+ }
21
+ },
13
22
  {
14
23
  "name": "accessible-name",
15
- "description": "String used to label the component to screen reader users.",
24
+ "description": "String used to label the component for screen reader users.",
16
25
  "value": {
17
26
  "type": [
18
27
  "string"
@@ -21,7 +30,7 @@
21
30
  },
22
31
  {
23
32
  "name": "accessible-name-ref",
24
- "description": "Id of the element used as label of the component to screen reader users.",
33
+ "description": "A space-separated list of IDs referencing the elements that\nlabel the component for screen reader users.",
25
34
  "value": {
26
35
  "type": [
27
36
  "string"
@@ -112,9 +121,18 @@
112
121
  ],
113
122
  "js": {
114
123
  "properties": [
124
+ {
125
+ "name": "accessibleDescriptionRef",
126
+ "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.",
127
+ "value": {
128
+ "type": [
129
+ "string"
130
+ ]
131
+ }
132
+ },
115
133
  {
116
134
  "name": "accessibleName",
117
- "description": "String used to label the component to screen reader users.",
135
+ "description": "String used to label the component for screen reader users.",
118
136
  "value": {
119
137
  "type": [
120
138
  "string"
@@ -123,7 +141,7 @@
123
141
  },
124
142
  {
125
143
  "name": "accessibleNameRef",
126
- "description": "Id of the element used as label of the component to screen reader users.",
144
+ "description": "A space-separated list of IDs referencing the elements that\nlabel the component for screen reader users.",
127
145
  "value": {
128
146
  "type": [
129
147
  "string"
package/web-types.lit.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "$schema": "https://json.schemastore.org/web-types",
3
3
  "name": "@vaadin/checkbox-group",
4
- "version": "25.3.0-alpha8",
4
+ "version": "25.3.0-alpha9",
5
5
  "description-markup": "markdown",
6
6
  "framework": "lit",
7
7
  "framework-config": {
@@ -19,16 +19,23 @@
19
19
  "description": "`<vaadin-checkbox-group>` is a web component that allows the user to choose several items from a group of binary choices.\n\n```html\n<vaadin-checkbox-group label=\"Export data\">\n <vaadin-checkbox value=\"0\" label=\"Order ID\"></vaadin-checkbox>\n <vaadin-checkbox value=\"1\" label=\"Product name\"></vaadin-checkbox>\n <vaadin-checkbox value=\"2\" label=\"Customer\"></vaadin-checkbox>\n <vaadin-checkbox value=\"3\" label=\"Status\"></vaadin-checkbox>\n</vaadin-checkbox-group>\n```\n\n### Styling\n\nThe following shadow DOM parts are available for styling:\n\nPart name | Description\n---------------------|----------------\n`label` | The slotted label element wrapper\n`group-field` | The checkbox elements wrapper\n`helper-text` | The slotted helper text element wrapper\n`error-message` | The slotted error message element wrapper\n`required-indicator` | The `required` state indicator element\n\nThe following state attributes are available for styling:\n\nAttribute | Description\n--------------------|---------------------------------\n`disabled` | Set when the element is disabled\n`readonly` | Set when the element is readonly\n`invalid` | Set when the element is invalid\n`focused` | Set when the element is focused\n`has-label` | Set when the element has a label\n`has-value` | Set when the element has a value\n`has-helper` | Set when the element has helper text\n`has-error-message` | Set when the element has an error message\n`has-tooltip` | Set when the element has a slotted tooltip\n\nThe following custom CSS properties are available for styling:\n\nCustom CSS property |\n:--------------------------------------------------|\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-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-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-required-indicator-color` |\n| `--vaadin-input-field-required-indicator` |\n\nSee [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.",
20
20
  "extension": true,
21
21
  "attributes": [
22
+ {
23
+ "name": ".accessibleDescriptionRef",
24
+ "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.",
25
+ "value": {
26
+ "kind": "expression"
27
+ }
28
+ },
22
29
  {
23
30
  "name": ".accessibleName",
24
- "description": "String used to label the component to screen reader users.",
31
+ "description": "String used to label the component for screen reader users.",
25
32
  "value": {
26
33
  "kind": "expression"
27
34
  }
28
35
  },
29
36
  {
30
37
  "name": ".accessibleNameRef",
31
- "description": "Id of the element used as label of the component to screen reader users.",
38
+ "description": "A space-separated list of IDs referencing the elements that\nlabel the component for screen reader users.",
32
39
  "value": {
33
40
  "kind": "expression"
34
41
  }