@vaadin/checkbox-group 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.
@@ -0,0 +1,467 @@
1
+ {
2
+ "schemaVersion": "1.0.0",
3
+ "readme": "",
4
+ "modules": [
5
+ {
6
+ "kind": "javascript-module",
7
+ "path": "vaadin-checkbox-group.js",
8
+ "declarations": [],
9
+ "exports": [
10
+ {
11
+ "kind": "js",
12
+ "name": "*",
13
+ "declaration": {
14
+ "name": "*",
15
+ "module": "src/vaadin-checkbox-group.js"
16
+ }
17
+ }
18
+ ]
19
+ },
20
+ {
21
+ "kind": "javascript-module",
22
+ "path": "src/vaadin-checkbox-group-mixin.js",
23
+ "declarations": [
24
+ {
25
+ "kind": "mixin",
26
+ "description": "A mixin providing common checkbox-group functionality.",
27
+ "name": "CheckboxGroupMixin",
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": "Override method inherited from `ValidateMixin`\nto validate the value array.",
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": "label",
98
+ "privacy": "public",
99
+ "type": {
100
+ "text": "string"
101
+ },
102
+ "description": "The label text for the input node.\nWhen no light dom defined via [slot=label], this value will be used.",
103
+ "attribute": "label",
104
+ "inheritedFrom": {
105
+ "name": "LabelMixin",
106
+ "package": "@vaadin/field-base/src/label-mixin.js"
107
+ }
108
+ },
109
+ {
110
+ "kind": "field",
111
+ "name": "readonly",
112
+ "privacy": "public",
113
+ "type": {
114
+ "text": "boolean"
115
+ },
116
+ "description": "When true, the user cannot modify the value of the checkbox group.\nThe difference between `disabled` and `readonly` is that in the\nread-only checkbox group, all the checkboxes are also read-only,\nand therefore remain focusable and announced by screen readers.",
117
+ "attribute": "readonly"
118
+ },
119
+ {
120
+ "kind": "field",
121
+ "name": "value",
122
+ "privacy": "public",
123
+ "type": {
124
+ "text": "!Array<!string>"
125
+ },
126
+ "description": "An array containing values of the currently checked checkboxes.\n\nThe array is immutable so toggling checkboxes always results in\ncreating a new array.",
127
+ "attribute": "value"
128
+ }
129
+ ],
130
+ "attributes": [
131
+ {
132
+ "name": "accessible-name",
133
+ "type": {
134
+ "text": "string"
135
+ },
136
+ "description": "String used to label the component to screen reader users.",
137
+ "fieldName": "accessibleName",
138
+ "inheritedFrom": {
139
+ "name": "FieldMixin",
140
+ "package": "@vaadin/field-base/src/field-mixin.js"
141
+ }
142
+ },
143
+ {
144
+ "name": "accessible-name-ref",
145
+ "type": {
146
+ "text": "string"
147
+ },
148
+ "description": "Id of the element used as label of the component to screen reader users.",
149
+ "fieldName": "accessibleNameRef",
150
+ "inheritedFrom": {
151
+ "name": "FieldMixin",
152
+ "package": "@vaadin/field-base/src/field-mixin.js"
153
+ }
154
+ },
155
+ {
156
+ "name": "error-message",
157
+ "type": {
158
+ "text": "string"
159
+ },
160
+ "description": "Error to show when the field is invalid.",
161
+ "fieldName": "errorMessage",
162
+ "inheritedFrom": {
163
+ "name": "FieldMixin",
164
+ "package": "@vaadin/field-base/src/field-mixin.js"
165
+ }
166
+ },
167
+ {
168
+ "name": "helper-text",
169
+ "type": {
170
+ "text": "string"
171
+ },
172
+ "description": "String used for the helper text.",
173
+ "fieldName": "helperText",
174
+ "inheritedFrom": {
175
+ "name": "FieldMixin",
176
+ "package": "@vaadin/field-base/src/field-mixin.js"
177
+ }
178
+ },
179
+ {
180
+ "name": "label",
181
+ "type": {
182
+ "text": "string"
183
+ },
184
+ "description": "The label text for the input node.\nWhen no light dom defined via [slot=label], this value will be used.",
185
+ "fieldName": "label",
186
+ "inheritedFrom": {
187
+ "name": "LabelMixin",
188
+ "package": "@vaadin/field-base/src/label-mixin.js"
189
+ }
190
+ },
191
+ {
192
+ "name": "readonly",
193
+ "type": {
194
+ "text": "boolean"
195
+ },
196
+ "description": "When true, the user cannot modify the value of the checkbox group.\nThe difference between `disabled` and `readonly` is that in the\nread-only checkbox group, all the checkboxes are also read-only,\nand therefore remain focusable and announced by screen readers.",
197
+ "fieldName": "readonly"
198
+ }
199
+ ],
200
+ "mixins": [
201
+ {
202
+ "name": "FieldMixin",
203
+ "package": "@vaadin/field-base/src/field-mixin.js"
204
+ },
205
+ {
206
+ "name": "FocusMixin",
207
+ "package": "@vaadin/a11y-base/src/focus-mixin.js"
208
+ },
209
+ {
210
+ "name": "DisabledMixin",
211
+ "package": "@vaadin/a11y-base/src/disabled-mixin.js"
212
+ }
213
+ ],
214
+ "parameters": [
215
+ {
216
+ "name": "superclass"
217
+ }
218
+ ]
219
+ }
220
+ ],
221
+ "exports": [
222
+ {
223
+ "kind": "js",
224
+ "name": "CheckboxGroupMixin",
225
+ "declaration": {
226
+ "name": "CheckboxGroupMixin",
227
+ "module": "src/vaadin-checkbox-group-mixin.js"
228
+ }
229
+ }
230
+ ]
231
+ },
232
+ {
233
+ "kind": "javascript-module",
234
+ "path": "src/vaadin-checkbox-group.js",
235
+ "declarations": [
236
+ {
237
+ "kind": "class",
238
+ "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.",
239
+ "name": "CheckboxGroup",
240
+ "members": [
241
+ {
242
+ "kind": "field",
243
+ "name": "accessibleName",
244
+ "privacy": "public",
245
+ "type": {
246
+ "text": "string"
247
+ },
248
+ "description": "String used to label the component to screen reader users.",
249
+ "attribute": "accessible-name",
250
+ "inheritedFrom": {
251
+ "name": "FieldMixin",
252
+ "package": "@vaadin/field-base/src/field-mixin.js"
253
+ }
254
+ },
255
+ {
256
+ "kind": "field",
257
+ "name": "accessibleNameRef",
258
+ "privacy": "public",
259
+ "type": {
260
+ "text": "string"
261
+ },
262
+ "description": "Id of the element used as label of the component to screen reader users.",
263
+ "attribute": "accessible-name-ref",
264
+ "inheritedFrom": {
265
+ "name": "FieldMixin",
266
+ "package": "@vaadin/field-base/src/field-mixin.js"
267
+ }
268
+ },
269
+ {
270
+ "kind": "method",
271
+ "name": "checkValidity",
272
+ "description": "Override method inherited from `ValidateMixin`\nto validate the value array.",
273
+ "return": {
274
+ "type": {
275
+ "text": "boolean"
276
+ }
277
+ },
278
+ "inheritedFrom": {
279
+ "name": "CheckboxGroupMixin",
280
+ "module": "src/vaadin-checkbox-group-mixin.js"
281
+ }
282
+ },
283
+ {
284
+ "kind": "field",
285
+ "name": "errorMessage",
286
+ "privacy": "public",
287
+ "type": {
288
+ "text": "string"
289
+ },
290
+ "description": "Error to show when the field is invalid.",
291
+ "attribute": "error-message",
292
+ "inheritedFrom": {
293
+ "name": "FieldMixin",
294
+ "package": "@vaadin/field-base/src/field-mixin.js"
295
+ }
296
+ },
297
+ {
298
+ "kind": "field",
299
+ "name": "helperText",
300
+ "privacy": "public",
301
+ "type": {
302
+ "text": "string"
303
+ },
304
+ "description": "String used for the helper text.",
305
+ "attribute": "helper-text",
306
+ "inheritedFrom": {
307
+ "name": "FieldMixin",
308
+ "package": "@vaadin/field-base/src/field-mixin.js"
309
+ }
310
+ },
311
+ {
312
+ "kind": "field",
313
+ "name": "readonly",
314
+ "privacy": "public",
315
+ "type": {
316
+ "text": "boolean"
317
+ },
318
+ "description": "When true, the user cannot modify the value of the checkbox group.\nThe difference between `disabled` and `readonly` is that in the\nread-only checkbox group, all the checkboxes are also read-only,\nand therefore remain focusable and announced by screen readers.",
319
+ "attribute": "readonly",
320
+ "inheritedFrom": {
321
+ "name": "CheckboxGroupMixin",
322
+ "module": "src/vaadin-checkbox-group-mixin.js"
323
+ }
324
+ },
325
+ {
326
+ "kind": "field",
327
+ "name": "value",
328
+ "privacy": "public",
329
+ "type": {
330
+ "text": "!Array<!string>"
331
+ },
332
+ "description": "An array containing values of the currently checked checkboxes.\n\nThe array is immutable so toggling checkboxes always results in\ncreating a new array.",
333
+ "attribute": "value",
334
+ "inheritedFrom": {
335
+ "name": "CheckboxGroupMixin",
336
+ "module": "src/vaadin-checkbox-group-mixin.js"
337
+ }
338
+ }
339
+ ],
340
+ "events": [
341
+ {
342
+ "type": {
343
+ "text": "CustomEvent"
344
+ },
345
+ "description": "Fired when the `invalid` property changes.",
346
+ "name": "invalid-changed"
347
+ },
348
+ {
349
+ "type": {
350
+ "text": "CustomEvent"
351
+ },
352
+ "description": "Fired whenever the field is validated.",
353
+ "name": "validated"
354
+ },
355
+ {
356
+ "type": {
357
+ "text": "CustomEvent"
358
+ },
359
+ "description": "Fired when the `value` property changes.",
360
+ "name": "value-changed"
361
+ }
362
+ ],
363
+ "mixins": [
364
+ {
365
+ "name": "CheckboxGroupMixin",
366
+ "module": "src/vaadin-checkbox-group-mixin.js"
367
+ },
368
+ {
369
+ "name": "ElementMixin",
370
+ "package": "@vaadin/component-base/src/element-mixin.js"
371
+ },
372
+ {
373
+ "name": "ThemableMixin",
374
+ "package": "@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js"
375
+ },
376
+ {
377
+ "name": "PolylitMixin",
378
+ "package": "@vaadin/component-base/src/polylit-mixin.js"
379
+ },
380
+ {
381
+ "name": "LumoInjectionMixin",
382
+ "package": "@vaadin/vaadin-themable-mixin/lumo-injection-mixin.js"
383
+ }
384
+ ],
385
+ "superclass": {
386
+ "name": "LitElement",
387
+ "package": "lit"
388
+ },
389
+ "tagName": "vaadin-checkbox-group",
390
+ "customElement": true,
391
+ "attributes": [
392
+ {
393
+ "name": "accessible-name",
394
+ "type": {
395
+ "text": "string"
396
+ },
397
+ "description": "String used to label the component to screen reader users.",
398
+ "fieldName": "accessibleName",
399
+ "inheritedFrom": {
400
+ "name": "FieldMixin",
401
+ "package": "@vaadin/field-base/src/field-mixin.js"
402
+ }
403
+ },
404
+ {
405
+ "name": "accessible-name-ref",
406
+ "type": {
407
+ "text": "string"
408
+ },
409
+ "description": "Id of the element used as label of the component to screen reader users.",
410
+ "fieldName": "accessibleNameRef",
411
+ "inheritedFrom": {
412
+ "name": "FieldMixin",
413
+ "package": "@vaadin/field-base/src/field-mixin.js"
414
+ }
415
+ },
416
+ {
417
+ "name": "error-message",
418
+ "type": {
419
+ "text": "string"
420
+ },
421
+ "description": "Error to show when the field is invalid.",
422
+ "fieldName": "errorMessage",
423
+ "inheritedFrom": {
424
+ "name": "FieldMixin",
425
+ "package": "@vaadin/field-base/src/field-mixin.js"
426
+ }
427
+ },
428
+ {
429
+ "name": "helper-text",
430
+ "type": {
431
+ "text": "string"
432
+ },
433
+ "description": "String used for the helper text.",
434
+ "fieldName": "helperText",
435
+ "inheritedFrom": {
436
+ "name": "FieldMixin",
437
+ "package": "@vaadin/field-base/src/field-mixin.js"
438
+ }
439
+ },
440
+ {
441
+ "name": "readonly",
442
+ "type": {
443
+ "text": "boolean"
444
+ },
445
+ "description": "When true, the user cannot modify the value of the checkbox group.\nThe difference between `disabled` and `readonly` is that in the\nread-only checkbox group, all the checkboxes are also read-only,\nand therefore remain focusable and announced by screen readers.",
446
+ "fieldName": "readonly",
447
+ "inheritedFrom": {
448
+ "name": "CheckboxGroupMixin",
449
+ "module": "src/vaadin-checkbox-group-mixin.js"
450
+ }
451
+ }
452
+ ]
453
+ }
454
+ ],
455
+ "exports": [
456
+ {
457
+ "kind": "js",
458
+ "name": "CheckboxGroup",
459
+ "declaration": {
460
+ "name": "CheckboxGroup",
461
+ "module": "src/vaadin-checkbox-group.js"
462
+ }
463
+ }
464
+ ]
465
+ }
466
+ ]
467
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vaadin/checkbox-group",
3
- "version": "25.1.0-alpha6",
3
+ "version": "25.1.0-alpha7",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },
@@ -23,6 +23,7 @@
23
23
  "src",
