@momentum-design/components 0.100.1 → 0.100.2

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 (46) hide show
  1. package/dist/browser/index.js +1370 -1142
  2. package/dist/browser/index.js.map +4 -4
  3. package/dist/components/accordion/accordion.component.d.ts +74 -0
  4. package/dist/components/accordion/accordion.component.js +128 -0
  5. package/dist/components/accordion/accordion.constants.d.ts +2 -0
  6. package/dist/components/accordion/accordion.constants.js +3 -0
  7. package/dist/components/accordion/accordion.styles.d.ts +2 -0
  8. package/dist/components/accordion/accordion.styles.js +17 -0
  9. package/dist/components/accordion/index.d.ts +10 -0
  10. package/dist/components/accordion/index.js +7 -0
  11. package/dist/components/accordionbutton/accordionbutton.component.d.ts +119 -0
  12. package/dist/components/accordionbutton/accordionbutton.component.js +238 -0
  13. package/dist/components/accordionbutton/accordionbutton.constants.d.ts +17 -0
  14. package/dist/components/accordionbutton/accordionbutton.constants.js +19 -0
  15. package/dist/components/accordionbutton/accordionbutton.styles.d.ts +2 -0
  16. package/dist/components/accordionbutton/accordionbutton.styles.js +121 -0
  17. package/dist/components/accordionbutton/accordionbutton.types.d.ts +8 -0
  18. package/dist/components/accordionbutton/accordionbutton.types.js +1 -0
  19. package/dist/components/accordionbutton/index.d.ts +10 -0
  20. package/dist/components/accordionbutton/index.js +7 -0
  21. package/dist/components/accordiongroup/accordiongroup.component.d.ts +71 -0
  22. package/dist/components/accordiongroup/accordiongroup.component.js +132 -0
  23. package/dist/components/accordiongroup/accordiongroup.constants.d.ts +15 -0
  24. package/dist/components/accordiongroup/accordiongroup.constants.js +16 -0
  25. package/dist/components/accordiongroup/accordiongroup.styles.d.ts +2 -0
  26. package/dist/components/accordiongroup/accordiongroup.styles.js +48 -0
  27. package/dist/components/accordiongroup/accordiongroup.types.d.ts +5 -0
  28. package/dist/components/accordiongroup/accordiongroup.types.js +1 -0
  29. package/dist/components/accordiongroup/index.d.ts +7 -0
  30. package/dist/components/accordiongroup/index.js +4 -0
  31. package/dist/custom-elements.json +1455 -489
  32. package/dist/index.d.ts +10 -7
  33. package/dist/index.js +10 -7
  34. package/dist/react/accordion/index.d.ts +53 -0
  35. package/dist/react/accordion/index.js +61 -0
  36. package/dist/react/accordionbutton/index.d.ts +50 -0
  37. package/dist/react/accordionbutton/index.js +58 -0
  38. package/dist/react/accordiongroup/index.d.ts +30 -0
  39. package/dist/react/accordiongroup/index.js +39 -0
  40. package/dist/react/index.d.ts +6 -3
  41. package/dist/react/index.js +6 -3
  42. package/dist/utils/keys.d.ts +1 -0
  43. package/dist/utils/keys.js +1 -0
  44. package/dist/utils/roles.d.ts +2 -0
  45. package/dist/utils/roles.js +2 -0
  46. package/package.json +1 -1
@@ -2,6 +2,972 @@
2
2
  "schemaVersion": "1.0.0",
3
3
  "readme": "",
