@momentum-design/components 0.123.5 → 0.124.0
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.
- package/dist/browser/index.js +406 -293
- package/dist/browser/index.js.map +3 -3
- package/dist/components/menubar/menubar.component.js +1 -1
- package/dist/components/menuitem/menuitem.styles.js +1 -1
- package/dist/components/menusection/menusection.component.d.ts +5 -0
- package/dist/components/menusection/menusection.component.js +5 -0
- package/dist/components/menusection/menusection.styles.js +10 -7
- package/dist/components/navmenuitem/navmenuitem.component.d.ts +74 -27
- package/dist/components/navmenuitem/navmenuitem.component.js +135 -87
- package/dist/components/navmenuitem/navmenuitem.constants.d.ts +1 -0
- package/dist/components/navmenuitem/navmenuitem.constants.js +1 -0
- package/dist/components/navmenuitem/navmenuitem.styles.js +64 -29
- package/dist/components/popover/popover.component.js +4 -2
- package/dist/components/sidenavigation/sidenavigation.component.d.ts +50 -6
- package/dist/components/sidenavigation/sidenavigation.component.js +132 -25
- package/dist/components/sidenavigation/sidenavigation.constants.d.ts +1 -0
- package/dist/components/sidenavigation/sidenavigation.constants.js +1 -0
- package/dist/components/sidenavigation/sidenavigation.context.d.ts +1 -2
- package/dist/components/sidenavigation/sidenavigation.context.js +8 -9
- package/dist/components/sidenavigation/sidenavigation.styles.js +76 -8
- package/dist/custom-elements.json +447 -237
- package/dist/react/index.d.ts +1 -1
- package/dist/react/index.js +1 -1
- package/dist/react/menusection/index.d.ts +5 -0
- package/dist/react/menusection/index.js +5 -0
- package/dist/react/navmenuitem/index.d.ts +9 -3
- package/dist/react/navmenuitem/index.js +9 -3
- package/dist/react/sidenavigation/index.d.ts +12 -2
- package/dist/react/sidenavigation/index.js +12 -2
- package/package.json +1 -1
|
@@ -513,6 +513,157 @@
|
|
|
513
513
|
}
|
|
514
514
|
]
|
|
515
515
|
},
|
|
516
|
+
{
|
|
517
|
+
"kind": "javascript-module",
|
|
518
|
+
"path": "components/accordiongroup/accordiongroup.component.js",
|
|
519
|
+
"declarations": [
|
|
520
|
+
{
|
|
521
|
+
"kind": "class",
|
|
522
|
+
"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.",
|
|
523
|
+
"name": "AccordionGroup",
|
|
524
|
+
"cssProperties": [
|
|
525
|
+
{
|
|
526
|
+
"description": "The border color of the entire accordiongroup",
|
|
527
|
+
"name": "--mdc-accordiongroup-border-color"
|
|
528
|
+
}
|
|
529
|
+
],
|
|
530
|
+
"slots": [
|
|
531
|
+
{
|
|
532
|
+
"description": "The default slot can contain the `accordion` or `accordionbutton` components.",
|
|
533
|
+
"name": "default"
|
|
534
|
+
}
|
|
535
|
+
],
|
|
536
|
+
"members": [
|
|
537
|
+
{
|
|
538
|
+
"kind": "field",
|
|
539
|
+
"name": "size",
|
|
540
|
+
"type": {
|
|
541
|
+
"text": "Size"
|
|
542
|
+
},
|
|
543
|
+
"description": "The size of the accordion item.",
|
|
544
|
+
"default": "'small'",
|
|
545
|
+
"attribute": "size",
|
|
546
|
+
"reflects": true
|
|
547
|
+
},
|
|
548
|
+
{
|
|
549
|
+
"kind": "field",
|
|
550
|
+
"name": "variant",
|
|
551
|
+
"type": {
|
|
552
|
+
"text": "Variant"
|
|
553
|
+
},
|
|
554
|
+
"description": "The variant of the accordion item. Based on the variant, the styling of the accordion gets changed.",
|
|
555
|
+
"default": "'stacked'",
|
|
556
|
+
"attribute": "variant",
|
|
557
|
+
"reflects": true
|
|
558
|
+
},
|
|
559
|
+
{
|
|
560
|
+
"kind": "field",
|
|
561
|
+
"name": "allowMultiple",
|
|
562
|
+
"type": {
|
|
563
|
+
"text": "boolean"
|
|
564
|
+
},
|
|
565
|
+
"default": "false",
|
|
566
|
+
"description": "If true, multiple accordion items can be visible at the same time.",
|
|
567
|
+
"attribute": "allow-multiple",
|
|
568
|
+
"reflects": true
|
|
569
|
+
},
|
|
570
|
+
{
|
|
571
|
+
"kind": "method",
|
|
572
|
+
"name": "handleAccordionExpanded",
|
|
573
|
+
"privacy": "private",
|
|
574
|
+
"return": {
|
|
575
|
+
"type": {
|
|
576
|
+
"text": "void"
|
|
577
|
+
}
|
|
578
|
+
},
|
|
579
|
+
"parameters": [
|
|
580
|
+
{
|
|
581
|
+
"name": "event",
|
|
582
|
+
"type": {
|
|
583
|
+
"text": "Event"
|
|
584
|
+
},
|
|
585
|
+
"description": "The event object from the 'shown' event."
|
|
586
|
+
}
|
|
587
|
+
],
|
|
588
|
+
"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."
|
|
589
|
+
},
|
|
590
|
+
{
|
|
591
|
+
"kind": "method",
|
|
592
|
+
"name": "setChildrenAccordionAttributes",
|
|
593
|
+
"privacy": "private",
|
|
594
|
+
"return": {
|
|
595
|
+
"type": {
|
|
596
|
+
"text": "void"
|
|
597
|
+
}
|
|
598
|
+
},
|
|
599
|
+
"parameters": [
|
|
600
|
+
{
|
|
601
|
+
"name": "attributeName",
|
|
602
|
+
"type": {
|
|
603
|
+
"text": "string"
|
|
604
|
+
},
|
|
605
|
+
"description": "The name of the attribute to set."
|
|
606
|
+
},
|
|
607
|
+
{
|
|
608
|
+
"name": "attributeValue",
|
|
609
|
+
"type": {
|
|
610
|
+
"text": "string"
|
|
611
|
+
},
|
|
612
|
+
"description": "The value to set the attribute to."
|
|
613
|
+
}
|
|
614
|
+
],
|
|
615
|
+
"description": "Sets the given attribute on all child accordion or accordionbutton components."
|
|
616
|
+
}
|
|
617
|
+
],
|
|
618
|
+
"attributes": [
|
|
619
|
+
{
|
|
620
|
+
"name": "size",
|
|
621
|
+
"type": {
|
|
622
|
+
"text": "Size"
|
|
623
|
+
},
|
|
624
|
+
"description": "The size of the accordion item.",
|
|
625
|
+
"default": "'small'",
|
|
626
|
+
"fieldName": "size"
|
|
627
|
+
},
|
|
628
|
+
{
|
|
629
|
+
"name": "variant",
|
|
630
|
+
"type": {
|
|
631
|
+
"text": "Variant"
|
|
632
|
+
},
|
|
633
|
+
"description": "The variant of the accordion item. Based on the variant, the styling of the accordion gets changed.",
|
|
634
|
+
"default": "'stacked'",
|
|
635
|
+
"fieldName": "variant"
|
|
636
|
+
},
|
|
637
|
+
{
|
|
638
|
+
"name": "allow-multiple",
|
|
639
|
+
"type": {
|
|
640
|
+
"text": "boolean"
|
|
641
|
+
},
|
|
642
|
+
"default": "false",
|
|
643
|
+
"description": "If true, multiple accordion items can be visible at the same time.",
|
|
644
|
+
"fieldName": "allowMultiple"
|
|
645
|
+
}
|
|
646
|
+
],
|
|
647
|
+
"superclass": {
|
|
648
|
+
"name": "Component",
|
|
649
|
+
"module": "/src/models"
|
|
650
|
+
},
|
|
651
|
+
"tagName": "mdc-accordiongroup",
|
|
652
|
+
"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 */",
|
|
653
|
+
"customElement": true
|
|
654
|
+
}
|
|
655
|
+
],
|
|
656
|
+
"exports": [
|
|
657
|
+
{
|
|
658
|
+
"kind": "js",
|
|
659
|
+
"name": "default",
|
|
660
|
+
"declaration": {
|
|
661
|
+
"name": "AccordionGroup",
|
|
662
|
+
"module": "components/accordiongroup/accordiongroup.component.js"
|
|
663
|
+
}
|
|
664
|
+
}
|
|
665
|
+
]
|
|
666
|
+
},
|
|
516
667
|
{
|
|
517
668
|
"kind": "javascript-module",
|
|
518
669
|
"path": "components/accordionbutton/accordionbutton.component.js",
|
|
@@ -853,157 +1004,6 @@
|
|
|
853
1004
|
}
|
|
854
1005
|
]
|
|
855
1006
|
},
|
|
856
|
-
{
|
|
857
|
-
"kind": "javascript-module",
|
|
858
|
-
"path": "components/accordiongroup/accordiongroup.component.js",
|
|
859
|
-
"declarations": [
|
|
860
|
-
{
|
|
861
|
-
"kind": "class",
|
|
862
|
-
"description": "An accordion group is a vertically stacked set of interactive headings that each contain a header and body content.\nEach heading of the accordion acts as a control that enable users to expand or hide their associated body sections of content.\nAccordions are commonly used to reduce the need to scroll when presenting multiple sections of content on a single page.\n\n- Default Slot: The accordion group component only accepts, `accordion` and `accordionbutton` components as the children, rest are ignored.\n\nThere are three types of variants:\n- Stacked - Each accordion will have a gap of 1.5rem (24px).\n- Borderless - Each accordion will not have any border and the group will also not have any border.\n- Contained - Each accordion will have no gap in between them and the border of the entire accordiongroup will be continuous.\n\nThere are two types of sizes:\n- Small: Small size has a padding of 1rem (16px) for both heading and body sections.\n- Large: Large size has a padding of 1.5rem (24px) for both heading and body sections.\n\nThe variant and size will be applied to all accordions inside this accordion group.\nTo show/expand more than one accordion at any given time, then set `allow-multiple` to `true`. By default, it's `false`.\n\nIf you don't need any controls on your accordion heading, then it's advised to use `accordionbutton` component.\n\nIf the first accordion of the accordion group is expanded by default, then the screen reader might loose focus when toggling the visibilty of the first accordion.",
|
|
863
|
-
"name": "AccordionGroup",
|
|
864
|
-
"cssProperties": [
|
|
865
|
-
{
|
|
866
|
-
"description": "The border color of the entire accordiongroup",
|
|
867
|
-
"name": "--mdc-accordiongroup-border-color"
|
|
868
|
-
}
|
|
869
|
-
],
|
|
870
|
-
"slots": [
|
|
871
|
-
{
|
|
872
|
-
"description": "The default slot can contain the `accordion` or `accordionbutton` components.",
|
|
873
|
-
"name": "default"
|
|
874
|
-
}
|
|
875
|
-
],
|
|
876
|
-
"members": [
|
|
877
|
-
{
|
|
878
|
-
"kind": "field",
|
|
879
|
-
"name": "size",
|
|
880
|
-
"type": {
|
|
881
|
-
"text": "Size"
|
|
882
|
-
},
|
|
883
|
-
"description": "The size of the accordion item.",
|
|
884
|
-
"default": "'small'",
|
|
885
|
-
"attribute": "size",
|
|
886
|
-
"reflects": true
|
|
887
|
-
},
|
|
888
|
-
{
|
|
889
|
-
"kind": "field",
|
|
890
|
-
"name": "variant",
|
|
891
|
-
"type": {
|
|
892
|
-
"text": "Variant"
|
|
893
|
-
},
|
|
894
|
-
"description": "The variant of the accordion item. Based on the variant, the styling of the accordion gets changed.",
|
|
895
|
-
"default": "'stacked'",
|
|
896
|
-
"attribute": "variant",
|
|
897
|
-
"reflects": true
|
|
898
|
-
},
|
|
899
|
-
{
|
|
900
|
-
"kind": "field",
|
|
901
|
-
"name": "allowMultiple",
|
|
902
|
-
"type": {
|
|
903
|
-
"text": "boolean"
|
|
904
|
-
},
|
|
905
|
-
"default": "false",
|
|
906
|
-
"description": "If true, multiple accordion items can be visible at the same time.",
|
|
907
|
-
"attribute": "allow-multiple",
|
|
908
|
-
"reflects": true
|
|
909
|
-
},
|
|
910
|
-
{
|
|
911
|
-
"kind": "method",
|
|
912
|
-
"name": "handleAccordionExpanded",
|
|
913
|
-
"privacy": "private",
|
|
914
|
-
"return": {
|
|
915
|
-
"type": {
|
|
916
|
-
"text": "void"
|
|
917
|
-
}
|
|
918
|
-
},
|
|
919
|
-
"parameters": [
|
|
920
|
-
{
|
|
921
|
-
"name": "event",
|
|
922
|
-
"type": {
|
|
923
|
-
"text": "Event"
|
|
924
|
-
},
|
|
925
|
-
"description": "The event object from the 'shown' event."
|
|
926
|
-
}
|
|
927
|
-
],
|
|
928
|
-
"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."
|
|
929
|
-
},
|
|
930
|
-
{
|
|
931
|
-
"kind": "method",
|
|
932
|
-
"name": "setChildrenAccordionAttributes",
|
|
933
|
-
"privacy": "private",
|
|
934
|
-
"return": {
|
|
935
|
-
"type": {
|
|
936
|
-
"text": "void"
|
|
937
|
-
}
|
|
938
|
-
},
|
|
939
|
-
"parameters": [
|
|
940
|
-
{
|
|
941
|
-
"name": "attributeName",
|
|
942
|
-
"type": {
|
|
943
|
-
"text": "string"
|
|
944
|
-
},
|
|
945
|
-
"description": "The name of the attribute to set."
|
|
946
|
-
},
|
|
947
|
-
{
|
|
948
|
-
"name": "attributeValue",
|
|
949
|
-
"type": {
|
|
950
|
-
"text": "string"
|
|
951
|
-
},
|
|
952
|
-
"description": "The value to set the attribute to."
|
|
953
|
-
}
|
|
954
|
-
],
|
|
955
|
-
"description": "Sets the given attribute on all child accordion or accordionbutton components."
|
|
956
|
-
}
|
|
957
|
-
],
|
|
958
|
-
"attributes": [
|
|
959
|
-
{
|
|
960
|
-
"name": "size",
|
|
961
|
-
"type": {
|
|
962
|
-
"text": "Size"
|
|
963
|
-
},
|
|
964
|
-
"description": "The size of the accordion item.",
|
|
965
|
-
"default": "'small'",
|
|
966
|
-
"fieldName": "size"
|
|
967
|
-
},
|
|
968
|
-
{
|
|
969
|
-
"name": "variant",
|
|
970
|
-
"type": {
|
|
971
|
-
"text": "Variant"
|
|
972
|
-
},
|
|
973
|
-
"description": "The variant of the accordion item. Based on the variant, the styling of the accordion gets changed.",
|
|
974
|
-
"default": "'stacked'",
|
|
975
|
-
"fieldName": "variant"
|
|
976
|
-
},
|
|
977
|
-
{
|
|
978
|
-
"name": "allow-multiple",
|
|
979
|
-
"type": {
|
|
980
|
-
"text": "boolean"
|
|
981
|
-
},
|
|
982
|
-
"default": "false",
|
|
983
|
-
"description": "If true, multiple accordion items can be visible at the same time.",
|
|
984
|
-
"fieldName": "allowMultiple"
|
|
985
|
-
}
|
|
986
|
-
],
|
|
987
|
-
"superclass": {
|
|
988
|
-
"name": "Component",
|
|
989
|
-
"module": "/src/models"
|
|
990
|
-
},
|
|
991
|
-
"tagName": "mdc-accordiongroup",
|
|
992
|
-
"jsDoc": "/**\n * An accordion group is a vertically stacked set of interactive headings that each contain a header and body content.\n * Each heading of the accordion acts as a control that enable users to expand or hide their associated body sections of content.\n * Accordions are commonly used to reduce the need to scroll when presenting multiple sections of content on a single page.\n *\n * - Default Slot: The accordion group component only accepts, `accordion` and `accordionbutton` components as the children, rest are ignored.\n *\n * There are three types of variants:\n * - Stacked - Each accordion will have a gap of 1.5rem (24px).\n * - Borderless - Each accordion will not have any border and the group will also not have any border.\n * - Contained - Each accordion will have no gap in between them and the border of the entire accordiongroup will be continuous.\n *\n * There are two types of sizes:\n * - Small: Small size has a padding of 1rem (16px) for both heading and body sections.\n * - Large: Large size has a padding of 1.5rem (24px) for both heading and body sections.\n *\n * The variant and size will be applied to all accordions inside this accordion group.\n * To show/expand more than one accordion at any given time, then set `allow-multiple` to `true`. By default, it's `false`.\n *\n * If you don't need any controls on your accordion heading, then it's advised to use `accordionbutton` component.\n *\n * If the first accordion of the accordion group is expanded by default, then the screen reader might loose focus when toggling the visibilty of the first accordion.\n *\n * @tagname mdc-accordiongroup\n *\n * @slot default - The default slot can contain the `accordion` or `accordionbutton` components.\n *\n * @cssproperty --mdc-accordiongroup-border-color - The border color of the entire accordiongroup\n */",
|
|
993
|
-
"customElement": true
|
|
994
|
-
}
|
|
995
|
-
],
|
|
996
|
-
"exports": [
|
|
997
|
-
{
|
|
998
|
-
"kind": "js",
|
|
999
|
-
"name": "default",
|
|
1000
|
-
"declaration": {
|
|
1001
|
-
"name": "AccordionGroup",
|
|
1002
|
-
"module": "components/accordiongroup/accordiongroup.component.js"
|
|
1003
|
-
}
|
|
1004
|
-
}
|
|
1005
|
-
]
|
|
1006
|
-
},
|
|
1007
1007
|
{
|
|
1008
1008
|
"kind": "javascript-module",
|
|
1009
1009
|
"path": "components/alertchip/alertchip.component.js",
|
|
@@ -29170,6 +29170,24 @@
|
|
|
29170
29170
|
"kind": "class",
|
|
29171
29171
|
"description": "`mdc-menusection` is a container element used to group a set of menu items.\n\nThis component supports a mix of `menuitem`, `menuitemcheckbox`, and `menuitemradio` components.\n\n- If multiple `menuitemradio` components are slotted into the section, the group enforces a single-selection rule:\n only one radio item can be selected at a time.\n- If `menuitemcheckbox` components are included, their checked state can be toggled independently.",
|
|
29172
29172
|
"name": "MenuSection",
|
|
29173
|
+
"cssProperties": [
|
|
29174
|
+
{
|
|
29175
|
+
"description": "Sets the margin block of the divider.",
|
|
29176
|
+
"name": "--mdc-menusection-divider-margin-block"
|
|
29177
|
+
},
|
|
29178
|
+
{
|
|
29179
|
+
"description": "Sets the gap between items in the menusection.",
|
|
29180
|
+
"name": "--mdc-menusection-gap"
|
|
29181
|
+
},
|
|
29182
|
+
{
|
|
29183
|
+
"description": "Sets the width of the divider.",
|
|
29184
|
+
"name": "--mdc-menusection-divider-width"
|
|
29185
|
+
},
|
|
29186
|
+
{
|
|
29187
|
+
"description": "Sets the padding of the header, if present.",
|
|
29188
|
+
"name": "--mdc-menusection-header-padding"
|
|
29189
|
+
}
|
|
29190
|
+
],
|
|
29173
29191
|
"cssParts": [
|
|
29174
29192
|
{
|
|
29175
29193
|
"description": "The header of the menusection.",
|
|
@@ -29311,7 +29329,7 @@
|
|
|
29311
29329
|
"module": "/src/models"
|
|
29312
29330
|
},
|
|
29313
29331
|
"tagName": "mdc-menusection",
|
|
29314
|
-
"jsDoc": "/**\n * `mdc-menusection` is a container element used to group a set of menu items.\n *\n * This component supports a mix of `menuitem`, `menuitemcheckbox`, and `menuitemradio` components.\n *\n * - If multiple `menuitemradio` components are slotted into the section, the group enforces a single-selection rule:\n * only one radio item can be selected at a time.\n * - If `menuitemcheckbox` components are included, their checked state can be toggled independently.\n *\n * @tagname mdc-menusection\n *\n * @slot - Default slot for inserting `menuitem`, `menuitemcheckbox`, or `menuitemradio`\n *\n * @event change - (React: onChange) This event is dispatched when a `menuitemcheckbox`, or `menuitemradio` changes.\n * @event action - (React: onAction) This event is dispatched when a `menuitem` selected.\n *\n * @csspart header - The header of the menusection.\n * @csspart align-header - The header of the menusection when it is aligned to the start.\n * @csspart container - The container of the menusection.\n * @csspart divider - The divider of the menusection.\n */",
|
|
29332
|
+
"jsDoc": "/**\n * `mdc-menusection` is a container element used to group a set of menu items.\n *\n * This component supports a mix of `menuitem`, `menuitemcheckbox`, and `menuitemradio` components.\n *\n * - If multiple `menuitemradio` components are slotted into the section, the group enforces a single-selection rule:\n * only one radio item can be selected at a time.\n * - If `menuitemcheckbox` components are included, their checked state can be toggled independently.\n *\n * @tagname mdc-menusection\n *\n * @slot - Default slot for inserting `menuitem`, `menuitemcheckbox`, or `menuitemradio`\n *\n * @event change - (React: onChange) This event is dispatched when a `menuitemcheckbox`, or `menuitemradio` changes.\n * @event action - (React: onAction) This event is dispatched when a `menuitem` selected.\n *\n * @csspart header - The header of the menusection.\n * @csspart align-header - The header of the menusection when it is aligned to the start.\n * @csspart container - The container of the menusection.\n * @csspart divider - The divider of the menusection.\n *\n * @cssproperty --mdc-menusection-divider-margin-block - Sets the margin block of the divider.\n * @cssproperty --mdc-menusection-gap - Sets the gap between items in the menusection.\n * @cssproperty --mdc-menusection-divider-width - Sets the width of the divider.\n * @cssproperty --mdc-menusection-header-padding - Sets the padding of the header, if present.\n */",
|
|
29315
29333
|
"customElement": true
|
|
29316
29334
|
}
|
|
29317
29335
|
],
|
|
@@ -29332,24 +29350,44 @@
|
|
|
29332
29350
|
"declarations": [
|
|
29333
29351
|
{
|
|
29334
29352
|
"kind": "class",
|
|
29335
|
-
"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.",
|
|
29353
|
+
"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\nThe navmenuitem can be in an active or inactive state, indicating whether it is currently selected.\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.",
|
|
29336
29354
|
"name": "NavMenuItem",
|
|
29337
29355
|
"cssProperties": [
|
|
29338
29356
|
{
|
|
29339
|
-
"description": "
|
|
29340
|
-
"name": "--mdc-navmenuitem-
|
|
29357
|
+
"description": "Width of the navmenuitem when expanded.",
|
|
29358
|
+
"name": "--mdc-navmenuitem-in-sidenav-expanded-width"
|
|
29359
|
+
},
|
|
29360
|
+
{
|
|
29361
|
+
"description": "Left margin of the navmenuitem, when expanded.",
|
|
29362
|
+
"name": "--mdc-navmenuitem-in-sidenav-expanded-margin-left"
|
|
29341
29363
|
},
|
|
29342
29364
|
{
|
|
29343
|
-
"description": "
|
|
29344
|
-
"name": "--mdc-navmenuitem-
|
|
29365
|
+
"description": "Right margin of the navmenuitem, when expanded.",
|
|
29366
|
+
"name": "--mdc-navmenuitem-in-sidenav-expanded-margin-right"
|
|
29367
|
+
},
|
|
29368
|
+
{
|
|
29369
|
+
"description": "Width of the navmenuitem when collapsed.",
|
|
29370
|
+
"name": "--mdc-navmenuitem-in-sidenav-collapsed-width"
|
|
29371
|
+
},
|
|
29372
|
+
{
|
|
29373
|
+
"description": "Left margin of the navmenuitem, when collapsed.",
|
|
29374
|
+
"name": "--mdc-navmenuitem-in-sidenav-collapsed-margin-left"
|
|
29375
|
+
},
|
|
29376
|
+
{
|
|
29377
|
+
"description": "Right margin of the navmenuitem, when collapsed.",
|
|
29378
|
+
"name": "--mdc-navmenuitem-in-sidenav-collapsed-margin-right"
|
|
29379
|
+
},
|
|
29380
|
+
{
|
|
29381
|
+
"description": "Text color of the navmenuitem in its normal state.",
|
|
29382
|
+
"name": "--mdc-navmenuitem-color"
|
|
29345
29383
|
},
|
|
29346
29384
|
{
|
|
29347
29385
|
"description": "Text color of the navmenuitem when disabled.",
|
|
29348
29386
|
"name": "--mdc-navmenuitem-disabled-color"
|
|
29349
29387
|
},
|
|
29350
29388
|
{
|
|
29351
|
-
"description": "
|
|
29352
|
-
"name": "--mdc-navmenuitem-
|
|
29389
|
+
"description": "Background color of the active nav item in its rest state.",
|
|
29390
|
+
"name": "--mdc-navmenuitem-rest-active-background-color"
|
|
29353
29391
|
},
|
|
29354
29392
|
{
|
|
29355
29393
|
"description": "Background color of the navmenuitem when hovered.",
|
|
@@ -29375,10 +29413,6 @@
|
|
|
29375
29413
|
"description": "Background color of the active navmenuitem when disabled.",
|
|
29376
29414
|
"name": "--mdc-navmenuitem-disabled-active-background-color"
|
|
29377
29415
|
},
|
|
29378
|
-
{
|
|
29379
|
-
"description": "Background color of the active nav item in its rest state.",
|
|
29380
|
-
"name": "--mdc-navmenuitem-rest-active-background-color"
|
|
29381
|
-
},
|
|
29382
29416
|
{
|
|
29383
29417
|
"description": "Allows customization of the default background color.",
|
|
29384
29418
|
"name": "--mdc-listitem-default-background-color",
|
|
@@ -29549,7 +29583,7 @@
|
|
|
29549
29583
|
"type": {
|
|
29550
29584
|
"text": "boolean | undefined"
|
|
29551
29585
|
},
|
|
29552
|
-
"description": "The navmenuitem's active state indicates whether it is currently toggled on (active) or off (inactive).\
|
|
29586
|
+
"description": "The navmenuitem's active state indicates whether it is currently toggled on (active) or off (inactive).\nIf cannotActivate is set to true, the surrounding SideNavigation will\nnot set this property when the navmenuitem is clicked.",
|
|
29553
29587
|
"default": "undefined",
|
|
29554
29588
|
"attribute": "active",
|
|
29555
29589
|
"reflects": true,
|
|
@@ -29558,6 +29592,27 @@
|
|
|
29558
29592
|
"module": "components/listitem/listitem.component.js"
|
|
29559
29593
|
}
|
|
29560
29594
|
},
|
|
29595
|
+
{
|
|
29596
|
+
"kind": "field",
|
|
29597
|
+
"name": "cannotActivate",
|
|
29598
|
+
"type": {
|
|
29599
|
+
"text": "boolean | undefined"
|
|
29600
|
+
},
|
|
29601
|
+
"description": "When set to true, prevents the navmenuitem from being activated.\nThis is useful for cases where the navmenuitem is used as a button\nor link, where not the content on the current page is changing.\nBy default this is set to false, making the navmenuitem activatable (= aria-current gets set when active).",
|
|
29602
|
+
"default": "false",
|
|
29603
|
+
"attribute": "cannot-activate",
|
|
29604
|
+
"reflects": true
|
|
29605
|
+
},
|
|
29606
|
+
{
|
|
29607
|
+
"kind": "field",
|
|
29608
|
+
"name": "iconName",
|
|
29609
|
+
"type": {
|
|
29610
|
+
"text": "IconNames | undefined"
|
|
29611
|
+
},
|
|
29612
|
+
"description": "Name of the leading icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
|
29613
|
+
"attribute": "icon-name",
|
|
29614
|
+
"reflects": true
|
|
29615
|
+
},
|
|
29561
29616
|
{
|
|
29562
29617
|
"kind": "field",
|
|
29563
29618
|
"name": "badgeType",
|
|
@@ -29600,6 +29655,17 @@
|
|
|
29600
29655
|
"attribute": "nav-id",
|
|
29601
29656
|
"reflects": true
|
|
29602
29657
|
},
|
|
29658
|
+
{
|
|
29659
|
+
"kind": "field",
|
|
29660
|
+
"name": "showLabel",
|
|
29661
|
+
"type": {
|
|
29662
|
+
"text": "boolean | undefined"
|
|
29663
|
+
},
|
|
29664
|
+
"description": "Determines whether the nav item is expanded or not.\n\nIf used in SideNavigation, this property is automatically managed by the SideNavigation component.",
|
|
29665
|
+
"default": "undefined",
|
|
29666
|
+
"attribute": "show-label",
|
|
29667
|
+
"reflects": true
|
|
29668
|
+
},
|
|
29603
29669
|
{
|
|
29604
29670
|
"kind": "field",
|
|
29605
29671
|
"name": "ariaLabel",
|
|
@@ -29616,7 +29682,8 @@
|
|
|
29616
29682
|
"type": {
|
|
29617
29683
|
"text": "boolean | undefined"
|
|
29618
29684
|
},
|
|
29619
|
-
"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.",
|
|
29685
|
+
"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.\n\nIf you also want to prevent activation, use the `cannot-activate` property instead.",
|
|
29686
|
+
"default": "undefined",
|
|
29620
29687
|
"attribute": "disable-aria-current",
|
|
29621
29688
|
"reflects": true
|
|
29622
29689
|
},
|
|
@@ -29626,14 +29693,52 @@
|
|
|
29626
29693
|
"type": {
|
|
29627
29694
|
"text": "string | undefined"
|
|
29628
29695
|
},
|
|
29629
|
-
"description": "The tooltip text is displayed on hover of the
|
|
29696
|
+
"description": "The tooltip text is displayed on hover of the nav item.\nWill only be shown when the `show-label` property is false\n(i.e., when the nav item is collapsed).",
|
|
29630
29697
|
"attribute": "tooltip-text",
|
|
29631
29698
|
"reflects": true
|
|
29632
29699
|
},
|
|
29633
29700
|
{
|
|
29634
|
-
"kind": "
|
|
29635
|
-
"name": "
|
|
29636
|
-
"
|
|
29701
|
+
"kind": "field",
|
|
29702
|
+
"name": "tooltipPlacement",
|
|
29703
|
+
"type": {
|
|
29704
|
+
"text": "PopoverPlacement"
|
|
29705
|
+
},
|
|
29706
|
+
"default": "'right'",
|
|
29707
|
+
"description": "The placement of the tooltip relative to the nav item.",
|
|
29708
|
+
"attribute": "tooltip-placement",
|
|
29709
|
+
"reflects": true
|
|
29710
|
+
},
|
|
29711
|
+
{
|
|
29712
|
+
"kind": "field",
|
|
29713
|
+
"name": "tooltipAppearance",
|
|
29714
|
+
"type": {
|
|
29715
|
+
"text": "'when-collapsed' | 'always'"
|
|
29716
|
+
},
|
|
29717
|
+
"default": "'when-collapsed'",
|
|
29718
|
+
"description": "The appearance behavior of the tooltip.\nOptions are 'when-collapsed' (default) or 'always'.",
|
|
29719
|
+
"attribute": "tooltip-appearance",
|
|
29720
|
+
"reflects": true
|
|
29721
|
+
},
|
|
29722
|
+
{
|
|
29723
|
+
"kind": "field",
|
|
29724
|
+
"name": "tooltipBoundaryPadding",
|
|
29725
|
+
"type": {
|
|
29726
|
+
"text": "number | undefined"
|
|
29727
|
+
},
|
|
29728
|
+
"description": "The boundary padding for the tooltip.\nThis defines the minimum distance in pixels between the tooltip and the edges of the viewport.",
|
|
29729
|
+
"default": "0",
|
|
29730
|
+
"attribute": "tooltip-boundary-padding",
|
|
29731
|
+
"reflects": true
|
|
29732
|
+
},
|
|
29733
|
+
{
|
|
29734
|
+
"kind": "field",
|
|
29735
|
+
"name": "isActiveParentTooltipText",
|
|
29736
|
+
"type": {
|
|
29737
|
+
"text": "string | undefined"
|
|
29738
|
+
},
|
|
29739
|
+
"description": "Tooltip text shown when this parent NavItem has a active child navitem.\nThis is useful for nested navmenuitems within a sidenavigation.\n\nMake sure to include what was normally used as the `tooltip-text` in this property.\ni.e. `Messaging, contains active navmenuitem`",
|
|
29740
|
+
"attribute": "is-active-parent-tooltip-text",
|
|
29741
|
+
"reflects": true
|
|
29637
29742
|
},
|
|
29638
29743
|
{
|
|
29639
29744
|
"kind": "method",
|
|
@@ -29645,6 +29750,11 @@
|
|
|
29645
29750
|
}
|
|
29646
29751
|
}
|
|
29647
29752
|
},
|
|
29753
|
+
{
|
|
29754
|
+
"kind": "method",
|
|
29755
|
+
"name": "removeTooltip",
|
|
29756
|
+
"privacy": "private"
|
|
29757
|
+
},
|
|
29648
29758
|
{
|
|
29649
29759
|
"kind": "method",
|
|
29650
29760
|
"name": "isNested",
|
|
@@ -29668,34 +29778,23 @@
|
|
|
29668
29778
|
},
|
|
29669
29779
|
{
|
|
29670
29780
|
"kind": "method",
|
|
29671
|
-
"name": "
|
|
29781
|
+
"name": "getFilledIconName",
|
|
29672
29782
|
"privacy": "private",
|
|
29673
|
-
"
|
|
29674
|
-
{
|
|
29675
|
-
"
|
|
29676
|
-
"type": {
|
|
29677
|
-
"text": "string | undefined"
|
|
29678
|
-
}
|
|
29679
|
-
}
|
|
29680
|
-
]
|
|
29681
|
-
},
|
|
29682
|
-
{
|
|
29683
|
-
"kind": "method",
|
|
29684
|
-
"name": "renderArrowIcon",
|
|
29685
|
-
"privacy": "private",
|
|
29686
|
-
"parameters": [
|
|
29687
|
-
{
|
|
29688
|
-
"name": "showLabel",
|
|
29689
|
-
"type": {
|
|
29690
|
-
"text": "boolean | undefined"
|
|
29691
|
-
}
|
|
29783
|
+
"return": {
|
|
29784
|
+
"type": {
|
|
29785
|
+
"text": "IconNames | undefined"
|
|
29692
29786
|
}
|
|
29693
|
-
|
|
29787
|
+
}
|
|
29694
29788
|
},
|
|
29695
29789
|
{
|
|
29696
29790
|
"kind": "method",
|
|
29697
29791
|
"name": "renderBadge",
|
|
29698
29792
|
"privacy": "private",
|
|
29793
|
+
"return": {
|
|
29794
|
+
"type": {
|
|
29795
|
+
"text": "TemplateResult | typeof nothing"
|
|
29796
|
+
}
|
|
29797
|
+
},
|
|
29699
29798
|
"parameters": [
|
|
29700
29799
|
{
|
|
29701
29800
|
"name": "showLabel",
|
|
@@ -29705,19 +29804,6 @@
|
|
|
29705
29804
|
}
|
|
29706
29805
|
]
|
|
29707
29806
|
},
|
|
29708
|
-
{
|
|
29709
|
-
"kind": "field",
|
|
29710
|
-
"name": "iconName",
|
|
29711
|
-
"type": {
|
|
29712
|
-
"text": "IconNames | undefined"
|
|
29713
|
-
},
|
|
29714
|
-
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
|
29715
|
-
"attribute": "icon-name",
|
|
29716
|
-
"inheritedFrom": {
|
|
29717
|
-
"name": "IconNameMixin",
|
|
29718
|
-
"module": "utils/mixins/IconNameMixin.js"
|
|
29719
|
-
}
|
|
29720
|
-
},
|
|
29721
29807
|
{
|
|
29722
29808
|
"kind": "field",
|
|
29723
29809
|
"name": "arrowPosition",
|
|
@@ -30219,7 +30305,7 @@
|
|
|
30219
30305
|
"type": {
|
|
30220
30306
|
"text": "boolean | undefined"
|
|
30221
30307
|
},
|
|
30222
|
-
"description": "The navmenuitem's active state indicates whether it is currently toggled on (active) or off (inactive).\
|
|
30308
|
+
"description": "The navmenuitem's active state indicates whether it is currently toggled on (active) or off (inactive).\nIf cannotActivate is set to true, the surrounding SideNavigation will\nnot set this property when the navmenuitem is clicked.",
|
|
30223
30309
|
"default": "undefined",
|
|
30224
30310
|
"fieldName": "active",
|
|
30225
30311
|
"inheritedFrom": {
|
|
@@ -30227,6 +30313,23 @@
|
|
|
30227
30313
|
"module": "src/components/listitem/listitem.component.ts"
|
|
30228
30314
|
}
|
|
30229
30315
|
},
|
|
30316
|
+
{
|
|
30317
|
+
"name": "cannot-activate",
|
|
30318
|
+
"type": {
|
|
30319
|
+
"text": "boolean | undefined"
|
|
30320
|
+
},
|
|
30321
|
+
"description": "When set to true, prevents the navmenuitem from being activated.\nThis is useful for cases where the navmenuitem is used as a button\nor link, where not the content on the current page is changing.\nBy default this is set to false, making the navmenuitem activatable (= aria-current gets set when active).",
|
|
30322
|
+
"default": "false",
|
|
30323
|
+
"fieldName": "cannotActivate"
|
|
30324
|
+
},
|
|
30325
|
+
{
|
|
30326
|
+
"name": "icon-name",
|
|
30327
|
+
"type": {
|
|
30328
|
+
"text": "IconNames | undefined"
|
|
30329
|
+
},
|
|
30330
|
+
"description": "Name of the leading icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
|
30331
|
+
"fieldName": "iconName"
|
|
30332
|
+
},
|
|
30230
30333
|
{
|
|
30231
30334
|
"name": "badge-type",
|
|
30232
30335
|
"type": {
|
|
@@ -30261,6 +30364,15 @@
|
|
|
30261
30364
|
"default": "undefined",
|
|
30262
30365
|
"fieldName": "navId"
|
|
30263
30366
|
},
|
|
30367
|
+
{
|
|
30368
|
+
"name": "show-label",
|
|
30369
|
+
"type": {
|
|
30370
|
+
"text": "boolean | undefined"
|
|
30371
|
+
},
|
|
30372
|
+
"description": "Determines whether the nav item is expanded or not.\n\nIf used in SideNavigation, this property is automatically managed by the SideNavigation component.",
|
|
30373
|
+
"default": "undefined",
|
|
30374
|
+
"fieldName": "showLabel"
|
|
30375
|
+
},
|
|
30264
30376
|
{
|
|
30265
30377
|
"name": "aria-label",
|
|
30266
30378
|
"type": {
|
|
@@ -30275,7 +30387,8 @@
|
|
|
30275
30387
|
"type": {
|
|
30276
30388
|
"text": "boolean | undefined"
|
|
30277
30389
|
},
|
|
30278
|
-
"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.",
|
|
30390
|
+
"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.\n\nIf you also want to prevent activation, use the `cannot-activate` property instead.",
|
|
30391
|
+
"default": "undefined",
|
|
30279
30392
|
"fieldName": "disableAriaCurrent"
|
|
30280
30393
|
},
|
|
30281
30394
|
{
|
|
@@ -30283,20 +30396,43 @@
|
|
|
30283
30396
|
"type": {
|
|
30284
30397
|
"text": "string | undefined"
|
|
30285
30398
|
},
|
|
30286
|
-
"description": "The tooltip text is displayed on hover of the
|
|
30399
|
+
"description": "The tooltip text is displayed on hover of the nav item.\nWill only be shown when the `show-label` property is false\n(i.e., when the nav item is collapsed).",
|
|
30287
30400
|
"fieldName": "tooltipText"
|
|
30288
30401
|
},
|
|
30289
30402
|
{
|
|
30290
|
-
"name": "
|
|
30403
|
+
"name": "tooltip-placement",
|
|
30291
30404
|
"type": {
|
|
30292
|
-
"text": "
|
|
30405
|
+
"text": "PopoverPlacement"
|
|
30293
30406
|
},
|
|
30294
|
-
"
|
|
30295
|
-
"
|
|
30296
|
-
"
|
|
30297
|
-
|
|
30298
|
-
|
|
30299
|
-
|
|
30407
|
+
"default": "'right'",
|
|
30408
|
+
"description": "The placement of the tooltip relative to the nav item.",
|
|
30409
|
+
"fieldName": "tooltipPlacement"
|
|
30410
|
+
},
|
|
30411
|
+
{
|
|
30412
|
+
"name": "tooltip-appearance",
|
|
30413
|
+
"type": {
|
|
30414
|
+
"text": "'when-collapsed' | 'always'"
|
|
30415
|
+
},
|
|
30416
|
+
"default": "'when-collapsed'",
|
|
30417
|
+
"description": "The appearance behavior of the tooltip.\nOptions are 'when-collapsed' (default) or 'always'.",
|
|
30418
|
+
"fieldName": "tooltipAppearance"
|
|
30419
|
+
},
|
|
30420
|
+
{
|
|
30421
|
+
"name": "tooltip-boundary-padding",
|
|
30422
|
+
"type": {
|
|
30423
|
+
"text": "number | undefined"
|
|
30424
|
+
},
|
|
30425
|
+
"description": "The boundary padding for the tooltip.\nThis defines the minimum distance in pixels between the tooltip and the edges of the viewport.",
|
|
30426
|
+
"default": "0",
|
|
30427
|
+
"fieldName": "tooltipBoundaryPadding"
|
|
30428
|
+
},
|
|
30429
|
+
{
|
|
30430
|
+
"name": "is-active-parent-tooltip-text",
|
|
30431
|
+
"type": {
|
|
30432
|
+
"text": "string | undefined"
|
|
30433
|
+
},
|
|
30434
|
+
"description": "Tooltip text shown when this parent NavItem has a active child navitem.\nThis is useful for nested navmenuitems within a sidenavigation.\n\nMake sure to include what was normally used as the `tooltip-text` in this property.\ni.e. `Messaging, contains active navmenuitem`",
|
|
30435
|
+
"fieldName": "isActiveParentTooltipText"
|
|
30300
30436
|
},
|
|
30301
30437
|
{
|
|
30302
30438
|
"name": "arrow-position",
|
|
@@ -30472,18 +30608,12 @@
|
|
|
30472
30608
|
}
|
|
30473
30609
|
}
|
|
30474
30610
|
],
|
|
30475
|
-
"mixins": [
|
|
30476
|
-
{
|
|
30477
|
-
"name": "IconNameMixin",
|
|
30478
|
-
"module": "/src/utils/mixins/IconNameMixin"
|
|
30479
|
-
}
|
|
30480
|
-
],
|
|
30481
30611
|
"superclass": {
|
|
30482
30612
|
"name": "MenuItem",
|
|
30483
30613
|
"module": "/src/components/menuitem/menuitem.component"
|
|
30484
30614
|
},
|
|
30485
30615
|
"tagName": "mdc-navmenuitem",
|
|
30486
|
-
"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-
|
|
30616
|
+
"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 * The navmenuitem can be in an active or inactive state, indicating whether it is currently selected.\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-in-sidenav-expanded-width - Width of the navmenuitem when expanded.\n * @cssproperty --mdc-navmenuitem-in-sidenav-expanded-margin-left - Left margin of the navmenuitem, when expanded.\n * @cssproperty --mdc-navmenuitem-in-sidenav-expanded-margin-right - Right margin of the navmenuitem, when expanded.\n * @cssproperty --mdc-navmenuitem-in-sidenav-collapsed-width - Width of the navmenuitem when collapsed.\n * @cssproperty --mdc-navmenuitem-in-sidenav-collapsed-margin-left - Left margin of the navmenuitem, when collapsed.\n * @cssproperty --mdc-navmenuitem-in-sidenav-collapsed-margin-right - Right margin of the navmenuitem, when collapsed.\n * @cssproperty --mdc-navmenuitem-color - Text 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-rest-active-background-color - Background color of the active nav item in its rest state.\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 *\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 */",
|
|
30487
30617
|
"customElement": true,
|
|
30488
30618
|
"slots": [
|
|
30489
30619
|
{
|
|
@@ -42859,17 +42989,41 @@
|
|
|
42859
42989
|
"declarations": [
|
|
42860
42990
|
{
|
|
42861
42991
|
"kind": "class",
|
|
42862
|
-
"description": "The `mdc-sidenavigation` component provides a vertically stacked navigation experience,\ntypically used in layouts with persistent or collapsible sidebars.\n\n## Features:\n- Supports
|
|
42992
|
+
"description": "The `mdc-sidenavigation` component provides a vertically stacked navigation experience,\ntypically used in layouts with persistent or collapsible sidebars.\n\n## Features:\n- Supports five layout variants: `fixed-collapsed`, `fixed-expanded`, `flexible`, `flexible-on-hover`, and `hidden`\n- Toggleable expand/collapse behavior\n- Displays brand logo and customer name\n- Serves as a context provider for descendant components - `mdc-menubar` and `mdc-navmenuitem`\n\n### Usage:\nIn a sidenavigation, navmenuitems can be used in the following ways:\n\n1. **Simple navmenuitem** – No submenu or interaction beyond selection.\n\n2. **NavMenuItem with submenu**:\n - Provide an `id` on the `mdc-navmenuitem`\n - Set the `triggerId` on the corresponding `mdc-menupopover` to match the navmenuitem's `id`\n - Set `parent-nav-tooltip-text` with appropriate text that will display when a child menu item\n inside the nested menupopover is active, conveying which submenu item is currently selected\n\n3. **Actionable navmenuitem (no submenu)**:\n - Performs an action such as navigation or alert trigger\n - Set `disable-aria-current=\"true\"` to maintain visual active state without navigation behavior\n\n### Recommendations:\n- Use `mdc-text` for section headers\n- Use `mdc-divider` with the attribute `variant=\"gradient\"` for section dividers\n- For the brand logo, use an informative icon. Refer to `Momentum Informative Icons`\n\n#### Accessibility Notes:\n- Always provide meaningful `aria-label` attributes for both `mdc-navmenuitem` and `mdc-menubar`\nto ensure screen reader support\n- Set `grabber-btn-aria-label` to provide accessible labels for the expand/collapse grabber button",
|
|
42863
42993
|
"name": "SideNavigation",
|
|
42864
42994
|
"cssProperties": [
|
|
42865
42995
|
{
|
|
42866
42996
|
"description": "width of the sideNavigation when expanded",
|
|
42867
42997
|
"name": "--mdc-sidenavigation-expanded-width"
|
|
42868
42998
|
},
|
|
42999
|
+
{
|
|
43000
|
+
"description": "padding for the left side of navmenuitems, when expanded",
|
|
43001
|
+
"name": "--mdc-sidenavigation-expanded-left-padding"
|
|
43002
|
+
},
|
|
43003
|
+
{
|
|
43004
|
+
"description": "padding for the right side of navmenuitems, when expanded",
|
|
43005
|
+
"name": "--mdc-sidenavigation-expanded-right-padding"
|
|
43006
|
+
},
|
|
42869
43007
|
{
|
|
42870
43008
|
"description": "width of the sideNavigation when collapsed",
|
|
42871
43009
|
"name": "--mdc-sidenavigation-collapsed-width"
|
|
42872
43010
|
},
|
|
43011
|
+
{
|
|
43012
|
+
"description": "padding for the left side of navmenuitems, when collapsed",
|
|
43013
|
+
"name": "--mdc-sidenavigation-collapsed-left-padding"
|
|
43014
|
+
},
|
|
43015
|
+
{
|
|
43016
|
+
"description": "padding for the right side of navmenuitems, when collapsed",
|
|
43017
|
+
"name": "--mdc-sidenavigation-collapsed-right-padding"
|
|
43018
|
+
},
|
|
43019
|
+
{
|
|
43020
|
+
"description": "padding for the top of the scrollable section - note: if setting to 0 focus ring might be cut off",
|
|
43021
|
+
"name": "--mdc-sidenavigation-top-padding"
|
|
43022
|
+
},
|
|
43023
|
+
{
|
|
43024
|
+
"description": "padding for the bottom of the scrollable section",
|
|
43025
|
+
"name": "--mdc-sidenavigation-bottom-padding"
|
|
43026
|
+
},
|
|
42873
43027
|
{
|
|
42874
43028
|
"description": "z-index of the vertical divider button",
|
|
42875
43029
|
"name": "--mdc-sidenavigation-vertical-divider-button-z-index"
|
|
@@ -42885,13 +43039,21 @@
|
|
|
42885
43039
|
"name": "scrollable-section"
|
|
42886
43040
|
},
|
|
42887
43041
|
{
|
|
42888
|
-
"description": "The
|
|
42889
|
-
"name": "
|
|
43042
|
+
"description": "The menubar inside the scrollable section.",
|
|
43043
|
+
"name": "scrollable-menubar"
|
|
42890
43044
|
},
|
|
42891
43045
|
{
|
|
42892
43046
|
"description": "The divider between the scrollable and fixed sections.",
|
|
42893
43047
|
"name": "separator"
|
|
42894
43048
|
},
|
|
43049
|
+
{
|
|
43050
|
+
"description": "The fixed section of the side navigation.",
|
|
43051
|
+
"name": "fixed-section"
|
|
43052
|
+
},
|
|
43053
|
+
{
|
|
43054
|
+
"description": "The menubar inside the fixed section.",
|
|
43055
|
+
"name": "fixed-menubar"
|
|
43056
|
+
},
|
|
42895
43057
|
{
|
|
42896
43058
|
"description": "The container wrapping the brand logo and footer text.",
|
|
42897
43059
|
"name": "brand-logo-container"
|
|
@@ -42914,10 +43076,18 @@
|
|
|
42914
43076
|
"description": "Slot for the scrollable content area of the side navigation.",
|
|
42915
43077
|
"name": "scrollable-section"
|
|
42916
43078
|
},
|
|
43079
|
+
{
|
|
43080
|
+
"description": "Slot for the menubar inside the scrollable section.",
|
|
43081
|
+
"name": "scrollable-menubar"
|
|
43082
|
+
},
|
|
42917
43083
|
{
|
|
42918
43084
|
"description": "Slot for the fixed content area of the side navigation.",
|
|
42919
43085
|
"name": "fixed-section"
|
|
42920
43086
|
},
|
|
43087
|
+
{
|
|
43088
|
+
"description": "Slot for the menubar inside the fixed section.",
|
|
43089
|
+
"name": "fixed-menubar"
|
|
43090
|
+
},
|
|
42921
43091
|
{
|
|
42922
43092
|
"description": "Slot for the brand logo (e.g., icon or img).",
|
|
42923
43093
|
"name": "brand-logo"
|
|
@@ -42930,7 +43100,7 @@
|
|
|
42930
43100
|
"type": {
|
|
42931
43101
|
"text": "SideNavigationVariant"
|
|
42932
43102
|
},
|
|
42933
|
-
"description": "
|
|
43103
|
+
"description": "Five variants of the sideNavigation\n- **fixed-collapsed**: Shows icons without labels and has fixed width, 4.5rem.\n- **fixed-expanded**: Shows icons with labels and has fixed width, 15rem.\n- **flexible**: Toggles between collapsed/expanded states.\n- **flexible-on-hover**: Similar to flexible, but the grabber button is only visible on hover or focus.\n- **hidden**: Removes the sidenavigation from the DOM.",
|
|
42934
43104
|
"default": "flexible",
|
|
42935
43105
|
"attribute": "variant",
|
|
42936
43106
|
"reflects": true
|
|
@@ -42942,10 +43112,21 @@
|
|
|
42942
43112
|
"text": "string"
|
|
42943
43113
|
},
|
|
42944
43114
|
"default": "''",
|
|
42945
|
-
"description": "Displays footer text in the bottom section of the sidenavigation.",
|
|
43115
|
+
"description": "Displays footer text in the bottom section of the sidenavigation.\n\nNote: if footerText is not provided, the bottom brand logo section will not be rendered.",
|
|
42946
43116
|
"attribute": "footer-text",
|
|
42947
43117
|
"reflects": true
|
|
42948
43118
|
},
|
|
43119
|
+
{
|
|
43120
|
+
"kind": "field",
|
|
43121
|
+
"name": "expanded",
|
|
43122
|
+
"type": {
|
|
43123
|
+
"text": "boolean | undefined"
|
|
43124
|
+
},
|
|
43125
|
+
"description": "Determines whether the sideNavigation is expanded or not.\n\nNOTE: For `fixed-collapsed` and `fixed-expanded` variants, this property is hard set to `false` and `true` respectively.\nFor `flexible` and `flexible-on-hover` variants, this property can be toggled / controlled from parent.",
|
|
43126
|
+
"default": "true",
|
|
43127
|
+
"attribute": "expanded",
|
|
43128
|
+
"reflects": true
|
|
43129
|
+
},
|
|
42949
43130
|
{
|
|
42950
43131
|
"kind": "field",
|
|
42951
43132
|
"name": "grabberBtnAriaLabel",
|
|
@@ -42959,14 +43140,33 @@
|
|
|
42959
43140
|
},
|
|
42960
43141
|
{
|
|
42961
43142
|
"kind": "field",
|
|
42962
|
-
"name": "
|
|
43143
|
+
"name": "hideFixedSectionDivider",
|
|
42963
43144
|
"type": {
|
|
42964
|
-
"text": "
|
|
43145
|
+
"text": "boolean"
|
|
42965
43146
|
},
|
|
42966
|
-
"
|
|
42967
|
-
"
|
|
43147
|
+
"default": "false",
|
|
43148
|
+
"description": "Hides the divider between the scrollable and fixed sections when set to true.",
|
|
43149
|
+
"attribute": "hide-fixed-section-divider",
|
|
42968
43150
|
"reflects": true
|
|
42969
43151
|
},
|
|
43152
|
+
{
|
|
43153
|
+
"kind": "field",
|
|
43154
|
+
"name": "isHovered",
|
|
43155
|
+
"type": {
|
|
43156
|
+
"text": "boolean"
|
|
43157
|
+
},
|
|
43158
|
+
"privacy": "private",
|
|
43159
|
+
"default": "false"
|
|
43160
|
+
},
|
|
43161
|
+
{
|
|
43162
|
+
"kind": "field",
|
|
43163
|
+
"name": "isFocused",
|
|
43164
|
+
"type": {
|
|
43165
|
+
"text": "boolean"
|
|
43166
|
+
},
|
|
43167
|
+
"privacy": "private",
|
|
43168
|
+
"default": "false"
|
|
43169
|
+
},
|
|
42970
43170
|
{
|
|
42971
43171
|
"kind": "field",
|
|
42972
43172
|
"name": "Context",
|
|
@@ -43025,7 +43225,7 @@
|
|
|
43025
43225
|
"type": {
|
|
43026
43226
|
"text": "SideNavigationVariant"
|
|
43027
43227
|
},
|
|
43028
|
-
"description": "
|
|
43228
|
+
"description": "Five variants of the sideNavigation\n- **fixed-collapsed**: Shows icons without labels and has fixed width, 4.5rem.\n- **fixed-expanded**: Shows icons with labels and has fixed width, 15rem.\n- **flexible**: Toggles between collapsed/expanded states.\n- **flexible-on-hover**: Similar to flexible, but the grabber button is only visible on hover or focus.\n- **hidden**: Removes the sidenavigation from the DOM.",
|
|
43029
43229
|
"default": "flexible",
|
|
43030
43230
|
"fieldName": "variant"
|
|
43031
43231
|
},
|
|
@@ -43035,9 +43235,18 @@
|
|
|
43035
43235
|
"text": "string"
|
|
43036
43236
|
},
|
|
43037
43237
|
"default": "''",
|
|
43038
|
-
"description": "Displays footer text in the bottom section of the sidenavigation.",
|
|
43238
|
+
"description": "Displays footer text in the bottom section of the sidenavigation.\n\nNote: if footerText is not provided, the bottom brand logo section will not be rendered.",
|
|
43039
43239
|
"fieldName": "footerText"
|
|
43040
43240
|
},
|
|
43241
|
+
{
|
|
43242
|
+
"name": "expanded",
|
|
43243
|
+
"type": {
|
|
43244
|
+
"text": "boolean | undefined"
|
|
43245
|
+
},
|
|
43246
|
+
"description": "Determines whether the sideNavigation is expanded or not.\n\nNOTE: For `fixed-collapsed` and `fixed-expanded` variants, this property is hard set to `false` and `true` respectively.\nFor `flexible` and `flexible-on-hover` variants, this property can be toggled / controlled from parent.",
|
|
43247
|
+
"default": "true",
|
|
43248
|
+
"fieldName": "expanded"
|
|
43249
|
+
},
|
|
43041
43250
|
{
|
|
43042
43251
|
"name": "grabber-btn-aria-label",
|
|
43043
43252
|
"type": {
|
|
@@ -43048,12 +43257,13 @@
|
|
|
43048
43257
|
"fieldName": "grabberBtnAriaLabel"
|
|
43049
43258
|
},
|
|
43050
43259
|
{
|
|
43051
|
-
"name": "
|
|
43260
|
+
"name": "hide-fixed-section-divider",
|
|
43052
43261
|
"type": {
|
|
43053
|
-
"text": "
|
|
43262
|
+
"text": "boolean"
|
|
43054
43263
|
},
|
|
43055
|
-
"
|
|
43056
|
-
"
|
|
43264
|
+
"default": "false",
|
|
43265
|
+
"description": "Hides the divider between the scrollable and fixed sections when set to true.",
|
|
43266
|
+
"fieldName": "hideFixedSectionDivider"
|
|
43057
43267
|
}
|
|
43058
43268
|
],
|
|
43059
43269
|
"superclass": {
|
|
@@ -43061,7 +43271,7 @@
|
|
|
43061
43271
|
"module": "/src/models"
|
|
43062
43272
|
},
|
|
43063
43273
|
"tagName": "mdc-sidenavigation",
|
|
43064
|
-
"jsDoc": "/**\n * The `mdc-sidenavigation` component provides a vertically stacked navigation experience,\n * typically used in layouts with persistent or collapsible sidebars.\n *\n * ## Features:\n * - Supports
|
|
43274
|
+
"jsDoc": "/**\n * The `mdc-sidenavigation` component provides a vertically stacked navigation experience,\n * typically used in layouts with persistent or collapsible sidebars.\n *\n * ## Features:\n * - Supports five layout variants: `fixed-collapsed`, `fixed-expanded`, `flexible`, `flexible-on-hover`, and `hidden`\n * - Toggleable expand/collapse behavior\n * - Displays brand logo and customer name\n * - Serves as a context provider for descendant components - `mdc-menubar` and `mdc-navmenuitem`\n *\n * ### Usage:\n * In a sidenavigation, navmenuitems can be used in the following ways:\n *\n * 1. **Simple navmenuitem** – No submenu or interaction beyond selection.\n *\n * 2. **NavMenuItem with submenu**:\n * - Provide an `id` on the `mdc-navmenuitem`\n * - Set the `triggerId` on the corresponding `mdc-menupopover` to match the navmenuitem's `id`\n * - Set `parent-nav-tooltip-text` with appropriate text that will display when a child menu item\n * inside the nested menupopover is active, conveying which submenu item is currently selected\n *\n * 3. **Actionable navmenuitem (no submenu)**:\n * - Performs an action such as navigation or alert trigger\n * - Set `disable-aria-current=\"true\"` to maintain visual active state without navigation behavior\n *\n * ### Recommendations:\n * - Use `mdc-text` for section headers\n * - Use `mdc-divider` with the attribute `variant=\"gradient\"` for section dividers\n * - For the brand logo, use an informative icon. Refer to `Momentum Informative Icons`\n *\n * #### Accessibility Notes:\n * - Always provide meaningful `aria-label` attributes for both `mdc-navmenuitem` and `mdc-menubar`\n * to ensure screen reader support\n * - Set `grabber-btn-aria-label` to provide accessible labels for the expand/collapse grabber button\n *\n * @dependency mdc-text\n * @dependency mdc-button\n * @dependency mdc-divider\n * @dependency mdc-menubar\n *\n * @event activechange - (React: onActiveChange) Dispatched when the active state of the navmenuitem changes.\n *\n * @tagname mdc-sidenavigation\n *\n * @slot scrollable-section - Slot for the scrollable content area of the side navigation.\n * @slot scrollable-menubar - Slot for the menubar inside the scrollable section.\n * @slot fixed-section - Slot for the fixed content area of the side navigation.\n * @slot fixed-menubar - Slot for the menubar inside the fixed section.\n * @slot brand-logo - Slot for the brand logo (e.g., icon or img).\n *\n * @csspart side-navigation-container - The main container wrapping the entire side navigation.\n * @csspart scrollable-section - The scrollable section of the side navigation.\n * @csspart scrollable-menubar - The menubar inside the scrollable section.\n * @csspart separator - The divider between the scrollable and fixed sections.\n * @csspart fixed-section - The fixed section of the side navigation.\n * @csspart fixed-menubar - The menubar inside the fixed section.\n * @csspart brand-logo-container - The container wrapping the brand logo and footer text.\n * @csspart footer-text - The footer text label in the fixed section.\n * @csspart vertical-divider - The vertical divider between the scrollable and fixed sections.\n * @csspart vertical-divider-button - The button inside the vertical divider used to toggle expand/collapse.\n *\n * @event toggle - (React: onToggle) Dispatched when the grabber button is clicked to expand/collapse the sidenavigation.\n * @event activechange - (React: onActiveChange) Dispatched when the active state of a nested navmenuitem changes.\n *\n * @cssproperty --mdc-sidenavigation-expanded-width - width of the sideNavigation when expanded\n * @cssproperty --mdc-sidenavigation-expanded-left-padding - padding for the left side of navmenuitems, when expanded\n * @cssproperty --mdc-sidenavigation-expanded-right-padding - padding for the right side of navmenuitems, when expanded\n * @cssproperty --mdc-sidenavigation-collapsed-width - width of the sideNavigation when collapsed\n * @cssproperty --mdc-sidenavigation-collapsed-left-padding - padding for the left side of navmenuitems, when collapsed\n * @cssproperty --mdc-sidenavigation-collapsed-right-padding - padding for the right side of navmenuitems, when collapsed\n * @cssproperty --mdc-sidenavigation-top-padding - padding for the top of the scrollable section - note: if setting to 0 focus ring might be cut off\n * @cssproperty --mdc-sidenavigation-bottom-padding - padding for the bottom of the scrollable section\n * @cssproperty --mdc-sidenavigation-vertical-divider-button-z-index - z-index of the vertical divider button\n */",
|
|
43065
43275
|
"customElement": true
|
|
43066
43276
|
}
|
|
43067
43277
|
],
|