24
24
  "vaadin-*.d.ts",
25
25
  "vaadin-*.js",
26
+ "custom-elements.json",
26
27
  "web-types.json",
27
28
  "web-types.lit.json"
28
29
  ],
@@ -34,24 +35,25 @@
34
35
  ],
35
36
  "dependencies": {
36
37
  "@open-wc/dedupe-mixin": "^1.3.0",
37
- "@vaadin/a11y-base": "25.1.0-alpha6",
38
- "@vaadin/checkbox": "25.1.0-alpha6",
39
- "@vaadin/component-base": "25.1.0-alpha6",
40
- "@vaadin/field-base": "25.1.0-alpha6",
41
- "@vaadin/vaadin-themable-mixin": "25.1.0-alpha6",
38
+ "@vaadin/a11y-base": "25.1.0-alpha7",
39
+ "@vaadin/checkbox": "25.1.0-alpha7",
40
+ "@vaadin/component-base": "25.1.0-alpha7",
41
+ "@vaadin/field-base": "25.1.0-alpha7",
42
+ "@vaadin/vaadin-themable-mixin": "25.1.0-alpha7",
42
43
  "lit": "^3.0.0"
43
44
  },
44
45
  "devDependencies": {
45
- "@vaadin/aura": "25.1.0-alpha6",
46
- "@vaadin/chai-plugins": "25.1.0-alpha6",
47
- "@vaadin/test-runner-commands": "25.1.0-alpha6",
46
+ "@vaadin/aura": "25.1.0-alpha7",
47
+ "@vaadin/chai-plugins": "25.1.0-alpha7",
48
+ "@vaadin/test-runner-commands": "25.1.0-alpha7",
48
49
  "@vaadin/testing-helpers": "^2.0.0",
49
- "@vaadin/vaadin-lumo-styles": "25.1.0-alpha6",
50
+ "@vaadin/vaadin-lumo-styles": "25.1.0-alpha7",
50
51
  "sinon": "^21.0.0"
51
52
  },