4
4
  "modules": [
5
+ {
6
+ "kind": "javascript-module",
7
+ "path": "components/accordion/accordion.component.js",
8
+ "declarations": [
9
+ {
10
+ "kind": "class",
11
+ "description": "An accordion contains a header and body section with a focusable heading that can be expanded or collapsed.\n\nThe header section contains:\n- Prefix Icon\n- Header Text\n- Leading Slot - Contains the leading controls of the accordion on the header section. This will be placed on the leading side, after the header text.\n- Trailing Slot - Contains the trailing controls of the accordion on the header section. This will be placed on the trailing side, before the expand/collapse button.\n\nThe body section contains:\n- Default slot - User can place any content inside the body section.\n\nThe accordion can be expanded or collapsed. The visibility of the body section can be controlled by `expanded` attribute. <br/>\nThere are two types of variants based on that the border styling of the accordion gets reflected. <br/>\nThere are two sizes of accordion, one is small and the other is large.\nSmall size has a padding of 1rem (16px) and large size has a padding of 1.5rem (24px) for the body section of accordion.\n\nBy default, the header text in the accordion heading is of H3 with an aria-level of '3'.\nIf this accordion is placed on any other level in the entire webpage, then do adjust the aria-level number based on that.\n\nAn accordion can be disabled, and when it's disabled, the header section will not be clickable.\n\nIf you don't need any controls on your accordion heading, then it's advised to use `accordionbutton` component.",
12
+ "name": "Accordion",
13
+ "cssProperties": [
14
+ {
15
+ "description": "The border color of the accordion.",
16
+ "name": "--mdc-accordionbutton-border-color",
17
+ "inheritedFrom": {
18
+ "name": "AccordionButton",
19
+ "module": "src/components/accordionbutton/accordionbutton.component.ts"
20
+ }
21
+ },
22
+ {
23
+ "description": "The hover color of the accordion.",
24
+ "name": "--mdc-accordionbutton-hover-color",
25
+ "inheritedFrom": {
26
+ "name": "AccordionButton",
27
+ "module": "src/components/accordionbutton/accordionbutton.component.ts"
28
+ }
29
+ },
30
+ {
31
+ "description": "The active color of the accordion.",
32
+ "name": "--mdc-accordionbutton-active-color",
33
+ "inheritedFrom": {
34
+ "name": "AccordionButton",
35
+ "module": "src/components/accordionbutton/accordionbutton.component.ts"
36
+ }
37
+ },
38
+ {
39
+ "description": "The disabled color of the accordion.",
40
+ "name": "--mdc-accordionbutton-disabled-color",
41
+ "inheritedFrom": {
42
+ "name": "AccordionButton",
43
+ "module": "src/components/accordionbutton/accordionbutton.component.ts"
44
+ }
45
+ }
46
+ ],
47
+ "cssParts": [
48
+ {
49
+ "description": "The header section of the accordion.",
50
+ "name": "header-section",
51
+ "inheritedFrom": {
52
+ "name": "AccordionButton",
53
+ "module": "src/components/accordionbutton/accordionbutton.component.ts"
54
+ }
55
+ },
56
+ {
57
+ "description": "The leading header of the accordion.",
58
+ "name": "leading-header",
59
+ "inheritedFrom": {
60
+ "name": "AccordionButton",
61
+ "module": "src/components/accordionbutton/accordionbutton.component.ts"
62
+ }
63
+ },
64
+ {
65
+ "description": "The trailing header of the accordion.",
66
+ "name": "trailing-header",
67
+ "inheritedFrom": {
68
+ "name": "AccordionButton",
69
+ "module": "src/components/accordionbutton/accordionbutton.component.ts"
70
+ }
71
+ },
72
+ {
73
+ "description": "The trailing header button of the accordion.",
74
+ "name": "trailing-header__button"
75
+ },
76
+ {
77
+ "description": "The body section of the accordion.",
78
+ "name": "body-section",
79
+ "inheritedFrom": {
80
+ "name": "AccordionButton",
81
+ "module": "src/components/accordionbutton/accordionbutton.component.ts"
82
+ }
83
+ },
84
+ {
85
+ "description": "The header button section of the accordion button.",
86
+ "name": "header-button-section",
87
+ "inheritedFrom": {
88
+ "name": "AccordionButton",
89
+ "module": "src/components/accordionbutton/accordionbutton.component.ts"
90
+ }
91
+ },
92
+ {
93
+ "description": "The trailing header icon of the accordion button.",
94
+ "name": "trailing-header__icon",
95
+ "inheritedFrom": {
96
+ "name": "AccordionButton",
97
+ "module": "src/components/accordionbutton/accordionbutton.component.ts"
98
+ }
99
+ }
100
+ ],
101
+ "slots": [
102
+ {
103
+ "description": "The leading controls slot of the accordion on the header section.",
104
+ "name": "leading-controls"
105
+ },
106
+ {
107
+ "description": "The trailing controls slot of the accordion on the header section.",
108
+ "name": "trailing-controls"
109
+ },
110
+ {
111
+ "description": "The default slot contains the body section of the accordion. User can place anything inside this body slot.",
112
+ "name": "default",
113
+ "inheritedFrom": {
114
+ "name": "AccordionButton",
115
+ "module": "src/components/accordionbutton/accordionbutton.component.ts"
116
+ }
117
+ }
118
+ ],
119
+ "members": [
120
+ {
121
+ "kind": "method",
122
+ "name": "renderHeader",
123
+ "privacy": "protected",
124
+ "return": {
125
+ "type": {
126
+ "text": ""
127
+ }
128
+ },
129
+ "description": "Renders the header section of the accordion.\nThis includes the leading icon, text and controls, and the trailing controls.\nThe trailing controls include the expand/collapse button.\nThe button is disabled if the accordion is disabled.\nThe button is also given the aria-controls attribute set to the id of the body section.\nThe button is also given the aria-expanded attribute set to the expanded state of the accordion.\nThe prefix icon of the button is set to the expanded state of the accordion.",
130
+ "inheritedFrom": {
131
+ "name": "AccordionButton",
132
+ "module": "components/accordionbutton/accordionbutton.component.js"
133
+ }
134
+ },
135
+ {
136
+ "kind": "field",
137
+ "name": "disabled",
138
+ "type": {
139
+ "text": "boolean | undefined"
140
+ },
141
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
142
+ "default": "undefined",
143
+ "attribute": "disabled",
144
+ "reflects": true,
145
+ "inheritedFrom": {
146
+ "name": "DisabledMixin",
147
+ "module": "utils/mixins/DisabledMixin.js"
148
+ }
149
+ },
150
+ {
151
+ "kind": "field",
152
+ "name": "size",
153
+ "type": {
154
+ "text": "Size"
155
+ },
156
+ "description": "The size of the accordion item.",
157
+ "default": "'small'",
158
+ "attribute": "size",
159
+ "reflects": true,
160
+ "inheritedFrom": {
161
+ "name": "AccordionButton",
162
+ "module": "components/accordionbutton/accordionbutton.component.js"
163
+ }
164
+ },
165
+ {
166
+ "kind": "field",
167
+ "name": "variant",
168
+ "type": {
169
+ "text": "Variant"
170
+ },
171
+ "description": "The variant of the accordion item. Based on the variant, the styling of the accordion gets changed.",
172
+ "default": "'default'",
173
+ "attribute": "variant",
174
+ "reflects": true,
175
+ "inheritedFrom": {
176
+ "name": "AccordionButton",
177
+ "module": "components/accordionbutton/accordionbutton.component.js"
178
+ }
179
+ },
180
+ {
181
+ "kind": "field",
182
+ "name": "dataAriaLevel",
183
+ "type": {
184
+ "text": "number"
185
+ },
186
+ "description": "The aria level of the accordion component.",
187
+ "default": "3",
188
+ "attribute": "data-aria-level",
189
+ "reflects": true,
190
+ "inheritedFrom": {
191
+ "name": "AccordionButton",
192
+ "module": "components/accordionbutton/accordionbutton.component.js"
193
+ }
194
+ },
195
+ {
196
+ "kind": "field",
197
+ "name": "expanded",
198
+ "type": {
199
+ "text": "boolean"
200
+ },
201
+ "description": "The visibility of the accordion button.",
202
+ "default": "false",
203
+ "attribute": "expanded",
204
+ "reflects": true,
205
+ "inheritedFrom": {
206
+ "name": "AccordionButton",
207
+ "module": "components/accordionbutton/accordionbutton.component.js"
208
+ }
209
+ },
210
+ {
211
+ "kind": "field",
212
+ "name": "headerText",
213
+ "type": {
214
+ "text": "string | undefined"
215
+ },
216
+ "description": "The header text of the accordion item.",
217
+ "attribute": "header-text",
218
+ "reflects": true,
219
+ "inheritedFrom": {
220
+ "name": "AccordionButton",
221
+ "module": "components/accordionbutton/accordionbutton.component.js"
222
+ }
223
+ },
224
+ {
225
+ "kind": "field",
226
+ "name": "prefixIcon",
227
+ "type": {
228
+ "text": "IconNames | undefined"
229
+ },
230
+ "description": "The leading icon that is displayed before the header text.",
231
+ "attribute": "prefix-icon",
232
+ "inheritedFrom": {
233
+ "name": "AccordionButton",
234
+ "module": "components/accordionbutton/accordionbutton.component.js"
235
+ }
236
+ },
237
+ {
238
+ "kind": "method",
239
+ "name": "handleHeaderClick",
240
+ "privacy": "protected",
241
+ "return": {
242
+ "type": {
243
+ "text": "void"
244
+ }
245
+ },
246
+ "description": "Handles the click event of the header section.\nIf the accordion is disabled, it will not toggle the expanded state.\nIt will dispatch the `shown` event with the current expanded state.",
247
+ "inheritedFrom": {
248
+ "name": "AccordionButton",
249
+ "module": "components/accordionbutton/accordionbutton.component.js"
250
+ }
251
+ },
252
+ {
253
+ "kind": "method",
254
+ "name": "dispatchHeaderClickEvent",
255
+ "privacy": "private",
256
+ "return": {
257
+ "type": {
258
+ "text": "void"
259
+ }
260
+ },
261
+ "description": "Dispatches the `shown` event with the current expanded state.\nThe event is cancelable and bubbles.\nThe event detail contains the current expanded state.",
262
+ "inheritedFrom": {
263
+ "name": "AccordionButton",
264
+ "module": "components/accordionbutton/accordionbutton.component.js"
265
+ }
266
+ },
267
+ {
268
+ "kind": "method",
269
+ "name": "handleKeyDown",
270
+ "privacy": "private",
271
+ "return": {
272
+ "type": {
273
+ "text": "void"
274
+ }
275
+ },
276
+ "parameters": [
277
+ {
278
+ "name": "event",
279
+ "type": {
280
+ "text": "KeyboardEvent"
281
+ },
282
+ "description": "The KeyboardEvent fired."
283
+ }
284
+ ],
285
+ "description": "Handles the keydown event of the component.\nIf the key pressed is either Enter or Space, it calls the handleHeaderClick method.\nThis allows keyboard users to toggle the accordion button using these keys.",
286
+ "inheritedFrom": {
287
+ "name": "AccordionButton",
288
+ "module": "components/accordionbutton/accordionbutton.component.js"
289
+ }
290
+ },
291
+ {
292
+ "kind": "method",
293
+ "name": "renderIcon",
294
+ "privacy": "protected",
295
+ "return": {
296
+ "type": {
297
+ "text": "TemplateResult | typeof nothing"
298
+ }
299
+ },
300
+ "parameters": [
301
+ {
302
+ "name": "iconName",
303
+ "optional": true,
304
+ "type": {
305
+ "text": "IconNames"
306
+ }
307
+ }
308
+ ],
309
+ "inheritedFrom": {
310
+ "name": "AccordionButton",
311
+ "module": "components/accordionbutton/accordionbutton.component.js"
312
+ }
313
+ },
314
+ {
315
+ "kind": "method",
316
+ "name": "renderHeadingText",
317
+ "privacy": "protected",
318
+ "return": {
319
+ "type": {
320
+ "text": "TemplateResult | typeof nothing"
321
+ }
322
+ },
323
+ "inheritedFrom": {
324
+ "name": "AccordionButton",
325
+ "module": "components/accordionbutton/accordionbutton.component.js"
326
+ }
327
+ },
328
+ {
329
+ "kind": "method",
330
+ "name": "getArrowIconName",
331
+ "privacy": "protected",
332
+ "return": {
333
+ "type": {
334
+ "text": ""
335
+ }
336
+ },
337
+ "description": "Returns the icon name based on the expanded state.\nIf the accordion button is disabled, it always returns the arrow down icon.\nOtherwise, it returns the arrow up icon if the accordion button is expanded, otherwise the arrow down icon.",
338
+ "inheritedFrom": {
339
+ "name": "AccordionButton",
340
+ "module": "components/accordionbutton/accordionbutton.component.js"
341
+ }
342
+ },
343
+ {
344
+ "kind": "method",
345
+ "name": "renderBody",
346
+ "privacy": "protected",
347
+ "return": {
348
+ "type": {
349
+ "text": "TemplateResult | typeof nothing"
350
+ }
351
+ },
352
+ "inheritedFrom": {
353
+ "name": "AccordionButton",
354
+ "module": "components/accordionbutton/accordionbutton.component.js"
355
+ }
356
+ }
357
+ ],
358
+ "events": [
359
+ {
360
+ "description": "(React: onShown) This event is triggered when the accordion is expanded.",
361
+ "name": "shown",
362
+ "reactName": "onShown",
363
+ "inheritedFrom": {
364
+ "name": "AccordionButton",
365
+ "module": "src/components/accordionbutton/accordionbutton.component.ts"
366
+ }
367
+ }
368
+ ],
369
+ "superclass": {
370
+ "name": "AccordionButton",
371
+ "module": "/src/components/accordionbutton/accordionbutton.component"
372
+ },
373
+ "tagName": "mdc-accordion",
374
+ "jsDoc": "/**\n * An accordion contains a header and body section with a focusable heading that can be expanded or collapsed.\n *\n * The header section contains:\n * - Prefix Icon\n * - Header Text\n * - Leading Slot - Contains the leading controls of the accordion on the header section. This will be placed on the leading side, after the header text.\n * - Trailing Slot - Contains the trailing controls of the accordion on the header section. This will be placed on the trailing side, before the expand/collapse button.\n *\n * The body section contains:\n * - Default slot - User can place any content inside the body section.\n *\n * The accordion can be expanded or collapsed. The visibility of the body section can be controlled by `expanded` attribute. <br/>\n * There are two types of variants based on that the border styling of the accordion gets reflected. <br/>\n * There are two sizes of accordion, one is small and the other is large.\n * Small size has a padding of 1rem (16px) and large size has a padding of 1.5rem (24px) for the body section of accordion.\n *\n * By default, the header text in the accordion heading is of H3 with an aria-level of '3'.\n * If this accordion is placed on any other level in the entire webpage, then do adjust the aria-level number based on that.\n *\n * An accordion can be disabled, and when it's disabled, the header section will not be clickable.\n *\n * If you don't need any controls on your accordion heading, then it's advised to use `accordionbutton` component.\n *\n * @tagname mdc-accordion\n *\n * @dependency mdc-button\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @slot leading-controls - The leading controls slot of the accordion on the header section.\n * @slot trailing-controls - The trailing controls slot of the accordion on the header section.\n * @slot default - The default slot contains the body section of the accordion. User can place anything inside this body slot.\n *\n * @event shown - (React: onShown) This event is triggered when the accordion is expanded.\n *\n * @cssproperty --mdc-accordionbutton-border-color - The border color of the accordion.\n * @cssproperty --mdc-accordionbutton-hover-color - The hover color of the accordion.\n * @cssproperty --mdc-accordionbutton-active-color - The active color of the accordion.\n * @cssproperty --mdc-accordionbutton-disabled-color - The disabled color of the accordion.\n *\n * @csspart header-section - The header section of the accordion.\n * @csspart leading-header - The leading header of the accordion.\n * @csspart trailing-header - The trailing header of the accordion.\n * @csspart trailing-header__button - The trailing header button of the accordion.\n * @csspart body-section - The body section of the accordion.\n */",
375
+ "customElement": true,
376
+ "attributes": [
377
+ {
378
+ "name": "disabled",
379
+ "type": {
380
+ "text": "boolean | undefined"
381
+ },
382
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
383
+ "default": "undefined",
384
+ "fieldName": "disabled",
385
+ "inheritedFrom": {
386
+ "name": "DisabledMixin",
387
+ "module": "src/utils/mixins/DisabledMixin.ts"
388
+ }
389
+ },
390
+ {
391
+ "name": "size",
392
+ "type": {
393
+ "text": "Size"
394
+ },
395
+ "description": "The size of the accordion item.",
396
+ "default": "'small'",
397
+ "fieldName": "size",
398
+ "inheritedFrom": {
399
+ "name": "AccordionButton",
400
+ "module": "src/components/accordionbutton/accordionbutton.component.ts"
401
+ }
402
+ },
403
+ {
404
+ "name": "variant",
405
+ "type": {
406
+ "text": "Variant"
407
+ },
408
+ "description": "The variant of the accordion item. Based on the variant, the styling of the accordion gets changed.",
409
+ "default": "'default'",
410
+ "fieldName": "variant",
411
+ "inheritedFrom": {
412
+ "name": "AccordionButton",
413
+ "module": "src/components/accordionbutton/accordionbutton.component.ts"
414
+ }
415
+ },
416
+ {
417
+ "name": "data-aria-level",
418
+ "type": {
419
+ "text": "number"
420
+ },
421
+ "description": "The aria level of the accordion component.",
422
+ "default": "3",
423
+ "fieldName": "dataAriaLevel",
424
+ "inheritedFrom": {
425
+ "name": "AccordionButton",
426
+ "module": "src/components/accordionbutton/accordionbutton.component.ts"
427
+ }
428
+ },
429
+ {
430
+ "name": "expanded",
431
+ "type": {
432
+ "text": "boolean"
433
+ },
434
+ "description": "The visibility of the accordion button.",
435
+ "default": "false",
436
+ "fieldName": "expanded",
437
+ "inheritedFrom": {
438
+ "name": "AccordionButton",
439
+ "module": "src/components/accordionbutton/accordionbutton.component.ts"
440
+ }
441
+ },
442
+ {
443
+ "name": "header-text",
444
+ "type": {
445
+ "text": "string | undefined"
446
+ },
447
+ "description": "The header text of the accordion item.",
448
+ "fieldName": "headerText",
449
+ "inheritedFrom": {
450
+ "name": "AccordionButton",
451
+ "module": "src/components/accordionbutton/accordionbutton.component.ts"
452
+ }
453
+ },
454
+ {
455
+ "name": "prefix-icon",
456
+ "type": {
457
+ "text": "IconNames | undefined"
458
+ },
459
+ "description": "The leading icon that is displayed before the header text.",
460
+ "fieldName": "prefixIcon",
461
+ "inheritedFrom": {
462
+ "name": "AccordionButton",
463
+ "module": "src/components/accordionbutton/accordionbutton.component.ts"
464
+ }
465
+ }
466
+ ]
467
+ }
468
+ ],
469
+ "exports": [
470
+ {
471
+ "kind": "js",
472
+ "name": "default",
473
+ "declaration": {
474
+ "name": "Accordion",
475
+ "module": "components/accordion/accordion.component.js"
476
+ }
477
+ }
478
+ ]
479
+ },
480
+ {
481
+ "kind": "javascript-module",
482
+ "path": "components/accordionbutton/accordionbutton.component.js",
483
+ "declarations": [
484
+ {
485
+ "kind": "class",
486
+ "description": "An accordion button contains a header and body section with optional slots inside the heading which are focusable.\n\nThe header section contains:\n- Prefix Icon\n- Header Text\n\nThe body section contains:\n- Default slot - User can place any content inside the body section.\n\nThe accordion button can be expanded or collapsed. The visibility of the body section can be controlled by `expanded` attribute. <br/>\nThere are two types of variants based on that the border styling of the accordion gets reflected. <br/>\nThere are two sizes of accordion, one is small and the other is large.\nSmall size has a padding of 1rem (16px) and large size has a padding of 1.5rem (24px) for the body section of accordion.\n\nBy default, the header text in the accordion heading is of H3 with an aria-level of '3'.\nIf this accordion is placed on any other level in the entire webpage, then do adjust the aria-level number based on that.\n\nAn accordion can be disabled, and when it's disabled, the header section will not be clickable.\n\nIf you do need any controls on your accordion heading, then it's advised to use `accordion` component.",
487
+ "name": "AccordionButton",
488
+ "cssProperties": [
489
+ {
490
+ "description": "The border color of the accordion button.",
491
+ "name": "--mdc-accordionbutton-border-color"
492
+ },
493
+ {
494
+ "description": "The hover color of the accordion button.",
495
+ "name": "--mdc-accordionbutton-hover-color"
496
+ },
497
+ {
498
+ "description": "The active color of the accordion button.",
499
+ "name": "--mdc-accordionbutton-active-color"
500
+ },
501
+ {
502
+ "description": "The disabled color of the accordion button.",
503
+ "name": "--mdc-accordionbutton-disabled-color"
504
+ }
505
+ ],
506
+ "cssParts": [
507
+ {
508
+ "description": "The header section of the accordion button.",
509
+ "name": "header-section"
510
+ },
511
+ {
512
+ "description": "The header button section of the accordion button.",
513
+ "name": "header-button-section"
514
+ },
515
+ {
516
+ "description": "The leading header of the accordion button.",
517
+ "name": "leading-header"
518
+ },
519
+ {
520
+ "description": "The trailing header of the accordion button.",
521
+ "name": "trailing-header"
522
+ },
523
+ {
524
+ "description": "The trailing header icon of the accordion button.",
525
+ "name": "trailing-header__icon"
526
+ },
527
+ {
528
+ "description": "The body section of the accordion button.",
529
+ "name": "body-section"
530
+ }
531
+ ],
532
+ "slots": [
533
+ {
534
+ "description": "The default slot contains the body section of the accordion. User can place anything inside this body slot.",
535
+ "name": "default"
536
+ }
537
+ ],
538
+ "members": [
539
+ {
540
+ "kind": "field",
541
+ "name": "size",
542
+ "type": {
543
+ "text": "Size"
544
+ },
545
+ "description": "The size of the accordion item.",
546
+ "default": "'small'",
547
+ "attribute": "size",
548
+ "reflects": true
549
+ },
550
+ {
551
+ "kind": "field",
552
+ "name": "variant",
553
+ "type": {
554
+ "text": "Variant"
555
+ },
556
+ "description": "The variant of the accordion item. Based on the variant, the styling of the accordion gets changed.",
557
+ "default": "'default'",
558
+ "attribute": "variant",
559
+ "reflects": true
560
+ },
561
+ {
562
+ "kind": "field",
563
+ "name": "dataAriaLevel",
564
+ "type": {
565
+ "text": "number"
566
+ },
567
+ "description": "The aria level of the accordion component.",
568
+ "default": "3",
569
+ "attribute": "data-aria-level",
570
+ "reflects": true
571
+ },
572
+ {
573
+ "kind": "field",
574
+ "name": "expanded",
575
+ "type": {
576
+ "text": "boolean"
577
+ },
578
+ "description": "The visibility of the accordion button.",
579
+ "default": "false",
580
+ "attribute": "expanded",
581
+ "reflects": true
582
+ },
583
+ {
584
+ "kind": "field",
585
+ "name": "headerText",
586
+ "type": {
587
+ "text": "string | undefined"
588
+ },
589
+ "description": "The header text of the accordion item.",
590
+ "attribute": "header-text",
591
+ "reflects": true
592
+ },
593
+ {
594
+ "kind": "field",
595
+ "name": "prefixIcon",
596
+ "type": {
597
+ "text": "IconNames | undefined"
598
+ },
599
+ "description": "The leading icon that is displayed before the header text.",
600
+ "attribute": "prefix-icon"
601
+ },
602
+ {
603
+ "kind": "method",
604
+ "name": "handleHeaderClick",
605
+ "privacy": "protected",
606
+ "return": {
607
+ "type": {
608
+ "text": "void"
609
+ }
610
+ },
611
+ "description": "Handles the click event of the header section.\nIf the accordion is disabled, it will not toggle the expanded state.\nIt will dispatch the `shown` event with the current expanded state."
612
+ },
613
+ {
614
+ "kind": "method",
615
+ "name": "dispatchHeaderClickEvent",
616
+ "privacy": "private",
617
+ "return": {
618
+ "type": {
619
+ "text": "void"
620
+ }
621
+ },
622
+ "description": "Dispatches the `shown` event with the current expanded state.\nThe event is cancelable and bubbles.\nThe event detail contains the current expanded state."
623
+ },
624
+ {
625
+ "kind": "method",
626
+ "name": "handleKeyDown",
627
+ "privacy": "private",
628
+ "return": {
629
+ "type": {
630
+ "text": "void"
631
+ }
632
+ },
633
+ "parameters": [
634
+ {
635
+ "name": "event",
636
+ "type": {
637
+ "text": "KeyboardEvent"
638
+ },
639
+ "description": "The KeyboardEvent fired."
640
+ }
641
+ ],
642
+ "description": "Handles the keydown event of the component.\nIf the key pressed is either Enter or Space, it calls the handleHeaderClick method.\nThis allows keyboard users to toggle the accordion button using these keys."
643
+ },
644
+ {
645
+ "kind": "method",
646
+ "name": "renderIcon",
647
+ "privacy": "protected",
648
+ "return": {
649
+ "type": {
650
+ "text": "TemplateResult | typeof nothing"
651
+ }
652
+ },
653
+ "parameters": [
654
+ {
655
+ "name": "iconName",
656
+ "optional": true,
657
+ "type": {
658
+ "text": "IconNames"
659
+ }
660
+ }
661
+ ]
662
+ },
663
+ {
664
+ "kind": "method",
665
+ "name": "renderHeadingText",
666
+ "privacy": "protected",
667
+ "return": {
668
+ "type": {
669
+ "text": "TemplateResult | typeof nothing"
670
+ }
671
+ }
672
+ },
673
+ {
674
+ "kind": "method",
675
+ "name": "renderHeader",
676
+ "privacy": "protected",
677
+ "return": {
678
+ "type": {
679
+ "text": "TemplateResult"
680
+ }
681
+ }
682
+ },
683
+ {
684
+ "kind": "method",
685
+ "name": "getArrowIconName",
686
+ "privacy": "protected",
687
+ "return": {
688
+ "type": {
689
+ "text": ""
690
+ }
691
+ },
692
+ "description": "Returns the icon name based on the expanded state.\nIf the accordion button is disabled, it always returns the arrow down icon.\nOtherwise, it returns the arrow up icon if the accordion button is expanded, otherwise the arrow down icon."
693
+ },
694
+ {
695
+ "kind": "method",
696
+ "name": "renderBody",
697
+ "privacy": "protected",
698
+ "return": {
699
+ "type": {
700
+ "text": "TemplateResult | typeof nothing"
701
+ }
702
+ }
703
+ },
704
+ {
705
+ "kind": "field",
706
+ "name": "disabled",
707
+ "type": {
708
+ "text": "boolean | undefined"
709
+ },
710
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
711
+ "default": "undefined",
712
+ "attribute": "disabled",
713
+ "reflects": true,
714
+ "inheritedFrom": {
715
+ "name": "DisabledMixin",
716
+ "module": "utils/mixins/DisabledMixin.js"
717
+ }
718
+ }
719
+ ],
720
+ "events": [
721
+ {
722
+ "description": "(React: onShown) This event is triggered when the accordion button is expanded.",
723
+ "name": "shown",
724
+ "reactName": "onShown"
725
+ }
726
+ ],
727
+ "attributes": [
728
+ {
729
+ "name": "size",
730
+ "type": {
731
+ "text": "Size"
732
+ },
733
+ "description": "The size of the accordion item.",
734
+ "default": "'small'",
735
+ "fieldName": "size"
736
+ },
737
+ {
738
+ "name": "variant",
739
+ "type": {
740
+ "text": "Variant"
741
+ },
742
+ "description": "The variant of the accordion item. Based on the variant, the styling of the accordion gets changed.",
743
+ "default": "'default'",
744
+ "fieldName": "variant"
745
+ },
746
+ {
747
+ "name": "data-aria-level",
748
+ "type": {
749
+ "text": "number"
750
+ },
751
+ "description": "The aria level of the accordion component.",
752
+ "default": "3",
753
+ "fieldName": "dataAriaLevel"
754
+ },
755
+ {
756
+ "name": "expanded",
757
+ "type": {
758
+ "text": "boolean"
759
+ },
760
+ "description": "The visibility of the accordion button.",
761
+ "default": "false",
762
+ "fieldName": "expanded"
763
+ },
764
+ {
765
+ "name": "header-text",
766
+ "type": {
767
+ "text": "string | undefined"
768
+ },
769
+ "description": "The header text of the accordion item.",
770
+ "fieldName": "headerText"
771
+ },
772
+ {
773
+ "name": "prefix-icon",
774
+ "type": {
775
+ "text": "IconNames | undefined"
776
+ },
777
+ "description": "The leading icon that is displayed before the header text.",
778
+ "fieldName": "prefixIcon"
779
+ },
780
+ {
781
+ "name": "disabled",
782
+ "type": {
783
+ "text": "boolean | undefined"
784
+ },
785
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
786
+ "default": "undefined",
787
+ "fieldName": "disabled",
788
+ "inheritedFrom": {
789
+ "name": "DisabledMixin",
790
+ "module": "src/utils/mixins/DisabledMixin.ts"
791
+ }
792
+ }
793
+ ],
794
+ "mixins": [
795
+ {
796
+ "name": "DisabledMixin",
797
+ "module": "/src/utils/mixins/DisabledMixin"
798
+ }
799
+ ],
800
+ "superclass": {
801
+ "name": "Component",
802
+ "module": "/src/models"
803
+ },
804
+ "tagName": "mdc-accordionbutton",
805
+ "jsDoc": "/**\n * An accordion button contains a header and body section with optional slots inside the heading which are focusable.\n *\n * The header section contains:\n * - Prefix Icon\n * - Header Text\n *\n * The body section contains:\n * - Default slot - User can place any content inside the body section.\n *\n * The accordion button can be expanded or collapsed. The visibility of the body section can be controlled by `expanded` attribute. <br/>\n * There are two types of variants based on that the border styling of the accordion gets reflected. <br/>\n * There are two sizes of accordion, one is small and the other is large.\n * Small size has a padding of 1rem (16px) and large size has a padding of 1.5rem (24px) for the body section of accordion.\n *\n * By default, the header text in the accordion heading is of H3 with an aria-level of '3'.\n * If this accordion is placed on any other level in the entire webpage, then do adjust the aria-level number based on that.\n *\n * An accordion can be disabled, and when it's disabled, the header section will not be clickable.\n *\n * If you do need any controls on your accordion heading, then it's advised to use `accordion` component.\n *\n * @tagname mdc-accordionbutton\n *\n * @dependency mdc-button\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @slot default - The default slot contains the body section of the accordion. User can place anything inside this body slot.\n *\n * @event shown - (React: onShown) This event is triggered when the accordion button is expanded.\n *\n * @cssproperty --mdc-accordionbutton-border-color - The border color of the accordion button.\n * @cssproperty --mdc-accordionbutton-hover-color - The hover color of the accordion button.\n * @cssproperty --mdc-accordionbutton-active-color - The active color of the accordion button.\n * @cssproperty --mdc-accordionbutton-disabled-color - The disabled color of the accordion button.\n *\n * @csspart header-section - The header section of the accordion button.\n * @csspart header-button-section - The header button section of the accordion button.\n * @csspart leading-header - The leading header of the accordion button.\n * @csspart trailing-header - The trailing header of the accordion button.\n * @csspart trailing-header__icon - The trailing header icon of the accordion button.\n * @csspart body-section - The body section of the accordion button.\n */",
806
+ "customElement": true
807
+ }
808
+ ],
809
+ "exports": [
810
+ {
811
+ "kind": "js",
812
+ "name": "default",
813
+ "declaration": {
814
+ "name": "AccordionButton",
815
+ "module": "components/accordionbutton/accordionbutton.component.js"
816
+ }
817
+ }
818
+ ]
819
+ },
820
+ {
821
+ "kind": "javascript-module",
822
+ "path": "components/accordiongroup/accordiongroup.component.js",
823
+ "declarations": [
824
+ {
825
+ "kind": "class",
826
+ "description": "An accordion group is a vertically stacked set of interactive headings that each contain a header and body content.\nEach heading of the accordion acts as a control that enable users to expand or hide their associated body sections of content.\nAccordions are commonly used to reduce the need to scroll when presenting multiple sections of content on a single page.\n\n- Default Slot: The accordion group component only accepts, `accordion` and `accordionbutton` components as the children, rest are ignored.\n\nThere are three types of variants:\n- Stacked - Each accordion will have a gap of 1.5rem (24px).\n- Borderless - Each accordion will not have any border and the group will also not have any border.\n- Contained - Each accordion will have no gap in between them and the border of the entire accordiongroup will be continuous.\n\nThere are two types of sizes:\n- Small: Small size has a padding of 1rem (16px) for both heading and body sections.\n- Large: Large size has a padding of 1.5rem (24px) for both heading and body sections.\n\nThe variant and size will be applied to all accordions inside this accordion group.\nTo show/expand more than one accordion at any given time, then set `allow-multiple` to `true`. By default, it's `false`.\n\nIf you don't need any controls on your accordion heading, then it's advised to use `accordionbutton` component.",
827
+ "name": "AccordionGroup",
828
+ "cssProperties": [
829
+ {
830
+ "description": "The border color of the entire accordiongroup",
831
+ "name": "--mdc-accordiongroup-border-color"
832
+ }
833
+ ],
834
+ "slots": [
835
+ {
836
+ "description": "The default slot can contain the `accordion` or `accordionbutton` components.",
837
+ "name": "default"
838
+ }
839
+ ],
840
+ "members": [
841
+ {
842
+ "kind": "field",
843
+ "name": "size",
844
+ "type": {
845
+ "text": "Size"
846
+ },
847
+ "description": "The size of the accordion item.",
848
+ "default": "'small'",
849
+ "attribute": "size",
850
+ "reflects": true
851
+ },
852
+ {
853
+ "kind": "field",
854
+ "name": "variant",
855
+ "type": {
856
+ "text": "Variant"
857
+ },
858
+ "description": "The variant of the accordion item. Based on the variant, the styling of the accordion gets changed.",
859
+ "default": "'stacked'",
860
+ "attribute": "variant",
861
+ "reflects": true
862
+ },
863
+ {
864
+ "kind": "field",
865
+ "name": "allowMultiple",
866
+ "type": {
867
+ "text": "boolean"
868
+ },
869
+ "default": "false",
870
+ "description": "If true, multiple accordion items can be visible at the same time.",
871
+ "attribute": "allow-multiple",
872
+ "reflects": true
873
+ },
874
+ {
875
+ "kind": "method",
876
+ "name": "handleAccordionExpanded",
877
+ "privacy": "private",
878
+ "return": {
879
+ "type": {
880
+ "text": "void"
881
+ }
882
+ },
883
+ "parameters": [
884
+ {
885
+ "name": "event",
886
+ "type": {
887
+ "text": "Event"
888
+ },
889
+ "description": "The event object from the 'shown' event."
890
+ }
891
+ ],
892
+ "description": "Handles the 'shown' event for accordion items.\nIf `allowMultiple` is false, ensures that only one accordion item\nremains expanded by collapsing all other expanded items when a new item is expanded."
893
+ },
894
+ {
895
+ "kind": "method",
896
+ "name": "setChildrenAccordionAttributes",
897
+ "privacy": "private",
898
+ "return": {
899
+ "type": {
900
+ "text": "void"
901
+ }
902
+ },
903
+ "parameters": [
904
+ {
905
+ "name": "attributeName",
906
+ "type": {
907
+ "text": "string"
908
+ },
909
+ "description": "The name of the attribute to set."
910
+ },
911
+ {
912
+ "name": "attributeValue",
913
+ "type": {
914
+ "text": "string"
915
+ },
916
+ "description": "The value to set the attribute to."
917
+ }
918
+ ],
919
+ "description": "Sets the given attribute on all child accordion or accordionbutton components."
920
+ }
921
+ ],
922
+ "attributes": [
923
+ {
924
+ "name": "size",
925
+ "type": {
926
+ "text": "Size"
927
+ },
928
+ "description": "The size of the accordion item.",
929
+ "default": "'small'",
930
+ "fieldName": "size"
931
+ },
932
+ {
933
+ "name": "variant",
934
+ "type": {
935
+ "text": "Variant"
936
+ },
937
+ "description": "The variant of the accordion item. Based on the variant, the styling of the accordion gets changed.",
938
+ "default": "'stacked'",
939
+ "fieldName": "variant"
940
+ },
941
+ {
942
+ "name": "allow-multiple",
943
+ "type": {
944
+ "text": "boolean"
945
+ },
946
+ "default": "false",
947
+ "description": "If true, multiple accordion items can be visible at the same time.",
948
+ "fieldName": "allowMultiple"
949
+ }
950
+ ],
951
+ "superclass": {
952
+ "name": "Component",
953
+ "module": "/src/models"
954
+ },
955
+ "tagName": "mdc-accordiongroup",
956
+ "jsDoc": "/**\n * An accordion group is a vertically stacked set of interactive headings that each contain a header and body content.\n * Each heading of the accordion acts as a control that enable users to expand or hide their associated body sections of content.\n * Accordions are commonly used to reduce the need to scroll when presenting multiple sections of content on a single page.\n *\n * - Default Slot: The accordion group component only accepts, `accordion` and `accordionbutton` components as the children, rest are ignored.\n *\n * There are three types of variants:\n * - Stacked - Each accordion will have a gap of 1.5rem (24px).\n * - Borderless - Each accordion will not have any border and the group will also not have any border.\n * - Contained - Each accordion will have no gap in between them and the border of the entire accordiongroup will be continuous.\n *\n * There are two types of sizes:\n * - Small: Small size has a padding of 1rem (16px) for both heading and body sections.\n * - Large: Large size has a padding of 1.5rem (24px) for both heading and body sections.\n *\n * The variant and size will be applied to all accordions inside this accordion group.\n * To show/expand more than one accordion at any given time, then set `allow-multiple` to `true`. By default, it's `false`.\n *\n * If you don't need any controls on your accordion heading, then it's advised to use `accordionbutton` component.\n *\n * @tagname mdc-accordiongroup\n *\n * @slot default - The default slot can contain the `accordion` or `accordionbutton` components.\n *\n * @cssproperty --mdc-accordiongroup-border-color - The border color of the entire accordiongroup\n */",
957
+ "customElement": true
958
+ }
959
+ ],
960
+ "exports": [
961
+ {
962
+ "kind": "js",
963
+ "name": "default",
964
+ "declaration": {
965
+ "name": "AccordionGroup",
966
+ "module": "components/accordiongroup/accordiongroup.component.js"
967
+ }
968
+ }
969
+ ]
970
+ },
5
971
  {
6
972
  "kind": "javascript-module",
7
973
  "path": "components/alertchip/alertchip.component.js",
@@ -2001,264 +2967,89 @@
2001
2967
  "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
2002
2968
  "attribute": "icon-name",
2003
2969
  "inheritedFrom": {
2004
- "name": "IconNameMixin",
2005
- "module": "utils/mixins/IconNameMixin.js"
2006
- }
2007
- }
2008
- ],
2009
- "attributes": [
2010
- {
2011
- "name": "type",
2012
- "type": {
2013
- "text": "BadgeType | undefined"
2014
- },
2015
- "description": "Type of the badge\nCan be `dot` (notification) , `icon`, `counter`, `success`, `warning` or `error`.",
2016
- "fieldName": "type"
2017
- },
2018
- {
2019
- "name": "variant",
2020
- "type": {
2021
- "text": "IconVariant"
2022
- },
2023
- "description": "Type of the variant can be `primary` or `secondary`.\nIt defines the background and foreground color of the icon.",
2024
- "default": "primary",
2025
- "fieldName": "variant"
2026
- },
2027
- {
2028
- "name": "counter",
2029
- "type": {
2030
- "text": "number | undefined"
2031
- },
2032
- "description": "Counter is the number which can be provided in the badge.",
2033
- "fieldName": "counter"
2034
- },
2035
- {
2036
- "name": "max-counter",
2037
- "type": {
2038
- "text": "number"
2039
- },
2040
- "description": "The maximum number can be set up to 999, anything above that will be rendered as _999+_.\nThe max counter can be `9`, `99` or `999`.",
2041
- "default": "99",
2042
- "fieldName": "maxCounter"
2043
- },
2044
- {
2045
- "name": "overlay",
2046
- "type": {
2047
- "text": "boolean"
2048
- },
2049
- "default": "false",
2050
- "description": "Overlay is to add a thin outline to the badge.\nThis will help distinguish between the badge and the button,\nwhere the badge will be layered on top of a button.",
2051
- "fieldName": "overlay"
2052
- },
2053
- {
2054
- "name": "aria-label",
2055
- "type": {
2056
- "text": "string | null"
2057
- },
2058
- "default": "null",
2059
- "description": "Aria-label attribute to be set for accessibility",
2060
- "fieldName": "ariaLabel"
2061
- },
2062
- {
2063
- "name": "icon-name",
2064
- "type": {
2065
- "text": "IconNames | undefined"
2066
- },
2067
- "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
2068
- "fieldName": "iconName",
2069
- "inheritedFrom": {
2070
- "name": "IconNameMixin",
2071
- "module": "src/utils/mixins/IconNameMixin.ts"
2072
- }
2073
- }
2074
- ],
2075
- "mixins": [
2076
- {
2077
- "name": "IconNameMixin",
2078
- "module": "/src/utils/mixins/IconNameMixin"
2079
- }
2080
- ],
2081
- "superclass": {
2082
- "name": "Component",
2083
- "module": "/src/models"
2084
- },
2085
- "tagName": "mdc-badge",
2086
- "jsDoc": "/**\n * The `mdc-badge` component is a versatile UI element used to\n * display dot, icons, counters, success, warning and error type badge.\n *\n * Supported badge types:\n * - `dot`: Displays a dot notification badge with a blue color.\n * - `icon`: Displays a badge with a specified icon using the `icon-name` attribute.\n * - `counter`: Displays a badge with a counter value. If the counter exceeds the `max-counter`,\n * it shows `maxCounter+`. The maximum value of the counter is 999 and anything above that will be set to `999+`.\n * - `success`: Displays a success badge with a check circle icon and green color.\n * - `warning`: Displays a warning badge with a warning icon and yellow color.\n * - `error`: Displays a error badge with a error legacy icon and red color.\n *\n * For `icon`, `success`, `warning` and `error` types, the `mdc-icon` component is used to render the icon.\n *\n * For the `counter` type, the `mdc-text` component is used to render the counter value.\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @tagname mdc-badge\n *\n * @cssproperty --mdc-badge-primary-foreground-color - The foreground color of the primary badge.\n * @cssproperty --mdc-badge-primary-background-color - The background color of the primary badge.\n * @cssproperty --mdc-badge-secondary-foreground-color - The foreground color of the secondary badge.\n * @cssproperty --mdc-badge-secondary-background-color - The background color of the secondary badge.\n * @cssproperty --mdc-badge-success-foreground-color - The foreground color of the success badge.\n * @cssproperty --mdc-badge-success-background-color - The background color of the success badge.\n * @cssproperty --mdc-badge-warning-foreground-color - The foreground color of the warning badge.\n * @cssproperty --mdc-badge-warning-background-color - The background color of the warning badge.\n * @cssproperty --mdc-badge-error-foreground-color - The foreground color of the error badge.\n * @cssproperty --mdc-badge-error-background-color - The background color of the error badge.\n * @cssproperty --mdc-badge-overlay-background-color - The background color of the badge overlay.\n */",
2087
- "customElement": true
2088
- }
2089
- ],
2090
- "exports": [
2091
- {
2092
- "kind": "js",
2093
- "name": "default",
2094
- "declaration": {
2095
- "name": "Badge",
2096
- "module": "components/badge/badge.component.js"
2097
- }
2098
- }
2099
- ]
2100
- },
2101
- {
2102
- "kind": "javascript-module",
2103
- "path": "components/brandvisual/brandvisual.component.js",
2104
- "declarations": [
2105
- {
2106
- "kind": "class",
2107
- "description": "The `mdc-brandvisual` component is responsible for rendering logos dynamically & ensures they are\ndisplayed correctly within applications.\n\nFeatures:\n- Dynamically loads brandvisuals based on the `name` attribute.\n- Emits a `load` event when the brandvisual is successfully fetched.\n- Emits an `error` event when the brandvisual import fails.\n- Supports accessibility best practices.\n- Used for brand representation within the design system.",
2108
- "name": "Brandvisual",
2109
- "members": [
2110
- {
2111
- "kind": "field",
2112
- "name": "brandVisualData",
2113
- "type": {
2114
- "text": "HTMLElement | undefined"
2115
- },
2116
- "privacy": "private"
2117
- },
2118
- {
2119
- "kind": "field",
2120
- "name": "name",
2121
- "type": {
2122
- "text": "BrandVisualNames | undefined"
2123
- },
2124
- "description": "Name of the brandVisual (= filename)",
2125
- "attribute": "name",
2126
- "reflects": true
2127
- },
2128
- {
2129
- "kind": "method",
2130
- "name": "getBrandVisualData",
2131
- "privacy": "private"
2132
- },
2133
- {
2134
- "kind": "method",
2135
- "name": "handleBrandVisualLoadedSuccess",
2136
- "privacy": "private",
2137
- "parameters": [
2138
- {
2139
- "name": "brandVisualHtml",
2140
- "type": {
2141
- "text": "HTMLElement"
2142
- },
2143
- "description": "The brandvisual html element which has been fetched from the brandvisual provider."
2144
- }
2145
- ],
2146
- "description": "Sets the brandVisualData state to the fetched brandvisual.\nDispatches a 'load' event on the component once the brandvisual has been successfully loaded."
2147
- },
2148
- {
2149
- "kind": "method",
2150
- "name": "handleBrandVisualLoadedFailure",
2151
- "privacy": "private",
2152
- "parameters": [
2153
- {
2154
- "name": "error",
2155
- "type": {
2156
- "text": "unknown"
2157
- }
2158
- }
2159
- ],
2160
- "description": "Dispatches an 'error' event on the component when the brandvisual import has failed.\nThis event bubbles and is cancelable.\nThe error detail is set to the error object."
2161
- }
2162
- ],
2163
- "events": [
2164
- {
2165
- "description": "(React: onLoad) This event is dispatched when the brandvisual has been successfully loaded.",
2166
- "name": "load",
2167
- "reactName": "onLoad"
2168
- },
2169
- {
2170
- "description": "(React: onError) This event is dispatched when the brandvisual fetching has failed.",
2171
- "name": "error",
2172
- "reactName": "onError"
2173
- }
2174
- ],
2175
- "attributes": [
2176
- {
2177
- "name": "name",
2178
- "type": {
2179
- "text": "BrandVisualNames | undefined"
2180
- },
2181
- "description": "Name of the brandVisual (= filename)",
2182
- "fieldName": "name"
2183
- }
2184
- ],
2185
- "superclass": {
2186
- "name": "Component",
2187
- "module": "/src/models"
2188
- },
2189
- "tagName": "mdc-brandvisual",
2190
- "jsDoc": "/**\n * The `mdc-brandvisual` component is responsible for rendering logos dynamically & ensures they are\n * displayed correctly within applications.\n *\n * Features:\n * - Dynamically loads brandvisuals based on the `name` attribute.\n * - Emits a `load` event when the brandvisual is successfully fetched.\n * - Emits an `error` event when the brandvisual import fails.\n * - Supports accessibility best practices.\n * - Used for brand representation within the design system.\n *\n * @tagname mdc-brandvisual\n *\n * @event load - (React: onLoad) This event is dispatched when the brandvisual has been successfully loaded.\n * @event error - (React: onError) This event is dispatched when the brandvisual fetching has failed.\n *\n */",
2191
- "customElement": true
2192
- }
2193
- ],
2194
- "exports": [
2195
- {
2196
- "kind": "js",
2197
- "name": "default",
2198
- "declaration": {
2199
- "name": "Brandvisual",
2200
- "module": "components/brandvisual/brandvisual.component.js"
2201
- }
2202
- }
2203
- ]
2204
- },
2205
- {
2206
- "kind": "javascript-module",
2207
- "path": "components/bullet/bullet.component.js",
2208
- "declarations": [
2209
- {
2210
- "kind": "class",
2211
- "description": "Bullet component, which is a visual marker\nand be used to organize and present items in a list format.",
2212
- "name": "Bullet",
2213
- "cssProperties": [
2970
+ "name": "IconNameMixin",
2971
+ "module": "utils/mixins/IconNameMixin.js"
2972
+ }
2973
+ }
2974
+ ],
2975
+ "attributes": [
2214
2976
  {
2215
- "description": "background color of the bullet",
2216
- "name": "--mdc-bullet-background-color"
2977
+ "name": "type",
2978
+ "type": {
2979
+ "text": "BadgeType | undefined"
2980
+ },
2981
+ "description": "Type of the badge\nCan be `dot` (notification) , `icon`, `counter`, `success`, `warning` or `error`.",
2982
+ "fieldName": "type"
2217
2983
  },
2218
2984
  {
2219
- "description": "small size value of the bullet",
2220
- "name": "--mdc-bullet-size-small"
2985
+ "name": "variant",
2986
+ "type": {
2987
+ "text": "IconVariant"
2988
+ },
2989
+ "description": "Type of the variant can be `primary` or `secondary`.\nIt defines the background and foreground color of the icon.",
2990
+ "default": "primary",
2991
+ "fieldName": "variant"
2221
2992
  },
2222
2993
  {
2223
- "description": "medium size value of the bullet",
2224
- "name": "--mdc-bullet-size-medium"
2994
+ "name": "counter",
2995
+ "type": {
2996
+ "text": "number | undefined"
2997
+ },
2998
+ "description": "Counter is the number which can be provided in the badge.",
2999
+ "fieldName": "counter"
2225
3000
  },
2226
3001
  {
2227
- "description": "large size value of the bullet",
2228
- "name": "--mdc-bullet-size-large"
2229
- }
2230
- ],
2231
- "members": [
3002
+ "name": "max-counter",
3003
+ "type": {
3004
+ "text": "number"
3005
+ },
3006
+ "description": "The maximum number can be set up to 999, anything above that will be rendered as _999+_.\nThe max counter can be `9`, `99` or `999`.",
3007
+ "default": "99",
3008
+ "fieldName": "maxCounter"
3009
+ },
2232
3010
  {
2233
- "kind": "field",
2234
- "name": "size",
3011
+ "name": "overlay",
2235
3012
  "type": {
2236
- "text": "Size"
3013
+ "text": "boolean"
2237
3014
  },
2238
- "privacy": "public",
2239
- "description": "Size of the bullet\n\nPossible values: 'small', 'medium', 'large'",
2240
- "default": "small",
2241
- "attribute": "size",
2242
- "reflects": true
2243
- }
2244
- ],
2245
- "attributes": [
3015
+ "default": "false",
3016
+ "description": "Overlay is to add a thin outline to the badge.\nThis will help distinguish between the badge and the button,\nwhere the badge will be layered on top of a button.",
3017
+ "fieldName": "overlay"
3018
+ },
2246
3019
  {
2247
- "name": "size",
3020
+ "name": "aria-label",
2248
3021
  "type": {
2249
- "text": "Size"
3022
+ "text": "string | null"
2250
3023
  },
2251
- "description": "Size of the bullet\n\nPossible values: 'small', 'medium', 'large'",
2252
- "default": "small",
2253
- "fieldName": "size"
3024
+ "default": "null",
3025
+ "description": "Aria-label attribute to be set for accessibility",
3026
+ "fieldName": "ariaLabel"
3027
+ },
3028
+ {
3029
+ "name": "icon-name",
3030
+ "type": {
3031
+ "text": "IconNames | undefined"
3032
+ },
3033
+ "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
3034
+ "fieldName": "iconName",
3035
+ "inheritedFrom": {
3036
+ "name": "IconNameMixin",
3037
+ "module": "src/utils/mixins/IconNameMixin.ts"
3038
+ }
3039
+ }
3040
+ ],
3041
+ "mixins": [
3042
+ {
3043
+ "name": "IconNameMixin",
3044
+ "module": "/src/utils/mixins/IconNameMixin"
2254
3045
  }
2255
3046
  ],
