@momentum-design/components 0.120.11 → 0.120.13

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.
@@ -477,157 +477,6 @@
477
477
  }
478
478
  ]
479
479
  },
480
- {
481
- "kind": "javascript-module",
482
- "path": "components/accordiongroup/accordiongroup.component.js",
483
- "declarations": [
484
- {
485
- "kind": "class",
486
- "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.",
487
- "name": "AccordionGroup",
488
- "cssProperties": [
489
- {
490
- "description": "The border color of the entire accordiongroup",
491
- "name": "--mdc-accordiongroup-border-color"
492
- }
493
- ],
494
- "slots": [
495
- {
496
- "description": "The default slot can contain the `accordion` or `accordionbutton` components.",
497
- "name": "default"
498
- }
499
- ],
500
- "members": [
501
- {
502
- "kind": "field",
503
- "name": "size",
504
- "type": {
505
- "text": "Size"
506
- },
507
- "description": "The size of the accordion item.",
508
- "default": "'small'",
509
- "attribute": "size",
510
- "reflects": true
511
- },
512
- {
513
- "kind": "field",
514
- "name": "variant",
515
- "type": {
516
- "text": "Variant"
517
- },
518
- "description": "The variant of the accordion item. Based on the variant, the styling of the accordion gets changed.",
519
- "default": "'stacked'",
520
- "attribute": "variant",
521
- "reflects": true
522
- },
523
- {
524
- "kind": "field",
525
- "name": "allowMultiple",
526
- "type": {
527
- "text": "boolean"
528
- },
529
- "default": "false",
530
- "description": "If true, multiple accordion items can be visible at the same time.",
531
- "attribute": "allow-multiple",
532
- "reflects": true
533
- },
534
- {
535
- "kind": "method",
536
- "name": "handleAccordionExpanded",
537
- "privacy": "private",
538
- "return": {
539
- "type": {
540
- "text": "void"
541
- }
542
- },
543
- "parameters": [
544
- {
545
- "name": "event",
546
- "type": {
547
- "text": "Event"
548
- },
549
- "description": "The event object from the 'shown' event."
550
- }
551
- ],
552
- "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."
553
- },
554
- {
555
- "kind": "method",
556
- "name": "setChildrenAccordionAttributes",
557
- "privacy": "private",
558
- "return": {
559
- "type": {
560
- "text": "void"
561
- }
562
- },
563
- "parameters": [
564
- {
565
- "name": "attributeName",
566
- "type": {
567
- "text": "string"
568
- },
569
- "description": "The name of the attribute to set."
570
- },
571
- {
572
- "name": "attributeValue",
573
- "type": {
574
- "text": "string"
575
- },
576
- "description": "The value to set the attribute to."
577
- }
578
- ],
579
- "description": "Sets the given attribute on all child accordion or accordionbutton components."
580
- }
581
- ],
582
- "attributes": [
583
- {
584
- "name": "size",
585
- "type": {
586
- "text": "Size"
587
- },
588
- "description": "The size of the accordion item.",
589
- "default": "'small'",
590
- "fieldName": "size"
591
- },
592
- {
593
- "name": "variant",
594
- "type": {
595
- "text": "Variant"
596
- },
597
- "description": "The variant of the accordion item. Based on the variant, the styling of the accordion gets changed.",
598
- "default": "'stacked'",
599
- "fieldName": "variant"
600
- },
601
- {
602
- "name": "allow-multiple",
603
- "type": {
604
- "text": "boolean"
605
- },
606
- "default": "false",
607
- "description": "If true, multiple accordion items can be visible at the same time.",
608
- "fieldName": "allowMultiple"
609
- }
610
- ],
611
- "superclass": {
612
- "name": "Component",
613
- "module": "/src/models"
614
- },
615
- "tagName": "mdc-accordiongroup",
616
- "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 */",
617
- "customElement": true
618
- }
619
- ],
620
- "exports": [
621
- {
622
- "kind": "js",
623
- "name": "default",
624
- "declaration": {
625
- "name": "AccordionGroup",
626
- "module": "components/accordiongroup/accordiongroup.component.js"
627
- }
628
- }
629
- ]
630
- },
631
480
  {
632
481
  "kind": "javascript-module",
633
482
  "path": "components/accordionbutton/accordionbutton.component.js",
@@ -970,102 +819,253 @@
970
819
  },
