@momentum-design/components 0.129.9 → 0.129.10

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.
@@ -8,7 +8,7 @@
8
8
  "declarations": [
9
9
  {
10
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.\n\nIf an accordion is expanded by default, then the screen reader might loose focus when toggling the visibilty of the accordion.",
11
+ "description": "An accordion is a vertically stacked component with a header and expandable/collapsible body section.\nThe header displays a prefix icon, header text, optional control slots (leading and trailing), and a dedicated expand/collapse button.\nUnlike `accordionbutton`, only the expand/collapse button is clickable and not the entire header.\n\n## Header contains\n- Optional prefix icon\n- Header text (default H3, customizable via `data-aria-level`)\n- Leading slot for controls (placed after header text)\n- Trailing slot for controls (placed before expand/collapse button)\n- Expand/collapse button (automatically positioned at the end)\n\n## Body contains\n- Default slot for any content\n\nThe accordion supports different border styles through the `variant` attribute and different spacing through the `size` attribute.\nAn accordion can be disabled, which prevents all interactions including the expand/collapse button and any slotted controls.\n\n## When to use\n- Use `mdc-accordion` when you need additional interactive controls (chips, badges, buttons, icons) in the header.\n- Use `mdc-accordionbutton` if you only need a simple clickable header without extra controls.\n\n## Accessibility\n- Always provide `open-button-aria-label` and `close-button-aria-label` for screen reader support\n- Adjust `data-aria-level` based on heading hierarchy in your page\n- Note: Screen readers may lose focus when toggling if accordion is expanded by default",
12
12
  "name": "Accordion",
13
13
  "cssProperties": [
14
14
  {
@@ -20,24 +20,24 @@
20
20
  }
21
21
  },
22
22
  {
23
- "description": "The hover color of the accordion.",
24
- "name": "--mdc-accordionbutton-hover-color",
23
+ "description": "The disabled text color of the accordion.",
24
+ "name": "--mdc-accordionbutton-disabled-color",
25
25
  "inheritedFrom": {
26
26
  "name": "AccordionButton",
27
27
  "module": "src/components/accordionbutton/accordionbutton.component.ts"
28
28
  }
29
29
  },
30
30
  {
31
- "description": "The active color of the accordion.",
32
- "name": "--mdc-accordionbutton-active-color",
31
+ "description": "The hover background color of the accordion button header.",
32
+ "name": "--mdc-accordionbutton-hover-color",
33
33
  "inheritedFrom": {
34
34
  "name": "AccordionButton",
35
35
  "module": "src/components/accordionbutton/accordionbutton.component.ts"
36
36
  }
37
37
  },
38
38
  {
39
- "description": "The disabled color of the accordion.",
40
- "name": "--mdc-accordionbutton-disabled-color",
39
+ "description": "The active background color of the accordion button header.",
40
+ "name": "--mdc-accordionbutton-active-color",
41
41
  "inheritedFrom": {
42
42
  "name": "AccordionButton",
43
43
  "module": "src/components/accordionbutton/accordionbutton.component.ts"
@@ -100,11 +100,11 @@
100
100
  ],
101
101
  "slots": [
102
102
  {
103
- "description": "The leading controls slot of the accordion on the header section.",
103
+ "description": "The leading controls slot of the accordion on the header section. Placed after the header text.",
104
104
  "name": "leading-controls"
105
105
  },
106
106
  {
107
- "description": "The trailing controls slot of the accordion on the header section.",
107
+ "description": "The trailing controls slot of the accordion on the header section. Placed before the expand/collapse button.",
108
108
  "name": "trailing-controls"
109
109
  },
110
110
  {
@@ -123,7 +123,7 @@
123
123
  "type": {
124
124
  "text": "string | undefined"
125
125
  },
126
- "description": "Aria-label attribute for the trigger button when accordion is expanded.",
126
+ "description": "Accessible label for the expand/collapse button when the accordion is in expanded state.\nProvides context to screen readers about the button's action to close the accordion.",
127
127
  "attribute": "close-button-aria-label",
128
128
  "reflects": true
129
129
  },
@@ -133,7 +133,7 @@
133
133
  "type": {
134
134
  "text": "number"
135
135
  },
136
- "description": "The aria level of the accordion component.",
136
+ "description": "Specifies the heading level for accessibility purposes.\nShould match the heading hierarchy of the page (e.g., 2 for H2, 3 for H3).",
137
137
  "default": "3",
138
138
  "attribute": "data-aria-level",
139
139
  "reflects": true,
@@ -153,8 +153,8 @@
153
153
  "attribute": "disabled",
154
154
  "reflects": true,
155
155
  "inheritedFrom": {
156
- "name": "DisabledMixin",
157
- "module": "utils/mixins/DisabledMixin.js"
156
+ "name": "AccordionButton",
157
+ "module": "components/accordionbutton/accordionbutton.component.js"
158
158
  }
159
159
  },
160
160
  {
@@ -178,7 +178,7 @@
178
178
  "type": {
179
179
  "text": "boolean"
180
180
  },
181
- "description": "The visibility of the accordion button.",
181
+ "description": "Controls whether the accordion body content is visible.\n- When true, the body section is shown; when false, it is hidden.",
182
182
  "default": "false",
183
183
  "attribute": "expanded",
184
184
  "reflects": true,
@@ -247,7 +247,7 @@
247
247
  "type": {
248
248
  "text": "string | undefined"
249
249
  },
250
- "description": "The header text of the accordion item.",
250
+ "description": "Text content displayed in the accordion header.",
251
251
  "attribute": "header-text",
252
252
  "reflects": true,
253
253
  "inheritedFrom": {
@@ -261,7 +261,7 @@
261
261
  "type": {
262
262
  "text": "string | undefined"
263
263
  },
264
- "description": "Aria-label attribute for the trigger button when accordion is collapsed.",
264
+ "description": "Accessible label for the expand/collapse button when the accordion is in collapsed state.\nProvides context to screen readers about the button's action to open the accordion.",
265
265
  "attribute": "open-button-aria-label",
266
266
  "reflects": true
267
267
  },
@@ -271,7 +271,7 @@
271
271
  "type": {
272
272
  "text": "IconNames | undefined"
273
273
  },
274
- "description": "The leading icon that is displayed before the header text.",
274
+ "description": "Icon displayed at the start of the accordion header, before the header text.\nMust be a valid icon name.",
275
275
  "attribute": "prefix-icon",
276
276
  "inheritedFrom": {
277
277
  "name": "AccordionButton",
@@ -350,7 +350,7 @@
350
350
  "type": {
351
351
  "text": "Size"
352
352
  },
353
- "description": "The size of the accordion item.",
353
+ "description": "Controls the spacing and padding of the accordion. \n- Small provides 1rem (16px) padding, large provides 1.5rem (24px) padding.",
354
354
  "default": "'small'",
355
355
  "attribute": "size",
356
356
  "reflects": true,
@@ -365,7 +365,7 @@
365
365
  "type": {
366
366
  "text": "Variant"
367
367
  },
368
- "description": "The variant of the accordion item. Based on the variant, the styling of the accordion gets changed.",
368
+ "description": "Visual style variant of the accordion. \n- Default includes borders, borderless removes all border styling.",
369
369
  "default": "'default'",
370
370
  "attribute": "variant",
371
371
  "reflects": true,
@@ -377,7 +377,7 @@
377
377
  ],
378
378
  "events": [
379
379
  {
380
- "description": "(React: onShown) This event is triggered when the accordion is expanded.",
380
+ "description": "(React: onShown) This event is triggered when the accordion is toggled (expanded or collapsed).",
381
381
  "name": "shown",
382
382
  "reactName": "onShown",
383
383
  "inheritedFrom": {
@@ -392,7 +392,7 @@
392
392
  "type": {
393
393
  "text": "string | undefined"
394
394
  },
395
- "description": "Aria-label attribute for the trigger button when accordion is collapsed.",
395
+ "description": "Accessible label for the expand/collapse button when the accordion is in collapsed state.\nProvides context to screen readers about the button's action to open the accordion.",
396
396
  "fieldName": "openButtonAriaLabel"
397
397
  },
398
398
  {
@@ -400,7 +400,7 @@
400
400
  "type": {
401
401
  "text": "string | undefined"
402
402
  },
403
- "description": "Aria-label attribute for the trigger button when accordion is expanded.",
403
+ "description": "Accessible label for the expand/collapse button when the accordion is in expanded state.\nProvides context to screen readers about the button's action to close the accordion.",
404
404
  "fieldName": "closeButtonAriaLabel"
405
405
  },
406
406
  {
@@ -412,8 +412,8 @@
412
412
  "default": "undefined",
413
413
  "fieldName": "disabled",
414
414
  "inheritedFrom": {
415
- "name": "DisabledMixin",
416
- "module": "src/utils/mixins/DisabledMixin.ts"
415
+ "name": "AccordionButton",
416
+ "module": "src/components/accordionbutton/accordionbutton.component.ts"
417
417
  }
418
418
  },
419
419
  {
@@ -421,7 +421,7 @@
421
421
  "type": {
422
422
  "text": "Size"
423
423
  },
424
- "description": "The size of the accordion item.",
424
+ "description": "Controls the spacing and padding of the accordion. \n- Small provides 1rem (16px) padding, large provides 1.5rem (24px) padding.",
425
425
  "default": "'small'",
426
426
  "fieldName": "size",
427
427
  "inheritedFrom": {
@@ -434,7 +434,7 @@
434
434
  "type": {
435
435
  "text": "Variant"
436
436
  },
437
- "description": "The variant of the accordion item. Based on the variant, the styling of the accordion gets changed.",
437
+ "description": "Visual style variant of the accordion. \n- Default includes borders, borderless removes all border styling.",
438
438
  "default": "'default'",
439
439
  "fieldName": "variant",
440
440
  "inheritedFrom": {
@@ -447,7 +447,7 @@
447
447
  "type": {
448
448
  "text": "number"
449
449
  },
450
- "description": "The aria level of the accordion component.",
450
+ "description": "Specifies the heading level for accessibility purposes.\nShould match the heading hierarchy of the page (e.g., 2 for H2, 3 for H3).",
451
451
  "default": "3",
452
452
  "fieldName": "dataAriaLevel",
453
453
  "inheritedFrom": {
@@ -460,7 +460,7 @@
460
460
  "type": {
461
461
  "text": "boolean"
462
462
  },
463
- "description": "The visibility of the accordion button.",
463
+ "description": "Controls whether the accordion body content is visible.\n- When true, the body section is shown; when false, it is hidden.",
464
464
  "default": "false",
465
465
  "fieldName": "expanded",
466
466
  "inheritedFrom": {
@@ -473,7 +473,7 @@
473
473
  "type": {
474
474
  "text": "string | undefined"
475
475
  },
476
- "description": "The header text of the accordion item.",
476
+ "description": "Text content displayed in the accordion header.",
477
477
  "fieldName": "headerText",
478
478
  "inheritedFrom": {
479
479
  "name": "AccordionButton",
@@ -485,7 +485,7 @@
485
485
  "type": {
486
486
  "text": "IconNames | undefined"
487
487
  },
488
- "description": "The leading icon that is displayed before the header text.",
488
+ "description": "Icon displayed at the start of the accordion header, before the header text.\nMust be a valid icon name.",
489
489
  "fieldName": "prefixIcon",
490
490
  "inheritedFrom": {
491
491
  "name": "AccordionButton",
@@ -498,7 +498,7 @@
498
498
  "module": "/src/components/accordionbutton/accordionbutton.component"
499
499
  },
500
500
  "tagName": "mdc-accordion",
501
- "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 * If an accordion is expanded by default, then the screen reader might loose focus when toggling the visibilty of the accordion.\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 body-section - The body section of the accordion.\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 */",
501
+ "jsDoc": "/**\n * An accordion is a vertically stacked component with a header and expandable/collapsible body section.\n * The header displays a prefix icon, header text, optional control slots (leading and trailing), and a dedicated expand/collapse button.\n * Unlike `accordionbutton`, only the expand/collapse button is clickable and not the entire header.\n *\n * ## Header contains\n * - Optional prefix icon\n * - Header text (default H3, customizable via `data-aria-level`)\n * - Leading slot for controls (placed after header text)\n * - Trailing slot for controls (placed before expand/collapse button)\n * - Expand/collapse button (automatically positioned at the end)\n *\n * ## Body contains\n * - Default slot for any content\n *\n * The accordion supports different border styles through the `variant` attribute and different spacing through the `size` attribute.\n * An accordion can be disabled, which prevents all interactions including the expand/collapse button and any slotted controls.\n * \n * ## When to use\n * - Use `mdc-accordion` when you need additional interactive controls (chips, badges, buttons, icons) in the header.\n * - Use `mdc-accordionbutton` if you only need a simple clickable header without extra controls.\n *\n * ## Accessibility\n * - Always provide `open-button-aria-label` and `close-button-aria-label` for screen reader support\n * - Adjust `data-aria-level` based on heading hierarchy in your page\n * - Note: Screen readers may lose focus when toggling if accordion is expanded by default\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. Placed after the header text.\n * @slot trailing-controls - The trailing controls slot of the accordion on the header section. Placed before the expand/collapse button.\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 toggled (expanded or collapsed).\n *\n * @cssproperty --mdc-accordionbutton-border-color - The border color of the accordion.\n * @cssproperty --mdc-accordionbutton-disabled-color - The disabled text color of the accordion.\n *\n * @csspart body-section - The body section of the accordion.\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 */",
502
502
  "customElement": true
503
503
  }
504
504
  ],
@@ -519,7 +519,7 @@
519
519
  "declarations": [
520
520
  {
521
521
  "kind": "class",
522
- "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.\n\nIf an accordion button is expanded by default, then the screen reader might loose focus when toggling the visibilty of the accordion button.",
522
+ "description": "An accordion button is a vertically stacked component with a clickable header and expandable/collapsible body section.\nThe entire header is clickable to toggle the visibility of the body content.\n\n## Header contains\n- Optional prefix icon\n- Header text (default H3, customizable via `data-aria-level`)\n- Expand/collapse arrow icon (visual indicator)\n\n## Body contains\n- Default slot for any content\n\nThe accordion button supports different border styles through the `variant` attribute and different spacing through the `size` attribute.\nAn accordion button can be disabled, which prevents the header from being clickable.\n\n## When to use\n- Use `mdc-accordionbutton` for simple clickable headers without additional controls.\n- Use `mdc-accordion` instead if you need extra controls (chips, badges, icons) in the header.\n\n## Accessibility\n- Adjust `data-aria-level` based on heading hierarchy in your page.\n- Note: Screen readers may lose focus when toggling if accordion button is expanded by default.",
523
523
  "name": "AccordionButton",
524
524
  "cssProperties": [
525
525
  {
@@ -527,15 +527,15 @@
527
527
  "name": "--mdc-accordionbutton-border-color"
528
528
  },
529
529
  {
530
- "description": "The hover color of the accordion button.",
530
+ "description": "The hover background color of the accordion button header.",
531
531
  "name": "--mdc-accordionbutton-hover-color"
532
532
  },
533
533
  {
534
- "description": "The active color of the accordion button.",
534
+ "description": "The active background color of the accordion button header.",
535
535
  "name": "--mdc-accordionbutton-active-color"
536
536
  },
537
537
  {
538
- "description": "The disabled color of the accordion button.",
538
+ "description": "The disabled text color of the accordion button.",
539
539
  "name": "--mdc-accordionbutton-disabled-color"
540
540
  }
541
541
  ],
@@ -578,7 +578,7 @@
578
578
  "type": {
579
579
  "text": "number"
580
580
  },
581
- "description": "The aria level of the accordion component.",
581
+ "description": "Specifies the heading level for accessibility purposes.\nShould match the heading hierarchy of the page (e.g., 2 for H2, 3 for H3).",
582
582
  "default": "3",
583
583
  "attribute": "data-aria-level",
584
584
  "reflects": true
@@ -615,7 +615,7 @@
615
615
  "type": {
616
616
  "text": "boolean"
617
617
  },
618
- "description": "The visibility of the accordion button.",
618
+ "description": "Controls whether the accordion body content is visible.\n- When true, the body section is shown; when false, it is hidden.",
619
619
  "default": "false",
620
620
  "attribute": "expanded",
621
621
  "reflects": true
@@ -668,7 +668,7 @@
668
668
  "type": {
669
669
  "text": "string | undefined"
670
670
  },
671
- "description": "The header text of the accordion item.",
671
+ "description": "Text content displayed in the accordion header.",
672
672
  "attribute": "header-text",
673
673
  "reflects": true
674
674
  },
@@ -678,7 +678,7 @@
678
678
  "type": {
679
679
  "text": "IconNames | undefined"
680
680
  },
681
- "description": "The leading icon that is displayed before the header text.",
681
+ "description": "Icon displayed at the start of the accordion header, before the header text.\nMust be a valid icon name.",
682
682
  "attribute": "prefix-icon"
683
683
  },
684
684
  {
@@ -736,7 +736,7 @@
736
736
  "type": {
737
737
  "text": "Size"
738
738
  },
739
- "description": "The size of the accordion item.",
739
+ "description": "Controls the spacing and padding of the accordion. \n- Small provides 1rem (16px) padding, large provides 1.5rem (24px) padding.",
740
740
  "default": "'small'",
741
741
  "attribute": "size",
742
742
  "reflects": true
@@ -747,7 +747,7 @@
747
747
  "type": {
748
748
  "text": "Variant"
749
749
  },
750
- "description": "The variant of the accordion item. Based on the variant, the styling of the accordion gets changed.",
750
+ "description": "Visual style variant of the accordion. \n- Default includes borders, borderless removes all border styling.",
751
751
  "default": "'default'",
752
752
  "attribute": "variant",
753
753
  "reflects": true
@@ -755,7 +755,7 @@
755
755
  ],
756
756
  "events": [
757
757
  {
758
- "description": "(React: onShown) This event is triggered when the accordion button is expanded.",
758
+ "description": "(React: onShown) This event is triggered when the accordion button is toggled (expanded or collapsed).",
759
759
  "name": "shown",
760
760
  "reactName": "onShown"
761
761
  }
@@ -766,7 +766,7 @@
766
766
  "type": {
767
767
  "text": "Size"
768
768
  },
769
- "description": "The size of the accordion item.",
769
+ "description": "Controls the spacing and padding of the accordion. \n- Small provides 1rem (16px) padding, large provides 1.5rem (24px) padding.",
770
770
  "default": "'small'",
771
771
  "fieldName": "size"
772
772
  },
@@ -775,7 +775,7 @@
775
775
  "type": {
776
776
  "text": "Variant"
777
777
  },
778
- "description": "The variant of the accordion item. Based on the variant, the styling of the accordion gets changed.",
778
+ "description": "Visual style variant of the accordion. \n- Default includes borders, borderless removes all border styling.",
779
779
  "default": "'default'",
780
780
  "fieldName": "variant"
781
781
  },
@@ -784,7 +784,7 @@
784
784
  "type": {
785
785
  "text": "number"
786
786
  },
787
- "description": "The aria level of the accordion component.",
787
+ "description": "Specifies the heading level for accessibility purposes.\nShould match the heading hierarchy of the page (e.g., 2 for H2, 3 for H3).",
788
788
  "default": "3",
789
789
  "fieldName": "dataAriaLevel"
790
790
  },
@@ -793,7 +793,7 @@
793
793
  "type": {
794
794
  "text": "boolean"
795
795
  },
796
- "description": "The visibility of the accordion button.",
796
+ "description": "Controls whether the accordion body content is visible.\n- When true, the body section is shown; when false, it is hidden.",
797
797
  "default": "false",
798
798
  "fieldName": "expanded"
799
799
  },
@@ -802,7 +802,7 @@
802
802
  "type": {
803
803
  "text": "string | undefined"
804
804
  },
805
- "description": "The header text of the accordion item.",
805
+ "description": "Text content displayed in the accordion header.",
806
806
  "fieldName": "headerText"
807
807
  },
808
808
  {
@@ -810,7 +810,7 @@
810
810
  "type": {
811
811
  "text": "IconNames | undefined"
812
812
  },
813
- "description": "The leading icon that is displayed before the header text.",
813
+ "description": "Icon displayed at the start of the accordion header, before the header text.\nMust be a valid icon name.",
814
814
  "fieldName": "prefixIcon"
815
815
  },
816
816
  {
@@ -838,7 +838,7 @@
838
838
  "module": "/src/models"
839
839
  },
840
840
  "tagName": "mdc-accordionbutton",
841
- "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 * If an accordion button is expanded by default, then the screen reader might loose focus when toggling the visibilty of the accordion button.\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 body-section - The body section of the accordion button.\n * @csspart header-button-section - The header button section of the accordion button.\n * @csspart header-section - The header 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 */",
841
+ "jsDoc": "/**\n * An accordion button is a vertically stacked component with a clickable header and expandable/collapsible body section.\n * The entire header is clickable to toggle the visibility of the body content.\n *\n * ## Header contains\n * - Optional prefix icon\n * - Header text (default H3, customizable via `data-aria-level`)\n * - Expand/collapse arrow icon (visual indicator)\n *\n * ## Body contains\n * - Default slot for any content\n *\n * The accordion button supports different border styles through the `variant` attribute and different spacing through the `size` attribute.\n * An accordion button can be disabled, which prevents the header from being clickable.\n *\n * ## When to use\n * - Use `mdc-accordionbutton` for simple clickable headers without additional controls.\n * - Use `mdc-accordion` instead if you need extra controls (chips, badges, icons) in the header.\n *\n * ## Accessibility\n * - Adjust `data-aria-level` based on heading hierarchy in your page.\n * - Note: Screen readers may lose focus when toggling if accordion button is expanded by default.\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 toggled (expanded or collapsed).\n *\n * @cssproperty --mdc-accordionbutton-border-color - The border color of the accordion button.\n * @cssproperty --mdc-accordionbutton-hover-color - The hover background color of the accordion button header.\n * @cssproperty --mdc-accordionbutton-active-color - The active background color of the accordion button header.\n * @cssproperty --mdc-accordionbutton-disabled-color - The disabled text color of the accordion button.\n *\n * @csspart body-section - The body section of the accordion button.\n * @csspart header-button-section - The header button section of the accordion button.\n * @csspart header-section - The header 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 */",
842
842
  "customElement": true
843
843
  }
844
844
  ],
@@ -859,12 +859,12 @@
859
859
  "declarations": [
860
860
  {
861
861
  "kind": "class",
862
- "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.\n\nIf the first accordion of the accordion group is expanded by default, then the screen reader might loose focus when toggling the visibilty of the first accordion.",
862
+ "description": "An accordion group is a container that manages multiple accordion or accordionbutton components as a unified set.\nIt controls the visual styling, spacing, and expansion behavior of all child accordions.\n\nThe group applies consistent `variant` and `size` attributes to all children automatically.\nBy default, expanding one accordion collapses others (`allow-multiple` is false). Set `allow-multiple` to true to allow multiple expanded items.\n\n## Accepted children\n- Use `mdc-accordionbutton` children for simple clickable headers.\n- Use `mdc-accordion` children when you need additional controls (chips, badges, icons) in the headers.\n- Other elements in the slot are ignored.\n\n## Accessibility\n- Note: Screen readers may lose focus when toggling if the first accordion is expanded by default.",
863
863
  "name": "AccordionGroup",
864
864
  "cssProperties": [
865
865
  {
866
- "description": "The border color of the entire accordiongroup",
867
- "name": "--mdc-accordiongroup-border-color"
866
+ "description": "The border color applied to all child accordion items and their separators.",
867
+ "name": "--mdc-accordiongroup-items-border-color"
868
868
  }
869
869
  ],
870
870
  "slots": [
@@ -881,7 +881,7 @@
881
881
  "text": "boolean"
882
882
  },
883
883
  "default": "false",
884
- "description": "If true, multiple accordion items can be visible at the same time.",
884
+ "description": "Controls whether multiple accordions can be expanded simultaneously.\n- When false, expanding one accordion automatically collapses others.\n- When true, multiple accordions can remain open at the same time.",
885
885
  "attribute": "allow-multiple",
886
886
  "reflects": true
887
887
  },
@@ -938,7 +938,7 @@
938
938
  "type": {
939
939
  "text": "Size"
940
940
  },
941
- "description": "The size of the accordion item.",
941
+ "description": "Controls the spacing and padding for all accordion items in the group.\nThis size is applied to all child accordions.\n- Small provides 1rem (16px) padding, large provides 1.5rem (24px) padding.",
942
942
  "default": "'small'",
943
943
  "attribute": "size",
944
944
  "reflects": true
@@ -949,7 +949,7 @@
949
949
  "type": {
950
950
  "text": "Variant"
951
951
  },
952
- "description": "The variant of the accordion item. Based on the variant, the styling of the accordion gets changed.",
952
+ "description": "Visual style variant applied to all accordions in the group.\n- Stacked: accordions have 1.5rem gap between them.\n- Borderless: removes all borders from accordions and group.\n- Contained: accordions have continuous borders with no gaps.",
953
953
  "default": "'stacked'",
954
954
  "attribute": "variant",
955
955
  "reflects": true
@@ -961,7 +961,7 @@
961
961
  "type": {
962
962
  "text": "Size"
963
963
  },
964
- "description": "The size of the accordion item.",
964
+ "description": "Controls the spacing and padding for all accordion items in the group.\nThis size is applied to all child accordions.\n- Small provides 1rem (16px) padding, large provides 1.5rem (24px) padding.",
965
965
  "default": "'small'",
966
966
  "fieldName": "size"
967
967
  },
@@ -970,7 +970,7 @@
970
970
  "type": {
971
971
  "text": "Variant"
972
972
  },
973
- "description": "The variant of the accordion item. Based on the variant, the styling of the accordion gets changed.",
973
+ "description": "Visual style variant applied to all accordions in the group.\n- Stacked: accordions have 1.5rem gap between them.\n- Borderless: removes all borders from accordions and group.\n- Contained: accordions have continuous borders with no gaps.",
974
974
  "default": "'stacked'",
975
975
  "fieldName": "variant"
976
976
  },
@@ -980,7 +980,7 @@
980
980
  "text": "boolean"
981
981
  },
982
982
  "default": "false",
983
- "description": "If true, multiple accordion items can be visible at the same time.",
983
+ "description": "Controls whether multiple accordions can be expanded simultaneously.\n- When false, expanding one accordion automatically collapses others.\n- When true, multiple accordions can remain open at the same time.",
984
984
  "fieldName": "allowMultiple"
985
985
  }
986
986
  ],