2256
3047
  "superclass": {
2257
3048
  "name": "Component",
2258
3049
  "module": "/src/models"
2259
3050
  },
2260
- "tagName": "mdc-bullet",
2261
- "jsDoc": "/**\n * Bullet component, which is a visual marker\n * and be used to organize and present items in a list format.\n *\n * @tagname mdc-bullet\n *\n * @cssproperty --mdc-bullet-background-color - background color of the bullet\n * @cssproperty --mdc-bullet-size-small - small size value of the bullet\n * @cssproperty --mdc-bullet-size-medium - medium size value of the bullet\n * @cssproperty --mdc-bullet-size-large - large size value of the bullet\n */",
3051
+ "tagName": "mdc-badge",
3052
+ "jsDoc": "/**\n * The `mdc-badge` component is a versatile UI element used to\n * display dot, icons, counters, success, warning and error type badge.\n *\n * Supported badge types:\n * - `dot`: Displays a dot notification badge with a blue color.\n * - `icon`: Displays a badge with a specified icon using the `icon-name` attribute.\n * - `counter`: Displays a badge with a counter value. If the counter exceeds the `max-counter`,\n * it shows `maxCounter+`. The maximum value of the counter is 999 and anything above that will be set to `999+`.\n * - `success`: Displays a success badge with a check circle icon and green color.\n * - `warning`: Displays a warning badge with a warning icon and yellow color.\n * - `error`: Displays a error badge with a error legacy icon and red color.\n *\n * For `icon`, `success`, `warning` and `error` types, the `mdc-icon` component is used to render the icon.\n *\n * For the `counter` type, the `mdc-text` component is used to render the counter value.\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @tagname mdc-badge\n *\n * @cssproperty --mdc-badge-primary-foreground-color - The foreground color of the primary badge.\n * @cssproperty --mdc-badge-primary-background-color - The background color of the primary badge.\n * @cssproperty --mdc-badge-secondary-foreground-color - The foreground color of the secondary badge.\n * @cssproperty --mdc-badge-secondary-background-color - The background color of the secondary badge.\n * @cssproperty --mdc-badge-success-foreground-color - The foreground color of the success badge.\n * @cssproperty --mdc-badge-success-background-color - The background color of the success badge.\n * @cssproperty --mdc-badge-warning-foreground-color - The foreground color of the warning badge.\n * @cssproperty --mdc-badge-warning-background-color - The background color of the warning badge.\n * @cssproperty --mdc-badge-error-foreground-color - The foreground color of the error badge.\n * @cssproperty --mdc-badge-error-background-color - The background color of the error badge.\n * @cssproperty --mdc-badge-overlay-background-color - The background color of the badge overlay.\n */",
2262
3053
  "customElement": true