971
820
  {
972
821
  "kind": "javascript-module",
973
- "path": "components/alertchip/alertchip.component.js",
822
+ "path": "components/accordiongroup/accordiongroup.component.js",
974
823
  "declarations": [
975
824
  {
976
825
  "kind": "class",
977
- "description": "mdc-alertchip component is an interactive chip that consumers can use to represent an alert.\n\n- It supports a leading icon along with label.\n- It supports 5 variants of alerts - neutral, warning, error, success, and informational\n\nThis component is built by extending Buttonsimple.",
978
- "name": "AlertChip",
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.\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.",
827
+ "name": "AccordionGroup",
979
828
  "cssProperties": [
980
829
  {
981
- "description": "The color of the label text",
982
- "name": "--mdc-chip-color"
983
- },
984
- {
985
- "description": "The color of the icon",
986
- "name": "--mdc-chip-icon-color"
987
- },
988
- {
989
- "description": "The border color of the alertchip",
990
- "name": "--mdc-chip-border-color"
991
- },
992
- {
993
- "description": "The background color of the alertchip",
994
- "name": "--mdc-chip-background-color"
830
+ "description": "The border color of the entire accordiongroup",
831
+ "name": "--mdc-accordiongroup-border-color"
995
832
  }
996
833
  ],
997
- "cssParts": [
998
- {
999
- "description": "The alert icon",
1000
- "name": "icon"
1001
- },
834
+ "slots": [
1002
835
  {
1003
- "description": "The text label of the alertchip",
1004
- "name": "label"
836
+ "description": "The default slot can contain the `accordion` or `accordionbutton` components.",
837
+ "name": "default"
1005
838
  }
1006
839
  ],
1007
840
  "members": [
1008
841
  {
1009
842
  "kind": "field",
1010
- "name": "variant",
843
+ "name": "size",
1011
844
  "type": {
1012
- "text": "VariantType"
845
+ "text": "Size"
1013
846
  },
1014
- "description": "The variant of the alertchip. It supports 5 variants\n- neutral\n- warning\n- error\n- success\n- informational",
1015
- "default": "neutral",
1016
- "attribute": "variant"
847
+ "description": "The size of the accordion item.",
848
+ "default": "'small'",
849
+ "attribute": "size",
850
+ "reflects": true
1017
851
  },
1018
852
  {
1019
853
  "kind": "field",
1020
- "name": "label",
854
+ "name": "variant",
1021
855
  "type": {
1022
- "text": "string"
856
+ "text": "Variant"
1023
857
  },
1024
- "default": "''",
1025
- "description": "The visible label text of the alertchip.\n\nWe recommend limiting the <b>maximum length of the label text to 20 characters</b>,\nincluding empty spaces to split words.",
1026
- "attribute": "label"
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
1027
862
  },
1028
863
  {
1029
864
  "kind": "field",
1030
- "name": "autoFocusOnMount",
865
+ "name": "allowMultiple",
1031
866
  "type": {
1032
867
  "text": "boolean"
1033
868
  },
1034
869
  "default": "false",
1035
- "description": "This property indicates whether the element should receive focus automatically when it is mounted.\n\nIt will not focus if the element is re-attached to the DOM after being removed.",
1036
- "attribute": "auto-focus-on-mount",
1037
- "reflects": true,
1038
- "inheritedFrom": {
1039
- "name": "AutoFocusOnMountMixin",
1040
- "module": "utils/mixins/AutoFocusOnMountMixin.js"
1041
- }
870
+ "description": "If true, multiple accordion items can be visible at the same time.",
871
+ "attribute": "allow-multiple",
872
+ "reflects": true
1042
873
  },
1043
874
  {
1044
- "kind": "field",
1045
- "name": "tabIndex",
1046
- "type": {
1047
- "text": "number"
875
+ "kind": "method",
876
+ "name": "handleAccordionExpanded",
877
+ "privacy": "private",
878
+ "return": {
879
+ "type": {
880
+ "text": "void"
881
+ }
1048
882
  },
1049
- "default": "0",
1050
- "description": "This property specifies the tab order of the element.",
1051
- "attribute": "tabIndex",
1052
- "reflects": true,
1053
- "inheritedFrom": {
1054
- "name": "TabIndexMixin",
1055
- "module": "utils/mixins/TabIndexMixin.js"
1056
- }
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."
1057
893
  },
1058
894
  {
1059
- "kind": "field",
1060
- "name": "disabled",
1061
- "type": {
1062
- "text": "boolean | undefined"
1063
- },
1064
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
1065
- "default": "undefined",
1066
- "attribute": "disabled",
1067
- "reflects": true,
1068
- "inheritedFrom": {
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 * 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 */",
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
+ },
971
+ {
972
+ "kind": "javascript-module",
973
+ "path": "components/alertchip/alertchip.component.js",
974
+ "declarations": [
975
+ {
976
+ "kind": "class",
977
+ "description": "mdc-alertchip component is an interactive chip that consumers can use to represent an alert.\n\n- It supports a leading icon along with label.\n- It supports 5 variants of alerts - neutral, warning, error, success, and informational\n\nThis component is built by extending Buttonsimple.",
978
+ "name": "AlertChip",
979
+ "cssProperties": [
980
+ {
981
+ "description": "The color of the label text",
982
+ "name": "--mdc-chip-color"
983
+ },
984
+ {
985
+ "description": "The color of the icon",
986
+ "name": "--mdc-chip-icon-color"
987
+ },
988
+ {
989
+ "description": "The border color of the alertchip",
990
+ "name": "--mdc-chip-border-color"
991
+ },
992
+ {
993
+ "description": "The background color of the alertchip",
994
+ "name": "--mdc-chip-background-color"
995
+ }
996
+ ],
997
+ "cssParts": [
998
+ {
999
+ "description": "The alert icon",
1000
+ "name": "icon"
1001
+ },
1002
+ {
1003
+ "description": "The text label of the alertchip",
1004
+ "name": "label"
1005
+ }
1006
+ ],
1007
+ "members": [
1008
+ {
1009
+ "kind": "field",
1010
+ "name": "variant",
1011
+ "type": {
1012
+ "text": "VariantType"
1013
+ },
1014
+ "description": "The variant of the alertchip. It supports 5 variants\n- neutral\n- warning\n- error\n- success\n- informational",
1015
+ "default": "neutral",
1016
+ "attribute": "variant"
1017
+ },
1018
+ {
1019
+ "kind": "field",
1020
+ "name": "label",
1021
+ "type": {
1022
+ "text": "string"
1023
+ },
1024
+ "default": "''",
1025
+ "description": "The visible label text of the alertchip.\n\nWe recommend limiting the <b>maximum length of the label text to 20 characters</b>,\nincluding empty spaces to split words.",
1026
+ "attribute": "label"
1027
+ },
1028
+ {
1029
+ "kind": "field",
1030
+ "name": "autoFocusOnMount",
1031
+ "type": {
1032
+ "text": "boolean"
1033
+ },
1034
+ "default": "false",
1035
+ "description": "This property indicates whether the element should receive focus automatically when it is mounted.\n\nIt will not focus if the element is re-attached to the DOM after being removed.",
1036
+ "attribute": "auto-focus-on-mount",
1037
+ "reflects": true,
1038
+ "inheritedFrom": {
1039
+ "name": "AutoFocusOnMountMixin",
1040
+ "module": "utils/mixins/AutoFocusOnMountMixin.js"
1041
+ }
1042
+ },
1043
+ {
1044
+ "kind": "field",
1045
+ "name": "tabIndex",
1046
+ "type": {
1047
+ "text": "number"
1048
+ },
1049
+ "default": "0",
1050
+ "description": "This property specifies the tab order of the element.",
1051
+ "attribute": "tabIndex",
1052
+ "reflects": true,
1053
+ "inheritedFrom": {
1054
+ "name": "TabIndexMixin",
1055
+ "module": "utils/mixins/TabIndexMixin.js"
1056
+ }
1057
+ },
1058
+ {
1059
+ "kind": "field",
1060
+ "name": "disabled",
1061
+ "type": {
1062
+ "text": "boolean | undefined"
1063
+ },
1064
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
1065
+ "default": "undefined",
1066
+ "attribute": "disabled",
1067
+ "reflects": true,
1068
+ "inheritedFrom": {
1069
1069
  "name": "DisabledMixin",
1070
1070
  "module": "utils/mixins/DisabledMixin.js"
1071
1071
  }
@@ -28026,168 +28026,56 @@
28026
28026
  },
28027
28027
  {
28028
28028
  "kind": "javascript-module",
28029
- "path": "components/optgroup/optgroup.component.js",
28029
+ "path": "components/navmenuitem/navmenuitem.component.js",
28030
28030
  "declarations": [
28031
28031
  {
28032
28032
  "kind": "class",
28033
- "description": "optgroup component, which creates a grouping of mdc-option within a listbox element.",
28034
- "name": "OptGroup",
28033
+ "description": "`mdc-navmenuitem` is a menuitem styled to work as a navigation tab.\nIt supports a leading icon, optional badge and dynamic text rendering.\n\nNote: `mdc-navmenuitem` is intended to be used inside `mdc-menubar` as part of the sideNavigation\ncomponent. Its structure, spacing, and interactions are designed to align with\nthe visual and functional requirements of side navigation layouts.\n\nBy providing the tooltip-text attribute, a tooltip will be displayed on hover of the navmenuitem. This tooltip is useful when an active navmenuitem is present within a submenu of the sidenavigation component.",
28034
+ "name": "NavMenuItem",
28035
28035
  "cssProperties": [
28036
28036
  {
28037
- "description": "Allows customization of the disabled option color.",
28038
- "name": "--mdc-optgroup-disabled-color"
28039
- }
28040
- ],
28041
- "cssParts": [
28042
- {
28043
- "description": "The header text of the optgroup.",
28044
- "name": "header-text"
28045
- }
28046
- ],
28047
- "slots": [
28037
+ "description": "Text color of the navmenuitem in its normal state.",
28038
+ "name": "--mdc-navmenuitem-color"
28039
+ },
28048
28040
  {
28049
- "description": "This is a default slot for mdc-option elements.",
28050
- "name": "default"
28051
- }
28052
- ],
28053
- "members": [
28041
+ "description": "Border color of the navmenuitem in its normal state.",
28042
+ "name": "--mdc-navmenuitem-border-color"
28043
+ },
28054
28044
  {
28055
- "kind": "field",
28056
- "name": "label",
28057
- "type": {
28058
- "text": "string | undefined"
28059
- },
28060
- "description": "The header text to be displayed on the top of the options list.",
28061
- "attribute": "label",
28062
- "reflects": true
28045
+ "description": "Text color of the navmenuitem when disabled.",
28046
+ "name": "--mdc-navmenuitem-disabled-color"
28063
28047
  },
28064
28048
  {
28065
- "kind": "method",
28066
- "name": "setDisabledForAllOptions",
28067
- "privacy": "private",
28068
- "return": {
28069
- "type": {
28070
- "text": "void"
28071
- }
28072
- }
28049
+ "description": "Width of the navmenuitem when expanded.",
28050
+ "name": "--mdc-navmenuitem-expanded-width"
28073
28051
  },
28074
28052
  {
28075
- "kind": "field",
28076
- "name": "dataAriaLabel",
28077
- "type": {
28078
- "text": "string | null"
28079
- },
28080
- "default": "null",
28081
- "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
28082
- "attribute": "data-aria-label",
28083
- "reflects": true,
28084
- "inheritedFrom": {
28085
- "name": "DataAriaLabelMixin",
28086
- "module": "utils/mixins/DataAriaLabelMixin.js"
28087
- }
28053
+ "description": "Background color of the navmenuitem when hovered.",
28054
+ "name": "--mdc-navmenuitem-hover-background-color"
28088
28055
  },
28089
28056
  {
28090
- "kind": "field",
28091
- "name": "disabled",
28092
- "type": {
28093
- "text": "boolean | undefined"
28094
- },
28095
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
28096
- "default": "undefined",
28097
- "attribute": "disabled",
28098
- "reflects": true,
28099
- "inheritedFrom": {
28100
- "name": "DisabledMixin",
28101
- "module": "utils/mixins/DisabledMixin.js"
28102
- }
28103
- }
28104
- ],
28105
- "attributes": [
28057
+ "description": "Background color of the active navmenuitem when hovered.",
28058
+ "name": "--mdc-navmenuitem-hover-active-background-color"
28059
+ },
28106
28060
  {
28107
- "name": "label",
28108
- "type": {
28109
- "text": "string | undefined"
28110
- },
28111
- "description": "The header text to be displayed on the top of the options list.",
28112
- "fieldName": "label"
28061
+ "description": "Background color of the navmenuitem when pressed.",
28062
+ "name": "--mdc-navmenuitem-pressed-background-color"
28113
28063
  },
28114
28064
  {
28115
- "name": "data-aria-label",
28116
- "type": {
28117
- "text": "string | null"
28118
- },
28119
- "default": "null",
28120
- "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
28121
- "fieldName": "dataAriaLabel",
28122
- "inheritedFrom": {
28123
- "name": "DataAriaLabelMixin",
28124
- "module": "src/utils/mixins/DataAriaLabelMixin.ts"
28125
- }
28065
+ "description": "Background color of the active navmenuitem when pressed.",
28066
+ "name": "--mdc-navmenuitem-pressed-active-background-color"
28126
28067
  },
28127
28068
  {
28128
- "name": "disabled",
28129
- "type": {
28130
- "text": "boolean | undefined"
28131
- },
28132
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
28133
- "default": "undefined",
28134
- "fieldName": "disabled",
28135
- "inheritedFrom": {
28136
- "name": "DisabledMixin",
28137
- "module": "src/utils/mixins/DisabledMixin.ts"
28138
- }
28139
- }
28140
- ],
28141
- "mixins": [
28142
- {
28143
- "name": "DataAriaLabelMixin",
28144
- "module": "/src/utils/mixins/DataAriaLabelMixin"
28069
+ "description": "Background color of the navmenuitem when disabled.",
28070
+ "name": "--mdc-navmenuitem-disabled-background-color"
28145
28071
  },
28146
28072
  {
28147
- "name": "DisabledMixin",
28148
- "module": "/src/utils/mixins/DisabledMixin"
28149
- }
28150
- ],
28151
- "superclass": {
28152
- "name": "Component",
28153
- "module": "/src/models"
28154
- },
28155
- "tagName": "mdc-optgroup",
28156
- "jsDoc": "/**\n * optgroup component, which creates a grouping of mdc-option within a listbox element.\n *\n * @dependency mdc-text\n *\n * @tagname mdc-optgroup\n *\n * @slot default - This is a default slot for mdc-option elements.\n *\n * @cssproperty --mdc-optgroup-disabled-color - Allows customization of the disabled option color.\n *\n * @csspart header-text - The header text of the optgroup.\n */",
28157
- "customElement": true
28158
- }
28159
- ],
28160
- "exports": [
28161
- {
28162
- "kind": "js",
28163
- "name": "default",
28164
- "declaration": {
28165
- "name": "OptGroup",
28166
- "module": "components/optgroup/optgroup.component.js"
28167
- }
28168
- }
28169
- ]
28170
- },
28171
- {
28172
- "kind": "javascript-module",
28173
- "path": "components/option/option.component.js",
28174
- "declarations": [
28175
- {
28176
- "kind": "class",
28177
- "description": "Option component, which is used within Selectlistbox within Select component.\n\nThe label and secondary label of the option can be set using the `label` and `secondaryLabel` properties respectively.\nThe `label` is the primary text displayed in the option, while the `secondaryLabel` is the secondary text displayed below the primary label.\n\nThe `selected` property is used to indicate whether the option is selected or not.\nWhen the `selected` property is set to true, a checkmark icon will be displayed\non the right side of the option to indicate that it is selected.\n\nThe `prefixIcon` property can be used to display an icon on the left side of the option label.\n\n**Note**: If an option contains a long text, it is recommended to create a tooltip for the option that displays the full text on hover.\nConsumers need to add a unique ID to this option and use that ID in the tooltip's `triggerID` attribute. We are not creating the tooltip automatically, consumers need to add `<mdc-tooltip>` element manually and associate it with the option using the `triggerID` attribute.",
28178
- "name": "Option",
28179
- "cssProperties": [
28180
- {
28181
- "description": "gap between columns in the option",
28182
- "name": "--mdc-listitem-column-gap",
28183
- "inheritedFrom": {
28184
- "name": "ListItem",
28185
- "module": "src/components/listitem/listitem.component.ts"
28186
- }
28073
+ "description": "Background color of the active navmenuitem when disabled.",
28074
+ "name": "--mdc-navmenuitem-disabled-active-background-color"
28187
28075
  },
28188
28076
  {
28189
- "description": "width of the icon in the option",
28190
- "name": "--mdc-option-icon-width"
28077
+ "description": "Background color of the active nav item in its rest state.",
28078
+ "name": "--mdc-navmenuitem-rest-active-background-color"
28191
28079
  },
28192
28080
  {
28193
28081
  "description": "Allows customization of the default background color.",
@@ -28237,6 +28125,14 @@
28237
28125
  "module": "src/components/listitem/listitem.component.ts"
28238
28126
  }
28239
28127
  },
28128
+ {
28129
+ "description": "Allows customization of column gap.",
28130
+ "name": "--mdc-listitem-column-gap",
28131
+ "inheritedFrom": {
28132
+ "name": "ListItem",
28133
+ "module": "src/components/listitem/listitem.component.ts"
28134
+ }
28135
+ },
28240
28136
  {
28241
28137
  "description": "Allows customization of padding left and right.",
28242
28138
  "name": "--mdc-listitem-padding-left-right",
@@ -28279,6 +28175,30 @@
28279
28175
  }
28280
28176
  ],
28281
28177
  "cssParts": [
28178
+ {
28179
+ "description": "The arrow of the navmenuitem.",
28180
+ "name": "arrow"
28181
+ },
28182
+ {
28183
+ "description": "The badge of the navmenuitem.",
28184
+ "name": "badge"
28185
+ },
28186
+ {
28187
+ "description": "The container of the icon.",
28188
+ "name": "icon-container"
28189
+ },
28190
+ {
28191
+ "description": "The container of the text.",
28192
+ "name": "text-container"
28193
+ },
28194
+ {
28195
+ "description": "The trailing arrow of the navmenuitem.",
28196
+ "name": "trailing-arrow",
28197
+ "inheritedFrom": {
28198
+ "name": "MenuItem",
28199
+ "module": "src/components/menuitem/menuitem.component.ts"
28200
+ }
28201
+ },
28282
28202
  {
28283
28203
  "description": "Allows customization of the leading part.",
28284
28204
  "name": "leading",
@@ -28287,6 +28207,14 @@
28287
28207
  "module": "src/components/listitem/listitem.component.ts"
28288
28208
  }
28289
28209
  },
28210
+ {
28211
+ "description": "Allows customization of leading arrow icon.",
28212
+ "name": "leading-arrow",
28213
+ "inheritedFrom": {
28214
+ "name": "MenuItem",
28215
+ "module": "src/components/menuitem/menuitem.component.ts"
28216
+ }
28217
+ },
28290
28218
  {
28291
28219
  "description": "Allows customization of the leading text part.",
28292
28220
  "name": "leading-text",
@@ -28315,134 +28243,307 @@
28315
28243
  "members": [
28316
28244
  {
28317
28245
  "kind": "field",
28318
- "name": "selected",
28246
+ "name": "active",
28319
28247
  "type": {
28320
- "text": "boolean"
28248
+ "text": "boolean | undefined"
28321
28249
  },
28322
- "default": "false",
28323
- "description": "The selected attribute is used to indicate that the option is selected.",
28324
- "attribute": "selected",
28250
+ "description": "The navmenuitem's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the navmenuitem is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the navmenuitem is in an inactive state, indicating it is toggled off.",
28251
+ "default": "undefined",
28252
+ "attribute": "active",
28325
28253
  "reflects": true
28326
28254
  },
28327
28255
  {
28328
28256
  "kind": "field",
28329
- "name": "prefixIcon",
28257
+ "name": "badgeType",
28330
28258
  "type": {
28331
- "text": "IconNames | undefined"
28259
+ "text": "BadgeType | undefined"
28332
28260
  },
28333
- "description": "The prefix icon attribute is used to display the icon name on the left of the option label.",
28334
- "attribute": "prefix-icon",
28261
+ "description": "Type of the badge\nCan be `dot` (notification) or `counter`.",
28262
+ "attribute": "badge-type",
28335
28263
  "reflects": true
28336
28264
  },
28337
28265
  {
28338
28266
  "kind": "field",
28339
- "name": "ariaLabel",
28267
+ "name": "counter",
28340
28268
  "type": {
28341
- "text": "string | null"
28269
+ "text": "number | undefined"
28342
28270
  },
28343
- "default": "null",
28344
- "description": "Any additional description can be provided here for screen readers.",
28345
- "attribute": "aria-label",
28271
+ "description": "Counter is the number which can be provided in the badge.",
28272
+ "attribute": "counter",
28346
28273
  "reflects": true
28347
28274
  },
28348
28275
  {
28349
28276
  "kind": "field",
28350
- "name": "name",
28277
+ "name": "maxCounter",
28351
28278
  "type": {
28352
- "text": "string"
28279
+ "text": "number"
28353
28280
  },
28354
- "default": "''",
28355
- "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
28356
- "attribute": "name",
28357
- "reflects": true,
28358
- "inheritedFrom": {
28359
- "name": "FormInternalsMixin",
28360
- "module": "utils/mixins/FormInternalsMixin.js"
28361
- }
28281
+ "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`.",
28282
+ "default": "99",
28283
+ "attribute": "max-counter",
28284
+ "reflects": true
28362
28285
  },
28363
28286
  {
28364
28287
  "kind": "field",
28365
- "name": "value",
28288
+ "name": "navId",
28366
28289
  "type": {
28367
- "text": "string"
28290
+ "text": "string | undefined"
28368
28291
  },
28369
- "default": "''",
28370
- "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
28371
- "attribute": "value",
28372
- "reflects": true,
28373
- "inheritedFrom": {
28374
- "name": "FormInternalsMixin",
28375
- "module": "utils/mixins/FormInternalsMixin.js"
28376
- }
28292
+ "description": "Id of the navMenuItem (used as a identificator when used in the menubar)\nNote: It has to be unique.",
28293
+ "default": "undefined",
28294
+ "attribute": "nav-id",
28295
+ "reflects": true
28377
28296
  },
28378
28297
  {
28379
28298
  "kind": "field",
28380
- "name": "validationMessage",
28299
+ "name": "ariaLabel",
28381
28300
  "type": {
28382
- "text": "string | undefined"
28301
+ "text": "string | null"
28383
28302
  },
28384
- "description": "Custom validation message that will override the default message and displayed when the input is invalid.\n\nTo display custom validation messages, you must listen for input events (or other relevant events)\non your component and update the `validationMessage` property with the desired message string.\nUpdating this property will ensure that new validation messages are shown to the user.\n- The `validationMessage` property overrides the default browser validation message when set.\n- Consumers are responsible for updating `validationMessage` in response to input or validation state changes.",
28385
- "attribute": "validation-message",
28386
- "reflects": true,
28387
- "inheritedFrom": {
28388
- "name": "FormInternalsMixin",
28389
- "module": "utils/mixins/FormInternalsMixin.js"
28390
- }
28303
+ "default": "null",
28304
+ "description": "Aria-label attribute to be set for accessibility",
28305
+ "attribute": "aria-label"
28391
28306
  },
28392
28307
  {
28393
28308
  "kind": "field",
28394
- "name": "validity",
28309
+ "name": "disableAriaCurrent",
28395
28310
  "type": {
28396
- "text": "ValidityState"
28311
+ "text": "boolean | undefined"
28397
28312
  },
28398
- "readonly": true,
28399
- "inheritedFrom": {
28400
- "name": "FormInternalsMixin",
28401
- "module": "utils/mixins/FormInternalsMixin.js"
28402
- }
28313
+ "description": "When set to true, prevents the automatic setting of the `aria-current` attribute on the navmenuitem\nwhen it becomes active. This is useful for cases where you want to maintain the visual active styling\nbut need to handle aria-current attribute differently or not at all.\nThe active button styling will still be applied regardless of this setting.",
28314
+ "attribute": "disable-aria-current",
28315
+ "reflects": true
28403
28316
  },
28404
28317
  {
28405
28318
  "kind": "field",
28406
- "name": "willValidate",
28407
- "readonly": true,
28408
- "inheritedFrom": {
28409
- "name": "FormInternalsMixin",
28410
- "module": "utils/mixins/FormInternalsMixin.js"
28411
- }
28319
+ "name": "tooltipText",
28320
+ "type": {
28321
+ "text": "string | undefined"
28322
+ },
28323
+ "description": "The tooltip text is displayed on hover of the list item.",
28324
+ "attribute": "tooltip-text",
28325
+ "reflects": true
28412
28326
  },
28413
28327
  {
28414
28328
  "kind": "method",
28415
- "name": "setValidity",
28416
- "description": "Sets the validity of the input field based on the input field's validity.",
28329
+ "name": "removeTooltip",
28330
+ "privacy": "private"
28331
+ },
28332
+ {
28333
+ "kind": "method",
28334
+ "name": "renderDynamicTooltip",
28335
+ "privacy": "private",
28417
28336
  "return": {
28418
28337
  "type": {
28419
- "text": ""
28338
+ "text": "void"
28420
28339
  }
28421
- },
28422
- "inheritedFrom": {
28423
- "name": "FormInternalsMixin",
28424
- "module": "utils/mixins/FormInternalsMixin.js"
28425
28340
  }
28426
28341
  },
28427
28342
  {
28428
28343
  "kind": "method",
28429
- "name": "checkValidity",
28344
+ "name": "isNested",
28345
+ "privacy": "private",
28430
28346
  "return": {
28431
28347
  "type": {
28432
28348
  "text": "boolean"
28433
28349
  }
28434
28350
  },
28435
- "inheritedFrom": {
28436
- "name": "FormInternalsMixin",
28437
- "module": "utils/mixins/FormInternalsMixin.js"
28351
+ "description": "Check whether the navmenuitem is inside a nested nav structure.\nReturns `true` if there is a parent `mdc-menupopover`\nThis method assumes nesting implies deeper levels of nav hierarchy."
28352
+ },
28353
+ {
28354
+ "kind": "method",
28355
+ "name": "handleClickEvent",
28356
+ "privacy": "private",
28357
+ "return": {
28358
+ "type": {
28359
+ "text": "void"
28360
+ }
28438
28361
  }
28439
28362
  },
28440
28363
  {
28441
28364
  "kind": "method",
28442
- "name": "reportValidity",
28365
+ "name": "renderTextLabel",
28366
+ "privacy": "private",
28367
+ "parameters": [
28368
+ {
28369
+ "name": "label",
28370
+ "type": {
28371
+ "text": "string | undefined"
28372
+ }
28373
+ }
28374
+ ]
28375
+ },
28376
+ {
28377
+ "kind": "method",
28378
+ "name": "renderArrowIcon",
28379
+ "privacy": "private",
28380
+ "parameters": [
28381
+ {
28382
+ "name": "showLabel",
28383
+ "type": {
28384
+ "text": "boolean | undefined"
28385
+ }
28386
+ }
28387
+ ]
28388
+ },
28389
+ {
28390
+ "kind": "method",
28391
+ "name": "renderBadge",
28392
+ "privacy": "private",
28393
+ "parameters": [
28394
+ {
28395
+ "name": "showLabel",
28396
+ "type": {
28397
+ "text": "boolean | undefined"
28398
+ }
28399
+ }
28400
+ ]
28401
+ },
28402
+ {
28403
+ "kind": "field",
28404
+ "name": "iconName",
28405
+ "type": {
28406
+ "text": "IconNames | undefined"
28407
+ },
28408
+ "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
28409
+ "attribute": "icon-name",
28443
28410
  "inheritedFrom": {
28444
- "name": "FormInternalsMixin",
28445
- "module": "utils/mixins/FormInternalsMixin.js"
28411
+ "name": "IconNameMixin",
28412
+ "module": "utils/mixins/IconNameMixin.js"
28413
+ }
28414
+ },
28415
+ {
28416
+ "kind": "field",
28417
+ "name": "arrowPosition",
28418
+ "type": {
28419
+ "text": "ArrowPositions | undefined"
28420
+ },
28421
+ "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.",
28422
+ "attribute": "arrow-position",
28423
+ "reflects": true,
28424
+ "inheritedFrom": {
28425
+ "name": "MenuItem",
28426
+ "module": "components/menuitem/menuitem.component.js"
28427
+ }
28428
+ },
28429
+ {
28430
+ "kind": "field",
28431
+ "name": "arrowDirection",
28432
+ "type": {
28433
+ "text": "ArrowDirections | undefined"
28434
+ },
28435
+ "description": "Defines the direction the arrow icon points.\n- `'positive'`: Arrow points toward the trailing side.\n- `'negative'`: Arrow points toward the leading side.",
28436
+ "attribute": "arrow-direction",
28437
+ "reflects": true,
28438
+ "inheritedFrom": {
28439
+ "name": "MenuItem",
28440
+ "module": "components/menuitem/menuitem.component.js"
28441
+ }
28442
+ },
28443
+ {
28444
+ "kind": "field",
28445
+ "name": "name",
28446
+ "type": {
28447
+ "text": "string | undefined"
28448
+ },
28449
+ "description": "The name attribute is used to identify the menu item when it is selected.",
28450
+ "attribute": "name",
28451
+ "reflects": true,
28452
+ "inheritedFrom": {
28453
+ "name": "MenuItem",
28454
+ "module": "components/menuitem/menuitem.component.js"
28455
+ }
28456
+ },
28457
+ {
28458
+ "kind": "field",
28459
+ "name": "value",
28460
+ "type": {
28461
+ "text": "string | undefined"
28462
+ },
28463
+ "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.",
28464
+ "attribute": "value",
28465
+ "reflects": true,
28466
+ "inheritedFrom": {
28467
+ "name": "MenuItem",
28468
+ "module": "components/menuitem/menuitem.component.js"
28469
+ }
28470
+ },
28471
+ {
28472
+ "kind": "method",
28473
+ "name": "handleKeyDown",
28474
+ "privacy": "protected",
28475
+ "return": {
28476
+ "type": {
28477
+ "text": "void"
28478
+ }
28479
+ },
28480
+ "parameters": [
28481
+ {
28482
+ "name": "event",
28483
+ "type": {
28484
+ "text": "KeyboardEvent"
28485
+ },
28486
+ "description": "The keyboard event that triggered the action."
28487
+ }
28488
+ ],
28489
+ "description": "Handles the keydown event for the menu item.\nIf the Enter key is pressed, it triggers a click event on the menu item.\nThis allows keyboard users to activate the menu item using the Enter key.\n\nThis follows the native behaviour, actionable element can be triggered by Enter\nkey on the keydown event.\n\nNote: Action triggered by Space on the keyup event.",
28490
+ "inheritedFrom": {
28491
+ "name": "ListItem",
28492
+ "module": "components/listitem/listitem.component.js"
28493
+ }
28494
+ },
28495
+ {
28496
+ "kind": "method",
28497
+ "name": "handleKeyUp",
28498
+ "privacy": "private",
28499
+ "return": {
28500
+ "type": {
28501
+ "text": "void"
28502
+ }
28503
+ },
28504
+ "parameters": [
28505
+ {
28506
+ "name": "event",
28507
+ "type": {
28508
+ "text": "KeyboardEvent"
28509
+ },
28510
+ "description": "The keyboard event that triggered the action."
28511
+ }
28512
+ ],
28513
+ "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.",
28514
+ "inheritedFrom": {
28515
+ "name": "MenuItem",
28516
+ "module": "components/menuitem/menuitem.component.js"
28517
+ }
28518
+ },
28519
+ {
28520
+ "kind": "method",
28521
+ "name": "renderTrailingControls",
28522
+ "privacy": "protected",
28523
+ "description": "Renders the trailing controls slot and optionally the trailing arrow icon,\nbased on `arrowPosition` and `arrowDirection`.",
28524
+ "return": {
28525
+ "type": {
28526
+ "text": ""
28527
+ }
28528
+ },
28529
+ "inheritedFrom": {
28530
+ "name": "ListItem",
28531
+ "module": "components/listitem/listitem.component.js"
28532
+ }
28533
+ },
28534
+ {
28535
+ "kind": "method",
28536
+ "name": "renderLeadingControls",
28537
+ "privacy": "protected",
28538
+ "description": "Renders the leading controls slot and optionally the leading arrow icon,\nbased on `arrowPosition` and `arrowDirection`.",
28539
+ "return": {
28540
+ "type": {
28541
+ "text": ""
28542
+ }
28543
+ },
28544
+ "inheritedFrom": {
28545
+ "name": "ListItem",
28546
+ "module": "components/listitem/listitem.component.js"
28446
28547
  }
28447
28548
  },
28448
28549
  {
@@ -28599,30 +28700,6 @@
28599
28700
  "module": "components/listitem/listitem.component.js"
28600
28701
  }
28601
28702
  },
28602
- {
28603
- "kind": "method",
28604
- "name": "handleKeyDown",
28605
- "privacy": "protected",
28606
- "return": {
28607
- "type": {
28608
- "text": "void"
28609
- }
28610
- },
28611
- "parameters": [
28612
- {
28613
- "name": "event",
28614
- "type": {
28615
- "text": "KeyboardEvent"
28616
- },
28617
- "description": "The keyboard event triggered when a key is pressed down."
28618
- }
28619
- ],
28620
- "description": "Fires the click event when the enter or space key is pressed down.\nThis behavior is similar to a button click and key interaction.",
28621
- "inheritedFrom": {
28622
- "name": "ListItem",
28623
- "module": "components/listitem/listitem.component.js"
28624
- }
28625
- },
28626
28703
  {
28627
28704
  "kind": "method",
28628
28705
  "name": "triggerClickEvent",
@@ -28711,36 +28788,6 @@
28711
28788
  "module": "components/listitem/listitem.component.js"
28712
28789
  }
28713
28790
  },
28714
- {
28715
- "kind": "method",
28716
- "name": "renderTrailingControls",
28717
- "privacy": "protected",
28718
- "description": "Renders the trailing controls slot.",
28719
- "return": {
28720
- "type": {
28721
- "text": ""
28722
- }
28723
- },
28724
- "inheritedFrom": {
28725
- "name": "ListItem",
28726
- "module": "components/listitem/listitem.component.js"
28727
- }
28728
- },
28729
- {
28730
- "kind": "method",
28731
- "name": "renderLeadingControls",
28732
- "privacy": "protected",
28733
- "description": "Renders the leading controls slot.",
28734
- "return": {
28735
- "type": {
28736
- "text": ""
28737
- }
28738
- },
28739
- "inheritedFrom": {
28740
- "name": "ListItem",
28741
- "module": "components/listitem/listitem.component.js"
28742
- }
28743
- },
28744
28791
  {
28745
28792
  "kind": "method",
28746
28793
  "name": "stopEventPropagation",
@@ -28768,7 +28815,7 @@
28768
28815
  ],
28769
28816
  "events": [
28770
28817
  {
28771
- "description": "(React: onClick) This event is dispatched when the option is clicked.",
28818
+ "description": "(React: onClick) This event is dispatched when the navmenuitem is clicked.",
28772
28819
  "name": "click",
28773
28820
  "reactName": "onClick",
28774
28821
  "inheritedFrom": {
@@ -28777,7 +28824,7 @@
28777
28824
  }
28778
28825
  },
28779
28826
  {
28780
- "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the option.",
28827
+ "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the navmenuitem.",
28781
28828
  "name": "keydown",
28782
28829
  "reactName": "onKeyDown",
28783
28830
  "inheritedFrom": {
@@ -28786,7 +28833,7 @@
28786
28833
  }
28787
28834
  },
28788
28835
  {
28789
- "description": "(React: onKeyUp) This event is dispatched when a key is released on the option.",
28836
+ "description": "(React: onKeyUp) This event is dispatched when a key is released on the navmenuitem.",
28790
28837
  "name": "keyup",
28791
28838
  "reactName": "onKeyUp",
28792
28839
  "inheritedFrom": {
@@ -28795,7 +28842,7 @@
28795
28842
  }
28796
28843
  },
28797
28844
  {
28798
- "description": "(React: onFocus) This event is dispatched when the option receives focus.",
28845
+ "description": "(React: onFocus) This event is dispatched when the navmenuitem receives focus.",
28799
28846
  "name": "focus",
28800
28847
  "reactName": "onFocus",
28801
28848
  "inheritedFrom": {
@@ -28804,7 +28851,12 @@
28804
28851
  }
28805
28852
  },
28806
28853
  {
28807
- "description": "(React: onEnabled) This event is dispatched after the listitem is enabled",
28854
+ "description": "(React: onActiveChange) Dispatched when the active state of the navmenuitem changes.",
28855
+ "name": "activechange",
28856
+ "reactName": "onActiveChange"
28857
+ },
28858
+ {
28859
+ "description": "(React: onEnabled) This event is dispatched after the menuitem is enabled",
28808
28860
  "name": "enabled",
28809
28861
  "reactName": "onEnabled",
28810
28862
  "inheritedFrom": {
@@ -28813,7 +28865,7 @@
28813
28865
  }
28814
28866
  },
28815
28867
  {
28816
- "description": "(React: onDisabled) This event is dispatched after the listitem is disabled",
28868
+ "description": "(React: onDisabled) This event is dispatched after the menuitem is disabled",
28817
28869
  "name": "disabled",
28818
28870
  "reactName": "onDisabled",
28819
28871
  "inheritedFrom": {
@@ -28822,7 +28874,7 @@
28822
28874
  }
28823
28875
  },
28824
28876
  {
28825
- "description": "(React: onCreated) This event is dispatched after the listitem is created (added to the DOM)",
28877
+ "description": "(React: onCreated) This event is dispatched after the menuitem is created (added to the DOM)",
28826
28878
  "name": "created",
28827
28879
  "reactName": "onCreated",
28828
28880
  "inheritedFrom": {
@@ -28831,7 +28883,7 @@
28831
28883
  }
28832
28884
  },
28833
28885
  {
28834
- "description": "(React: onDestroyed) This event is dispatched after the listitem is destroyed (removed from the DOM)",
28886
+ "description": "(React: onDestroyed) This event is dispatched after the menuitem is destroyed (removed from the DOM)",
28835
28887
  "name": "destroyed",
28836
28888
  "reactName": "onDestroyed",
28837
28889
  "inheritedFrom": {
@@ -28842,21 +28894,47 @@
28842
28894
  ],
28843
28895
  "attributes": [
28844
28896
  {
28845
- "name": "selected",
28897
+ "name": "active",
28846
28898
  "type": {
28847
- "text": "boolean"
28899
+ "text": "boolean | undefined"
28848
28900
  },
28849
- "default": "false",
28850
- "description": "The selected attribute is used to indicate that the option is selected.",
28851
- "fieldName": "selected"
28901
+ "description": "The navmenuitem's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the navmenuitem is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the navmenuitem is in an inactive state, indicating it is toggled off.",
28902
+ "default": "undefined",
28903
+ "fieldName": "active"
28852
28904
  },
28853
28905
  {
28854
- "name": "prefix-icon",
28906
+ "name": "badge-type",
28855
28907
  "type": {
28856
- "text": "IconNames | undefined"
28908
+ "text": "BadgeType | undefined"
28857
28909
  },
28858
- "description": "The prefix icon attribute is used to display the icon name on the left of the option label.",
28859
- "fieldName": "prefixIcon"
28910
+ "description": "Type of the badge\nCan be `dot` (notification) or `counter`.",
28911
+ "fieldName": "badgeType"
28912
+ },
28913
+ {
28914
+ "name": "counter",
28915
+ "type": {
28916
+ "text": "number | undefined"
28917
+ },
28918
+ "description": "Counter is the number which can be provided in the badge.",
28919
+ "fieldName": "counter"
28920
+ },
28921
+ {
28922
+ "name": "max-counter",
28923
+ "type": {
28924
+ "text": "number"
28925
+ },
28926
+ "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`.",
28927
+ "default": "99",
28928
+ "fieldName": "maxCounter"
28929
+ },
28930
+ {
28931
+ "name": "nav-id",
28932
+ "type": {
28933
+ "text": "string | undefined"
28934
+ },
28935
+ "description": "Id of the navMenuItem (used as a identificator when used in the menubar)\nNote: It has to be unique.",
28936
+ "default": "undefined",
28937
+ "fieldName": "navId"
28860
28938
  },
28861
28939
  {
28862
28940
  "name": "aria-label",
@@ -28864,45 +28942,83 @@
28864
28942
  "text": "string | null"
28865
28943
  },
28866
28944
  "default": "null",
28867
- "description": "Any additional description can be provided here for screen readers.",
28945
+ "description": "Aria-label attribute to be set for accessibility",
28868
28946
  "fieldName": "ariaLabel"
28869
28947
  },
28870
28948
  {
28871
- "name": "name",
28949
+ "name": "disable-aria-current",
28872
28950
  "type": {
28873
- "text": "string"
28951
+ "text": "boolean | undefined"
28874
28952
  },
28875
- "default": "''",
28876
- "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
28877
- "fieldName": "name",
28953
+ "description": "When set to true, prevents the automatic setting of the `aria-current` attribute on the navmenuitem\nwhen it becomes active. This is useful for cases where you want to maintain the visual active styling\nbut need to handle aria-current attribute differently or not at all.\nThe active button styling will still be applied regardless of this setting.",
28954
+ "fieldName": "disableAriaCurrent"
28955
+ },
28956
+ {
28957
+ "name": "tooltip-text",
28958
+ "type": {
28959
+ "text": "string | undefined"
28960
+ },
28961
+ "description": "The tooltip text is displayed on hover of the list item.",
28962
+ "fieldName": "tooltipText"
28963
+ },
28964
+ {
28965
+ "name": "icon-name",
28966
+ "type": {
28967
+ "text": "IconNames | undefined"
28968
+ },
28969
+ "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
28970
+ "fieldName": "iconName",
28878
28971
  "inheritedFrom": {
28879
- "name": "FormInternalsMixin",
28880
- "module": "src/utils/mixins/FormInternalsMixin.ts"
28972
+ "name": "IconNameMixin",
28973
+ "module": "src/utils/mixins/IconNameMixin.ts"
28881
28974
  }
28882
28975
  },
28883
28976
  {
28884
- "name": "value",
28977
+ "name": "arrow-position",
28885
28978
  "type": {
28886
- "text": "string"
28979
+ "text": "ArrowPositions | undefined"
28887
28980
  },
28888
- "default": "''",
28889
- "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
28890
- "fieldName": "value",
28981
+ "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.",
28982
+ "fieldName": "arrowPosition",
28891
28983
  "inheritedFrom": {
28892
- "name": "FormInternalsMixin",
28893
- "module": "src/utils/mixins/FormInternalsMixin.ts"
28984
+ "name": "MenuItem",
28985
+ "module": "src/components/menuitem/menuitem.component.ts"
28894
28986
  }
28895
28987
  },
28896
28988
  {
28897
- "name": "validation-message",
28989
+ "name": "arrow-direction",
28990
+ "type": {
28991
+ "text": "ArrowDirections | undefined"
28992
+ },
28993
+ "description": "Defines the direction the arrow icon points.\n- `'positive'`: Arrow points toward the trailing side.\n- `'negative'`: Arrow points toward the leading side.",
28994
+ "fieldName": "arrowDirection",
28995
+ "inheritedFrom": {
28996
+ "name": "MenuItem",
28997
+ "module": "src/components/menuitem/menuitem.component.ts"
28998
+ }
28999
+ },
29000
+ {
29001
+ "name": "name",
28898
29002
  "type": {
28899
29003
  "text": "string | undefined"
28900
29004
  },
28901
- "description": "Custom validation message that will override the default message and displayed when the input is invalid.\n\nTo display custom validation messages, you must listen for input events (or other relevant events)\non your component and update the `validationMessage` property with the desired message string.\nUpdating this property will ensure that new validation messages are shown to the user.\n- The `validationMessage` property overrides the default browser validation message when set.\n- Consumers are responsible for updating `validationMessage` in response to input or validation state changes.",
28902
- "fieldName": "validationMessage",
29005
+ "description": "The name attribute is used to identify the menu item when it is selected.",
29006
+ "fieldName": "name",
28903
29007
  "inheritedFrom": {
28904
- "name": "FormInternalsMixin",
28905
- "module": "src/utils/mixins/FormInternalsMixin.ts"
29008
+ "name": "MenuItem",
29009
+ "module": "src/components/menuitem/menuitem.component.ts"
29010
+ }
29011
+ },
29012
+ {
29013
+ "name": "value",
29014
+ "type": {
29015
+ "text": "string | undefined"
29016
+ },
29017
+ "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.",
29018
+ "fieldName": "value",
29019
+ "inheritedFrom": {
29020
+ "name": "MenuItem",
29021
+ "module": "src/components/menuitem/menuitem.component.ts"
28906
29022
  }
28907
29023
  },
28908
29024
  {
@@ -29020,20 +29136,20 @@
29020
29136
  ],
29021
29137
  "mixins": [
29022
29138
  {
29023
- "name": "FormInternalsMixin",
29024
- "module": "/src/utils/mixins/FormInternalsMixin"
29139
+ "name": "IconNameMixin",
29140
+ "module": "/src/utils/mixins/IconNameMixin"
29025
29141
  }
29026
29142
  ],
29027
29143
  "superclass": {
29028
- "name": "ListItem",
29029
- "module": "/src/components/listitem/listitem.component"
29144
+ "name": "MenuItem",
29145
+ "module": "/src/components/menuitem/menuitem.component"
29030
29146
  },
29031
- "tagName": "mdc-option",
29032
- "jsDoc": "/**\n * Option component, which is used within Selectlistbox within Select component.\n *\n * The label and secondary label of the option can be set using the `label` and `secondaryLabel` properties respectively.\n * The `label` is the primary text displayed in the option, while the `secondaryLabel` is the secondary text displayed below the primary label.\n *\n * The `selected` property is used to indicate whether the option is selected or not.\n * When the `selected` property is set to true, a checkmark icon will be displayed\n * on the right side of the option to indicate that it is selected.\n *\n * The `prefixIcon` property can be used to display an icon on the left side of the option label.\n *\n * **Note**: If an option contains a long text, it is recommended to create a tooltip for the option that displays the full text on hover.\n * Consumers need to add a unique ID to this option and use that ID in the tooltip's `triggerID` attribute. We are not creating the tooltip automatically, consumers need to add `<mdc-tooltip>` element manually and associate it with the option using the `triggerID` attribute.\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @tagname mdc-option\n *\n * @event click - (React: onClick) This event is dispatched when the option is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the option.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the option.\n * @event focus - (React: onFocus) This event is dispatched when the option receives focus.\n *\n * @cssproperty --mdc-listitem-column-gap - gap between columns in the option\n * @cssproperty --mdc-option-icon-width - width of the icon in the option\n *\n * @csspart leading - Allows customization of the leading part.\n * @csspart leading-text - Allows customization of the leading text part.\n * @csspart trailing - Allows customization of the trailing part.\n * @csspart trailing-text - Allows customization of the trailing text part.\n */",
29147
+ "tagName": "mdc-navmenuitem",
29148
+ "jsDoc": "/**\n * `mdc-navmenuitem` is a menuitem styled to work as a navigation tab.\n * It supports a leading icon, optional badge and dynamic text rendering.\n *\n * Note: `mdc-navmenuitem` is intended to be used inside `mdc-menubar` as part of the sideNavigation\n * component. Its structure, spacing, and interactions are designed to align with\n * the visual and functional requirements of side navigation layouts.\n *\n * By providing the tooltip-text attribute, a tooltip will be displayed on hover of the navmenuitem. This tooltip is useful when an active navmenuitem is present within a submenu of the sidenavigation component.\n *\n * @tagname mdc-navmenuitem\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n * @dependency mdc-badge\n * @dependency mdc-tooltip\n *\n * @event click - (React: onClick) This event is dispatched when the navmenuitem is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the navmenuitem.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the navmenuitem.\n * @event focus - (React: onFocus) This event is dispatched when the navmenuitem receives focus.\n * @event activechange - (React: onActiveChange) Dispatched when the active state of the navmenuitem changes.\n *\n * @cssproperty --mdc-navmenuitem-color - Text color of the navmenuitem in its normal state.\n * @cssproperty --mdc-navmenuitem-border-color - Border color of the navmenuitem in its normal state.\n * @cssproperty --mdc-navmenuitem-disabled-color - Text color of the navmenuitem when disabled.\n * @cssproperty --mdc-navmenuitem-expanded-width - Width of the navmenuitem when expanded.\n * @cssproperty --mdc-navmenuitem-hover-background-color - Background color of the navmenuitem when hovered.\n * @cssproperty --mdc-navmenuitem-hover-active-background-color - Background color of the active navmenuitem when hovered.\n * @cssproperty --mdc-navmenuitem-pressed-background-color - Background color of the navmenuitem when pressed.\n * @cssproperty --mdc-navmenuitem-pressed-active-background-color - Background color of the active navmenuitem when pressed.\n * @cssproperty --mdc-navmenuitem-disabled-background-color - Background color of the navmenuitem when disabled.\n * @cssproperty --mdc-navmenuitem-disabled-active-background-color - Background color of the active navmenuitem when disabled.\n * @cssproperty --mdc-navmenuitem-rest-active-background-color - Background color of the active nav item in its rest state.\n *\n * @csspart arrow - The arrow of the navmenuitem.\n * @csspart badge - The badge of the navmenuitem.\n * @csspart icon-container - The container of the icon.\n * @csspart text-container - The container of the text.\n * @csspart trailing-arrow - The trailing arrow of the navmenuitem.\n */",
29033
29149
  "customElement": true,
29034
29150
  "slots": [
29035
29151
  {
29036
- "description": "slot for list item controls to appear of leading end.",
29152
+ "description": "slot for menu item controls to appear of leading end.",
29037
29153
  "name": "leading-controls",
29038
29154
  "inheritedFrom": {
29039
29155
  "name": "ListItem",
@@ -29041,7 +29157,7 @@
29041
29157
  }
29042
29158
  },
29043
29159
  {
29044
- "description": "slot for list item primary label.",
29160
+ "description": "slot for menu item primary label.",
29045
29161
  "name": "leading-text-primary-label",
29046
29162
  "inheritedFrom": {
29047
29163
  "name": "ListItem",
@@ -29049,7 +29165,7 @@
29049
29165
  }
29050
29166
  },
29051
29167
  {
29052
- "description": "slot for list item secondary label.",
29168
+ "description": "slot for menu item secondary label.",
29053
29169
  "name": "leading-text-secondary-label",
29054
29170
  "inheritedFrom": {
29055
29171
  "name": "ListItem",
@@ -29057,7 +29173,7 @@
29057
29173
  }
29058
29174
  },
29059
29175
  {
29060
- "description": "slot for list item tertiary label.",
29176
+ "description": "slot for menu item tertiary label.",
29061
29177
  "name": "leading-text-tertiary-label",
29062
29178
  "inheritedFrom": {
29063
29179
  "name": "ListItem",
@@ -29065,7 +29181,7 @@
29065
29181
  }
29066
29182
  },
29067
29183
  {
29068
- "description": "slot for list item side header text.",
29184
+ "description": "slot for menu item side header text.",
29069
29185
  "name": "trailing-text-side-header",
29070
29186
  "inheritedFrom": {
29071
29187
  "name": "ListItem",
@@ -29073,7 +29189,7 @@
29073
29189
  }
29074
29190
  },
29075
29191
  {
29076
- "description": "slot for list item subline text.",
29192
+ "description": "slot for menu item subline text.",
29077
29193
  "name": "trailing-text-subline",
29078
29194
  "inheritedFrom": {
29079
29195
  "name": "ListItem",
@@ -29081,7 +29197,7 @@
29081
29197
  }
29082
29198
  },
29083
29199
  {
29084
- "description": "slot for list item controls to appear of trailing end.",
29200
+ "description": "slot for menu item controls to appear of trailing end.",
29085
29201
  "name": "trailing-controls",
29086
29202
  "inheritedFrom": {
29087
29203
  "name": "ListItem",
@@ -29104,116 +29220,220 @@
29104
29220
  "kind": "js",
29105
29221
  "name": "default",
29106
29222
  "declaration": {
29107
- "name": "Option",
29108
- "module": "components/option/option.component.js"
29223
+ "name": "NavMenuItem",
29224
+ "module": "components/navmenuitem/navmenuitem.component.js"
29109
29225
  }
29110
29226
  }
29111
29227
  ]
29112
29228
  },
29113
29229
  {
29114
29230
  "kind": "javascript-module",
29115
- "path": "components/navmenuitem/navmenuitem.component.js",
29231
+ "path": "components/optgroup/optgroup.component.js",
29116
29232
  "declarations": [
29117
29233
  {
29118
29234
  "kind": "class",
29119
- "description": "`mdc-navmenuitem` is a menuitem styled to work as a navigation tab.\nIt supports a leading icon, optional badge and dynamic text rendering.\n\nNote: `mdc-navmenuitem` is intended to be used inside `mdc-menubar` as part of the sideNavigation\ncomponent. Its structure, spacing, and interactions are designed to align with\nthe visual and functional requirements of side navigation layouts.\n\nBy providing the tooltip-text attribute, a tooltip will be displayed on hover of the navmenuitem. This tooltip is useful when an active navmenuitem is present within a submenu of the sidenavigation component.",
29120
- "name": "NavMenuItem",
29235
+ "description": "optgroup component, which creates a grouping of mdc-option within a listbox element.",
29236
+ "name": "OptGroup",
29121
29237
  "cssProperties": [
29122
29238
  {
29123
- "description": "Text color of the navmenuitem in its normal state.",
29124
- "name": "--mdc-navmenuitem-color"
29125
- },
29126
- {
29127
- "description": "Border color of the navmenuitem in its normal state.",
29128
- "name": "--mdc-navmenuitem-border-color"
29129
- },
29130
- {
29131
- "description": "Text color of the navmenuitem when disabled.",
29132
- "name": "--mdc-navmenuitem-disabled-color"
29133
- },
29134
- {
29135
- "description": "Width of the navmenuitem when expanded.",
29136
- "name": "--mdc-navmenuitem-expanded-width"
29137
- },
29138
- {
29139
- "description": "Background color of the navmenuitem when hovered.",
29140
- "name": "--mdc-navmenuitem-hover-background-color"
29141
- },
29142
- {
29143
- "description": "Background color of the active navmenuitem when hovered.",
29144
- "name": "--mdc-navmenuitem-hover-active-background-color"
29145
- },
29146
- {
29147
- "description": "Background color of the navmenuitem when pressed.",
29148
- "name": "--mdc-navmenuitem-pressed-background-color"
29149
- },
29150
- {
29151
- "description": "Background color of the active navmenuitem when pressed.",
29152
- "name": "--mdc-navmenuitem-pressed-active-background-color"
29153
- },
29239
+ "description": "Allows customization of the disabled option color.",
29240
+ "name": "--mdc-optgroup-disabled-color"
29241
+ }
29242
+ ],
29243
+ "cssParts": [
29154
29244
  {
29155
- "description": "Background color of the navmenuitem when disabled.",
29156
- "name": "--mdc-navmenuitem-disabled-background-color"
29157
- },
29245
+ "description": "The header text of the optgroup.",
29246
+ "name": "header-text"
29247
+ }
29248
+ ],
29249
+ "slots": [
29158
29250
  {
29159
- "description": "Background color of the active navmenuitem when disabled.",
29160
- "name": "--mdc-navmenuitem-disabled-active-background-color"
29161
- },
29251
+ "description": "This is a default slot for mdc-option elements.",
29252
+ "name": "default"
29253
+ }
29254
+ ],
29255
+ "members": [
29162
29256
  {
29163
- "description": "Background color of the active nav item in its rest state.",
29164
- "name": "--mdc-navmenuitem-rest-active-background-color"
29257
+ "kind": "field",
29258
+ "name": "label",
29259
+ "type": {
29260
+ "text": "string | undefined"
29261
+ },
29262
+ "description": "The header text to be displayed on the top of the options list.",
29263
+ "attribute": "label",
29264
+ "reflects": true
29165
29265
  },
29166
29266
  {
29167
- "description": "Allows customization of the default background color.",
29168
- "name": "--mdc-listitem-default-background-color",
29169
- "inheritedFrom": {
29170
- "name": "ListItem",
29171
- "module": "src/components/listitem/listitem.component.ts"
29267
+ "kind": "method",
29268
+ "name": "setDisabledForAllOptions",
29269
+ "privacy": "private",
29270
+ "return": {
29271
+ "type": {
29272
+ "text": "void"
29273
+ }
29172
29274
  }
29173
29275
  },
29174
29276
  {
29175
- "description": "Allows customization of the background color on hover.",
29176
- "name": "--mdc-listitem-background-color-hover",
29277
+ "kind": "field",
29278
+ "name": "dataAriaLabel",
29279
+ "type": {
29280
+ "text": "string | null"
29281
+ },
29282
+ "default": "null",
29283
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
29284
+ "attribute": "data-aria-label",
29285
+ "reflects": true,
29177
29286
  "inheritedFrom": {
29178
- "name": "ListItem",
29179
- "module": "src/components/listitem/listitem.component.ts"
29287
+ "name": "DataAriaLabelMixin",
29288
+ "module": "utils/mixins/DataAriaLabelMixin.js"
29180
29289
  }
29181
29290
  },
29182
29291
  {
29183
- "description": "Allows customization of the background color when pressed.",
29184
- "name": "--mdc-listitem-background-color-active",
29185
- "inheritedFrom": {
29186
- "name": "ListItem",
29187
- "module": "src/components/listitem/listitem.component.ts"
29188
- }
29189
- },
29292
+ "kind": "field",
29293
+ "name": "disabled",
29294
+ "type": {
29295
+ "text": "boolean | undefined"
29296
+ },
29297
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
29298
+ "default": "undefined",
29299
+ "attribute": "disabled",
29300
+ "reflects": true,
29301
+ "inheritedFrom": {
29302
+ "name": "DisabledMixin",
29303
+ "module": "utils/mixins/DisabledMixin.js"
29304
+ }
29305
+ }
29306
+ ],
29307
+ "attributes": [
29190
29308
  {
29191
- "description": "Allows customization of the primary label, side header and subline text slot color.",
29192
- "name": "--mdc-listitem-primary-label-color",
29309
+ "name": "label",
29310
+ "type": {
29311
+ "text": "string | undefined"
29312
+ },
29313
+ "description": "The header text to be displayed on the top of the options list.",
29314
+ "fieldName": "label"
29315
+ },
29316
+ {
29317
+ "name": "data-aria-label",
29318
+ "type": {
29319
+ "text": "string | null"
29320
+ },
29321
+ "default": "null",
29322
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
29323
+ "fieldName": "dataAriaLabel",
29324
+ "inheritedFrom": {
29325
+ "name": "DataAriaLabelMixin",
29326
+ "module": "src/utils/mixins/DataAriaLabelMixin.ts"
29327
+ }
29328
+ },
29329
+ {
29330
+ "name": "disabled",
29331
+ "type": {
29332
+ "text": "boolean | undefined"
29333
+ },
29334
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
29335
+ "default": "undefined",
29336
+ "fieldName": "disabled",
29337
+ "inheritedFrom": {
29338
+ "name": "DisabledMixin",
29339
+ "module": "src/utils/mixins/DisabledMixin.ts"
29340
+ }
29341
+ }
29342
+ ],
29343
+ "mixins": [
29344
+ {
29345
+ "name": "DataAriaLabelMixin",
29346
+ "module": "/src/utils/mixins/DataAriaLabelMixin"
29347
+ },
29348
+ {
29349
+ "name": "DisabledMixin",
29350
+ "module": "/src/utils/mixins/DisabledMixin"
29351
+ }
29352
+ ],
29353
+ "superclass": {
29354
+ "name": "Component",
29355
+ "module": "/src/models"
29356
+ },
29357
+ "tagName": "mdc-optgroup",
29358
+ "jsDoc": "/**\n * optgroup component, which creates a grouping of mdc-option within a listbox element.\n *\n * @dependency mdc-text\n *\n * @tagname mdc-optgroup\n *\n * @slot default - This is a default slot for mdc-option elements.\n *\n * @cssproperty --mdc-optgroup-disabled-color - Allows customization of the disabled option color.\n *\n * @csspart header-text - The header text of the optgroup.\n */",
29359
+ "customElement": true
29360
+ }
29361
+ ],
29362
+ "exports": [
29363
+ {
29364
+ "kind": "js",
29365
+ "name": "default",
29366
+ "declaration": {
29367
+ "name": "OptGroup",
29368
+ "module": "components/optgroup/optgroup.component.js"
29369
+ }
29370
+ }
29371
+ ]
29372
+ },
29373
+ {
29374
+ "kind": "javascript-module",
29375
+ "path": "components/option/option.component.js",
29376
+ "declarations": [
29377
+ {
29378
+ "kind": "class",
29379
+ "description": "Option component, which is used within Selectlistbox within Select component.\n\nThe label and secondary label of the option can be set using the `label` and `secondaryLabel` properties respectively.\nThe `label` is the primary text displayed in the option, while the `secondaryLabel` is the secondary text displayed below the primary label.\n\nThe `selected` property is used to indicate whether the option is selected or not.\nWhen the `selected` property is set to true, a checkmark icon will be displayed\non the right side of the option to indicate that it is selected.\n\nThe `prefixIcon` property can be used to display an icon on the left side of the option label.\n\n**Note**: If an option contains a long text, it is recommended to create a tooltip for the option that displays the full text on hover.\nConsumers need to add a unique ID to this option and use that ID in the tooltip's `triggerID` attribute. We are not creating the tooltip automatically, consumers need to add `<mdc-tooltip>` element manually and associate it with the option using the `triggerID` attribute.",
29380
+ "name": "Option",
29381
+ "cssProperties": [
29382
+ {
29383
+ "description": "gap between columns in the option",
29384
+ "name": "--mdc-listitem-column-gap",
29193
29385
  "inheritedFrom": {
29194
29386
  "name": "ListItem",
29195
29387
  "module": "src/components/listitem/listitem.component.ts"
29196
29388
  }
29197
29389
  },
29198
29390
  {
29199
- "description": "Allows customization of the secondary and tertiary label text slot color.",
29200
- "name": "--mdc-listitem-secondary-label-color",
29391
+ "description": "width of the icon in the option",
29392
+ "name": "--mdc-option-icon-width"
29393
+ },
29394
+ {
29395
+ "description": "Allows customization of the default background color.",
29396
+ "name": "--mdc-listitem-default-background-color",
29201
29397
  "inheritedFrom": {
29202
29398
  "name": "ListItem",
29203
29399
  "module": "src/components/listitem/listitem.component.ts"
29204
29400
  }
29205
29401
  },
29206
29402
  {
29207
- "description": "Allows customization of the disabled color.",
29208
- "name": "--mdc-listitem-disabled-color",
29403
+ "description": "Allows customization of the background color on hover.",
29404
+ "name": "--mdc-listitem-background-color-hover",
29209
29405
  "inheritedFrom": {
29210
29406
  "name": "ListItem",
29211
29407
  "module": "src/components/listitem/listitem.component.ts"
29212
29408
  }
29213
29409
  },
29214
29410
  {
29215
- "description": "Allows customization of column gap.",
29216
- "name": "--mdc-listitem-column-gap",
29411
+ "description": "Allows customization of the background color when pressed.",
29412
+ "name": "--mdc-listitem-background-color-active",
29413
+ "inheritedFrom": {
29414
+ "name": "ListItem",
29415
+ "module": "src/components/listitem/listitem.component.ts"
29416
+ }
29417
+ },
29418
+ {
29419
+ "description": "Allows customization of the primary label, side header and subline text slot color.",
29420
+ "name": "--mdc-listitem-primary-label-color",
29421
+ "inheritedFrom": {
29422
+ "name": "ListItem",
29423
+ "module": "src/components/listitem/listitem.component.ts"
29424
+ }
29425
+ },
29426
+ {
29427
+ "description": "Allows customization of the secondary and tertiary label text slot color.",
29428
+ "name": "--mdc-listitem-secondary-label-color",
29429
+ "inheritedFrom": {
29430
+ "name": "ListItem",
29431
+ "module": "src/components/listitem/listitem.component.ts"
29432
+ }
29433
+ },
29434
+ {
29435
+ "description": "Allows customization of the disabled color.",
29436
+ "name": "--mdc-listitem-disabled-color",
29217
29437
  "inheritedFrom": {
29218
29438
  "name": "ListItem",
29219
29439
  "module": "src/components/listitem/listitem.component.ts"
@@ -29261,30 +29481,6 @@
29261
29481
  }
29262
29482
  ],
29263
29483
  "cssParts": [
29264
- {
29265
- "description": "The arrow of the navmenuitem.",
29266
- "name": "arrow"
29267
- },
29268
- {
29269
- "description": "The badge of the navmenuitem.",
29270
- "name": "badge"
29271
- },
29272
- {
29273
- "description": "The container of the icon.",
29274
- "name": "icon-container"
29275
- },
29276
- {
29277
- "description": "The container of the text.",
29278
- "name": "text-container"
29279
- },
29280
- {
29281
- "description": "The trailing arrow of the navmenuitem.",
29282
- "name": "trailing-arrow",
29283
- "inheritedFrom": {
29284
- "name": "MenuItem",
29285
- "module": "src/components/menuitem/menuitem.component.ts"
29286
- }
29287
- },
29288
29484
  {
29289
29485
  "description": "Allows customization of the leading part.",
29290
29486
  "name": "leading",
@@ -29293,14 +29489,6 @@
29293
29489
  "module": "src/components/listitem/listitem.component.ts"
29294
29490
  }
29295
29491
  },
29296
- {
29297
- "description": "Allows customization of leading arrow icon.",
29298
- "name": "leading-arrow",
29299
- "inheritedFrom": {
29300
- "name": "MenuItem",
29301
- "module": "src/components/menuitem/menuitem.component.ts"
29302
- }
29303
- },
29304
29492
  {
29305
29493
  "description": "Allows customization of the leading text part.",
29306
29494
  "name": "leading-text",
@@ -29329,55 +29517,23 @@
29329
29517
  "members": [
29330
29518
  {
29331
29519
  "kind": "field",
29332
- "name": "active",
29333
- "type": {
29334
- "text": "boolean | undefined"
29335
- },
29336
- "description": "The navmenuitem's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the navmenuitem is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the navmenuitem is in an inactive state, indicating it is toggled off.",
29337
- "default": "undefined",
29338
- "attribute": "active",
29339
- "reflects": true
29340
- },
29341
- {
29342
- "kind": "field",
29343
- "name": "badgeType",
29344
- "type": {
29345
- "text": "BadgeType | undefined"
29346
- },
29347
- "description": "Type of the badge\nCan be `dot` (notification) or `counter`.",
29348
- "attribute": "badge-type",
29349
- "reflects": true
29350
- },
29351
- {
29352
- "kind": "field",
29353
- "name": "counter",
29354
- "type": {
29355
- "text": "number | undefined"
29356
- },
29357
- "description": "Counter is the number which can be provided in the badge.",
29358
- "attribute": "counter",
29359
- "reflects": true
29360
- },
29361
- {
29362
- "kind": "field",
29363
- "name": "maxCounter",
29520
+ "name": "selected",
29364
29521
  "type": {
29365
- "text": "number"
29522
+ "text": "boolean"
29366
29523
  },
29367
- "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`.",
29368
- "default": "99",
29369
- "attribute": "max-counter",
29524
+ "default": "false",
29525
+ "description": "The selected attribute is used to indicate that the option is selected.",
29526
+ "attribute": "selected",
29370
29527
  "reflects": true
29371
29528
  },
29372
29529
  {
29373
29530
  "kind": "field",
29374
- "name": "navId",
29531
+ "name": "prefixIcon",
29375
29532
  "type": {
29376
- "text": "string | undefined"
29533
+ "text": "IconNames | undefined"
29377
29534
  },
29378
- "description": "Id of the navMenuItem (used as a identificator when used in the menubar)\nNote: It has to be unique.",
29379
- "default": "undefined",
29380
- "attribute": "nav-id",
29535
+ "description": "The prefix icon attribute is used to display the icon name on the left of the option label.",
29536
+ "attribute": "prefix-icon",
29381
29537
  "reflects": true
29382
29538
  },
29383
29539
  {
@@ -29387,249 +29543,108 @@
29387
29543
  "text": "string | null"
29388
29544
  },
29389
29545
  "default": "null",
29390
- "description": "Aria-label attribute to be set for accessibility",
29391
- "attribute": "aria-label"
29392
- },
29393
- {
29394
- "kind": "field",
29395
- "name": "disableAriaCurrent",
29396
- "type": {
29397
- "text": "boolean | undefined"
29398
- },
29399
- "description": "When set to true, prevents the automatic setting of the `aria-current` attribute on the navmenuitem\nwhen it becomes active. This is useful for cases where you want to maintain the visual active styling\nbut need to handle aria-current attribute differently or not at all.\nThe active button styling will still be applied regardless of this setting.",
29400
- "attribute": "disable-aria-current",
29401
- "reflects": true
29402
- },
29403
- {
29404
- "kind": "field",
29405
- "name": "tooltipText",
29406
- "type": {
29407
- "text": "string | undefined"
29408
- },
29409
- "description": "The tooltip text is displayed on hover of the list item.",
29410
- "attribute": "tooltip-text",
29546
+ "description": "Any additional description can be provided here for screen readers.",
29547
+ "attribute": "aria-label",
29411
29548
  "reflects": true
29412
29549
  },
29413
- {
29414
- "kind": "method",
29415
- "name": "removeTooltip",
29416
- "privacy": "private"
29417
- },
29418
- {
29419
- "kind": "method",
29420
- "name": "renderDynamicTooltip",
29421
- "privacy": "private",
29422
- "return": {
29423
- "type": {
29424
- "text": "void"
29425
- }
29426
- }
29427
- },
29428
- {
29429
- "kind": "method",
29430
- "name": "isNested",
29431
- "privacy": "private",
29432
- "return": {
29433
- "type": {
29434
- "text": "boolean"
29435
- }
29436
- },
29437
- "description": "Check whether the navmenuitem is inside a nested nav structure.\nReturns `true` if there is a parent `mdc-menupopover`\nThis method assumes nesting implies deeper levels of nav hierarchy."
29438
- },
29439
- {
29440
- "kind": "method",
29441
- "name": "handleClickEvent",
29442
- "privacy": "private",
29443
- "return": {
29444
- "type": {
29445
- "text": "void"
29446
- }
29447
- }
29448
- },
29449
- {
29450
- "kind": "method",
29451
- "name": "renderTextLabel",
29452
- "privacy": "private",
29453
- "parameters": [
29454
- {
29455
- "name": "label",
29456
- "type": {
29457
- "text": "string | undefined"
29458
- }
29459
- }
29460
- ]
29461
- },
29462
- {
29463
- "kind": "method",
29464
- "name": "renderArrowIcon",
29465
- "privacy": "private",
29466
- "parameters": [
29467
- {
29468
- "name": "showLabel",
29469
- "type": {
29470
- "text": "boolean | undefined"
29471
- }
29472
- }
29473
- ]
29474
- },
29475
- {
29476
- "kind": "method",
29477
- "name": "renderBadge",
29478
- "privacy": "private",
29479
- "parameters": [
29480
- {
29481
- "name": "showLabel",
29482
- "type": {
29483
- "text": "boolean | undefined"
29484
- }
29485
- }
29486
- ]
29487
- },
29488
29550
  {
29489
29551
  "kind": "field",
29490
- "name": "iconName",
29491
- "type": {
29492
- "text": "IconNames | undefined"
29493
- },
29494
- "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
29495
- "attribute": "icon-name",
29496
- "inheritedFrom": {
29497
- "name": "IconNameMixin",
29498
- "module": "utils/mixins/IconNameMixin.js"
29499
- }
29500
- },
29501
- {
29502
- "kind": "field",
29503
- "name": "arrowPosition",
29552
+ "name": "name",
29504
29553
  "type": {
29505
- "text": "ArrowPositions | undefined"
29554
+ "text": "string"
29506
29555
  },
29507
- "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.",
29508
- "attribute": "arrow-position",
29556
+ "default": "''",
29557
+ "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
29558
+ "attribute": "name",
29509
29559
  "reflects": true,
29510
29560
  "inheritedFrom": {
29511
- "name": "MenuItem",
29512
- "module": "components/menuitem/menuitem.component.js"
29561
+ "name": "FormInternalsMixin",
29562
+ "module": "utils/mixins/FormInternalsMixin.js"
29513
29563
  }
29514
29564
  },
29515
29565
  {
29516
29566
  "kind": "field",
29517
- "name": "arrowDirection",
29567
+ "name": "value",
29518
29568
  "type": {
29519
- "text": "ArrowDirections | undefined"
29569
+ "text": "string"
29520
29570
  },
29521
- "description": "Defines the direction the arrow icon points.\n- `'positive'`: Arrow points toward the trailing side.\n- `'negative'`: Arrow points toward the leading side.",
29522
- "attribute": "arrow-direction",
29571
+ "default": "''",
29572
+ "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
29573
+ "attribute": "value",
29523
29574
  "reflects": true,
29524
29575
  "inheritedFrom": {
29525
- "name": "MenuItem",
29526
- "module": "components/menuitem/menuitem.component.js"
29576
+ "name": "FormInternalsMixin",
29577
+ "module": "utils/mixins/FormInternalsMixin.js"
29527
29578
  }
29528
29579
  },
29529
29580
  {
29530
29581
  "kind": "field",
29531
- "name": "name",
29582
+ "name": "validationMessage",
29532
29583
  "type": {
29533
29584
  "text": "string | undefined"
29534
29585
  },
29535
- "description": "The name attribute is used to identify the menu item when it is selected.",
29536
- "attribute": "name",
29586
+ "description": "Custom validation message that will override the default message and displayed when the input is invalid.\n\nTo display custom validation messages, you must listen for input events (or other relevant events)\non your component and update the `validationMessage` property with the desired message string.\nUpdating this property will ensure that new validation messages are shown to the user.\n- The `validationMessage` property overrides the default browser validation message when set.\n- Consumers are responsible for updating `validationMessage` in response to input or validation state changes.",
29587
+ "attribute": "validation-message",
29537
29588
  "reflects": true,
29538
29589
  "inheritedFrom": {
29539
- "name": "MenuItem",
29540
- "module": "components/menuitem/menuitem.component.js"
29590
+ "name": "FormInternalsMixin",
29591
+ "module": "utils/mixins/FormInternalsMixin.js"
29541
29592
  }
29542
29593
  },
29543
29594
  {
29544
29595
  "kind": "field",
29545
- "name": "value",
29596
+ "name": "validity",
29546
29597
  "type": {
29547
- "text": "string | undefined"
29548
- },
29549
- "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.",
29550
- "attribute": "value",
29551
- "reflects": true,
29552
- "inheritedFrom": {
29553
- "name": "MenuItem",
29554
- "module": "components/menuitem/menuitem.component.js"
29555
- }
29556
- },
29557
- {
29558
- "kind": "method",
29559
- "name": "handleKeyDown",
29560
- "privacy": "protected",
29561
- "return": {
29562
- "type": {
29563
- "text": "void"
29564
- }
29598
+ "text": "ValidityState"
29565
29599
  },
29566
- "parameters": [
29567
- {
29568
- "name": "event",
29569
- "type": {
29570
- "text": "KeyboardEvent"
29571
- },
29572
- "description": "The keyboard event that triggered the action."
29573
- }
29574
- ],
29575
- "description": "Handles the keydown event for the menu item.\nIf the Enter key is pressed, it triggers a click event on the menu item.\nThis allows keyboard users to activate the menu item using the Enter key.\n\nThis follows the native behaviour, actionable element can be triggered by Enter\nkey on the keydown event.\n\nNote: Action triggered by Space on the keyup event.",
29600
+ "readonly": true,
29576
29601
  "inheritedFrom": {
29577
- "name": "ListItem",
29578
- "module": "components/listitem/listitem.component.js"
29602
+ "name": "FormInternalsMixin",
29603
+ "module": "utils/mixins/FormInternalsMixin.js"
29579
29604
  }
29580
29605
  },
29581
29606
  {
29582
- "kind": "method",
29583
- "name": "handleKeyUp",
29584
- "privacy": "private",
29585
- "return": {
29586
- "type": {
29587
- "text": "void"
29588
- }
29589
- },
29590
- "parameters": [
29591
- {
29592
- "name": "event",
29593
- "type": {
29594
- "text": "KeyboardEvent"
29595
- },
29596
- "description": "The keyboard event that triggered the action."
29597
- }
29598
- ],
29599
- "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.",
29607
+ "kind": "field",
29608
+ "name": "willValidate",
29609
+ "readonly": true,
29600
29610
  "inheritedFrom": {
29601
- "name": "MenuItem",
29602
- "module": "components/menuitem/menuitem.component.js"
29611
+ "name": "FormInternalsMixin",
29612
+ "module": "utils/mixins/FormInternalsMixin.js"
29603
29613
  }
29604
29614
  },
29605
29615
  {
29606
29616
  "kind": "method",
29607
- "name": "renderTrailingControls",
29608
- "privacy": "protected",
29609
- "description": "Renders the trailing controls slot and optionally the trailing arrow icon,\nbased on `arrowPosition` and `arrowDirection`.",
29617
+ "name": "setValidity",
29618
+ "description": "Sets the validity of the input field based on the input field's validity.",
29610
29619
  "return": {
29611
29620
  "type": {
29612
29621
  "text": ""
29613
29622
  }
29614
29623
  },
29615
29624
  "inheritedFrom": {
29616
- "name": "ListItem",
29617
- "module": "components/listitem/listitem.component.js"
29625
+ "name": "FormInternalsMixin",
29626
+ "module": "utils/mixins/FormInternalsMixin.js"
29618
29627
  }
29619
29628
  },
29620
29629
  {
29621
29630
  "kind": "method",
29622
- "name": "renderLeadingControls",
29623
- "privacy": "protected",
29624
- "description": "Renders the leading controls slot and optionally the leading arrow icon,\nbased on `arrowPosition` and `arrowDirection`.",
29631
+ "name": "checkValidity",
29625
29632
  "return": {
29626
29633
  "type": {
29627
- "text": ""
29634
+ "text": "boolean"
29628
29635
  }
29629
29636
  },
29630
29637
  "inheritedFrom": {
29631
- "name": "ListItem",
29632
- "module": "components/listitem/listitem.component.js"
29638
+ "name": "FormInternalsMixin",
29639
+ "module": "utils/mixins/FormInternalsMixin.js"
29640
+ }
29641
+ },
29642
+ {
29643
+ "kind": "method",
29644
+ "name": "reportValidity",
29645
+ "inheritedFrom": {
29646
+ "name": "FormInternalsMixin",
29647
+ "module": "utils/mixins/FormInternalsMixin.js"
29633
29648
  }
29634
29649
  },
29635
29650
  {
@@ -29786,6 +29801,30 @@
29786
29801
  "module": "components/listitem/listitem.component.js"
29787
29802
  }
29788
29803
  },
29804
+ {
29805
+ "kind": "method",
29806
+ "name": "handleKeyDown",
29807
+ "privacy": "protected",
29808
+ "return": {
29809
+ "type": {
29810
+ "text": "void"
29811
+ }
29812
+ },
29813
+ "parameters": [
29814
+ {
29815
+ "name": "event",
29816
+ "type": {
29817
+ "text": "KeyboardEvent"
29818
+ },
29819
+ "description": "The keyboard event triggered when a key is pressed down."
29820
+ }
29821
+ ],
29822
+ "description": "Fires the click event when the enter or space key is pressed down.\nThis behavior is similar to a button click and key interaction.",
29823
+ "inheritedFrom": {
29824
+ "name": "ListItem",
29825
+ "module": "components/listitem/listitem.component.js"
29826
+ }
29827
+ },
29789
29828
  {
29790
29829
  "kind": "method",
29791
29830
  "name": "triggerClickEvent",
@@ -29874,6 +29913,36 @@
29874
29913
  "module": "components/listitem/listitem.component.js"
29875
29914
  }
29876
29915
  },
29916
+ {
29917
+ "kind": "method",
29918
+ "name": "renderTrailingControls",
29919
+ "privacy": "protected",
29920
+ "description": "Renders the trailing controls slot.",
29921
+ "return": {
29922
+ "type": {
29923
+ "text": ""
29924
+ }
29925
+ },
29926
+ "inheritedFrom": {
29927
+ "name": "ListItem",
29928
+ "module": "components/listitem/listitem.component.js"
29929
+ }
29930
+ },
29931
+ {
29932
+ "kind": "method",
29933
+ "name": "renderLeadingControls",
29934
+ "privacy": "protected",
29935
+ "description": "Renders the leading controls slot.",
29936
+ "return": {
29937
+ "type": {
29938
+ "text": ""
29939
+ }
29940
+ },
29941
+ "inheritedFrom": {
29942
+ "name": "ListItem",
29943
+ "module": "components/listitem/listitem.component.js"
29944
+ }
29945
+ },
29877
29946
  {
29878
29947
  "kind": "method",
29879
29948
  "name": "stopEventPropagation",
@@ -29901,7 +29970,7 @@
29901
29970
  ],
29902
29971
  "events": [
29903
29972
  {
29904
- "description": "(React: onClick) This event is dispatched when the navmenuitem is clicked.",
29973
+ "description": "(React: onClick) This event is dispatched when the option is clicked.",
29905
29974
  "name": "click",
29906
29975
  "reactName": "onClick",
29907
29976
  "inheritedFrom": {
@@ -29910,7 +29979,7 @@
29910
29979
  }
29911
29980
  },
29912
29981
  {
29913
- "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the navmenuitem.",
29982
+ "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the option.",
29914
29983
  "name": "keydown",
29915
29984
  "reactName": "onKeyDown",
29916
29985
  "inheritedFrom": {
@@ -29919,7 +29988,7 @@
29919
29988
  }
29920
29989
  },
29921
29990
  {
29922
- "description": "(React: onKeyUp) This event is dispatched when a key is released on the navmenuitem.",
29991
+ "description": "(React: onKeyUp) This event is dispatched when a key is released on the option.",
29923
29992
  "name": "keyup",
29924
29993
  "reactName": "onKeyUp",
29925
29994
  "inheritedFrom": {
@@ -29928,7 +29997,7 @@
29928
29997
  }
29929
29998
  },
29930
29999
  {
29931
- "description": "(React: onFocus) This event is dispatched when the navmenuitem receives focus.",
30000
+ "description": "(React: onFocus) This event is dispatched when the option receives focus.",
29932
30001
  "name": "focus",
29933
30002
  "reactName": "onFocus",
29934
30003
  "inheritedFrom": {
@@ -29937,12 +30006,7 @@
29937
30006
  }
29938
30007
  },
29939
30008
  {
29940
- "description": "(React: onActiveChange) Dispatched when the active state of the navmenuitem changes.",
29941
- "name": "activechange",
29942
- "reactName": "onActiveChange"
29943
- },
29944
- {
29945
- "description": "(React: onEnabled) This event is dispatched after the menuitem is enabled",
30009
+ "description": "(React: onEnabled) This event is dispatched after the listitem is enabled",
29946
30010
  "name": "enabled",
29947
30011
  "reactName": "onEnabled",
29948
30012
  "inheritedFrom": {
@@ -29951,7 +30015,7 @@
29951
30015
  }
29952
30016
  },
29953
30017
  {
29954
- "description": "(React: onDisabled) This event is dispatched after the menuitem is disabled",
30018
+ "description": "(React: onDisabled) This event is dispatched after the listitem is disabled",
29955
30019
  "name": "disabled",
29956
30020
  "reactName": "onDisabled",
29957
30021
  "inheritedFrom": {
@@ -29960,7 +30024,7 @@
29960
30024
  }
29961
30025
  },
29962
30026
  {
29963
- "description": "(React: onCreated) This event is dispatched after the menuitem is created (added to the DOM)",
30027
+ "description": "(React: onCreated) This event is dispatched after the listitem is created (added to the DOM)",
29964
30028
  "name": "created",
29965
30029
  "reactName": "onCreated",
29966
30030
  "inheritedFrom": {
@@ -29969,7 +30033,7 @@
29969
30033
  }
29970
30034
  },
29971
30035
  {
29972
- "description": "(React: onDestroyed) This event is dispatched after the menuitem is destroyed (removed from the DOM)",
30036
+ "description": "(React: onDestroyed) This event is dispatched after the listitem is destroyed (removed from the DOM)",
29973
30037
  "name": "destroyed",
29974
30038
  "reactName": "onDestroyed",
29975
30039
  "inheritedFrom": {
@@ -29980,47 +30044,21 @@
29980
30044
  ],
29981
30045
  "attributes": [
29982
30046
  {
29983
- "name": "active",
29984
- "type": {
29985
- "text": "boolean | undefined"
29986
- },
29987
- "description": "The navmenuitem's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the navmenuitem is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the navmenuitem is in an inactive state, indicating it is toggled off.",
29988
- "default": "undefined",
29989
- "fieldName": "active"
29990
- },
29991
- {
29992
- "name": "badge-type",
29993
- "type": {
29994
- "text": "BadgeType | undefined"
29995
- },
29996
- "description": "Type of the badge\nCan be `dot` (notification) or `counter`.",
29997
- "fieldName": "badgeType"
29998
- },
29999
- {
30000
- "name": "counter",
30001
- "type": {
30002
- "text": "number | undefined"
30003
- },
30004
- "description": "Counter is the number which can be provided in the badge.",
30005
- "fieldName": "counter"
30006
- },
30007
- {
30008
- "name": "max-counter",
30047
+ "name": "selected",
30009
30048
  "type": {
30010
- "text": "number"
30049
+ "text": "boolean"
30011
30050
  },
30012
- "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`.",
30013
- "default": "99",
30014
- "fieldName": "maxCounter"
30051
+ "default": "false",
30052
+ "description": "The selected attribute is used to indicate that the option is selected.",
30053
+ "fieldName": "selected"
30015
30054
  },
30016
30055
  {
30017
- "name": "nav-id",
30056
+ "name": "prefix-icon",
30018
30057
  "type": {
30019
- "text": "string | undefined"
30058
+ "text": "IconNames | undefined"
30020
30059
  },
30021
- "description": "Id of the navMenuItem (used as a identificator when used in the menubar)\nNote: It has to be unique.",
30022
- "default": "undefined",
30023
- "fieldName": "navId"
30060
+ "description": "The prefix icon attribute is used to display the icon name on the left of the option label.",
30061
+ "fieldName": "prefixIcon"
30024
30062
  },
30025
30063
  {
30026
30064
  "name": "aria-label",
@@ -30028,83 +30066,45 @@
30028
30066
  "text": "string | null"
30029
30067
  },
30030
30068
  "default": "null",
30031
- "description": "Aria-label attribute to be set for accessibility",
30069
+ "description": "Any additional description can be provided here for screen readers.",
30032
30070
  "fieldName": "ariaLabel"
30033
30071
  },
30034
30072
  {
30035
- "name": "disable-aria-current",
30036
- "type": {
30037
- "text": "boolean | undefined"
30038
- },
30039
- "description": "When set to true, prevents the automatic setting of the `aria-current` attribute on the navmenuitem\nwhen it becomes active. This is useful for cases where you want to maintain the visual active styling\nbut need to handle aria-current attribute differently or not at all.\nThe active button styling will still be applied regardless of this setting.",
30040
- "fieldName": "disableAriaCurrent"
30041
- },
30042
- {
30043
- "name": "tooltip-text",
30044
- "type": {
30045
- "text": "string | undefined"
30046
- },
30047
- "description": "The tooltip text is displayed on hover of the list item.",
30048
- "fieldName": "tooltipText"
30049
- },
30050
- {
30051
- "name": "icon-name",
30052
- "type": {
30053
- "text": "IconNames | undefined"
30054
- },
30055
- "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
30056
- "fieldName": "iconName",
30057
- "inheritedFrom": {
30058
- "name": "IconNameMixin",
30059
- "module": "src/utils/mixins/IconNameMixin.ts"
30060
- }
30061
- },
30062
- {
30063
- "name": "arrow-position",
30064
- "type": {
30065
- "text": "ArrowPositions | undefined"
30066
- },
30067
- "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.",
30068
- "fieldName": "arrowPosition",
30069
- "inheritedFrom": {
30070
- "name": "MenuItem",
30071
- "module": "src/components/menuitem/menuitem.component.ts"
30072
- }
30073
- },
30074
- {
30075
- "name": "arrow-direction",
30073
+ "name": "name",
30076
30074
  "type": {
30077
- "text": "ArrowDirections | undefined"
30075
+ "text": "string"
30078
30076
  },
30079
- "description": "Defines the direction the arrow icon points.\n- `'positive'`: Arrow points toward the trailing side.\n- `'negative'`: Arrow points toward the leading side.",
30080
- "fieldName": "arrowDirection",
30077
+ "default": "''",
30078
+ "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
30079
+ "fieldName": "name",
30081
30080
  "inheritedFrom": {
30082
- "name": "MenuItem",
30083
- "module": "src/components/menuitem/menuitem.component.ts"
30081
+ "name": "FormInternalsMixin",
30082
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
30084
30083
  }
30085
30084
  },
30086
30085
  {
30087
- "name": "name",
30086
+ "name": "value",
30088
30087
  "type": {
30089
- "text": "string | undefined"
30088
+ "text": "string"
30090
30089
  },
30091
- "description": "The name attribute is used to identify the menu item when it is selected.",
30092
- "fieldName": "name",
30090
+ "default": "''",
30091
+ "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
30092
+ "fieldName": "value",
30093
30093
  "inheritedFrom": {
30094
- "name": "MenuItem",
30095
- "module": "src/components/menuitem/menuitem.component.ts"
30094
+ "name": "FormInternalsMixin",
30095
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
30096
30096
  }
30097
30097
  },
30098
30098
  {
30099
- "name": "value",
30099
+ "name": "validation-message",
30100
30100
  "type": {
30101
30101
  "text": "string | undefined"
30102
30102
  },
30103
- "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.",
30104
- "fieldName": "value",
30103
+ "description": "Custom validation message that will override the default message and displayed when the input is invalid.\n\nTo display custom validation messages, you must listen for input events (or other relevant events)\non your component and update the `validationMessage` property with the desired message string.\nUpdating this property will ensure that new validation messages are shown to the user.\n- The `validationMessage` property overrides the default browser validation message when set.\n- Consumers are responsible for updating `validationMessage` in response to input or validation state changes.",
30104
+ "fieldName": "validationMessage",
30105
30105
  "inheritedFrom": {
30106
- "name": "MenuItem",
30107
- "module": "src/components/menuitem/menuitem.component.ts"
30106
+ "name": "FormInternalsMixin",
30107
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
30108
30108
  }
30109
30109
  },
30110
30110
  {
@@ -30222,20 +30222,20 @@
30222
30222
  ],
30223
30223
  "mixins": [
30224
30224
  {
30225
- "name": "IconNameMixin",
30226
- "module": "/src/utils/mixins/IconNameMixin"
30225
+ "name": "FormInternalsMixin",
30226
+ "module": "/src/utils/mixins/FormInternalsMixin"
30227
30227
  }
30228
30228
  ],
30229
30229
  "superclass": {
30230
- "name": "MenuItem",
30231
- "module": "/src/components/menuitem/menuitem.component"
30230
+ "name": "ListItem",
30231
+ "module": "/src/components/listitem/listitem.component"
30232
30232
  },
30233
- "tagName": "mdc-navmenuitem",
30234
- "jsDoc": "/**\n * `mdc-navmenuitem` is a menuitem styled to work as a navigation tab.\n * It supports a leading icon, optional badge and dynamic text rendering.\n *\n * Note: `mdc-navmenuitem` is intended to be used inside `mdc-menubar` as part of the sideNavigation\n * component. Its structure, spacing, and interactions are designed to align with\n * the visual and functional requirements of side navigation layouts.\n *\n * By providing the tooltip-text attribute, a tooltip will be displayed on hover of the navmenuitem. This tooltip is useful when an active navmenuitem is present within a submenu of the sidenavigation component.\n *\n * @tagname mdc-navmenuitem\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n * @dependency mdc-badge\n * @dependency mdc-tooltip\n *\n * @event click - (React: onClick) This event is dispatched when the navmenuitem is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the navmenuitem.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the navmenuitem.\n * @event focus - (React: onFocus) This event is dispatched when the navmenuitem receives focus.\n * @event activechange - (React: onActiveChange) Dispatched when the active state of the navmenuitem changes.\n *\n * @cssproperty --mdc-navmenuitem-color - Text color of the navmenuitem in its normal state.\n * @cssproperty --mdc-navmenuitem-border-color - Border color of the navmenuitem in its normal state.\n * @cssproperty --mdc-navmenuitem-disabled-color - Text color of the navmenuitem when disabled.\n * @cssproperty --mdc-navmenuitem-expanded-width - Width of the navmenuitem when expanded.\n * @cssproperty --mdc-navmenuitem-hover-background-color - Background color of the navmenuitem when hovered.\n * @cssproperty --mdc-navmenuitem-hover-active-background-color - Background color of the active navmenuitem when hovered.\n * @cssproperty --mdc-navmenuitem-pressed-background-color - Background color of the navmenuitem when pressed.\n * @cssproperty --mdc-navmenuitem-pressed-active-background-color - Background color of the active navmenuitem when pressed.\n * @cssproperty --mdc-navmenuitem-disabled-background-color - Background color of the navmenuitem when disabled.\n * @cssproperty --mdc-navmenuitem-disabled-active-background-color - Background color of the active navmenuitem when disabled.\n * @cssproperty --mdc-navmenuitem-rest-active-background-color - Background color of the active nav item in its rest state.\n *\n * @csspart arrow - The arrow of the navmenuitem.\n * @csspart badge - The badge of the navmenuitem.\n * @csspart icon-container - The container of the icon.\n * @csspart text-container - The container of the text.\n * @csspart trailing-arrow - The trailing arrow of the navmenuitem.\n */",
30233
+ "tagName": "mdc-option",
30234
+ "jsDoc": "/**\n * Option component, which is used within Selectlistbox within Select component.\n *\n * The label and secondary label of the option can be set using the `label` and `secondaryLabel` properties respectively.\n * The `label` is the primary text displayed in the option, while the `secondaryLabel` is the secondary text displayed below the primary label.\n *\n * The `selected` property is used to indicate whether the option is selected or not.\n * When the `selected` property is set to true, a checkmark icon will be displayed\n * on the right side of the option to indicate that it is selected.\n *\n * The `prefixIcon` property can be used to display an icon on the left side of the option label.\n *\n * **Note**: If an option contains a long text, it is recommended to create a tooltip for the option that displays the full text on hover.\n * Consumers need to add a unique ID to this option and use that ID in the tooltip's `triggerID` attribute. We are not creating the tooltip automatically, consumers need to add `<mdc-tooltip>` element manually and associate it with the option using the `triggerID` attribute.\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @tagname mdc-option\n *\n * @event click - (React: onClick) This event is dispatched when the option is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the option.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the option.\n * @event focus - (React: onFocus) This event is dispatched when the option receives focus.\n *\n * @cssproperty --mdc-listitem-column-gap - gap between columns in the option\n * @cssproperty --mdc-option-icon-width - width of the icon in the option\n *\n * @csspart leading - Allows customization of the leading part.\n * @csspart leading-text - Allows customization of the leading text part.\n * @csspart trailing - Allows customization of the trailing part.\n * @csspart trailing-text - Allows customization of the trailing text part.\n */",
30235
30235
  "customElement": true,
30236
30236
  "slots": [
30237
30237
  {
30238
- "description": "slot for menu item controls to appear of leading end.",
30238
+ "description": "slot for list item controls to appear of leading end.",
30239
30239
  "name": "leading-controls",
30240
30240
  "inheritedFrom": {
30241
30241
  "name": "ListItem",
@@ -30243,7 +30243,7 @@
30243
30243
  }
30244
30244
  },
30245
30245
  {
30246
- "description": "slot for menu item primary label.",
30246
+ "description": "slot for list item primary label.",
30247
30247
  "name": "leading-text-primary-label",
30248
30248
  "inheritedFrom": {
30249
30249
  "name": "ListItem",
@@ -30251,7 +30251,7 @@
30251
30251
  }
30252
30252
  },
30253
30253
  {
30254
- "description": "slot for menu item secondary label.",
30254
+ "description": "slot for list item secondary label.",
30255
30255
  "name": "leading-text-secondary-label",
30256
30256
  "inheritedFrom": {
30257
30257
  "name": "ListItem",
@@ -30259,7 +30259,7 @@
30259
30259
  }
30260
30260
  },
30261
30261
  {
30262
- "description": "slot for menu item tertiary label.",
30262
+ "description": "slot for list item tertiary label.",
30263
30263
  "name": "leading-text-tertiary-label",
30264
30264
  "inheritedFrom": {
30265
30265
  "name": "ListItem",
@@ -30267,7 +30267,7 @@
30267
30267
  }
30268
30268
  },
30269
30269
  {
30270
- "description": "slot for menu item side header text.",
30270
+ "description": "slot for list item side header text.",
30271
30271
  "name": "trailing-text-side-header",
30272
30272
  "inheritedFrom": {
30273
30273
  "name": "ListItem",
@@ -30275,7 +30275,7 @@
30275
30275
  }
30276
30276
  },
30277
30277
  {
30278
- "description": "slot for menu item subline text.",
30278
+ "description": "slot for list item subline text.",
30279
30279
  "name": "trailing-text-subline",
30280
30280
  "inheritedFrom": {
30281
30281
  "name": "ListItem",
@@ -30283,7 +30283,7 @@
30283
30283
  }
30284
30284
  },
30285
30285
  {
30286
- "description": "slot for menu item controls to appear of trailing end.",
30286
+ "description": "slot for list item controls to appear of trailing end.",
30287
30287
  "name": "trailing-controls",
30288
30288
  "inheritedFrom": {
30289
30289
  "name": "ListItem",
@@ -30306,8 +30306,8 @@
30306
30306
  "kind": "js",
30307
30307
  "name": "default",
30308
30308
  "declaration": {
30309
- "name": "NavMenuItem",
30310
- "module": "components/navmenuitem/navmenuitem.component.js"
30309
+ "name": "Option",
30310
+ "module": "components/option/option.component.js"
30311
30311
  }
30312
30312
  }
30313
30313
  ]