@@ -989,7 +989,7 @@
989
989
  "module": "/src/models"
990
990
  },
991
991
  "tagName": "mdc-accordiongroup",
992
- "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 * If the first accordion of the accordion group is expanded by default, then the screen reader might loose focus when toggling the visibilty of the first accordion.\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 */",
992
+ "jsDoc": "/**\n * An accordion group is a container that manages multiple accordion or accordionbutton components as a unified set.\n * It controls the visual styling, spacing, and expansion behavior of all child accordions.\n *\n * The group applies consistent `variant` and `size` attributes to all children automatically.\n * By default, expanding one accordion collapses others (`allow-multiple` is false). Set `allow-multiple` to true to allow multiple expanded items.\n *\n * ## Accepted children\n * - Use `mdc-accordionbutton` children for simple clickable headers.\n * - Use `mdc-accordion` children when you need additional controls (chips, badges, icons) in the headers.\n * - Other elements in the slot are ignored.\n *\n * ## Accessibility\n * - Note: Screen readers may lose focus when toggling if the first accordion is expanded by default.\n *\n * @tagname mdc-accordiongroup\n *\n * @slot default - The default slot can contain the `accordion` or `accordionbutton` components.\n *\n * @cssproperty --mdc-accordiongroup-items-border-color - The border color applied to all child accordion items and their separators.\n */",
993
993
  "customElement": true