2263
3054
  }
2264
3055
  ],
@@ -2267,8 +3058,8 @@
2267
3058
  "kind": "js",
2268
3059
  "name": "default",
2269
3060
  "declaration": {
2270
- "name": "Bullet",
2271
- "module": "components/bullet/bullet.component.js"
3061
+ "name": "Badge",
3062
+ "module": "components/badge/badge.component.js"
2272
3063
  }
2273
3064
  }
2274
3065
  ]
@@ -2891,70 +3682,245 @@
2891
3682
  }
2892
3683
  },
2893
3684
  {
2894
- "name": "type",
3685
+ "name": "type",
3686
+ "type": {
3687
+ "text": "ButtonType"
3688
+ },
3689
+ "description": "This property defines the type attribute for the button element.\nThe type attribute specifies the behavior of the button when it is clicked.\n- **submit**: The button submits the form data to the server.\n- **reset**: The button resets the form data to its initial state.\n- **button**: The button does nothing when clicked.",
3690
+ "default": "button",
3691
+ "fieldName": "type",
3692
+ "inheritedFrom": {
3693
+ "name": "Buttonsimple",
3694
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
3695
+ }
3696
+ }
3697
+ ],
3698
+ "mixins": [
3699
+ {
3700
+ "name": "ButtonComponentMixin",
3701
+ "module": "/src/utils/mixins/ButtonComponentMixin"
3702
+ }
3703
+ ],
3704
+ "superclass": {
3705
+ "name": "Buttonsimple",
3706
+ "module": "/src/components/buttonsimple/buttonsimple.component"
3707
+ },
3708
+ "tagName": "mdc-button",
3709
+ "jsDoc": "/**\n * `mdc-button` is a component that can be configured in various ways to suit different use cases.\n *\n * Button Variants:\n * - **Primary**: Solid background color.\n * - **Secondary**: Transparent background with a solid border.\n * - **Tertiary**: No background or border, appears as plain text but retains all button functionalities.\n *\n * Button Colors:\n * - **Positive**: Green color.\n * - **Negative**: Red color.\n * - **Accent**: Blue color.\n * - **Promotional**: Purple color.\n * - **Default**: White color.\n *\n * Button Sizes (in REM units):\n * - **Pill button**: 40, 32, 28, 24.\n * - **Icon button**: 64, 52, 40, 32, 28, 24.\n * - **Tertiary icon button**: 20.\n *\n * Button Types:\n * - **Pill button**: A button that contains text value. Commonly used for call to action, tags, or filters.\n * - **Pill button with icons**: A button containing an icon either on the left or right side of the button.\n * - **Icon button**: A button represented by just an icon without any text.\n * The type of button is inferred based on the presence of slot and/or prefix and postfix icons.\n *\n * @dependency mdc-icon\n *\n * @tagname mdc-button\n *\n * @slot - Text label of the button.\n */",
3710
+ "customElement": true,
3711
+ "events": [
3712
+ {
3713
+ "description": "(React: onClick) This event is dispatched when the button is clicked.",
3714
+ "name": "click",
3715
+ "reactName": "onClick",
3716
+ "inheritedFrom": {
3717
+ "name": "Buttonsimple",
3718
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
3719
+ }
3720
+ },
3721
+ {
3722
+ "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the button.",
3723
+ "name": "keydown",
3724
+ "reactName": "onKeyDown",
3725
+ "inheritedFrom": {
3726
+ "name": "Buttonsimple",
3727
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
3728
+ }
3729
+ },
3730
+ {
3731
+ "description": "(React: onKeyUp) This event is dispatched when a key is released on the button.",
3732
+ "name": "keyup",
3733
+ "reactName": "onKeyUp",
3734
+ "inheritedFrom": {
3735
+ "name": "Buttonsimple",
3736
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
3737
+ }
3738
+ },
3739
+ {
3740
+ "description": "(React: onFocus) This event is dispatched when the button receives focus.",
3741
+ "name": "focus",
3742
+ "reactName": "onFocus",
3743
+ "inheritedFrom": {
3744
+ "name": "Buttonsimple",
3745
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
3746
+ }
3747
+ }
3748
+ ]
3749
+ }
3750
+ ],
3751
+ "exports": [
3752
+ {
3753
+ "kind": "js",
3754
+ "name": "default",
3755
+ "declaration": {
3756
+ "name": "Button",
3757
+ "module": "components/button/button.component.js"
3758
+ }
3759
+ }
3760
+ ]
3761
+ },
3762
+ {
3763
+ "kind": "javascript-module",
3764
+ "path": "components/bullet/bullet.component.js",
3765
+ "declarations": [
3766
+ {
3767
+ "kind": "class",
3768
+ "description": "Bullet component, which is a visual marker\nand be used to organize and present items in a list format.",
3769
+ "name": "Bullet",
3770
+ "cssProperties": [
3771
+ {
3772
+ "description": "background color of the bullet",
3773
+ "name": "--mdc-bullet-background-color"
3774
+ },
3775
+ {
3776
+ "description": "small size value of the bullet",
3777
+ "name": "--mdc-bullet-size-small"
3778
+ },
3779
+ {
3780
+ "description": "medium size value of the bullet",
3781
+ "name": "--mdc-bullet-size-medium"
3782
+ },
3783
+ {
3784
+ "description": "large size value of the bullet",
3785
+ "name": "--mdc-bullet-size-large"
3786
+ }
3787
+ ],
3788
+ "members": [
3789
+ {
3790
+ "kind": "field",
3791
+ "name": "size",
3792
+ "type": {
3793
+ "text": "Size"
3794
+ },
3795
+ "privacy": "public",
3796
+ "description": "Size of the bullet\n\nPossible values: 'small', 'medium', 'large'",
3797
+ "default": "small",
3798
+ "attribute": "size",
3799
+ "reflects": true
3800
+ }
3801
+ ],
3802
+ "attributes": [
3803
+ {
3804
+ "name": "size",
3805
+ "type": {
3806
+ "text": "Size"
3807
+ },
3808
+ "description": "Size of the bullet\n\nPossible values: 'small', 'medium', 'large'",
3809
+ "default": "small",
3810
+ "fieldName": "size"
3811
+ }
3812
+ ],
3813
+ "superclass": {
3814
+ "name": "Component",
3815
+ "module": "/src/models"
3816
+ },
3817
+ "tagName": "mdc-bullet",
3818
+ "jsDoc": "/**\n * Bullet component, which is a visual marker\n * and be used to organize and present items in a list format.\n *\n * @tagname mdc-bullet\n *\n * @cssproperty --mdc-bullet-background-color - background color of the bullet\n * @cssproperty --mdc-bullet-size-small - small size value of the bullet\n * @cssproperty --mdc-bullet-size-medium - medium size value of the bullet\n * @cssproperty --mdc-bullet-size-large - large size value of the bullet\n */",
3819
+ "customElement": true
3820
+ }
3821
+ ],
3822
+ "exports": [
3823
+ {
3824
+ "kind": "js",
3825
+ "name": "default",
3826
+ "declaration": {
3827
+ "name": "Bullet",
3828
+ "module": "components/bullet/bullet.component.js"
3829
+ }
3830
+ }
3831
+ ]
3832
+ },
3833
+ {
3834
+ "kind": "javascript-module",
3835
+ "path": "components/brandvisual/brandvisual.component.js",
3836
+ "declarations": [
3837
+ {
3838
+ "kind": "class",
3839
+ "description": "The `mdc-brandvisual` component is responsible for rendering logos dynamically & ensures they are\ndisplayed correctly within applications.\n\nFeatures:\n- Dynamically loads brandvisuals based on the `name` attribute.\n- Emits a `load` event when the brandvisual is successfully fetched.\n- Emits an `error` event when the brandvisual import fails.\n- Supports accessibility best practices.\n- Used for brand representation within the design system.",
3840
+ "name": "Brandvisual",
3841
+ "members": [
3842
+ {
3843
+ "kind": "field",
3844
+ "name": "brandVisualData",
3845
+ "type": {
3846
+ "text": "HTMLElement | undefined"
3847
+ },
3848
+ "privacy": "private"
3849
+ },
3850
+ {
3851
+ "kind": "field",
3852
+ "name": "name",
2895
3853
  "type": {
2896
- "text": "ButtonType"
3854
+ "text": "BrandVisualNames | undefined"
2897
3855
  },
2898
- "description": "This property defines the type attribute for the button element.\nThe type attribute specifies the behavior of the button when it is clicked.\n- **submit**: The button submits the form data to the server.\n- **reset**: The button resets the form data to its initial state.\n- **button**: The button does nothing when clicked.",
2899
- "default": "button",
2900
- "fieldName": "type",
2901
- "inheritedFrom": {
2902
- "name": "Buttonsimple",
2903
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
2904
- }
2905
- }
2906
- ],
2907
- "mixins": [
3856
+ "description": "Name of the brandVisual (= filename)",
3857
+ "attribute": "name",
3858
+ "reflects": true
3859
+ },
2908
3860
  {
2909
- "name": "ButtonComponentMixin",
2910
- "module": "/src/utils/mixins/ButtonComponentMixin"
3861
+ "kind": "method",
3862
+ "name": "getBrandVisualData",
3863
+ "privacy": "private"
3864
+ },
3865
+ {
3866
+ "kind": "method",
3867
+ "name": "handleBrandVisualLoadedSuccess",
3868
+ "privacy": "private",
3869
+ "parameters": [
3870
+ {
3871
+ "name": "brandVisualHtml",
3872
+ "type": {
3873
+ "text": "HTMLElement"
3874
+ },
3875
+ "description": "The brandvisual html element which has been fetched from the brandvisual provider."
3876
+ }
3877
+ ],
3878
+ "description": "Sets the brandVisualData state to the fetched brandvisual.\nDispatches a 'load' event on the component once the brandvisual has been successfully loaded."
3879
+ },
3880
+ {
3881
+ "kind": "method",
3882
+ "name": "handleBrandVisualLoadedFailure",
3883
+ "privacy": "private",
3884
+ "parameters": [
3885
+ {
3886
+ "name": "error",
3887
+ "type": {
3888
+ "text": "unknown"
3889
+ }
3890
+ }
3891
+ ],
3892
+ "description": "Dispatches an 'error' event on the component when the brandvisual import has failed.\nThis event bubbles and is cancelable.\nThe error detail is set to the error object."
2911
3893
  }
2912
3894
  ],
2913
- "superclass": {
2914
- "name": "Buttonsimple",
2915
- "module": "/src/components/buttonsimple/buttonsimple.component"
2916
- },
2917
- "tagName": "mdc-button",
2918
- "jsDoc": "/**\n * `mdc-button` is a component that can be configured in various ways to suit different use cases.\n *\n * Button Variants:\n * - **Primary**: Solid background color.\n * - **Secondary**: Transparent background with a solid border.\n * - **Tertiary**: No background or border, appears as plain text but retains all button functionalities.\n *\n * Button Colors:\n * - **Positive**: Green color.\n * - **Negative**: Red color.\n * - **Accent**: Blue color.\n * - **Promotional**: Purple color.\n * - **Default**: White color.\n *\n * Button Sizes (in REM units):\n * - **Pill button**: 40, 32, 28, 24.\n * - **Icon button**: 64, 52, 40, 32, 28, 24.\n * - **Tertiary icon button**: 20.\n *\n * Button Types:\n * - **Pill button**: A button that contains text value. Commonly used for call to action, tags, or filters.\n * - **Pill button with icons**: A button containing an icon either on the left or right side of the button.\n * - **Icon button**: A button represented by just an icon without any text.\n * The type of button is inferred based on the presence of slot and/or prefix and postfix icons.\n *\n * @dependency mdc-icon\n *\n * @tagname mdc-button\n *\n * @slot - Text label of the button.\n */",
2919
- "customElement": true,
2920
3895
  "events": [
2921
3896
  {
2922
- "description": "(React: onClick) This event is dispatched when the button is clicked.",
2923
- "name": "click",
2924
- "reactName": "onClick",
2925
- "inheritedFrom": {
2926
- "name": "Buttonsimple",
2927
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
2928
- }
2929
- },
2930
- {
2931
- "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the button.",
2932
- "name": "keydown",
2933
- "reactName": "onKeyDown",
2934
- "inheritedFrom": {
2935
- "name": "Buttonsimple",
2936
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
2937
- }
3897
+ "description": "(React: onLoad) This event is dispatched when the brandvisual has been successfully loaded.",
3898
+ "name": "load",
3899
+ "reactName": "onLoad"
2938
3900
  },
2939
3901
  {
2940
- "description": "(React: onKeyUp) This event is dispatched when a key is released on the button.",
2941
- "name": "keyup",
2942
- "reactName": "onKeyUp",
2943
- "inheritedFrom": {
2944
- "name": "Buttonsimple",
2945
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
2946
- }
2947
- },
3902
+ "description": "(React: onError) This event is dispatched when the brandvisual fetching has failed.",
3903
+ "name": "error",
3904
+ "reactName": "onError"
3905
+ }
3906
+ ],
3907
+ "attributes": [
2948
3908
  {
2949
- "description": "(React: onFocus) This event is dispatched when the button receives focus.",
2950
- "name": "focus",
2951
- "reactName": "onFocus",
2952
- "inheritedFrom": {
2953
- "name": "Buttonsimple",
2954
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
2955
- }
3909
+ "name": "name",
3910
+ "type": {
3911
+ "text": "BrandVisualNames | undefined"
3912
+ },
3913
+ "description": "Name of the brandVisual (= filename)",
3914
+ "fieldName": "name"
2956
3915
  }
2957
- ]
3916
+ ],
3917
+ "superclass": {
3918
+ "name": "Component",
3919
+ "module": "/src/models"
3920
+ },
3921
+ "tagName": "mdc-brandvisual",
3922
+ "jsDoc": "/**\n * The `mdc-brandvisual` component is responsible for rendering logos dynamically & ensures they are\n * displayed correctly within applications.\n *\n * Features:\n * - Dynamically loads brandvisuals based on the `name` attribute.\n * - Emits a `load` event when the brandvisual is successfully fetched.\n * - Emits an `error` event when the brandvisual import fails.\n * - Supports accessibility best practices.\n * - Used for brand representation within the design system.\n *\n * @tagname mdc-brandvisual\n *\n * @event load - (React: onLoad) This event is dispatched when the brandvisual has been successfully loaded.\n * @event error - (React: onError) This event is dispatched when the brandvisual fetching has failed.\n *\n */",
3923
+ "customElement": true
2958
3924
  }