53
+ "customElements": "custom-elements.json",
52
54
  "web-types": [
53
55
  "web-types.json",
54
56
  "web-types.lit.json"
55
57
  ],
56
- "gitHead": "da6f4194492cbd77d18c6c1cd8d4d9f072e9ce8d"
58
+ "gitHead": "98c586125f769c8fefd307536965293668fda81d"
57
59
  }
@@ -76,7 +76,7 @@ import { CheckboxGroupMixin } from './vaadin-checkbox-group-mixin.js';
76
76
  * @fires {CustomEvent} value-changed - Fired when the `value` property changes.
77
77
  * @fires {CustomEvent} validated - Fired whenever the field is validated.
78
78
  *
79
- * @customElement
79
+ * @customElement vaadin-checkbox-group
80
80
  * @extends HTMLElement
81
81
  * @mixes ThemableMixin
82
82
  * @mixes ElementMixin
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.1.0-alpha6",
4
+ "version": "25.1.0-alpha7",
5
5
  "description-markup": "markdown",
6
6
  "contributions": {
7
7
  "html": {
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "$schema": "https://json.schemastore.org/web-types",
3
3
  "name": "@vaadin/checkbox-group",
4
- "version": "25.1.0-alpha6",
4
+ "version": "25.1.0-alpha7",
5
5
  "description-markup": "markdown",
6
6
  "framework": "lit",
7
7
  "framework-config": {