994
994
  }
995
995
  ],
@@ -2,30 +2,31 @@ import { type EventName } from '@lit/react';
2
2
  import Component from '../../components/accordion';
3
3
  import type { Events as EventsInherited } from '../../components/accordionbutton/accordionbutton.types';
4
4
  /**
5
- * An accordion contains a header and body section with a focusable heading that can be expanded or collapsed.
5
+ * An accordion is a vertically stacked component with a header and expandable/collapsible body section.
6
+ * The header displays a prefix icon, header text, optional control slots (leading and trailing), and a dedicated expand/collapse button.
7
+ * Unlike `accordionbutton`, only the expand/collapse button is clickable and not the entire header.
6
8
  *
7
- * The header section contains:
8
- * - Prefix Icon
9
- * - Header Text
10
- * - 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.
11
- * - 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.
9
+ * ## Header contains
10
+ * - Optional prefix icon
11
+ * - Header text (default H3, customizable via `data-aria-level`)
12
+ * - Leading slot for controls (placed after header text)
13
+ * - Trailing slot for controls (placed before expand/collapse button)
14
+ * - Expand/collapse button (automatically positioned at the end)
12
15
  *
13
- * The body section contains:
14
- * - Default slot - User can place any content inside the body section.
16
+ * ## Body contains
17
+ * - Default slot for any content
15
18
  *
16
- * The accordion can be expanded or collapsed. The visibility of the body section can be controlled by `expanded` attribute. <br/>
17
- * There are two types of variants based on that the border styling of the accordion gets reflected. <br/>
18
- * There are two sizes of accordion, one is small and the other is large.
19
- * Small size has a padding of 1rem (16px) and large size has a padding of 1.5rem (24px) for the body section of accordion.
19
+ * The accordion supports different border styles through the `variant` attribute and different spacing through the `size` attribute.
20
+ * An accordion can be disabled, which prevents all interactions including the expand/collapse button and any slotted controls.
20
21
  *
21
- * By default, the header text in the accordion heading is of H3 with an aria-level of '3'.
22
- * If this accordion is placed on any other level in the entire webpage, then do adjust the aria-level number based on that.
22
+ * ## When to use
23
+ * - Use `mdc-accordion` when you need additional interactive controls (chips, badges, buttons, icons) in the header.
24
+ * - Use `mdc-accordionbutton` if you only need a simple clickable header without extra controls.
23
25
  *
24
- * An accordion can be disabled, and when it's disabled, the header section will not be clickable.
25
- *
26
- * If you don't need any controls on your accordion heading, then it's advised to use `accordionbutton` component.
27
- *
28
- * If an accordion is expanded by default, then the screen reader might loose focus when toggling the visibilty of the accordion.
26
+ * ## Accessibility
27
+ * - Always provide `open-button-aria-label` and `close-button-aria-label` for screen reader support
28
+ * - Adjust `data-aria-level` based on heading hierarchy in your page
29
+ * - Note: Screen readers may lose focus when toggling if accordion is expanded by default
29
30
  *
30
31
  * @tagname mdc-accordion
31
32
  *
@@ -33,16 +34,14 @@ import type { Events as EventsInherited } from '../../components/accordionbutton
33
34
  * @dependency mdc-icon
34
35
  * @dependency mdc-text
35
36
  *
36
- * @slot leading-controls - The leading controls slot of the accordion on the header section.
37
- * @slot trailing-controls - The trailing controls slot of the accordion on the header section.
37
+ * @slot leading-controls - The leading controls slot of the accordion on the header section. Placed after the header text.
38
+ * @slot trailing-controls - The trailing controls slot of the accordion on the header section. Placed before the expand/collapse button.
38
39
  * @slot default - The default slot contains the body section of the accordion. User can place anything inside this body slot.
39
40
  *
40
- * @event shown - (React: onShown) This event is triggered when the accordion is expanded.
41
+ * @event shown - (React: onShown) This event is triggered when the accordion is toggled (expanded or collapsed).
41
42
  *
42
43
  * @cssproperty --mdc-accordionbutton-border-color - The border color of the accordion.
43
- * @cssproperty --mdc-accordionbutton-hover-color - The hover color of the accordion.
44
- * @cssproperty --mdc-accordionbutton-active-color - The active color of the accordion.
45
- * @cssproperty --mdc-accordionbutton-disabled-color - The disabled color of the accordion.
44
+ * @cssproperty --mdc-accordionbutton-disabled-color - The disabled text color of the accordion.
46
45
  *
47
46
  * @csspart body-section - The body section of the accordion.
48
47
  * @csspart header-section - The header section of the accordion.