2959
3925
  ],
2960
3926
  "exports": [
@@ -2962,8 +3928,8 @@
2962
3928
  "kind": "js",
2963
3929
  "name": "default",
2964
3930
  "declaration": {
2965
- "name": "Button",
2966
- "module": "components/button/button.component.js"
3931
+ "name": "Brandvisual",
3932
+ "module": "components/brandvisual/brandvisual.component.js"
2967
3933
  }
2968
3934
  }
2969
3935
  ]
@@ -16837,15 +17803,15 @@
16837
17803
  },
16838
17804
  {
16839
17805
  "kind": "javascript-module",
16840
- "path": "components/menuitem/menuitem.component.js",
17806
+ "path": "components/menuitemcheckbox/menuitemcheckbox.component.js",
16841
17807
  "declarations": [
16842
17808
  {
16843
17809
  "kind": "class",
16844
- "description": "menuitem component is inherited by listitem component with the role set `menuitem`.<br/>\nA menu item can contain an icon on the leading or trailing side.\n\nThe leading and trailing slots can be used to display controls and text.<br/>\nBased on the leading/trailing slot, the position of the controls and text can be adjusted.\n\nPlease use element with role=menu as a parent element even when there is only menuitem for a11y purpose.\nFor example mdc-menupopover or mdc-menubar.\n\nMenu item has `name` and `value` attribute that can be used to identify the menu item when it is selected.",
16845
- "name": "MenuItem",
17810
+ "description": "A menuitemcheckbox component is a checkable menuitem.\nThere should be no focusable descendants inside this menuitemcheckbox component.\n\nThe `checked` attribute indicates whether the menuitemcheckbox is checked or not.\n\nMenu item checkbox has `name` and `value` attribute that can be used to identify the menu item when it is selected.\n\nThe `indicator` attribute is used to differentiate between <b>checkbox</b>, <b>checkmark</b>, <b>toggle</b> and <b>none</b>.\nBy default, the `indicator` is set to <b>checkbox</b>.<br/>\n\nThe checkbox will always be positioned on the leading side of the menuitem label and\nthe toggle and checkmark will always be positioned on the trailing side.\n\nThe checkbox will have the possible states of `true` or `false`.\nIf the indicator is set to <b>checkmark</b> and if the `checked` attribute is set to `true`,\nthen the checkmark will be displayed. if not, then no indicator will be displayed.\n\nThe forth options for the `indicator` is <b>none</b>, which will not display any indicator at all.\nIt is intended to be used for customised menu items where the indicator is implemented differently.\nFor example, you can use a custom icon or a different visual element to indicate the state of the menu item.\nMake sure the new indicator is accessible.\n\nIf you want only one item in a group to be checked, consider using menuitemradio component.",
17811
+ "name": "MenuItemCheckbox",
16846
17812
  "slots": [
16847
17813
  {
16848
- "description": "slot for menu item controls to appear of leading end.",
17814
+ "description": "slot for menu item checkbox controls to appear of leading end.",
16849
17815
  "name": "leading-controls",
16850
17816
  "inheritedFrom": {
16851
17817
  "name": "ListItem",
@@ -16853,7 +17819,7 @@
16853
17819
  }
16854
17820
  },
16855
17821
  {
16856
- "description": "slot for menu item primary label.",
17822
+ "description": "slot for menu item checkbox primary label.",
16857
17823
  "name": "leading-text-primary-label",
16858
17824
  "inheritedFrom": {
16859
17825
  "name": "ListItem",
@@ -16861,7 +17827,7 @@
16861
17827
  }
16862
17828
  },
16863
17829
  {
16864
- "description": "slot for menu item secondary label.",
17830
+ "description": "slot for menu item checkbox secondary label.",
16865
17831
  "name": "leading-text-secondary-label",
16866
17832
  "inheritedFrom": {
16867
17833
  "name": "ListItem",
@@ -16869,7 +17835,7 @@
16869
17835
  }
16870
17836
  },
16871
17837
  {
16872
- "description": "slot for menu item tertiary label.",
17838
+ "description": "slot for menu item checkbox tertiary label.",
16873
17839
  "name": "leading-text-tertiary-label",
16874
17840
  "inheritedFrom": {
16875
17841
  "name": "ListItem",
@@ -16877,7 +17843,7 @@
16877
17843
  }
16878
17844
  },
16879
17845
  {
16880
- "description": "slot for menu item side header text.",
17846
+ "description": "slot for menu item checkbox side header text.",
16881
17847
  "name": "trailing-text-side-header",
16882
17848
  "inheritedFrom": {
16883
17849
  "name": "ListItem",
@@ -16885,7 +17851,7 @@
16885
17851
  }
16886
17852
  },
16887
17853
  {
16888
- "description": "slot for menu item subline text.",
17854
+ "description": "slot for menu item checkbox subline text.",
16889
17855
  "name": "trailing-text-subline",
16890
17856
  "inheritedFrom": {
16891
17857
  "name": "ListItem",
@@ -16893,7 +17859,7 @@
16893
17859
  }
16894
17860
  },
16895
17861
  {
16896
- "description": "slot for menu item controls to appear of trailing end.",
17862
+ "description": "slot for menu item checkbox controls to appear of trailing end.",
16897
17863
  "name": "trailing-controls",
16898
17864
  "inheritedFrom": {
16899
17865
  "name": "ListItem",
@@ -16902,6 +17868,67 @@
16902
17868
  }
16903
17869
  ],
16904
17870
  "members": [
17871
+ {
17872
+ "kind": "field",
17873
+ "name": "checked",
17874
+ "type": {
17875
+ "text": "boolean"
17876
+ },
17877
+ "default": "false",
17878
+ "description": "The checked attribute is used to indicate that the menuitemcheckbox is checked or not.",
17879
+ "attribute": "checked",
17880
+ "reflects": true
17881
+ },
17882
+ {
17883
+ "kind": "field",
17884
+ "name": "indicator",
17885
+ "type": {
17886
+ "text": "Indicator"
17887
+ },
17888
+ "description": "The indicator attribute is used to differentiate between <b>checkbox</b> and <b>toggle</b>.",
17889
+ "default": "'checkbox'",
17890
+ "attribute": "indicator",
17891
+ "reflects": true
17892
+ },
17893
+ {
17894
+ "kind": "method",
17895
+ "name": "handleMouseClick",
17896
+ "privacy": "private",
17897
+ "description": "Handles click events to toggle checked state\nIf the menuitemcheckbox is disabled, it does nothing.\nIf the menuitemcheckbox is not disabled, it toggles the `checked` state between `true` and `false`."
17898
+ },
17899
+ {
17900
+ "kind": "method",
17901
+ "name": "staticCheckbox",
17902
+ "privacy": "private",
17903
+ "return": {
17904
+ "type": {
17905
+ "text": ""
17906
+ }
17907
+ },
17908
+ "description": "Returns a static checkbox element if the indicator is set to checkbox.\nIf the indicator is not set to checkbox, it returns nothing."
17909
+ },
17910
+ {
17911
+ "kind": "method",
17912
+ "name": "staticToggle",
17913
+ "privacy": "private",
17914
+ "return": {
17915
+ "type": {
17916
+ "text": ""
17917
+ }
17918
+ },
17919
+ "description": "Returns a static toggle element if the indicator is set to toggle.\nIf the indicator is not set to toggle, it returns nothing.\n\nThe toggle will always be positioned on the trailing side of the menuitem label."
17920
+ },
17921
+ {
17922
+ "kind": "method",
17923
+ "name": "getCheckmarkIcon",
17924
+ "privacy": "private",
17925
+ "return": {
17926
+ "type": {
17927
+ "text": ""
17928
+ }
17929
+ },
17930
+ "description": "Returns a checkmark icon if the indicator is set to checkmark and the checked state is true.\nIf the indicator is not set to checkmark or the checked state is false, it returns nothing.\n\nThe checkmark icon will always be positioned on the trailing side of the menuitem label."
17931
+ },
16905
17932
  {
16906
17933
  "kind": "field",
16907
17934
  "name": "arrowPosition",
@@ -16910,7 +17937,11 @@
16910
17937
  },
16911
17938
  "description": "Defines where the arrow icon will appear.\n- `'leading'`: Icon appears on the leading edge (start).\n- `'trailing'`: Icon appears on the trailing edge (end).\n\nIf not set, no arrow is displayed.",
16912
17939
  "attribute": "arrow-position",
16913
- "reflects": true
17940
+ "reflects": true,
17941
+ "inheritedFrom": {
17942
+ "name": "MenuItem",
17943
+ "module": "components/menuitem/menuitem.component.js"
17944
+ }
16914
17945
  },
16915
17946
  {
16916
17947
  "kind": "field",
@@ -16920,7 +17951,11 @@
16920
17951
  },
16921
17952
  "description": "Defines the direction the arrow icon points.\n- `'positive'`: Arrow points toward the trailing side.\n- `'negative'`: Arrow points toward the leading side.",
16922
17953
  "attribute": "arrow-direction",
16923
- "reflects": true
17954
+ "reflects": true,
17955
+ "inheritedFrom": {
17956
+ "name": "MenuItem",
17957
+ "module": "components/menuitem/menuitem.component.js"
17958
+ }
16924
17959
  },
16925
17960
  {
16926
17961
  "kind": "field",
@@ -16931,7 +17966,11 @@
16931
17966
  "default": "undefined",
16932
17967
  "description": "The name attribute is used to identify the menu item when it is selected.",
16933
17968
  "attribute": "name",
16934
- "reflects": true
17969
+ "reflects": true,
17970
+ "inheritedFrom": {
17971
+ "name": "MenuItem",
17972
+ "module": "components/menuitem/menuitem.component.js"
17973
+ }
16935
17974
  },
16936
17975
  {
16937
17976
  "kind": "field",
@@ -16942,7 +17981,11 @@
16942
17981
  "default": "undefined",
16943
17982
  "description": "The value attribute is used to represent a value when the menu item is selected.\nIt is typically used with checkbox and radio menu items, but can be handy for any menu item.",
16944
17983
  "attribute": "value",
16945
- "reflects": true
17984
+ "reflects": true,
17985
+ "inheritedFrom": {
17986
+ "name": "MenuItem",
17987
+ "module": "components/menuitem/menuitem.component.js"
17988
+ }
16946
17989
  },
16947
17990
  {
16948
17991
  "kind": "method",
@@ -16986,7 +18029,11 @@
16986
18029
  "description": "The keyboard event that triggered the action."
16987
18030
  }
16988
18031
  ],
16989
- "description": "Handles the keyup event for the menu item.\nIf the Space key is released, it triggers a click event on the menu item.\nThis allows keyboard users to activate the menu item using the Space key.\nIt also prevents the default action of the Space key to avoid scrolling the page.\n\nThis follows the native behaviour, actionable element can be triggered by Space\nkey on the keyup event.\n\nNote: Action triggered by Enter on the keydown event."
18032
+ "description": "Handles the keyup event for the menu item.\nIf the Space key is released, it triggers a click event on the menu item.\nThis allows keyboard users to activate the menu item using the Space key.\nIt also prevents the default action of the Space key to avoid scrolling the page.\n\nThis follows the native behaviour, actionable element can be triggered by Space\nkey on the keyup event.\n\nNote: Action triggered by Enter on the keydown event.",
18033
+ "inheritedFrom": {
18034
+ "name": "MenuItem",
18035
+ "module": "components/menuitem/menuitem.component.js"
18036
+ }
16990
18037
  },
16991
18038
  {
16992
18039
  "kind": "method",
@@ -17323,7 +18370,15 @@
17323
18370
  ],
17324
18371
  "events": [
17325
18372
  {
17326
- "description": "(React: onClick) This event is dispatched when the menuitem is clicked.",
18373
+ "name": "change",
18374
+ "type": {
18375
+ "text": "Event"
18376
+ },
18377
+ "description": "(React: onChange) This event is dispatched when the menuitemcheckbox changes.",
18378
+ "reactName": "onChange"
18379
+ },
18380
+ {
18381
+ "description": "(React: onClick) This event is dispatched when the menuitemcheckbox is clicked.",
17327
18382
  "name": "click",
17328
18383
  "reactName": "onClick",
17329
18384
  "inheritedFrom": {
@@ -17331,6 +18386,15 @@
17331
18386
  "module": "src/components/listitem/listitem.component.ts"
17332
18387
  }
17333
18388
  },
18389
+ {
18390
+ "description": "(React: onFocus) This event is dispatched when the menuitemcheckbox receives focus.",
18391
+ "name": "focus",
18392
+ "reactName": "onFocus",
18393
+ "inheritedFrom": {
18394
+ "name": "ListItem",
18395
+ "module": "src/components/listitem/listitem.component.ts"
18396
+ }
18397
+ },
17334
18398
  {
17335
18399
  "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the menuitem.",
17336
18400
  "name": "keydown",
@@ -17349,15 +18413,6 @@
17349
18413
  "module": "src/components/listitem/listitem.component.ts"
17350
18414
  }
17351
18415
  },
17352
- {
17353
- "description": "(React: onFocus) This event is dispatched when the menuitem receives focus.",
17354
- "name": "focus",
17355
- "reactName": "onFocus",
17356
- "inheritedFrom": {
17357
- "name": "ListItem",
17358
- "module": "src/components/listitem/listitem.component.ts"
17359
- }
17360
- },
17361
18416
  {
17362
18417
  "description": "(React: onEnabled) This event is dispatched after the listitem is enabled",
17363
18418
  "name": "enabled",
@@ -17396,13 +18451,35 @@
17396
18451
  }
17397
18452
  ],
17398
18453
  "attributes": [
18454
+ {
18455
+ "name": "checked",
18456
+ "type": {
18457
+ "text": "boolean"
18458
+ },
18459
+ "default": "false",
18460
+ "description": "The checked attribute is used to indicate that the menuitemcheckbox is checked or not.",
18461
+ "fieldName": "checked"
18462
+ },
18463
+ {
18464
+ "name": "indicator",
18465
+ "type": {
18466
+ "text": "Indicator"
18467
+ },
18468
+ "description": "The indicator attribute is used to differentiate between <b>checkbox</b> and <b>toggle</b>.",
18469
+ "default": "'checkbox'",
18470
+ "fieldName": "indicator"
18471
+ },
17399
18472
  {
17400
18473
  "name": "arrow-position",
17401
18474
  "type": {
17402
18475
  "text": "ArrowPositions | undefined"
17403
18476
  },
17404
18477
  "description": "Defines where the arrow icon will appear.\n- `'leading'`: Icon appears on the leading edge (start).\n- `'trailing'`: Icon appears on the trailing edge (end).\n\nIf not set, no arrow is displayed.",
17405
- "fieldName": "arrowPosition"
18478
+ "fieldName": "arrowPosition",
18479
+ "inheritedFrom": {
18480
+ "name": "MenuItem",
18481
+ "module": "src/components/menuitem/menuitem.component.ts"
18482
+ }
17406
18483
  },
17407
18484
  {
17408
18485
  "name": "arrow-direction",
@@ -17410,7 +18487,11 @@
17410
18487
  "text": "ArrowDirections | undefined"
17411
18488
  },
17412
18489
  "description": "Defines the direction the arrow icon points.\n- `'positive'`: Arrow points toward the trailing side.\n- `'negative'`: Arrow points toward the leading side.",
17413
- "fieldName": "arrowDirection"
18490
+ "fieldName": "arrowDirection",
18491
+ "inheritedFrom": {
18492
+ "name": "MenuItem",
18493
+ "module": "src/components/menuitem/menuitem.component.ts"
18494
+ }
17414
18495
  },
17415
18496
  {
17416
18497
  "name": "name",
@@ -17419,7 +18500,11 @@
17419
18500
  },
17420
18501
  "default": "undefined",
17421
18502
  "description": "The name attribute is used to identify the menu item when it is selected.",
17422
- "fieldName": "name"
18503
+ "fieldName": "name",
18504
+ "inheritedFrom": {
18505
+ "name": "MenuItem",
18506
+ "module": "src/components/menuitem/menuitem.component.ts"
18507
+ }
17423
18508
  },
17424
18509
  {
17425
18510
  "name": "value",
@@ -17428,7 +18513,11 @@
17428
18513
  },
17429
18514
  "default": "undefined",
17430
18515
  "description": "The value attribute is used to represent a value when the menu item is selected.\nIt is typically used with checkbox and radio menu items, but can be handy for any menu item.",
17431
- "fieldName": "value"
18516
+ "fieldName": "value",
18517
+ "inheritedFrom": {
18518
+ "name": "MenuItem",
18519
+ "module": "src/components/menuitem/menuitem.component.ts"
18520
+ }
17432
18521
  },
17433
18522
  {
17434
18523
  "name": "disabled",
@@ -17569,11 +18658,11 @@
17569
18658
  }
17570
18659
  ],
17571
18660
  "superclass": {
17572
- "name": "ListItem",
17573
- "module": "/src/components/listitem/listitem.component"
18661
+ "name": "MenuItem",
18662
+ "module": "/src/components/menuitem/menuitem.component"
17574
18663
  },
17575
- "tagName": "mdc-menuitem",
17576
- "jsDoc": "/**\n * menuitem component is inherited by listitem component with the role set `menuitem`.<br/>\n * A menu item can contain an icon on the leading or trailing side.\n *\n * The leading and trailing slots can be used to display controls and text.<br/>\n * Based on the leading/trailing slot, the position of the controls and text can be adjusted.\n *\n * Please use element with role=menu as a parent element even when there is only menuitem for a11y purpose.\n * For example mdc-menupopover or mdc-menubar.\n *\n * Menu item has `name` and `value` attribute that can be used to identify the menu item when it is selected.\n *\n * @dependency mdc-text\n * @dependency mdc-icon\n * @dependency mdc-tooltip\n *\n * @tagname mdc-menuitem\n *\n * @slot leading-controls - slot for menu item controls to appear of leading end.\n * @slot leading-text-primary-label - slot for menu item primary label.\n * @slot leading-text-secondary-label - slot for menu item secondary label.\n * @slot leading-text-tertiary-label - slot for menu item tertiary label.\n * @slot trailing-text-side-header - slot for menu item side header text.\n * @slot trailing-text-subline - slot for menu item subline text.\n * @slot trailing-controls - slot for menu item controls to appear of trailing end.\n *\n * @event click - (React: onClick) This event is dispatched when the menuitem is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the menuitem.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the menuitem.\n * @event focus - (React: onFocus) This event is dispatched when the menuitem receives focus.\n */",
18664
+ "tagName": "mdc-menuitemcheckbox",
18665
+ "jsDoc": "/**\n * A menuitemcheckbox component is a checkable menuitem.\n * There should be no focusable descendants inside this menuitemcheckbox component.\n *\n * The `checked` attribute indicates whether the menuitemcheckbox is checked or not.\n *\n * Menu item checkbox has `name` and `value` attribute that can be used to identify the menu item when it is selected.\n *\n * The `indicator` attribute is used to differentiate between <b>checkbox</b>, <b>checkmark</b>, <b>toggle</b> and <b>none</b>.\n * By default, the `indicator` is set to <b>checkbox</b>.<br/>\n *\n * The checkbox will always be positioned on the leading side of the menuitem label and\n * the toggle and checkmark will always be positioned on the trailing side.\n *\n * The checkbox will have the possible states of `true` or `false`.\n * If the indicator is set to <b>checkmark</b> and if the `checked` attribute is set to `true`,\n * then the checkmark will be displayed. if not, then no indicator will be displayed.\n *\n * The forth options for the `indicator` is <b>none</b>, which will not display any indicator at all.\n * It is intended to be used for customised menu items where the indicator is implemented differently.\n * For example, you can use a custom icon or a different visual element to indicate the state of the menu item.\n * Make sure the new indicator is accessible.\n *\n * If you want only one item in a group to be checked, consider using menuitemradio component.\n *\n * @dependency mdc-staticcheckbox\n * @dependency mdc-statictoggle\n * @dependency mdc-icon\n *\n * @tagname mdc-menuitemcheckbox\n *\n * @slot leading-controls - slot for menu item checkbox controls to appear of leading end.\n * @slot leading-text-primary-label - slot for menu item checkbox primary label.\n * @slot leading-text-secondary-label - slot for menu item checkbox secondary label.\n * @slot leading-text-tertiary-label - slot for menu item checkbox tertiary label.\n * @slot trailing-text-side-header - slot for menu item checkbox side header text.\n * @slot trailing-text-subline - slot for menu item checkbox subline text.\n * @slot trailing-controls - slot for menu item checkbox controls to appear of trailing end.\n *\n * @event change - (React: onChange) This event is dispatched when the menuitemcheckbox changes.\n * @event click - (React: onClick) This event is dispatched when the menuitemcheckbox is clicked.\n * @event focus - (React: onFocus) This event is dispatched when the menuitemcheckbox receives focus.\n */",
17577
18666
  "customElement": true,
17578
18667
  "cssProperties": [
17579
18668
  {
@@ -17648,23 +18737,23 @@
17648
18737
  "kind": "js",
17649
18738
  "name": "default",
17650
18739
  "declaration": {
17651
- "name": "MenuItem",
17652
- "module": "components/menuitem/menuitem.component.js"
18740
+ "name": "MenuItemCheckbox",
18741
+ "module": "components/menuitemcheckbox/menuitemcheckbox.component.js"
17653
18742
  }
17654
18743
  }
17655
18744
  ]
17656
18745
  },
17657
18746
  {
17658
18747
  "kind": "javascript-module",
17659
- "path": "components/menuitemcheckbox/menuitemcheckbox.component.js",
18748
+ "path": "components/menuitem/menuitem.component.js",
17660
18749
  "declarations": [
17661
18750
  {
17662
18751
  "kind": "class",
17663
- "description": "A menuitemcheckbox component is a checkable menuitem.\nThere should be no focusable descendants inside this menuitemcheckbox component.\n\nThe `checked` attribute indicates whether the menuitemcheckbox is checked or not.\n\nMenu item checkbox has `name` and `value` attribute that can be used to identify the menu item when it is selected.\n\nThe `indicator` attribute is used to differentiate between <b>checkbox</b>, <b>checkmark</b>, <b>toggle</b> and <b>none</b>.\nBy default, the `indicator` is set to <b>checkbox</b>.<br/>\n\nThe checkbox will always be positioned on the leading side of the menuitem label and\nthe toggle and checkmark will always be positioned on the trailing side.\n\nThe checkbox will have the possible states of `true` or `false`.\nIf the indicator is set to <b>checkmark</b> and if the `checked` attribute is set to `true`,\nthen the checkmark will be displayed. if not, then no indicator will be displayed.\n\nThe forth options for the `indicator` is <b>none</b>, which will not display any indicator at all.\nIt is intended to be used for customised menu items where the indicator is implemented differently.\nFor example, you can use a custom icon or a different visual element to indicate the state of the menu item.\nMake sure the new indicator is accessible.\n\nIf you want only one item in a group to be checked, consider using menuitemradio component.",
17664
- "name": "MenuItemCheckbox",
18752
+ "description": "menuitem component is inherited by listitem component with the role set `menuitem`.<br/>\nA menu item can contain an icon on the leading or trailing side.\n\nThe leading and trailing slots can be used to display controls and text.<br/>\nBased on the leading/trailing slot, the position of the controls and text can be adjusted.\n\nPlease use element with role=menu as a parent element even when there is only menuitem for a11y purpose.\nFor example mdc-menupopover or mdc-menubar.\n\nMenu item has `name` and `value` attribute that can be used to identify the menu item when it is selected.",
18753
+ "name": "MenuItem",
17665
18754
  "slots": [
17666
18755
  {
17667
- "description": "slot for menu item checkbox controls to appear of leading end.",
18756
+ "description": "slot for menu item controls to appear of leading end.",
17668
18757
  "name": "leading-controls",
17669
18758
  "inheritedFrom": {
17670
18759
  "name": "ListItem",
@@ -17672,7 +18761,7 @@
17672
18761
  }
17673
18762
  },
17674
18763
  {
17675
- "description": "slot for menu item checkbox primary label.",
18764
+ "description": "slot for menu item primary label.",
17676
18765
  "name": "leading-text-primary-label",
17677
18766
  "inheritedFrom": {
17678
18767
  "name": "ListItem",
@@ -17680,7 +18769,7 @@
17680
18769
  }
17681
18770
  },
17682
18771
  {
17683
- "description": "slot for menu item checkbox secondary label.",
18772
+ "description": "slot for menu item secondary label.",
17684
18773
  "name": "leading-text-secondary-label",
17685
18774
  "inheritedFrom": {
17686
18775
  "name": "ListItem",
@@ -17688,7 +18777,7 @@
17688
18777
  }
17689
18778
  },
17690
18779
  {
17691
- "description": "slot for menu item checkbox tertiary label.",
18780
+ "description": "slot for menu item tertiary label.",
17692
18781
  "name": "leading-text-tertiary-label",
17693
18782
  "inheritedFrom": {
17694
18783
  "name": "ListItem",
@@ -17696,7 +18785,7 @@
17696
18785
  }
17697
18786
  },
17698
18787
  {
17699
- "description": "slot for menu item checkbox side header text.",
18788
+ "description": "slot for menu item side header text.",
17700
18789
  "name": "trailing-text-side-header",
17701
18790
  "inheritedFrom": {
17702
18791
  "name": "ListItem",
@@ -17704,7 +18793,7 @@
17704
18793
  }
17705
18794
  },
17706
18795
  {
17707
- "description": "slot for menu item checkbox subline text.",
18796
+ "description": "slot for menu item subline text.",
17708
18797
  "name": "trailing-text-subline",
17709
18798
  "inheritedFrom": {
17710
18799
  "name": "ListItem",
@@ -17712,7 +18801,7 @@
17712
18801
  }
17713
18802
  },
17714
18803
  {
17715
- "description": "slot for menu item checkbox controls to appear of trailing end.",
18804
+ "description": "slot for menu item controls to appear of trailing end.",
17716
18805
  "name": "trailing-controls",
17717
18806
  "inheritedFrom": {
17718
18807
  "name": "ListItem",
@@ -17721,67 +18810,6 @@
17721
18810
  }
17722
18811
  ],
17723
18812
  "members": [
17724
- {
17725
- "kind": "field",
17726
- "name": "checked",
17727
- "type": {
17728
- "text": "boolean"
17729
- },
17730
- "default": "false",
17731
- "description": "The checked attribute is used to indicate that the menuitemcheckbox is checked or not.",
17732
- "attribute": "checked",
17733
- "reflects": true
17734
- },
17735
- {
17736
- "kind": "field",
17737
- "name": "indicator",
17738
- "type": {
17739
- "text": "Indicator"
17740
- },
17741
- "description": "The indicator attribute is used to differentiate between <b>checkbox</b> and <b>toggle</b>.",
17742
- "default": "'checkbox'",
17743
- "attribute": "indicator",
17744
- "reflects": true
17745
- },
17746
- {
17747
- "kind": "method",
17748
- "name": "handleMouseClick",
17749
- "privacy": "private",
17750
- "description": "Handles click events to toggle checked state\nIf the menuitemcheckbox is disabled, it does nothing.\nIf the menuitemcheckbox is not disabled, it toggles the `checked` state between `true` and `false`."
17751
- },
17752
- {
17753
- "kind": "method",
17754
- "name": "staticCheckbox",
17755
- "privacy": "private",
17756
- "return": {
17757
- "type": {
17758
- "text": ""
17759
- }
17760
- },
17761
- "description": "Returns a static checkbox element if the indicator is set to checkbox.\nIf the indicator is not set to checkbox, it returns nothing."
17762
- },
17763
- {
17764
- "kind": "method",
17765
- "name": "staticToggle",
17766
- "privacy": "private",
17767
- "return": {
17768
- "type": {
17769
- "text": ""
17770
- }
17771
- },
17772
- "description": "Returns a static toggle element if the indicator is set to toggle.\nIf the indicator is not set to toggle, it returns nothing.\n\nThe toggle will always be positioned on the trailing side of the menuitem label."
17773
- },
17774
- {
17775
- "kind": "method",
17776
- "name": "getCheckmarkIcon",
17777
- "privacy": "private",
17778
- "return": {
17779
- "type": {
17780
- "text": ""
17781
- }
17782
- },
17783
- "description": "Returns a checkmark icon if the indicator is set to checkmark and the checked state is true.\nIf the indicator is not set to checkmark or the checked state is false, it returns nothing.\n\nThe checkmark icon will always be positioned on the trailing side of the menuitem label."
17784
- },
17785
18813
  {
17786
18814
  "kind": "field",
17787
18815
  "name": "arrowPosition",
@@ -17790,11 +18818,7 @@
17790
18818
  },
17791
18819
  "description": "Defines where the arrow icon will appear.\n- `'leading'`: Icon appears on the leading edge (start).\n- `'trailing'`: Icon appears on the trailing edge (end).\n\nIf not set, no arrow is displayed.",
17792
18820
  "attribute": "arrow-position",
17793
- "reflects": true,
17794
- "inheritedFrom": {
17795
- "name": "MenuItem",
17796
- "module": "components/menuitem/menuitem.component.js"
17797
- }
18821
+ "reflects": true
17798
18822
  },
17799
18823
  {
17800
18824
  "kind": "field",
@@ -17804,11 +18828,7 @@
17804
18828
  },
17805
18829
  "description": "Defines the direction the arrow icon points.\n- `'positive'`: Arrow points toward the trailing side.\n- `'negative'`: Arrow points toward the leading side.",
17806
18830
  "attribute": "arrow-direction",
17807
- "reflects": true,
17808
- "inheritedFrom": {
17809
- "name": "MenuItem",
17810
- "module": "components/menuitem/menuitem.component.js"
17811
- }
18831
+ "reflects": true
17812
18832
  },
17813
18833
  {
17814
18834
  "kind": "field",
@@ -17819,11 +18839,7 @@
17819
18839
  "default": "undefined",
17820
18840
  "description": "The name attribute is used to identify the menu item when it is selected.",
17821
18841
  "attribute": "name",
17822
- "reflects": true,
17823
- "inheritedFrom": {
17824
- "name": "MenuItem",
17825
- "module": "components/menuitem/menuitem.component.js"
17826
- }
18842
+ "reflects": true
17827
18843
  },
17828
18844
  {
17829
18845
  "kind": "field",
@@ -17834,11 +18850,7 @@
17834
18850
  "default": "undefined",
17835
18851
  "description": "The value attribute is used to represent a value when the menu item is selected.\nIt is typically used with checkbox and radio menu items, but can be handy for any menu item.",
17836
18852
  "attribute": "value",
17837
- "reflects": true,
17838
- "inheritedFrom": {
17839
- "name": "MenuItem",
17840
- "module": "components/menuitem/menuitem.component.js"
17841
- }
18853
+ "reflects": true
17842
18854
  },
17843
18855
  {
17844
18856
  "kind": "method",
@@ -17882,11 +18894,7 @@
17882
18894
  "description": "The keyboard event that triggered the action."
17883
18895
  }
17884
18896
  ],
17885
- "description": "Handles the keyup event for the menu item.\nIf the Space key is released, it triggers a click event on the menu item.\nThis allows keyboard users to activate the menu item using the Space key.\nIt also prevents the default action of the Space key to avoid scrolling the page.\n\nThis follows the native behaviour, actionable element can be triggered by Space\nkey on the keyup event.\n\nNote: Action triggered by Enter on the keydown event.",
17886
- "inheritedFrom": {
17887
- "name": "MenuItem",
17888
- "module": "components/menuitem/menuitem.component.js"
17889
- }
18897
+ "description": "Handles the keyup event for the menu item.\nIf the Space key is released, it triggers a click event on the menu item.\nThis allows keyboard users to activate the menu item using the Space key.\nIt also prevents the default action of the Space key to avoid scrolling the page.\n\nThis follows the native behaviour, actionable element can be triggered by Space\nkey on the keyup event.\n\nNote: Action triggered by Enter on the keydown event."
17890
18898
  },
17891
18899
  {
17892
18900
  "kind": "method",
@@ -18223,15 +19231,7 @@
18223
19231
  ],
18224
19232
  "events": [
18225
19233
  {
18226
- "name": "change",
18227
- "type": {
18228
- "text": "Event"
18229
- },
18230
- "description": "(React: onChange) This event is dispatched when the menuitemcheckbox changes.",
18231
- "reactName": "onChange"
18232
- },
18233
- {
18234
- "description": "(React: onClick) This event is dispatched when the menuitemcheckbox is clicked.",
19234
+ "description": "(React: onClick) This event is dispatched when the menuitem is clicked.",
18235
19235
  "name": "click",
18236
19236
  "reactName": "onClick",
18237
19237
  "inheritedFrom": {
@@ -18239,15 +19239,6 @@
18239
19239
  "module": "src/components/listitem/listitem.component.ts"
18240
19240
  }
18241
19241
  },
18242
- {
18243
- "description": "(React: onFocus) This event is dispatched when the menuitemcheckbox receives focus.",
18244
- "name": "focus",
18245
- "reactName": "onFocus",
18246
- "inheritedFrom": {
18247
- "name": "ListItem",
18248
- "module": "src/components/listitem/listitem.component.ts"
18249
- }
18250
- },
18251
19242
  {
18252
19243
  "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the menuitem.",
18253
19244
  "name": "keydown",
@@ -18266,6 +19257,15 @@
18266
19257
  "module": "src/components/listitem/listitem.component.ts"
18267
19258
  }
18268
19259
  },
19260
+ {
19261
+ "description": "(React: onFocus) This event is dispatched when the menuitem receives focus.",
19262
+ "name": "focus",
19263
+ "reactName": "onFocus",
19264
+ "inheritedFrom": {
19265
+ "name": "ListItem",
19266
+ "module": "src/components/listitem/listitem.component.ts"
19267
+ }
19268
+ },
18269
19269
  {
18270
19270
  "description": "(React: onEnabled) This event is dispatched after the listitem is enabled",
18271
19271
  "name": "enabled",
@@ -18304,35 +19304,13 @@
18304
19304
  }
18305
19305
  ],
18306
19306
  "attributes": [
18307
- {
18308
- "name": "checked",
18309
- "type": {
18310
- "text": "boolean"
18311
- },
18312
- "default": "false",
18313
- "description": "The checked attribute is used to indicate that the menuitemcheckbox is checked or not.",
18314
- "fieldName": "checked"
18315
- },
18316
- {
18317
- "name": "indicator",
18318
- "type": {
18319
- "text": "Indicator"
18320
- },
18321
- "description": "The indicator attribute is used to differentiate between <b>checkbox</b> and <b>toggle</b>.",
18322
- "default": "'checkbox'",
18323
- "fieldName": "indicator"
18324
- },
18325
19307
  {
18326
19308
  "name": "arrow-position",
18327
19309
  "type": {
18328
19310
  "text": "ArrowPositions | undefined"
18329
19311
  },
18330
19312
  "description": "Defines where the arrow icon will appear.\n- `'leading'`: Icon appears on the leading edge (start).\n- `'trailing'`: Icon appears on the trailing edge (end).\n\nIf not set, no arrow is displayed.",
18331
- "fieldName": "arrowPosition",
18332
- "inheritedFrom": {
18333
- "name": "MenuItem",
18334
- "module": "src/components/menuitem/menuitem.component.ts"
18335
- }
19313
+ "fieldName": "arrowPosition"
18336
19314
  },
18337
19315
  {
18338
19316
  "name": "arrow-direction",
@@ -18340,11 +19318,7 @@
18340
19318
  "text": "ArrowDirections | undefined"
18341
19319
  },
18342
19320
  "description": "Defines the direction the arrow icon points.\n- `'positive'`: Arrow points toward the trailing side.\n- `'negative'`: Arrow points toward the leading side.",
18343
- "fieldName": "arrowDirection",
18344
- "inheritedFrom": {
18345
- "name": "MenuItem",
18346
- "module": "src/components/menuitem/menuitem.component.ts"
18347
- }
19321
+ "fieldName": "arrowDirection"
18348
19322
  },
18349
19323
  {
18350
19324
  "name": "name",
@@ -18353,11 +19327,7 @@
18353
19327
  },
18354
19328
  "default": "undefined",
18355
19329
  "description": "The name attribute is used to identify the menu item when it is selected.",
18356
- "fieldName": "name",
18357
- "inheritedFrom": {
18358
- "name": "MenuItem",
18359
- "module": "src/components/menuitem/menuitem.component.ts"
18360
- }
19330
+ "fieldName": "name"
18361
19331
  },
18362
19332
  {
18363
19333
  "name": "value",
@@ -18366,11 +19336,7 @@
18366
19336
  },
18367
19337
  "default": "undefined",
18368
19338
  "description": "The value attribute is used to represent a value when the menu item is selected.\nIt is typically used with checkbox and radio menu items, but can be handy for any menu item.",
18369
- "fieldName": "value",
18370
- "inheritedFrom": {
18371
- "name": "MenuItem",
18372
- "module": "src/components/menuitem/menuitem.component.ts"
18373
- }
19339
+ "fieldName": "value"
18374
19340
  },
18375
19341
  {
18376
19342
  "name": "disabled",
@@ -18511,11 +19477,11 @@
18511
19477
  }
18512
19478
  ],
18513
19479
  "superclass": {
18514
- "name": "MenuItem",
18515
- "module": "/src/components/menuitem/menuitem.component"
19480
+ "name": "ListItem",
19481
+ "module": "/src/components/listitem/listitem.component"
18516
19482
  },
18517
- "tagName": "mdc-menuitemcheckbox",
18518
- "jsDoc": "/**\n * A menuitemcheckbox component is a checkable menuitem.\n * There should be no focusable descendants inside this menuitemcheckbox component.\n *\n * The `checked` attribute indicates whether the menuitemcheckbox is checked or not.\n *\n * Menu item checkbox has `name` and `value` attribute that can be used to identify the menu item when it is selected.\n *\n * The `indicator` attribute is used to differentiate between <b>checkbox</b>, <b>checkmark</b>, <b>toggle</b> and <b>none</b>.\n * By default, the `indicator` is set to <b>checkbox</b>.<br/>\n *\n * The checkbox will always be positioned on the leading side of the menuitem label and\n * the toggle and checkmark will always be positioned on the trailing side.\n *\n * The checkbox will have the possible states of `true` or `false`.\n * If the indicator is set to <b>checkmark</b> and if the `checked` attribute is set to `true`,\n * then the checkmark will be displayed. if not, then no indicator will be displayed.\n *\n * The forth options for the `indicator` is <b>none</b>, which will not display any indicator at all.\n * It is intended to be used for customised menu items where the indicator is implemented differently.\n * For example, you can use a custom icon or a different visual element to indicate the state of the menu item.\n * Make sure the new indicator is accessible.\n *\n * If you want only one item in a group to be checked, consider using menuitemradio component.\n *\n * @dependency mdc-staticcheckbox\n * @dependency mdc-statictoggle\n * @dependency mdc-icon\n *\n * @tagname mdc-menuitemcheckbox\n *\n * @slot leading-controls - slot for menu item checkbox controls to appear of leading end.\n * @slot leading-text-primary-label - slot for menu item checkbox primary label.\n * @slot leading-text-secondary-label - slot for menu item checkbox secondary label.\n * @slot leading-text-tertiary-label - slot for menu item checkbox tertiary label.\n * @slot trailing-text-side-header - slot for menu item checkbox side header text.\n * @slot trailing-text-subline - slot for menu item checkbox subline text.\n * @slot trailing-controls - slot for menu item checkbox controls to appear of trailing end.\n *\n * @event change - (React: onChange) This event is dispatched when the menuitemcheckbox changes.\n * @event click - (React: onClick) This event is dispatched when the menuitemcheckbox is clicked.\n * @event focus - (React: onFocus) This event is dispatched when the menuitemcheckbox receives focus.\n */",
19483
+ "tagName": "mdc-menuitem",
19484
+ "jsDoc": "/**\n * menuitem component is inherited by listitem component with the role set `menuitem`.<br/>\n * A menu item can contain an icon on the leading or trailing side.\n *\n * The leading and trailing slots can be used to display controls and text.<br/>\n * Based on the leading/trailing slot, the position of the controls and text can be adjusted.\n *\n * Please use element with role=menu as a parent element even when there is only menuitem for a11y purpose.\n * For example mdc-menupopover or mdc-menubar.\n *\n * Menu item has `name` and `value` attribute that can be used to identify the menu item when it is selected.\n *\n * @dependency mdc-text\n * @dependency mdc-icon\n * @dependency mdc-tooltip\n *\n * @tagname mdc-menuitem\n *\n * @slot leading-controls - slot for menu item controls to appear of leading end.\n * @slot leading-text-primary-label - slot for menu item primary label.\n * @slot leading-text-secondary-label - slot for menu item secondary label.\n * @slot leading-text-tertiary-label - slot for menu item tertiary label.\n * @slot trailing-text-side-header - slot for menu item side header text.\n * @slot trailing-text-subline - slot for menu item subline text.\n * @slot trailing-controls - slot for menu item controls to appear of trailing end.\n *\n * @event click - (React: onClick) This event is dispatched when the menuitem is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the menuitem.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the menuitem.\n * @event focus - (React: onFocus) This event is dispatched when the menuitem receives focus.\n */",
18519
19485
  "customElement": true,
18520
19486
  "cssProperties": [
18521
19487
  {
@@ -18590,8 +19556,8 @@
18590
19556
  "kind": "js",
18591
19557
  "name": "default",
18592
19558
  "declaration": {
18593
- "name": "MenuItemCheckbox",
18594
- "module": "components/menuitemcheckbox/menuitemcheckbox.component.js"
19559
+ "name": "MenuItem",
19560
+ "module": "components/menuitem/menuitem.component.js"
18595
19561
  }
18596
19562
  }
18597
19563
  ]