@momentum-design/components 0.91.1 → 0.92.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 +408 -404
- package/dist/browser/index.js.map +4 -4
- package/dist/components/listitem/listitem.component.js +16 -19
- package/dist/components/listitem/listitem.constants.d.ts +1 -3
- package/dist/components/listitem/listitem.constants.js +1 -4
- package/dist/components/listitem/listitem.utils.d.ts +3 -0
- package/dist/components/listitem/listitem.utils.js +4 -0
- package/dist/components/menubar/menubar.component.d.ts +6 -2
- package/dist/components/menubar/menubar.component.js +52 -23
- package/dist/components/menupopover/menupopover.utils.d.ts +1 -2
- package/dist/components/menupopover/menupopover.utils.js +9 -6
- package/dist/components/menusection/menusection.component.d.ts +15 -0
- package/dist/components/menusection/menusection.component.js +38 -2
- package/dist/components/menusection/menusection.styles.js +9 -1
- package/dist/components/{navitem → navmenuitem}/index.d.ts +3 -3
- package/dist/components/navmenuitem/index.js +8 -0
- package/dist/components/{navitem/navitem.component.d.ts → navmenuitem/navmenuitem.component.d.ts} +35 -35
- package/dist/components/{navitem/navitem.component.js → navmenuitem/navmenuitem.component.js} +43 -45
- package/dist/components/{navitem/navitem.constants.d.ts → navmenuitem/navmenuitem.constants.d.ts} +1 -1
- package/dist/components/{navitem/navitem.constants.js → navmenuitem/navmenuitem.constants.js} +1 -1
- package/dist/components/{navitem/navitem.styles.js → navmenuitem/navmenuitem.styles.js} +33 -29
- package/dist/components/{navitem/navitem.types.d.ts → navmenuitem/navmenuitem.types.d.ts} +1 -1
- package/dist/components/popover/popover.component.js +1 -1
- package/dist/components/sidenavigation/index.d.ts +1 -0
- package/dist/components/sidenavigation/index.js +1 -0
- package/dist/components/sidenavigation/sidenavigation.component.d.ts +30 -11
- package/dist/components/sidenavigation/sidenavigation.component.js +60 -17
- package/dist/components/sidenavigation/sidenavigation.context.d.ts +5 -5
- package/dist/components/sidenavigation/sidenavigation.context.js +26 -25
- package/dist/custom-elements.json +532 -889
- package/dist/index.d.ts +2 -3
- package/dist/index.js +2 -3
- package/dist/react/index.d.ts +3 -4
- package/dist/react/index.js +3 -4
- package/dist/react/navmenuitem/index.d.ts +43 -0
- package/dist/react/navmenuitem/index.js +51 -0
- package/dist/react/sidenavigation/index.d.ts +10 -9
- package/dist/react/sidenavigation/index.js +10 -9
- package/package.json +1 -1
- package/dist/components/navitem/index.js +0 -8
- package/dist/components/navitemlist/index.d.ts +0 -7
- package/dist/components/navitemlist/index.js +0 -4
- package/dist/components/navitemlist/navitemlist.component.d.ts +0 -50
- package/dist/components/navitemlist/navitemlist.component.js +0 -89
- package/dist/components/navitemlist/navitemlist.constants.d.ts +0 -2
- package/dist/components/navitemlist/navitemlist.constants.js +0 -3
- package/dist/components/navitemlist/navitemlist.styles.d.ts +0 -2
- package/dist/components/navitemlist/navitemlist.styles.js +0 -23
- package/dist/react/navitem/index.d.ts +0 -43
- package/dist/react/navitem/index.js +0 -51
- package/dist/react/navitemlist/index.d.ts +0 -13
- package/dist/react/navitemlist/index.js +0 -22
- /package/dist/components/{navitem/navitem.styles.d.ts → navmenuitem/navmenuitem.styles.d.ts} +0 -0
- /package/dist/components/{navitem/navitem.types.js → navmenuitem/navmenuitem.types.js} +0 -0
@@ -530,67 +530,6 @@
|
|
530
530
|
}
|
531
531
|
]
|
532
532
|
},
|
533
|
-
{
|
534
|
-
"kind": "javascript-module",
|
535
|
-
"path": "components/appheader/appheader.component.js",
|
536
|
-
"declarations": [
|
537
|
-
{
|
538
|
-
"kind": "class",
|
539
|
-
"description": "The `mdc-appheader` component provides a structured and accessible app header layout.\nIt consists of three primary sections: leading, center, and trailing.\n\n- The **leading section** typically holds a **brand logo**, **brand name** or **menu icon**.\n- The **center section** can contain a **search bar**, **icons** or action controls.\n- The **trailing section** generally includes a **profile avatar**, **additional icons** or **action controls**.",
|
540
|
-
"name": "Appheader",
|
541
|
-
"cssParts": [
|
542
|
-
{
|
543
|
-
"description": "The main container for styling the header.",
|
544
|
-
"name": "container"
|
545
|
-
},
|
546
|
-
{
|
547
|
-
"description": "The leading section of the header.",
|
548
|
-
"name": "leading-section"
|
549
|
-
},
|
550
|
-
{
|
551
|
-
"description": "The center section of the header.",
|
552
|
-
"name": "center-section"
|
553
|
-
},
|
554
|
-
{
|
555
|
-
"description": "The trailing section of the header.",
|
556
|
-
"name": "trailing-section"
|
557
|
-
}
|
558
|
-
],
|
559
|
-
"slots": [
|
560
|
-
{
|
561
|
-
"description": "Slot for the leading section (e.g., brand logo, brand name).",
|
562
|
-
"name": "leading"
|
563
|
-
},
|
564
|
-
{
|
565
|
-
"description": "Slot for the center section (e.g., search bar, icons).",
|
566
|
-
"name": "center"
|
567
|
-
},
|
568
|
-
{
|
569
|
-
"description": "Slot for the trailing section (e.g., profile avatar, icons).",
|
570
|
-
"name": "trailing"
|
571
|
-
}
|
572
|
-
],
|
573
|
-
"members": [],
|
574
|
-
"superclass": {
|
575
|
-
"name": "Component",
|
576
|
-
"module": "/src/models"
|
577
|
-
},
|
578
|
-
"tagName": "mdc-appheader",
|
579
|
-
"jsDoc": "/**\n * The `mdc-appheader` component provides a structured and accessible app header layout.\n * It consists of three primary sections: leading, center, and trailing.\n *\n * - The **leading section** typically holds a **brand logo**, **brand name** or **menu icon**.\n * - The **center section** can contain a **search bar**, **icons** or action controls.\n * - The **trailing section** generally includes a **profile avatar**, **additional icons** or **action controls**.\n *\n * @tagname mdc-appheader\n *\n * @slot leading - Slot for the leading section (e.g., brand logo, brand name).\n * @slot center - Slot for the center section (e.g., search bar, icons).\n * @slot trailing - Slot for the trailing section (e.g., profile avatar, icons).\n *\n * @csspart container - The main container for styling the header.\n * @csspart leading-section - The leading section of the header.\n * @csspart center-section - The center section of the header.\n * @csspart trailing-section - The trailing section of the header.\n */",
|
580
|
-
"customElement": true
|
581
|
-
}
|
582
|
-
],
|
583
|
-
"exports": [
|
584
|
-
{
|
585
|
-
"kind": "js",
|
586
|
-
"name": "default",
|
587
|
-
"declaration": {
|
588
|
-
"name": "Appheader",
|
589
|
-
"module": "components/appheader/appheader.component.js"
|
590
|
-
}
|
591
|
-
}
|
592
|
-
]
|
593
|
-
},
|
594
533
|
{
|
595
534
|
"kind": "javascript-module",
|
596
535
|
"path": "components/animation/animation.component.js",
|
@@ -803,6 +742,67 @@
|
|
803
742
|
}
|
804
743
|
]
|
805
744
|
},
|
745
|
+
{
|
746
|
+
"kind": "javascript-module",
|
747
|
+
"path": "components/appheader/appheader.component.js",
|
748
|
+
"declarations": [
|
749
|
+
{
|
750
|
+
"kind": "class",
|
751
|
+
"description": "The `mdc-appheader` component provides a structured and accessible app header layout.\nIt consists of three primary sections: leading, center, and trailing.\n\n- The **leading section** typically holds a **brand logo**, **brand name** or **menu icon**.\n- The **center section** can contain a **search bar**, **icons** or action controls.\n- The **trailing section** generally includes a **profile avatar**, **additional icons** or **action controls**.",
|
752
|
+
"name": "Appheader",
|
753
|
+
"cssParts": [
|
754
|
+
{
|
755
|
+
"description": "The main container for styling the header.",
|
756
|
+
"name": "container"
|
757
|
+
},
|
758
|
+
{
|
759
|
+
"description": "The leading section of the header.",
|
760
|
+
"name": "leading-section"
|
761
|
+
},
|
762
|
+
{
|
763
|
+
"description": "The center section of the header.",
|
764
|
+
"name": "center-section"
|
765
|
+
},
|
766
|
+
{
|
767
|
+
"description": "The trailing section of the header.",
|
768
|
+
"name": "trailing-section"
|
769
|
+
}
|
770
|
+
],
|
771
|
+
"slots": [
|
772
|
+
{
|
773
|
+
"description": "Slot for the leading section (e.g., brand logo, brand name).",
|
774
|
+
"name": "leading"
|
775
|
+
},
|
776
|
+
{
|
777
|
+
"description": "Slot for the center section (e.g., search bar, icons).",
|
778
|
+
"name": "center"
|
779
|
+
},
|
780
|
+
{
|
781
|
+
"description": "Slot for the trailing section (e.g., profile avatar, icons).",
|
782
|
+
"name": "trailing"
|
783
|
+
}
|
784
|
+
],
|
785
|
+
"members": [],
|
786
|
+
"superclass": {
|
787
|
+
"name": "Component",
|
788
|
+
"module": "/src/models"
|
789
|
+
},
|
790
|
+
"tagName": "mdc-appheader",
|
791
|
+
"jsDoc": "/**\n * The `mdc-appheader` component provides a structured and accessible app header layout.\n * It consists of three primary sections: leading, center, and trailing.\n *\n * - The **leading section** typically holds a **brand logo**, **brand name** or **menu icon**.\n * - The **center section** can contain a **search bar**, **icons** or action controls.\n * - The **trailing section** generally includes a **profile avatar**, **additional icons** or **action controls**.\n *\n * @tagname mdc-appheader\n *\n * @slot leading - Slot for the leading section (e.g., brand logo, brand name).\n * @slot center - Slot for the center section (e.g., search bar, icons).\n * @slot trailing - Slot for the trailing section (e.g., profile avatar, icons).\n *\n * @csspart container - The main container for styling the header.\n * @csspart leading-section - The leading section of the header.\n * @csspart center-section - The center section of the header.\n * @csspart trailing-section - The trailing section of the header.\n */",
|
792
|
+
"customElement": true
|
793
|
+
}
|
794
|
+
],
|
795
|
+
"exports": [
|
796
|
+
{
|
797
|
+
"kind": "js",
|
798
|
+
"name": "default",
|
799
|
+
"declaration": {
|
800
|
+
"name": "Appheader",
|
801
|
+
"module": "components/appheader/appheader.component.js"
|
802
|
+
}
|
803
|
+
}
|
804
|
+
]
|
805
|
+
},
|
806
806
|
{
|
807
807
|
"kind": "javascript-module",
|
808
808
|
"path": "components/avatar/avatar.component.js",
|
@@ -15369,6 +15369,17 @@
|
|
15369
15369
|
"description": "Returns all menuitem elements, including those nested inside menusection.",
|
15370
15370
|
"readonly": true
|
15371
15371
|
},
|
15372
|
+
{
|
15373
|
+
"kind": "method",
|
15374
|
+
"name": "getAllPopovers",
|
15375
|
+
"privacy": "private",
|
15376
|
+
"return": {
|
15377
|
+
"type": {
|
15378
|
+
"text": "Element[]"
|
15379
|
+
}
|
15380
|
+
},
|
15381
|
+
"description": "Returns all menupopovers, including direct and slotted ones ."
|
15382
|
+
},
|
15372
15383
|
{
|
15373
15384
|
"kind": "method",
|
15374
15385
|
"name": "resetTabIndexAndSetActiveTabIndex",
|
@@ -15405,6 +15416,42 @@
|
|
15405
15416
|
}
|
15406
15417
|
]
|
15407
15418
|
},
|
15419
|
+
{
|
15420
|
+
"kind": "method",
|
15421
|
+
"name": "getSubmenu",
|
15422
|
+
"privacy": "private",
|
15423
|
+
"return": {
|
15424
|
+
"type": {
|
15425
|
+
"text": "MenuPopover | undefined"
|
15426
|
+
}
|
15427
|
+
},
|
15428
|
+
"parameters": [
|
15429
|
+
{
|
15430
|
+
"name": "triggerId",
|
15431
|
+
"type": {
|
15432
|
+
"text": "string | null"
|
15433
|
+
}
|
15434
|
+
}
|
15435
|
+
]
|
15436
|
+
},
|
15437
|
+
{
|
15438
|
+
"kind": "method",
|
15439
|
+
"name": "showSubmenu",
|
15440
|
+
"privacy": "private",
|
15441
|
+
"return": {
|
15442
|
+
"type": {
|
15443
|
+
"text": "void"
|
15444
|
+
}
|
15445
|
+
},
|
15446
|
+
"parameters": [
|
15447
|
+
{
|
15448
|
+
"name": "triggerId",
|
15449
|
+
"type": {
|
15450
|
+
"text": "string | null"
|
15451
|
+
}
|
15452
|
+
}
|
15453
|
+
]
|
15454
|
+
},
|
15408
15455
|
{
|
15409
15456
|
"kind": "method",
|
15410
15457
|
"name": "updatePopoverPlacement",
|
@@ -15473,24 +15520,6 @@
|
|
15473
15520
|
}
|
15474
15521
|
]
|
15475
15522
|
},
|
15476
|
-
{
|
15477
|
-
"kind": "method",
|
15478
|
-
"name": "showSubmenu",
|
15479
|
-
"privacy": "private",
|
15480
|
-
"return": {
|
15481
|
-
"type": {
|
15482
|
-
"text": "void"
|
15483
|
-
}
|
15484
|
-
},
|
15485
|
-
"parameters": [
|
15486
|
-
{
|
15487
|
-
"name": "triggerId",
|
15488
|
-
"type": {
|
15489
|
-
"text": "string | null"
|
15490
|
-
}
|
15491
|
-
}
|
15492
|
-
]
|
15493
|
-
},
|
15494
15523
|
{
|
15495
15524
|
"kind": "method",
|
15496
15525
|
"name": "getKeyWithDirectionFix",
|
@@ -15587,24 +15616,6 @@
|
|
15587
15616
|
}
|
15588
15617
|
]
|
15589
15618
|
},
|
15590
|
-
{
|
15591
|
-
"kind": "method",
|
15592
|
-
"name": "hasSubmenu",
|
15593
|
-
"privacy": "private",
|
15594
|
-
"return": {
|
15595
|
-
"type": {
|
15596
|
-
"text": "boolean"
|
15597
|
-
}
|
15598
|
-
},
|
15599
|
-
"parameters": [
|
15600
|
-
{
|
15601
|
-
"name": "triggerId",
|
15602
|
-
"type": {
|
15603
|
-
"text": "string | null"
|
15604
|
-
}
|
15605
|
-
}
|
15606
|
-
]
|
15607
|
-
},
|
15608
15619
|
{
|
15609
15620
|
"kind": "method",
|
15610
15621
|
"name": "getParentMenuItemIndex",
|
@@ -15664,15 +15675,15 @@
|
|
15664
15675
|
},
|
15665
15676
|
{
|
15666
15677
|
"kind": "javascript-module",
|
15667
|
-
"path": "components/
|
15678
|
+
"path": "components/menuitem/menuitem.component.js",
|
15668
15679
|
"declarations": [
|
15669
15680
|
{
|
15670
15681
|
"kind": "class",
|
15671
|
-
"description": "
|
15672
|
-
"name": "
|
15682
|
+
"description": "menuitem component is inherited by listitem component with the role set `menuitem`.<br/>\nA menu item can contain an icon on the leading or trailing side.\n\nThe leading and trailing slots can be used to display controls and text.<br/>\nBased on the leading/trailing slot, the position of the controls and text can be adjusted.\n\nPlease use element with role=menu as a parent element even when there is only menuitem for a11y purpose.\nFor example mdc-menupopover or mdc-menubar.\n\nMenu item has `name` and `value` attribute that can be used to identify the menu item when it is selected.",
|
15683
|
+
"name": "MenuItem",
|
15673
15684
|
"slots": [
|
15674
15685
|
{
|
15675
|
-
"description": "slot for menu item
|
15686
|
+
"description": "slot for menu item controls to appear of leading end.",
|
15676
15687
|
"name": "leading-controls",
|
15677
15688
|
"inheritedFrom": {
|
15678
15689
|
"name": "ListItem",
|
@@ -15680,7 +15691,7 @@
|
|
15680
15691
|
}
|
15681
15692
|
},
|
15682
15693
|
{
|
15683
|
-
"description": "slot for menu item
|
15694
|
+
"description": "slot for menu item primary label.",
|
15684
15695
|
"name": "leading-text-primary-label",
|
15685
15696
|
"inheritedFrom": {
|
15686
15697
|
"name": "ListItem",
|
@@ -15688,7 +15699,7 @@
|
|
15688
15699
|
}
|
15689
15700
|
},
|
15690
15701
|
{
|
15691
|
-
"description": "slot for menu item
|
15702
|
+
"description": "slot for menu item secondary label.",
|
15692
15703
|
"name": "leading-text-secondary-label",
|
15693
15704
|
"inheritedFrom": {
|
15694
15705
|
"name": "ListItem",
|
@@ -15696,7 +15707,7 @@
|
|
15696
15707
|
}
|
15697
15708
|
},
|
15698
15709
|
{
|
15699
|
-
"description": "slot for menu item
|
15710
|
+
"description": "slot for menu item tertiary label.",
|
15700
15711
|
"name": "leading-text-tertiary-label",
|
15701
15712
|
"inheritedFrom": {
|
15702
15713
|
"name": "ListItem",
|
@@ -15704,7 +15715,7 @@
|
|
15704
15715
|
}
|
15705
15716
|
},
|
15706
15717
|
{
|
15707
|
-
"description": "slot for menu item
|
15718
|
+
"description": "slot for menu item side header text.",
|
15708
15719
|
"name": "trailing-text-side-header",
|
15709
15720
|
"inheritedFrom": {
|
15710
15721
|
"name": "ListItem",
|
@@ -15712,7 +15723,7 @@
|
|
15712
15723
|
}
|
15713
15724
|
},
|
15714
15725
|
{
|
15715
|
-
"description": "slot for menu item
|
15726
|
+
"description": "slot for menu item subline text.",
|
15716
15727
|
"name": "trailing-text-subline",
|
15717
15728
|
"inheritedFrom": {
|
15718
15729
|
"name": "ListItem",
|
@@ -15720,7 +15731,7 @@
|
|
15720
15731
|
}
|
15721
15732
|
},
|
15722
15733
|
{
|
15723
|
-
"description": "slot for menu item
|
15734
|
+
"description": "slot for menu item controls to appear of trailing end.",
|
15724
15735
|
"name": "trailing-controls",
|
15725
15736
|
"inheritedFrom": {
|
15726
15737
|
"name": "ListItem",
|
@@ -15731,107 +15742,34 @@
|
|
15731
15742
|
"members": [
|
15732
15743
|
{
|
15733
15744
|
"kind": "field",
|
15734
|
-
"name": "
|
15745
|
+
"name": "arrowPosition",
|
15735
15746
|
"type": {
|
15736
|
-
"text": "
|
15747
|
+
"text": "ArrowPositions | undefined"
|
15737
15748
|
},
|
15738
|
-
"
|
15739
|
-
"
|
15740
|
-
"attribute": "checked",
|
15749
|
+
"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.",
|
15750
|
+
"attribute": "arrow-position",
|
15741
15751
|
"reflects": true
|
15742
15752
|
},
|
15743
15753
|
{
|
15744
15754
|
"kind": "field",
|
15745
|
-
"name": "
|
15755
|
+
"name": "arrowDirection",
|
15746
15756
|
"type": {
|
15747
|
-
"text": "
|
15757
|
+
"text": "ArrowDirections | undefined"
|
15748
15758
|
},
|
15749
|
-
"description": "
|
15750
|
-
"
|
15751
|
-
"attribute": "indicator",
|
15759
|
+
"description": "Defines the direction the arrow icon points.\n- `'positive'`: Arrow points toward the trailing side.\n- `'negative'`: Arrow points toward the leading side.",
|
15760
|
+
"attribute": "arrow-direction",
|
15752
15761
|
"reflects": true
|
15753
15762
|
},
|
15754
15763
|
{
|
15755
15764
|
"kind": "field",
|
15756
|
-
"name": "
|
15757
|
-
"
|
15758
|
-
|
15759
|
-
|
15760
|
-
|
15761
|
-
"
|
15762
|
-
"
|
15763
|
-
"
|
15764
|
-
"return": {
|
15765
|
-
"type": {
|
15766
|
-
"text": ""
|
15767
|
-
}
|
15768
|
-
},
|
15769
|
-
"description": "Returns a static checkbox element if the indicator is set to checkbox.\nIf the indicator is not set to checkbox, it returns nothing."
|
15770
|
-
},
|
15771
|
-
{
|
15772
|
-
"kind": "method",
|
15773
|
-
"name": "staticToggle",
|
15774
|
-
"privacy": "private",
|
15775
|
-
"return": {
|
15776
|
-
"type": {
|
15777
|
-
"text": ""
|
15778
|
-
}
|
15779
|
-
},
|
15780
|
-
"description": "Returns a static toggle element if the indicator is set to toggle.\nIf the indicator is not set to toggle, it returns nothing.\n\nThe toggle will always be positioned on the trailing side of the menuitem label."
|
15781
|
-
},
|
15782
|
-
{
|
15783
|
-
"kind": "method",
|
15784
|
-
"name": "getCheckmarkIcon",
|
15785
|
-
"privacy": "private",
|
15786
|
-
"return": {
|
15787
|
-
"type": {
|
15788
|
-
"text": ""
|
15789
|
-
}
|
15790
|
-
},
|
15791
|
-
"description": "Returns a checkmark icon if the indicator is set to checkmark and the checked state is true.\nIf the indicator is not set to checkmark or the checked state is false, it returns nothing.\n\nThe checkmark icon will always be positioned on the trailing side of the menuitem label."
|
15792
|
-
},
|
15793
|
-
{
|
15794
|
-
"kind": "field",
|
15795
|
-
"name": "arrowPosition",
|
15796
|
-
"type": {
|
15797
|
-
"text": "ArrowPositions | undefined"
|
15798
|
-
},
|
15799
|
-
"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.",
|
15800
|
-
"attribute": "arrow-position",
|
15801
|
-
"reflects": true,
|
15802
|
-
"inheritedFrom": {
|
15803
|
-
"name": "MenuItem",
|
15804
|
-
"module": "components/menuitem/menuitem.component.js"
|
15805
|
-
}
|
15806
|
-
},
|
15807
|
-
{
|
15808
|
-
"kind": "field",
|
15809
|
-
"name": "arrowDirection",
|
15810
|
-
"type": {
|
15811
|
-
"text": "ArrowDirections | undefined"
|
15812
|
-
},
|
15813
|
-
"description": "Defines the direction the arrow icon points.\n- `'positive'`: Arrow points toward the trailing side.\n- `'negative'`: Arrow points toward the leading side.",
|
15814
|
-
"attribute": "arrow-direction",
|
15815
|
-
"reflects": true,
|
15816
|
-
"inheritedFrom": {
|
15817
|
-
"name": "MenuItem",
|
15818
|
-
"module": "components/menuitem/menuitem.component.js"
|
15819
|
-
}
|
15820
|
-
},
|
15821
|
-
{
|
15822
|
-
"kind": "field",
|
15823
|
-
"name": "name",
|
15824
|
-
"type": {
|
15825
|
-
"text": "undefined | string | undefined"
|
15826
|
-
},
|
15827
|
-
"default": "undefined",
|
15828
|
-
"description": "The name attribute is used to identify the menu item when it is selected.",
|
15829
|
-
"attribute": "name",
|
15830
|
-
"reflects": true,
|
15831
|
-
"inheritedFrom": {
|
15832
|
-
"name": "MenuItem",
|
15833
|
-
"module": "components/menuitem/menuitem.component.js"
|
15834
|
-
}
|
15765
|
+
"name": "name",
|
15766
|
+
"type": {
|
15767
|
+
"text": "undefined | string | undefined"
|
15768
|
+
},
|
15769
|
+
"default": "undefined",
|
15770
|
+
"description": "The name attribute is used to identify the menu item when it is selected.",
|
15771
|
+
"attribute": "name",
|
15772
|
+
"reflects": true
|
15835
15773
|
},
|
15836
15774
|
{
|
15837
15775
|
"kind": "field",
|
@@ -15842,11 +15780,7 @@
|
|
15842
15780
|
"default": "undefined",
|
15843
15781
|
"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.",
|
15844
15782
|
"attribute": "value",
|
15845
|
-
"reflects": true
|
15846
|
-
"inheritedFrom": {
|
15847
|
-
"name": "MenuItem",
|
15848
|
-
"module": "components/menuitem/menuitem.component.js"
|
15849
|
-
}
|
15783
|
+
"reflects": true
|
15850
15784
|
},
|
15851
15785
|
{
|
15852
15786
|
"kind": "method",
|
@@ -15890,11 +15824,7 @@
|
|
15890
15824
|
"description": "The keyboard event that triggered the action."
|
15891
15825
|
}
|
15892
15826
|
],
|
15893
|
-
"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."
|
15894
|
-
"inheritedFrom": {
|
15895
|
-
"name": "MenuItem",
|
15896
|
-
"module": "components/menuitem/menuitem.component.js"
|
15897
|
-
}
|
15827
|
+
"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."
|
15898
15828
|
},
|
15899
15829
|
{
|
15900
15830
|
"kind": "method",
|
@@ -16231,12 +16161,7 @@
|
|
16231
16161
|
],
|
16232
16162
|
"events": [
|
16233
16163
|
{
|
16234
|
-
"description": "(React:
|
16235
|
-
"name": "change",
|
16236
|
-
"reactName": "onChange"
|
16237
|
-
},
|
16238
|
-
{
|
16239
|
-
"description": "(React: onClick) This event is dispatched when the menuitemcheckbox is clicked.",
|
16164
|
+
"description": "(React: onClick) This event is dispatched when the menuitem is clicked.",
|
16240
16165
|
"name": "click",
|
16241
16166
|
"reactName": "onClick",
|
16242
16167
|
"inheritedFrom": {
|
@@ -16244,15 +16169,6 @@
|
|
16244
16169
|
"module": "src/components/listitem/listitem.component.ts"
|
16245
16170
|
}
|
16246
16171
|
},
|
16247
|
-
{
|
16248
|
-
"description": "(React: onFocus) This event is dispatched when the menuitemcheckbox receives focus.",
|
16249
|
-
"name": "focus",
|
16250
|
-
"reactName": "onFocus",
|
16251
|
-
"inheritedFrom": {
|
16252
|
-
"name": "ListItem",
|
16253
|
-
"module": "src/components/listitem/listitem.component.ts"
|
16254
|
-
}
|
16255
|
-
},
|
16256
16172
|
{
|
16257
16173
|
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the menuitem.",
|
16258
16174
|
"name": "keydown",
|
@@ -16270,38 +16186,25 @@
|
|
16270
16186
|
"name": "ListItem",
|
16271
16187
|
"module": "src/components/listitem/listitem.component.ts"
|
16272
16188
|
}
|
16189
|
+
},
|
16190
|
+
{
|
16191
|
+
"description": "(React: onFocus) This event is dispatched when the menuitem receives focus.",
|
16192
|
+
"name": "focus",
|
16193
|
+
"reactName": "onFocus",
|
16194
|
+
"inheritedFrom": {
|
16195
|
+
"name": "ListItem",
|
16196
|
+
"module": "src/components/listitem/listitem.component.ts"
|
16197
|
+
}
|
16273
16198
|
}
|
16274
16199
|
],
|
16275
16200
|
"attributes": [
|
16276
|
-
{
|
16277
|
-
"name": "checked",
|
16278
|
-
"type": {
|
16279
|
-
"text": "boolean"
|
16280
|
-
},
|
16281
|
-
"default": "false",
|
16282
|
-
"description": "The checked attribute is used to indicate that the menuitemcheckbox is checked or not.",
|
16283
|
-
"fieldName": "checked"
|
16284
|
-
},
|
16285
|
-
{
|
16286
|
-
"name": "indicator",
|
16287
|
-
"type": {
|
16288
|
-
"text": "Indicator"
|
16289
|
-
},
|
16290
|
-
"description": "The indicator attribute is used to differentiate between <b>checkbox</b> and <b>toggle</b>.",
|
16291
|
-
"default": "'checkbox'",
|
16292
|
-
"fieldName": "indicator"
|
16293
|
-
},
|
16294
16201
|
{
|
16295
16202
|
"name": "arrow-position",
|
16296
16203
|
"type": {
|
16297
16204
|
"text": "ArrowPositions | undefined"
|
16298
16205
|
},
|
16299
16206
|
"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.",
|
16300
|
-
"fieldName": "arrowPosition"
|
16301
|
-
"inheritedFrom": {
|
16302
|
-
"name": "MenuItem",
|
16303
|
-
"module": "src/components/menuitem/menuitem.component.ts"
|
16304
|
-
}
|
16207
|
+
"fieldName": "arrowPosition"
|
16305
16208
|
},
|
16306
16209
|
{
|
16307
16210
|
"name": "arrow-direction",
|
@@ -16309,11 +16212,7 @@
|
|
16309
16212
|
"text": "ArrowDirections | undefined"
|
16310
16213
|
},
|
16311
16214
|
"description": "Defines the direction the arrow icon points.\n- `'positive'`: Arrow points toward the trailing side.\n- `'negative'`: Arrow points toward the leading side.",
|
16312
|
-
"fieldName": "arrowDirection"
|
16313
|
-
"inheritedFrom": {
|
16314
|
-
"name": "MenuItem",
|
16315
|
-
"module": "src/components/menuitem/menuitem.component.ts"
|
16316
|
-
}
|
16215
|
+
"fieldName": "arrowDirection"
|
16317
16216
|
},
|
16318
16217
|
{
|
16319
16218
|
"name": "name",
|
@@ -16322,11 +16221,7 @@
|
|
16322
16221
|
},
|
16323
16222
|
"default": "undefined",
|
16324
16223
|
"description": "The name attribute is used to identify the menu item when it is selected.",
|
16325
|
-
"fieldName": "name"
|
16326
|
-
"inheritedFrom": {
|
16327
|
-
"name": "MenuItem",
|
16328
|
-
"module": "src/components/menuitem/menuitem.component.ts"
|
16329
|
-
}
|
16224
|
+
"fieldName": "name"
|
16330
16225
|
},
|
16331
16226
|
{
|
16332
16227
|
"name": "value",
|
@@ -16335,11 +16230,7 @@
|
|
16335
16230
|
},
|
16336
16231
|
"default": "undefined",
|
16337
16232
|
"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.",
|
16338
|
-
"fieldName": "value"
|
16339
|
-
"inheritedFrom": {
|
16340
|
-
"name": "MenuItem",
|
16341
|
-
"module": "src/components/menuitem/menuitem.component.ts"
|
16342
|
-
}
|
16233
|
+
"fieldName": "value"
|
16343
16234
|
},
|
16344
16235
|
{
|
16345
16236
|
"name": "disabled",
|
@@ -16480,11 +16371,11 @@
|
|
16480
16371
|
}
|
16481
16372
|
],
|
16482
16373
|
"superclass": {
|
16483
|
-
"name": "
|
16484
|
-
"module": "/src/components/
|
16374
|
+
"name": "ListItem",
|
16375
|
+
"module": "/src/components/listitem/listitem.component"
|
16485
16376
|
},
|
16486
|
-
"tagName": "mdc-
|
16487
|
-
"jsDoc": "/**\n *
|
16377
|
+
"tagName": "mdc-menuitem",
|
16378
|
+
"jsDoc": "/**\n * menuitem component is inherited by listitem component with the role set `menuitem`.<br/>\n * A menu item can contain an icon on the leading or trailing side.\n *\n * The leading and trailing slots can be used to display controls and text.<br/>\n * Based on the leading/trailing slot, the position of the controls and text can be adjusted.\n *\n * Please use element with role=menu as a parent element even when there is only menuitem for a11y purpose.\n * For example mdc-menupopover or mdc-menubar.\n *\n * Menu item has `name` and `value` attribute that can be used to identify the menu item when it is selected.\n *\n * @dependency mdc-text\n * @dependency mdc-icon\n * @dependency mdc-tooltip\n *\n * @tagname mdc-menuitem\n *\n * @slot leading-controls - slot for menu item controls to appear of leading end.\n * @slot leading-text-primary-label - slot for menu item primary label.\n * @slot leading-text-secondary-label - slot for menu item secondary label.\n * @slot leading-text-tertiary-label - slot for menu item tertiary label.\n * @slot trailing-text-side-header - slot for menu item side header text.\n * @slot trailing-text-subline - slot for menu item subline text.\n * @slot trailing-controls - slot for menu item controls to appear of trailing end.\n *\n * @event click - (React: onClick) This event is dispatched when the menuitem is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the menuitem.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the menuitem.\n * @event focus - (React: onFocus) This event is dispatched when the menuitem receives focus.\n */",
|
16488
16379
|
"customElement": true,
|
16489
16380
|
"cssProperties": [
|
16490
16381
|
{
|
@@ -16559,23 +16450,23 @@
|
|
16559
16450
|
"kind": "js",
|
16560
16451
|
"name": "default",
|
16561
16452
|
"declaration": {
|
16562
|
-
"name": "
|
16563
|
-
"module": "components/
|
16453
|
+
"name": "MenuItem",
|
16454
|
+
"module": "components/menuitem/menuitem.component.js"
|
16564
16455
|
}
|
16565
16456
|
}
|
16566
16457
|
]
|
16567
16458
|
},
|
16568
16459
|
{
|
16569
16460
|
"kind": "javascript-module",
|
16570
|
-
"path": "components/
|
16461
|
+
"path": "components/menuitemcheckbox/menuitemcheckbox.component.js",
|
16571
16462
|
"declarations": [
|
16572
16463
|
{
|
16573
16464
|
"kind": "class",
|
16574
|
-
"description": "
|
16575
|
-
"name": "
|
16465
|
+
"description": "A menuitemcheckbox component is a checkable menuitem.\nThere should be no focusable descendants inside this menuitemcheckbox component.\n\nThe `checked` attribute indicates whether the menuitemcheckbox is checked or not.\n\nMenu item checkbox has `name` and `value` attribute that can be used to identify the menu item when it is selected.\n\nThe `indicator` attribute is used to differentiate between <b>checkbox</b>, <b>checkmark</b>, <b>toggle</b> and <b>none</b>.\nBy default, the `indicator` is set to <b>checkbox</b>.<br/>\n\nThe checkbox will always be positioned on the leading side of the menuitem label and\nthe toggle and checkmark will always be positioned on the trailing side.\n\nThe checkbox will have the possible states of `true` or `false`.\nIf the indicator is set to <b>checkmark</b> and if the `checked` attribute is set to `true`,\nthen the checkmark will be displayed. if not, then no indicator will be displayed.\n\nThe forth options for the `indicator` is <b>none</b>, which will not display any indicator at all.\nIt is intended to be used for customised menu items where the indicator is implemented differently.\nFor example, you can use a custom icon or a different visual element to indicate the state of the menu item.\nMake sure the new indicator is accessible.\n\nIf you want only one item in a group to be checked, consider using menuitemradio component.",
|
16466
|
+
"name": "MenuItemCheckbox",
|
16576
16467
|
"slots": [
|
16577
16468
|
{
|
16578
|
-
"description": "slot for menu item controls to appear of leading end.",
|
16469
|
+
"description": "slot for menu item checkbox controls to appear of leading end.",
|
16579
16470
|
"name": "leading-controls",
|
16580
16471
|
"inheritedFrom": {
|
16581
16472
|
"name": "ListItem",
|
@@ -16583,7 +16474,7 @@
|
|
16583
16474
|
}
|
16584
16475
|
},
|
16585
16476
|
{
|
16586
|
-
"description": "slot for menu item primary label.",
|
16477
|
+
"description": "slot for menu item checkbox primary label.",
|
16587
16478
|
"name": "leading-text-primary-label",
|
16588
16479
|
"inheritedFrom": {
|
16589
16480
|
"name": "ListItem",
|
@@ -16591,7 +16482,7 @@
|
|
16591
16482
|
}
|
16592
16483
|
},
|
16593
16484
|
{
|
16594
|
-
"description": "slot for menu item secondary label.",
|
16485
|
+
"description": "slot for menu item checkbox secondary label.",
|
16595
16486
|
"name": "leading-text-secondary-label",
|
16596
16487
|
"inheritedFrom": {
|
16597
16488
|
"name": "ListItem",
|
@@ -16599,7 +16490,7 @@
|
|
16599
16490
|
}
|
16600
16491
|
},
|
16601
16492
|
{
|
16602
|
-
"description": "slot for menu item tertiary label.",
|
16493
|
+
"description": "slot for menu item checkbox tertiary label.",
|
16603
16494
|
"name": "leading-text-tertiary-label",
|
16604
16495
|
"inheritedFrom": {
|
16605
16496
|
"name": "ListItem",
|
@@ -16607,7 +16498,7 @@
|
|
16607
16498
|
}
|
16608
16499
|
},
|
16609
16500
|
{
|
16610
|
-
"description": "slot for menu item side header text.",
|
16501
|
+
"description": "slot for menu item checkbox side header text.",
|
16611
16502
|
"name": "trailing-text-side-header",
|
16612
16503
|
"inheritedFrom": {
|
16613
16504
|
"name": "ListItem",
|
@@ -16615,7 +16506,7 @@
|
|
16615
16506
|
}
|
16616
16507
|
},
|
16617
16508
|
{
|
16618
|
-
"description": "slot for menu item subline text.",
|
16509
|
+
"description": "slot for menu item checkbox subline text.",
|
16619
16510
|
"name": "trailing-text-subline",
|
16620
16511
|
"inheritedFrom": {
|
16621
16512
|
"name": "ListItem",
|
@@ -16623,7 +16514,7 @@
|
|
16623
16514
|
}
|
16624
16515
|
},
|
16625
16516
|
{
|
16626
|
-
"description": "slot for menu item controls to appear of trailing end.",
|
16517
|
+
"description": "slot for menu item checkbox controls to appear of trailing end.",
|
16627
16518
|
"name": "trailing-controls",
|
16628
16519
|
"inheritedFrom": {
|
16629
16520
|
"name": "ListItem",
|
@@ -16634,93 +16525,174 @@
|
|
16634
16525
|
"members": [
|
16635
16526
|
{
|
16636
16527
|
"kind": "field",
|
16637
|
-
"name": "
|
16638
|
-
"type": {
|
16639
|
-
"text": "ArrowPositions | undefined"
|
16640
|
-
},
|
16641
|
-
"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.",
|
16642
|
-
"attribute": "arrow-position",
|
16643
|
-
"reflects": true
|
16644
|
-
},
|
16645
|
-
{
|
16646
|
-
"kind": "field",
|
16647
|
-
"name": "arrowDirection",
|
16528
|
+
"name": "checked",
|
16648
16529
|
"type": {
|
16649
|
-
"text": "
|
16530
|
+
"text": "boolean"
|
16650
16531
|
},
|
16651
|
-
"
|
16652
|
-
"
|
16532
|
+
"default": "false",
|
16533
|
+
"description": "The checked attribute is used to indicate that the menuitemcheckbox is checked or not.",
|
16534
|
+
"attribute": "checked",
|
16653
16535
|
"reflects": true
|
16654
16536
|
},
|
16655
16537
|
{
|
16656
16538
|
"kind": "field",
|
16657
|
-
"name": "
|
16539
|
+
"name": "indicator",
|
16658
16540
|
"type": {
|
16659
|
-
"text": "
|
16541
|
+
"text": "Indicator"
|
16660
16542
|
},
|
16661
|
-
"
|
16662
|
-
"
|
16663
|
-
"attribute": "
|
16543
|
+
"description": "The indicator attribute is used to differentiate between <b>checkbox</b> and <b>toggle</b>.",
|
16544
|
+
"default": "'checkbox'",
|
16545
|
+
"attribute": "indicator",
|
16664
16546
|
"reflects": true
|
16665
16547
|
},
|
16666
16548
|
{
|
16667
16549
|
"kind": "field",
|
16668
|
-
"name": "
|
16669
|
-
"
|
16670
|
-
|
16671
|
-
},
|
16672
|
-
"default": "undefined",
|
16673
|
-
"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.",
|
16674
|
-
"attribute": "value",
|
16675
|
-
"reflects": true
|
16550
|
+
"name": "handleMouseClick",
|
16551
|
+
"privacy": "private",
|
16552
|
+
"description": "Handles click events to toggle checked state\nIf the menuitemcheckbox is disabled, it does nothing.\nIf the menuitemcheckbox is not disabled, it toggles the `checked` state between `true` and `false`."
|
16676
16553
|
},
|
16677
16554
|
{
|
16678
16555
|
"kind": "method",
|
16679
|
-
"name": "
|
16680
|
-
"privacy": "
|
16556
|
+
"name": "staticCheckbox",
|
16557
|
+
"privacy": "private",
|
16681
16558
|
"return": {
|
16682
16559
|
"type": {
|
16683
|
-
"text": "
|
16560
|
+
"text": ""
|
16684
16561
|
}
|
16685
16562
|
},
|
16686
|
-
"
|
16687
|
-
{
|
16688
|
-
"name": "event",
|
16689
|
-
"type": {
|
16690
|
-
"text": "KeyboardEvent"
|
16691
|
-
},
|
16692
|
-
"description": "The keyboard event that triggered the action."
|
16693
|
-
}
|
16694
|
-
],
|
16695
|
-
"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.",
|
16696
|
-
"inheritedFrom": {
|
16697
|
-
"name": "ListItem",
|
16698
|
-
"module": "components/listitem/listitem.component.js"
|
16699
|
-
}
|
16563
|
+
"description": "Returns a static checkbox element if the indicator is set to checkbox.\nIf the indicator is not set to checkbox, it returns nothing."
|
16700
16564
|
},
|
16701
16565
|
{
|
16702
16566
|
"kind": "method",
|
16703
|
-
"name": "
|
16567
|
+
"name": "staticToggle",
|
16704
16568
|
"privacy": "private",
|
16705
16569
|
"return": {
|
16706
16570
|
"type": {
|
16707
|
-
"text": "
|
16571
|
+
"text": ""
|
16708
16572
|
}
|
16709
16573
|
},
|
16710
|
-
"
|
16711
|
-
{
|
16712
|
-
"name": "event",
|
16713
|
-
"type": {
|
16714
|
-
"text": "KeyboardEvent"
|
16715
|
-
},
|
16716
|
-
"description": "The keyboard event that triggered the action."
|
16717
|
-
}
|
16718
|
-
],
|
16719
|
-
"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."
|
16574
|
+
"description": "Returns a static toggle element if the indicator is set to toggle.\nIf the indicator is not set to toggle, it returns nothing.\n\nThe toggle will always be positioned on the trailing side of the menuitem label."
|
16720
16575
|
},
|
16721
16576
|
{
|
16722
16577
|
"kind": "method",
|
16723
|
-
"name": "
|
16578
|
+
"name": "getCheckmarkIcon",
|
16579
|
+
"privacy": "private",
|
16580
|
+
"return": {
|
16581
|
+
"type": {
|
16582
|
+
"text": ""
|
16583
|
+
}
|
16584
|
+
},
|
16585
|
+
"description": "Returns a checkmark icon if the indicator is set to checkmark and the checked state is true.\nIf the indicator is not set to checkmark or the checked state is false, it returns nothing.\n\nThe checkmark icon will always be positioned on the trailing side of the menuitem label."
|
16586
|
+
},
|
16587
|
+
{
|
16588
|
+
"kind": "field",
|
16589
|
+
"name": "arrowPosition",
|
16590
|
+
"type": {
|
16591
|
+
"text": "ArrowPositions | undefined"
|
16592
|
+
},
|
16593
|
+
"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.",
|
16594
|
+
"attribute": "arrow-position",
|
16595
|
+
"reflects": true,
|
16596
|
+
"inheritedFrom": {
|
16597
|
+
"name": "MenuItem",
|
16598
|
+
"module": "components/menuitem/menuitem.component.js"
|
16599
|
+
}
|
16600
|
+
},
|
16601
|
+
{
|
16602
|
+
"kind": "field",
|
16603
|
+
"name": "arrowDirection",
|
16604
|
+
"type": {
|
16605
|
+
"text": "ArrowDirections | undefined"
|
16606
|
+
},
|
16607
|
+
"description": "Defines the direction the arrow icon points.\n- `'positive'`: Arrow points toward the trailing side.\n- `'negative'`: Arrow points toward the leading side.",
|
16608
|
+
"attribute": "arrow-direction",
|
16609
|
+
"reflects": true,
|
16610
|
+
"inheritedFrom": {
|
16611
|
+
"name": "MenuItem",
|
16612
|
+
"module": "components/menuitem/menuitem.component.js"
|
16613
|
+
}
|
16614
|
+
},
|
16615
|
+
{
|
16616
|
+
"kind": "field",
|
16617
|
+
"name": "name",
|
16618
|
+
"type": {
|
16619
|
+
"text": "undefined | string | undefined"
|
16620
|
+
},
|
16621
|
+
"default": "undefined",
|
16622
|
+
"description": "The name attribute is used to identify the menu item when it is selected.",
|
16623
|
+
"attribute": "name",
|
16624
|
+
"reflects": true,
|
16625
|
+
"inheritedFrom": {
|
16626
|
+
"name": "MenuItem",
|
16627
|
+
"module": "components/menuitem/menuitem.component.js"
|
16628
|
+
}
|
16629
|
+
},
|
16630
|
+
{
|
16631
|
+
"kind": "field",
|
16632
|
+
"name": "value",
|
16633
|
+
"type": {
|
16634
|
+
"text": "undefined | string | undefined"
|
16635
|
+
},
|
16636
|
+
"default": "undefined",
|
16637
|
+
"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.",
|
16638
|
+
"attribute": "value",
|
16639
|
+
"reflects": true,
|
16640
|
+
"inheritedFrom": {
|
16641
|
+
"name": "MenuItem",
|
16642
|
+
"module": "components/menuitem/menuitem.component.js"
|
16643
|
+
}
|
16644
|
+
},
|
16645
|
+
{
|
16646
|
+
"kind": "method",
|
16647
|
+
"name": "handleKeyDown",
|
16648
|
+
"privacy": "protected",
|
16649
|
+
"return": {
|
16650
|
+
"type": {
|
16651
|
+
"text": "void"
|
16652
|
+
}
|
16653
|
+
},
|
16654
|
+
"parameters": [
|
16655
|
+
{
|
16656
|
+
"name": "event",
|
16657
|
+
"type": {
|
16658
|
+
"text": "KeyboardEvent"
|
16659
|
+
},
|
16660
|
+
"description": "The keyboard event that triggered the action."
|
16661
|
+
}
|
16662
|
+
],
|
16663
|
+
"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.",
|
16664
|
+
"inheritedFrom": {
|
16665
|
+
"name": "ListItem",
|
16666
|
+
"module": "components/listitem/listitem.component.js"
|
16667
|
+
}
|
16668
|
+
},
|
16669
|
+
{
|
16670
|
+
"kind": "method",
|
16671
|
+
"name": "handleKeyUp",
|
16672
|
+
"privacy": "private",
|
16673
|
+
"return": {
|
16674
|
+
"type": {
|
16675
|
+
"text": "void"
|
16676
|
+
}
|
16677
|
+
},
|
16678
|
+
"parameters": [
|
16679
|
+
{
|
16680
|
+
"name": "event",
|
16681
|
+
"type": {
|
16682
|
+
"text": "KeyboardEvent"
|
16683
|
+
},
|
16684
|
+
"description": "The keyboard event that triggered the action."
|
16685
|
+
}
|
16686
|
+
],
|
16687
|
+
"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.",
|
16688
|
+
"inheritedFrom": {
|
16689
|
+
"name": "MenuItem",
|
16690
|
+
"module": "components/menuitem/menuitem.component.js"
|
16691
|
+
}
|
16692
|
+
},
|
16693
|
+
{
|
16694
|
+
"kind": "method",
|
16695
|
+
"name": "renderTrailingControls",
|
16724
16696
|
"privacy": "protected",
|
16725
16697
|
"description": "Renders the trailing controls slot and optionally the trailing arrow icon,\nbased on `arrowPosition` and `arrowDirection`.",
|
16726
16698
|
"return": {
|
@@ -17053,7 +17025,12 @@
|
|
17053
17025
|
],
|
17054
17026
|
"events": [
|
17055
17027
|
{
|
17056
|
-
"description": "(React:
|
17028
|
+
"description": "(React: onChange) This event is dispatched when the menuitemcheckbox changes.",
|
17029
|
+
"name": "change",
|
17030
|
+
"reactName": "onChange"
|
17031
|
+
},
|
17032
|
+
{
|
17033
|
+
"description": "(React: onClick) This event is dispatched when the menuitemcheckbox is clicked.",
|
17057
17034
|
"name": "click",
|
17058
17035
|
"reactName": "onClick",
|
17059
17036
|
"inheritedFrom": {
|
@@ -17062,27 +17039,27 @@
|
|
17062
17039
|
}
|
17063
17040
|
},
|
17064
17041
|
{
|
17065
|
-
"description": "(React:
|
17066
|
-
"name": "
|
17067
|
-
"reactName": "
|
17042
|
+
"description": "(React: onFocus) This event is dispatched when the menuitemcheckbox receives focus.",
|
17043
|
+
"name": "focus",
|
17044
|
+
"reactName": "onFocus",
|
17068
17045
|
"inheritedFrom": {
|
17069
17046
|
"name": "ListItem",
|
17070
17047
|
"module": "src/components/listitem/listitem.component.ts"
|
17071
17048
|
}
|
17072
17049
|
},
|
17073
17050
|
{
|
17074
|
-
"description": "(React:
|
17075
|
-
"name": "
|
17076
|
-
"reactName": "
|
17051
|
+
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the menuitem.",
|
17052
|
+
"name": "keydown",
|
17053
|
+
"reactName": "onKeyDown",
|
17077
17054
|
"inheritedFrom": {
|
17078
17055
|
"name": "ListItem",
|
17079
17056
|
"module": "src/components/listitem/listitem.component.ts"
|
17080
17057
|
}
|
17081
17058
|
},
|
17082
17059
|
{
|
17083
|
-
"description": "(React:
|
17084
|
-
"name": "
|
17085
|
-
"reactName": "
|
17060
|
+
"description": "(React: onKeyUp) This event is dispatched when a key is released on the menuitem.",
|
17061
|
+
"name": "keyup",
|
17062
|
+
"reactName": "onKeyUp",
|
17086
17063
|
"inheritedFrom": {
|
17087
17064
|
"name": "ListItem",
|
17088
17065
|
"module": "src/components/listitem/listitem.component.ts"
|
@@ -17090,13 +17067,35 @@
|
|
17090
17067
|
}
|
17091
17068
|
],
|
17092
17069
|
"attributes": [
|
17070
|
+
{
|
17071
|
+
"name": "checked",
|
17072
|
+
"type": {
|
17073
|
+
"text": "boolean"
|
17074
|
+
},
|
17075
|
+
"default": "false",
|
17076
|
+
"description": "The checked attribute is used to indicate that the menuitemcheckbox is checked or not.",
|
17077
|
+
"fieldName": "checked"
|
17078
|
+
},
|
17079
|
+
{
|
17080
|
+
"name": "indicator",
|
17081
|
+
"type": {
|
17082
|
+
"text": "Indicator"
|
17083
|
+
},
|
17084
|
+
"description": "The indicator attribute is used to differentiate between <b>checkbox</b> and <b>toggle</b>.",
|
17085
|
+
"default": "'checkbox'",
|
17086
|
+
"fieldName": "indicator"
|
17087
|
+
},
|
17093
17088
|
{
|
17094
17089
|
"name": "arrow-position",
|
17095
17090
|
"type": {
|
17096
17091
|
"text": "ArrowPositions | undefined"
|
17097
17092
|
},
|
17098
17093
|
"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.",
|
17099
|
-
"fieldName": "arrowPosition"
|
17094
|
+
"fieldName": "arrowPosition",
|
17095
|
+
"inheritedFrom": {
|
17096
|
+
"name": "MenuItem",
|
17097
|
+
"module": "src/components/menuitem/menuitem.component.ts"
|
17098
|
+
}
|
17100
17099
|
},
|
17101
17100
|
{
|
17102
17101
|
"name": "arrow-direction",
|
@@ -17104,7 +17103,11 @@
|
|
17104
17103
|
"text": "ArrowDirections | undefined"
|
17105
17104
|
},
|
17106
17105
|
"description": "Defines the direction the arrow icon points.\n- `'positive'`: Arrow points toward the trailing side.\n- `'negative'`: Arrow points toward the leading side.",
|
17107
|
-
"fieldName": "arrowDirection"
|
17106
|
+
"fieldName": "arrowDirection",
|
17107
|
+
"inheritedFrom": {
|
17108
|
+
"name": "MenuItem",
|
17109
|
+
"module": "src/components/menuitem/menuitem.component.ts"
|
17110
|
+
}
|
17108
17111
|
},
|
17109
17112
|
{
|
17110
17113
|
"name": "name",
|
@@ -17113,7 +17116,11 @@
|
|
17113
17116
|
},
|
17114
17117
|
"default": "undefined",
|
17115
17118
|
"description": "The name attribute is used to identify the menu item when it is selected.",
|
17116
|
-
"fieldName": "name"
|
17119
|
+
"fieldName": "name",
|
17120
|
+
"inheritedFrom": {
|
17121
|
+
"name": "MenuItem",
|
17122
|
+
"module": "src/components/menuitem/menuitem.component.ts"
|
17123
|
+
}
|
17117
17124
|
},
|
17118
17125
|
{
|
17119
17126
|
"name": "value",
|
@@ -17122,7 +17129,11 @@
|
|
17122
17129
|
},
|
17123
17130
|
"default": "undefined",
|
17124
17131
|
"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.",
|
17125
|
-
"fieldName": "value"
|
17132
|
+
"fieldName": "value",
|
17133
|
+
"inheritedFrom": {
|
17134
|
+
"name": "MenuItem",
|
17135
|
+
"module": "src/components/menuitem/menuitem.component.ts"
|
17136
|
+
}
|
17126
17137
|
},
|
17127
17138
|
{
|
17128
17139
|
"name": "disabled",
|
@@ -17263,11 +17274,11 @@
|
|
17263
17274
|
}
|
17264
17275
|
],
|
17265
17276
|
"superclass": {
|
17266
|
-
"name": "
|
17267
|
-
"module": "/src/components/
|
17277
|
+
"name": "MenuItem",
|
17278
|
+
"module": "/src/components/menuitem/menuitem.component"
|
17268
17279
|
},
|
17269
|
-
"tagName": "mdc-
|
17270
|
-
"jsDoc": "/**\n *
|
17280
|
+
"tagName": "mdc-menuitemcheckbox",
|
17281
|
+
"jsDoc": "/**\n * A menuitemcheckbox component is a checkable menuitem.\n * There should be no focusable descendants inside this menuitemcheckbox component.\n *\n * The `checked` attribute indicates whether the menuitemcheckbox is checked or not.\n *\n * Menu item checkbox has `name` and `value` attribute that can be used to identify the menu item when it is selected.\n *\n * The `indicator` attribute is used to differentiate between <b>checkbox</b>, <b>checkmark</b>, <b>toggle</b> and <b>none</b>.\n * By default, the `indicator` is set to <b>checkbox</b>.<br/>\n *\n * The checkbox will always be positioned on the leading side of the menuitem label and\n * the toggle and checkmark will always be positioned on the trailing side.\n *\n * The checkbox will have the possible states of `true` or `false`.\n * If the indicator is set to <b>checkmark</b> and if the `checked` attribute is set to `true`,\n * then the checkmark will be displayed. if not, then no indicator will be displayed.\n *\n * The forth options for the `indicator` is <b>none</b>, which will not display any indicator at all.\n * It is intended to be used for customised menu items where the indicator is implemented differently.\n * For example, you can use a custom icon or a different visual element to indicate the state of the menu item.\n * Make sure the new indicator is accessible.\n *\n * If you want only one item in a group to be checked, consider using menuitemradio component.\n *\n * @dependency mdc-staticcheckbox\n * @dependency mdc-statictoggle\n * @dependency mdc-icon\n *\n * @tagname mdc-menuitemcheckbox\n *\n * @slot leading-controls - slot for menu item checkbox controls to appear of leading end.\n * @slot leading-text-primary-label - slot for menu item checkbox primary label.\n * @slot leading-text-secondary-label - slot for menu item checkbox secondary label.\n * @slot leading-text-tertiary-label - slot for menu item checkbox tertiary label.\n * @slot trailing-text-side-header - slot for menu item checkbox side header text.\n * @slot trailing-text-subline - slot for menu item checkbox subline text.\n * @slot trailing-controls - slot for menu item checkbox controls to appear of trailing end.\n *\n * @event change - (React: onChange) This event is dispatched when the menuitemcheckbox changes.\n * @event click - (React: onClick) This event is dispatched when the menuitemcheckbox is clicked.\n * @event focus - (React: onFocus) This event is dispatched when the menuitemcheckbox receives focus.\n */",
|
17271
17282
|
"customElement": true,
|
17272
17283
|
"cssProperties": [
|
17273
17284
|
{
|
@@ -17342,8 +17353,8 @@
|
|
17342
17353
|
"kind": "js",
|
17343
17354
|
"name": "default",
|
17344
17355
|
"declaration": {
|
17345
|
-
"name": "
|
17346
|
-
"module": "components/
|
17356
|
+
"name": "MenuItemCheckbox",
|
17357
|
+
"module": "components/menuitemcheckbox/menuitemcheckbox.component.js"
|
17347
17358
|
}
|
17348
17359
|
}
|
17349
17360
|
]
|
@@ -20226,6 +20237,17 @@
|
|
20226
20237
|
"description": "Name of the icon rendered before the text\n\nIf not provided, no icon will be rendered and text will be aligned to the start.",
|
20227
20238
|
"attribute": "prefix-icon"
|
20228
20239
|
},
|
20240
|
+
{
|
20241
|
+
"kind": "field",
|
20242
|
+
"name": "showDivider",
|
20243
|
+
"type": {
|
20244
|
+
"text": "boolean"
|
20245
|
+
},
|
20246
|
+
"default": "false",
|
20247
|
+
"description": "Whether to show a divider below the section header.\nThis is useful for visually separating sections in the menu.",
|
20248
|
+
"attribute": "show-divider",
|
20249
|
+
"reflects": true
|
20250
|
+
},
|
20229
20251
|
{
|
20230
20252
|
"kind": "method",
|
20231
20253
|
"name": "renderHeader",
|
@@ -20265,6 +20287,15 @@
|
|
20265
20287
|
},
|
20266
20288
|
"description": "Name of the icon rendered before the text\n\nIf not provided, no icon will be rendered and text will be aligned to the start.",
|
20267
20289
|
"fieldName": "prefixIcon"
|
20290
|
+
},
|
20291
|
+
{
|
20292
|
+
"name": "show-divider",
|
20293
|
+
"type": {
|
20294
|
+
"text": "boolean"
|
20295
|
+
},
|
20296
|
+
"default": "false",
|
20297
|
+
"description": "Whether to show a divider below the section header.\nThis is useful for visually separating sections in the menu.",
|
20298
|
+
"fieldName": "showDivider"
|
20268
20299
|
}
|
20269
20300
|
],
|
20270
20301
|
"superclass": {
|
@@ -20289,56 +20320,56 @@
|
|
20289
20320
|
},
|
20290
20321
|
{
|
20291
20322
|
"kind": "javascript-module",
|
20292
|
-
"path": "components/
|
20323
|
+
"path": "components/navmenuitem/navmenuitem.component.js",
|
20293
20324
|
"declarations": [
|
20294
20325
|
{
|
20295
20326
|
"kind": "class",
|
20296
|
-
"description": "`mdc-
|
20297
|
-
"name": "
|
20327
|
+
"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.",
|
20328
|
+
"name": "NavMenuItem",
|
20298
20329
|
"cssProperties": [
|
20299
20330
|
{
|
20300
|
-
"description": "Text color of the
|
20301
|
-
"name": "--mdc-
|
20331
|
+
"description": "Text color of the navmenuitem in its normal state.",
|
20332
|
+
"name": "--mdc-navmenuitem-color"
|
20302
20333
|
},
|
20303
20334
|
{
|
20304
|
-
"description": "Border color of the
|
20305
|
-
"name": "--mdc-
|
20335
|
+
"description": "Border color of the navmenuitem in its normal state.",
|
20336
|
+
"name": "--mdc-navmenuitem-border-color"
|
20306
20337
|
},
|
20307
20338
|
{
|
20308
|
-
"description": "Text color of the
|
20309
|
-
"name": "--mdc-
|
20339
|
+
"description": "Text color of the navmenuitem when disabled.",
|
20340
|
+
"name": "--mdc-navmenuitem-disabled-color"
|
20310
20341
|
},
|
20311
20342
|
{
|
20312
|
-
"description": "Width of the
|
20313
|
-
"name": "--mdc-
|
20343
|
+
"description": "Width of the navmenuitem when expanded.",
|
20344
|
+
"name": "--mdc-navmenuitem-expanded-width"
|
20314
20345
|
},
|
20315
20346
|
{
|
20316
|
-
"description": "Background color of the
|
20317
|
-
"name": "--mdc-
|
20347
|
+
"description": "Background color of the navmenuitem when hovered.",
|
20348
|
+
"name": "--mdc-navmenuitem-hover-background-color"
|
20318
20349
|
},
|
20319
20350
|
{
|
20320
|
-
"description": "Background color of the active
|
20321
|
-
"name": "--mdc-
|
20351
|
+
"description": "Background color of the active navmenuitem when hovered.",
|
20352
|
+
"name": "--mdc-navmenuitem-hover-active-background-color"
|
20322
20353
|
},
|
20323
20354
|
{
|
20324
|
-
"description": "Background color of the
|
20325
|
-
"name": "--mdc-
|
20355
|
+
"description": "Background color of the navmenuitem when pressed.",
|
20356
|
+
"name": "--mdc-navmenuitem-pressed-background-color"
|
20326
20357
|
},
|
20327
20358
|
{
|
20328
|
-
"description": "Background color of the active
|
20329
|
-
"name": "--mdc-
|
20359
|
+
"description": "Background color of the active navmenuitem when pressed.",
|
20360
|
+
"name": "--mdc-navmenuitem-pressed-active-background-color"
|
20330
20361
|
},
|
20331
20362
|
{
|
20332
|
-
"description": "Background color of the
|
20333
|
-
"name": "--mdc-
|
20363
|
+
"description": "Background color of the navmenuitem when disabled.",
|
20364
|
+
"name": "--mdc-navmenuitem-disabled-background-color"
|
20334
20365
|
},
|
20335
20366
|
{
|
20336
|
-
"description": "Background color of the active
|
20337
|
-
"name": "--mdc-
|
20367
|
+
"description": "Background color of the active navmenuitem when disabled.",
|
20368
|
+
"name": "--mdc-navmenuitem-disabled-active-background-color"
|
20338
20369
|
},
|
20339
20370
|
{
|
20340
20371
|
"description": "Background color of the active nav item in its rest state.",
|
20341
|
-
"name": "--mdc-
|
20372
|
+
"name": "--mdc-navmenuitem-rest-active-background-color"
|
20342
20373
|
},
|
20343
20374
|
{
|
20344
20375
|
"description": "Allows customization of the default background color.",
|
@@ -20412,7 +20443,7 @@
|
|
20412
20443
|
"type": {
|
20413
20444
|
"text": "boolean | undefined"
|
20414
20445
|
},
|
20415
|
-
"description": "The
|
20446
|
+
"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.",
|
20416
20447
|
"default": "undefined",
|
20417
20448
|
"attribute": "active",
|
20418
20449
|
"reflects": true
|
@@ -20454,7 +20485,7 @@
|
|
20454
20485
|
"type": {
|
20455
20486
|
"text": "string | undefined"
|
20456
20487
|
},
|
20457
|
-
"description": "Id of the
|
20488
|
+
"description": "Id of the navMenuItem (used as a identificator when used in the menubar)\nNote: It has to be unique.",
|
20458
20489
|
"default": "undefined",
|
20459
20490
|
"attribute": "nav-id",
|
20460
20491
|
"reflects": true
|
@@ -20475,7 +20506,7 @@
|
|
20475
20506
|
"type": {
|
20476
20507
|
"text": "boolean | undefined"
|
20477
20508
|
},
|
20478
|
-
"description": "When set to true, prevents the automatic setting of the `aria-current` attribute on the
|
20509
|
+
"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.",
|
20479
20510
|
"attribute": "disable-aria-current",
|
20480
20511
|
"reflects": true
|
20481
20512
|
},
|
@@ -20488,7 +20519,7 @@
|
|
20488
20519
|
"text": "boolean"
|
20489
20520
|
}
|
20490
20521
|
},
|
20491
|
-
"description": "Check whether the
|
20522
|
+
"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."
|
20492
20523
|
},
|
20493
20524
|
{
|
20494
20525
|
"kind": "method",
|
@@ -20993,7 +21024,7 @@
|
|
20993
21024
|
],
|
20994
21025
|
"events": [
|
20995
21026
|
{
|
20996
|
-
"description": "(React: onClick) This event is dispatched when the
|
21027
|
+
"description": "(React: onClick) This event is dispatched when the navmenuitem is clicked.",
|
20997
21028
|
"name": "click",
|
20998
21029
|
"reactName": "onClick",
|
20999
21030
|
"inheritedFrom": {
|
@@ -21002,7 +21033,7 @@
|
|
21002
21033
|
}
|
21003
21034
|
},
|
21004
21035
|
{
|
21005
|
-
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the
|
21036
|
+
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the navmenuitem.",
|
21006
21037
|
"name": "keydown",
|
21007
21038
|
"reactName": "onKeyDown",
|
21008
21039
|
"inheritedFrom": {
|
@@ -21011,7 +21042,7 @@
|
|
21011
21042
|
}
|
21012
21043
|
},
|
21013
21044
|
{
|
21014
|
-
"description": "(React: onKeyUp) This event is dispatched when a key is released on the
|
21045
|
+
"description": "(React: onKeyUp) This event is dispatched when a key is released on the navmenuitem.",
|
21015
21046
|
"name": "keyup",
|
21016
21047
|
"reactName": "onKeyUp",
|
21017
21048
|
"inheritedFrom": {
|
@@ -21020,7 +21051,7 @@
|
|
21020
21051
|
}
|
21021
21052
|
},
|
21022
21053
|
{
|
21023
|
-
"description": "(React: onFocus) This event is dispatched when the
|
21054
|
+
"description": "(React: onFocus) This event is dispatched when the navmenuitem receives focus.",
|
21024
21055
|
"name": "focus",
|
21025
21056
|
"reactName": "onFocus",
|
21026
21057
|
"inheritedFrom": {
|
@@ -21029,7 +21060,7 @@
|
|
21029
21060
|
}
|
21030
21061
|
},
|
21031
21062
|
{
|
21032
|
-
"description": "(React: onActiveChange) Dispatched when the active state of the
|
21063
|
+
"description": "(React: onActiveChange) Dispatched when the active state of the navmenuitem changes.",
|
21033
21064
|
"name": "activechange",
|
21034
21065
|
"reactName": "onActiveChange"
|
21035
21066
|
}
|
@@ -21040,7 +21071,7 @@
|
|
21040
21071
|
"type": {
|
21041
21072
|
"text": "boolean | undefined"
|
21042
21073
|
},
|
21043
|
-
"description": "The
|
21074
|
+
"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.",
|
21044
21075
|
"default": "undefined",
|
21045
21076
|
"fieldName": "active"
|
21046
21077
|
},
|
@@ -21074,7 +21105,7 @@
|
|
21074
21105
|
"type": {
|
21075
21106
|
"text": "string | undefined"
|
21076
21107
|
},
|
21077
|
-
"description": "Id of the
|
21108
|
+
"description": "Id of the navMenuItem (used as a identificator when used in the menubar)\nNote: It has to be unique.",
|
21078
21109
|
"default": "undefined",
|
21079
21110
|
"fieldName": "navId"
|
21080
21111
|
},
|
@@ -21092,7 +21123,7 @@
|
|
21092
21123
|
"type": {
|
21093
21124
|
"text": "boolean | undefined"
|
21094
21125
|
},
|
21095
|
-
"description": "When set to true, prevents the automatic setting of the `aria-current` attribute on the
|
21126
|
+
"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.",
|
21096
21127
|
"fieldName": "disableAriaCurrent"
|
21097
21128
|
},
|
21098
21129
|
{
|
@@ -21247,541 +21278,125 @@
|
|
21247
21278
|
{
|
21248
21279
|
"name": "subline-text",
|
21249
21280
|
"type": {
|
21250
|
-
"text": "string | undefined"
|
21251
|
-
},
|
21252
|
-
"description": "The subline text of the list item.\nThis appears on the trailing side of the list item.",
|
21253
|
-
"fieldName": "sublineText",
|
21254
|
-
"inheritedFrom": {
|
21255
|
-
"name": "ListItem",
|
21256
|
-
"module": "src/components/listitem/listitem.component.ts"
|
21257
|
-
}
|
21258
|
-
},
|
21259
|
-
{
|
21260
|
-
"name": "soft-disabled",
|
21261
|
-
"type": {
|
21262
|
-
"text": "boolean | undefined"
|
21263
|
-
},
|
21264
|
-
"description": "Indicates whether the element is soft disabled.\nWhen set to `true`, the element appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe element behaves like a disabled element, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
|
21265
|
-
"default": "undefined",
|
21266
|
-
"fieldName": "softDisabled",
|
21267
|
-
"inheritedFrom": {
|
21268
|
-
"name": "ListItem",
|
21269
|
-
"module": "src/components/listitem/listitem.component.ts"
|
21270
|
-
}
|
21271
|
-
},
|
21272
|
-
{
|
21273
|
-
"name": "tooltip-text",
|
21274
|
-
"type": {
|
21275
|
-
"text": "string | undefined"
|
21276
|
-
},
|
21277
|
-
"description": "The tooltip text is displayed on hover of the list item.",
|
21278
|
-
"fieldName": "tooltipText",
|
21279
|
-
"inheritedFrom": {
|
21280
|
-
"name": "ListItem",
|
21281
|
-
"module": "src/components/listitem/listitem.component.ts"
|
21282
|
-
}
|
21283
|
-
},
|
21284
|
-
{
|
21285
|
-
"name": "tooltip-placement",
|
21286
|
-
"type": {
|
21287
|
-
"text": "PopoverPlacement"
|
21288
|
-
},
|
21289
|
-
"description": "The tooltip placement of the list item. If the tooltip text is present,\nthen this tooltip placement will be applied.",
|
21290
|
-
"default": "'top'",
|
21291
|
-
"fieldName": "tooltipPlacement",
|
21292
|
-
"inheritedFrom": {
|
21293
|
-
"name": "ListItem",
|
21294
|
-
"module": "src/components/listitem/listitem.component.ts"
|
21295
|
-
}
|
21296
|
-
}
|
21297
|
-
],
|
21298
|
-
"mixins": [
|
21299
|
-
{
|
21300
|
-
"name": "IconNameMixin",
|
21301
|
-
"module": "/src/utils/mixins/IconNameMixin"
|
21302
|
-
}
|
21303
|
-
],
|
21304
|
-
"superclass": {
|
21305
|
-
"name": "MenuItem",
|
21306
|
-
"module": "/src/components/menuitem/menuitem.component"
|
21307
|
-
},
|
21308
|
-
"tagName": "mdc-navitem",
|
21309
|
-
"jsDoc": "/**\n * `mdc-navitem` 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-navitem` is intended to be used inside `mdc-navitemlist` 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 * @tagname mdc-navitem\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 navitem is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the navitem.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the navitem.\n * @event focus - (React: onFocus) This event is dispatched when the navitem receives focus.\n * @event activechange - (React: onActiveChange) Dispatched when the active state of the navitem changes.\n *\n * @cssproperty --mdc-navitem-color - Text color of the navitem in its normal state.\n * @cssproperty --mdc-navitem-border-color - Border color of the navitem in its normal state.\n * @cssproperty --mdc-navitem-disabled-color - Text color of the navitem when disabled.\n * @cssproperty --mdc-navitem-expanded-width - Width of the navItem when expanded.\n * @cssproperty --mdc-navitem-hover-background-color - Background color of the navitem when hovered.\n * @cssproperty --mdc-navitem-hover-active-background-color - Background color of the active navitem when hovered.\n * @cssproperty --mdc-navitem-pressed-background-color - Background color of the navitem when pressed.\n * @cssproperty --mdc-navitem-pressed-active-background-color - Background color of the active navitem when pressed.\n * @cssproperty --mdc-navitem-disabled-background-color - Background color of the navitem when disabled.\n * @cssproperty --mdc-navitem-disabled-active-background-color - Background color of the active navitem when disabled.\n * @cssproperty --mdc-navitem-rest-active-background-color - Background color of the active nav item in its rest state.\n */",
|
21310
|
-
"customElement": true,
|
21311
|
-
"slots": [
|
21312
|
-
{
|
21313
|
-
"description": "slot for menu item controls to appear of leading end.",
|
21314
|
-
"name": "leading-controls",
|
21315
|
-
"inheritedFrom": {
|
21316
|
-
"name": "ListItem",
|
21317
|
-
"module": "src/components/listitem/listitem.component.ts"
|
21318
|
-
}
|
21319
|
-
},
|
21320
|
-
{
|
21321
|
-
"description": "slot for menu item primary label.",
|
21322
|
-
"name": "leading-text-primary-label",
|
21323
|
-
"inheritedFrom": {
|
21324
|
-
"name": "ListItem",
|
21325
|
-
"module": "src/components/listitem/listitem.component.ts"
|
21326
|
-
}
|
21327
|
-
},
|
21328
|
-
{
|
21329
|
-
"description": "slot for menu item secondary label.",
|
21330
|
-
"name": "leading-text-secondary-label",
|
21331
|
-
"inheritedFrom": {
|
21332
|
-
"name": "ListItem",
|
21333
|
-
"module": "src/components/listitem/listitem.component.ts"
|
21334
|
-
}
|
21335
|
-
},
|
21336
|
-
{
|
21337
|
-
"description": "slot for menu item tertiary label.",
|
21338
|
-
"name": "leading-text-tertiary-label",
|
21339
|
-
"inheritedFrom": {
|
21340
|
-
"name": "ListItem",
|
21341
|
-
"module": "src/components/listitem/listitem.component.ts"
|
21342
|
-
}
|
21343
|
-
},
|
21344
|
-
{
|
21345
|
-
"description": "slot for menu item side header text.",
|
21346
|
-
"name": "trailing-text-side-header",
|
21347
|
-
"inheritedFrom": {
|
21348
|
-
"name": "ListItem",
|
21349
|
-
"module": "src/components/listitem/listitem.component.ts"
|
21350
|
-
}
|
21351
|
-
},
|
21352
|
-
{
|
21353
|
-
"description": "slot for menu item subline text.",
|
21354
|
-
"name": "trailing-text-subline",
|
21355
|
-
"inheritedFrom": {
|
21356
|
-
"name": "ListItem",
|
21357
|
-
"module": "src/components/listitem/listitem.component.ts"
|
21358
|
-
}
|
21359
|
-
},
|
21360
|
-
{
|
21361
|
-
"description": "slot for menu item controls to appear of trailing end.",
|
21362
|
-
"name": "trailing-controls",
|
21363
|
-
"inheritedFrom": {
|
21364
|
-
"name": "ListItem",
|
21365
|
-
"module": "src/components/listitem/listitem.component.ts"
|
21366
|
-
}
|
21367
|
-
}
|
21368
|
-
]
|
21369
|
-
}
|
21370
|
-
],
|
21371
|
-
"exports": [
|
21372
|
-
{
|
21373
|
-
"kind": "js",
|
21374
|
-
"name": "default",
|
21375
|
-
"declaration": {
|
21376
|
-
"name": "NavItem",
|
21377
|
-
"module": "components/navitem/navitem.component.js"
|
21378
|
-
}
|
21379
|
-
}
|
21380
|
-
]
|
21381
|
-
},
|
21382
|
-
{
|
21383
|
-
"kind": "javascript-module",
|
21384
|
-
"path": "components/navitemlist/navitemlist.component.js",
|
21385
|
-
"declarations": [
|
21386
|
-
{
|
21387
|
-
"kind": "class",
|
21388
|
-
"description": "`mdc-navitemlist` is a container component used to group multiple mdc-navitem elements into a navigation list.\nIt provides the structural foundation for organizing vertical nav items and\nensures consistent behavior and layout within side navigation patterns.\n\nNote: mdc-navitemlist is typically used within the sidenavigation component.",
|
21389
|
-
"name": "NavItemList",
|
21390
|
-
"slots": [
|
21391
|
-
{
|
21392
|
-
"description": "Slot for projecting one or more navigation items, optional section headers and dividers.",
|
21393
|
-
"name": "default",
|
21394
|
-
"inheritedFrom": {
|
21395
|
-
"name": "MenuBar",
|
21396
|
-
"module": "src/components/menubar/menubar.component.ts"
|
21397
|
-
}
|
21398
|
-
}
|
21399
|
-
],
|
21400
|
-
"members": [
|
21401
|
-
{
|
21402
|
-
"kind": "field",
|
21403
|
-
"name": "ariaLabel",
|
21404
|
-
"type": {
|
21405
|
-
"text": "string | null"
|
21406
|
-
},
|
21407
|
-
"default": "null",
|
21408
|
-
"description": "Aria-label attribute to be set for accessibility",
|
21409
|
-
"attribute": "aria-label"
|
21410
|
-
},
|
21411
|
-
{
|
21412
|
-
"kind": "field",
|
21413
|
-
"name": "navItems",
|
21414
|
-
"type": {
|
21415
|
-
"text": "NavItem[]"
|
21416
|
-
},
|
21417
|
-
"privacy": "private",
|
21418
|
-
"description": "Returns all nested, non-disabled mdc-navitem elements inside this component.",
|
21419
|
-
"readonly": true
|
21420
|
-
},
|
21421
|
-
{
|
21422
|
-
"kind": "field",
|
21423
|
-
"name": "menuItems",
|
21424
|
-
"type": {
|
21425
|
-
"text": "Array<HTMLElement>"
|
21426
|
-
},
|
21427
|
-
"description": "Returns all menuitem elements, including those nested inside menusection.",
|
21428
|
-
"readonly": true,
|
21429
|
-
"inheritedFrom": {
|
21430
|
-
"name": "MenuBar",
|
21431
|
-
"module": "components/menubar/menubar.component.js"
|
21432
|
-
}
|
21433
|
-
},
|
21434
|
-
{
|
21435
|
-
"kind": "method",
|
21436
|
-
"name": "resetTabIndexAndSetActiveTabIndex",
|
21437
|
-
"privacy": "private",
|
21438
|
-
"parameters": [
|
21439
|
-
{
|
21440
|
-
"name": "menuItems",
|
21441
|
-
"type": {
|
21442
|
-
"text": "Array<HTMLElement>"
|
21443
|
-
}
|
21444
|
-
},
|
21445
|
-
{
|
21446
|
-
"description": "The index of the new active element in the list.",
|
21447
|
-
"name": "newIndex"
|
21448
|
-
}
|
21449
|
-
],
|
21450
|
-
"description": "Resets all list items tabindex to -1 and sets the tabindex of the\nelement at the given index to 0, effectively setting the active\nelement. This is used when navigating the list via keyboard.",
|
21451
|
-
"inheritedFrom": {
|
21452
|
-
"name": "MenuBar",
|
21453
|
-
"module": "components/menubar/menubar.component.js"
|
21454
|
-
}
|
21455
|
-
},
|
21456
|
-
{
|
21457
|
-
"kind": "method",
|
21458
|
-
"name": "getCurrentIndex",
|
21459
|
-
"privacy": "private",
|
21460
|
-
"return": {
|
21461
|
-
"type": {
|
21462
|
-
"text": "number"
|
21463
|
-
}
|
21464
|
-
},
|
21465
|
-
"parameters": [
|
21466
|
-
{
|
21467
|
-
"name": "target",
|
21468
|
-
"type": {
|
21469
|
-
"text": "EventTarget | null"
|
21470
|
-
}
|
21471
|
-
}
|
21472
|
-
],
|
21473
|
-
"inheritedFrom": {
|
21474
|
-
"name": "MenuBar",
|
21475
|
-
"module": "components/menubar/menubar.component.js"
|
21476
|
-
}
|
21477
|
-
},
|
21478
|
-
{
|
21479
|
-
"kind": "method",
|
21480
|
-
"name": "updatePopoverPlacement",
|
21481
|
-
"privacy": "private",
|
21482
|
-
"return": {
|
21483
|
-
"type": {
|
21484
|
-
"text": "void"
|
21485
|
-
}
|
21486
|
-
},
|
21487
|
-
"inheritedFrom": {
|
21488
|
-
"name": "MenuBar",
|
21489
|
-
"module": "components/menubar/menubar.component.js"
|
21490
|
-
}
|
21491
|
-
},
|
21492
|
-
{
|
21493
|
-
"kind": "method",
|
21494
|
-
"name": "updateTabIndexAndFocus",
|
21495
|
-
"privacy": "private",
|
21496
|
-
"return": {
|
21497
|
-
"type": {
|
21498
|
-
"text": "void"
|
21499
|
-
}
|
21500
|
-
},
|
21501
|
-
"parameters": [
|
21502
|
-
{
|
21503
|
-
"name": "menuItems",
|
21504
|
-
"type": {
|
21505
|
-
"text": "HTMLElement[]"
|
21506
|
-
}
|
21507
|
-
},
|
21508
|
-
{
|
21509
|
-
"name": "currentIndex",
|
21510
|
-
"type": {
|
21511
|
-
"text": "number"
|
21512
|
-
}
|
21513
|
-
},
|
21514
|
-
{
|
21515
|
-
"name": "newIndex",
|
21516
|
-
"type": {
|
21517
|
-
"text": "number"
|
21518
|
-
}
|
21519
|
-
}
|
21520
|
-
],
|
21521
|
-
"inheritedFrom": {
|
21522
|
-
"name": "MenuBar",
|
21523
|
-
"module": "components/menubar/menubar.component.js"
|
21524
|
-
}
|
21525
|
-
},
|
21526
|
-
{
|
21527
|
-
"kind": "method",
|
21528
|
-
"name": "navigateToMenuItem",
|
21529
|
-
"privacy": "private",
|
21530
|
-
"return": {
|
21531
|
-
"type": {
|
21532
|
-
"text": "void"
|
21533
|
-
}
|
21534
|
-
},
|
21535
|
-
"parameters": [
|
21536
|
-
{
|
21537
|
-
"name": "currentIndex",
|
21538
|
-
"type": {
|
21539
|
-
"text": "number"
|
21540
|
-
}
|
21541
|
-
},
|
21542
|
-
{
|
21543
|
-
"name": "direction",
|
21544
|
-
"type": {
|
21545
|
-
"text": "'prev' | 'next'"
|
21546
|
-
}
|
21547
|
-
},
|
21548
|
-
{
|
21549
|
-
"name": "shouldOpenSubmenu",
|
21550
|
-
"default": "false"
|
21551
|
-
}
|
21552
|
-
],
|
21281
|
+
"text": "string | undefined"
|
21282
|
+
},
|
21283
|
+
"description": "The subline text of the list item.\nThis appears on the trailing side of the list item.",
|
21284
|
+
"fieldName": "sublineText",
|
21553
21285
|
"inheritedFrom": {
|
21554
|
-
"name": "
|
21555
|
-
"module": "components/
|
21286
|
+
"name": "ListItem",
|
21287
|
+
"module": "src/components/listitem/listitem.component.ts"
|
21556
21288
|
}
|
21557
21289
|
},
|
21558
21290
|
{
|
21559
|
-
"
|
21560
|
-
"
|
21561
|
-
|
21562
|
-
"return": {
|
21563
|
-
"type": {
|
21564
|
-
"text": "void"
|
21565
|
-
}
|
21291
|
+
"name": "soft-disabled",
|
21292
|
+
"type": {
|
21293
|
+
"text": "boolean | undefined"
|
21566
21294
|
},
|
21567
|
-
"
|
21568
|
-
|
21569
|
-
|
21570
|
-
"type": {
|
21571
|
-
"text": "string | null"
|
21572
|
-
}
|
21573
|
-
}
|
21574
|
-
],
|
21295
|
+
"description": "Indicates whether the element is soft disabled.\nWhen set to `true`, the element appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe element behaves like a disabled element, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
|
21296
|
+
"default": "undefined",
|
21297
|
+
"fieldName": "softDisabled",
|
21575
21298
|
"inheritedFrom": {
|
21576
|
-
"name": "
|
21577
|
-
"module": "components/
|
21299
|
+
"name": "ListItem",
|
21300
|
+
"module": "src/components/listitem/listitem.component.ts"
|
21578
21301
|
}
|
21579
21302
|
},
|
21580
21303
|
{
|
21581
|
-
"
|
21582
|
-
"
|
21583
|
-
|
21584
|
-
"return": {
|
21585
|
-
"type": {
|
21586
|
-
"text": "string"
|
21587
|
-
}
|
21304
|
+
"name": "tooltip-text",
|
21305
|
+
"type": {
|
21306
|
+
"text": "string | undefined"
|
21588
21307
|
},
|
21589
|
-
"
|
21590
|
-
|
21591
|
-
"name": "originalKey",
|
21592
|
-
"type": {
|
21593
|
-
"text": "string"
|
21594
|
-
}
|
21595
|
-
}
|
21596
|
-
],
|
21308
|
+
"description": "The tooltip text is displayed on hover of the list item.",
|
21309
|
+
"fieldName": "tooltipText",
|
21597
21310
|
"inheritedFrom": {
|
21598
|
-
"name": "
|
21599
|
-
"module": "components/
|
21311
|
+
"name": "ListItem",
|
21312
|
+
"module": "src/components/listitem/listitem.component.ts"
|
21600
21313
|
}
|
21601
21314
|
},
|
21602
21315
|
{
|
21603
|
-
"
|
21604
|
-
"
|
21605
|
-
|
21606
|
-
"return": {
|
21607
|
-
"type": {
|
21608
|
-
"text": "boolean"
|
21609
|
-
}
|
21316
|
+
"name": "tooltip-placement",
|
21317
|
+
"type": {
|
21318
|
+
"text": "PopoverPlacement"
|
21610
21319
|
},
|
21611
|
-
"
|
21612
|
-
|
21613
|
-
|
21614
|
-
"type": {
|
21615
|
-
"text": "HTMLElement"
|
21616
|
-
}
|
21617
|
-
}
|
21618
|
-
],
|
21619
|
-
"description": "Determines if a menuitem is a top-level menuitem (direct child of menubar or child of menusection whose parent is menubar)",
|
21320
|
+
"description": "The tooltip placement of the list item. If the tooltip text is present,\nthen this tooltip placement will be applied.",
|
21321
|
+
"default": "'top'",
|
21322
|
+
"fieldName": "tooltipPlacement",
|
21620
21323
|
"inheritedFrom": {
|
21621
|
-
"name": "
|
21622
|
-
"module": "components/
|
21324
|
+
"name": "ListItem",
|
21325
|
+
"module": "src/components/listitem/listitem.component.ts"
|
21623
21326
|
}
|
21624
|
-
}
|
21327
|
+
}
|
21328
|
+
],
|
21329
|
+
"mixins": [
|
21625
21330
|
{
|
21626
|
-
"
|
21627
|
-
"
|
21628
|
-
|
21629
|
-
|
21630
|
-
|
21631
|
-
|
21632
|
-
|
21633
|
-
|
21634
|
-
|
21635
|
-
|
21636
|
-
|
21637
|
-
|
21638
|
-
|
21639
|
-
|
21640
|
-
|
21641
|
-
],
|
21331
|
+
"name": "IconNameMixin",
|
21332
|
+
"module": "/src/utils/mixins/IconNameMixin"
|
21333
|
+
}
|
21334
|
+
],
|
21335
|
+
"superclass": {
|
21336
|
+
"name": "MenuItem",
|
21337
|
+
"module": "/src/components/menuitem/menuitem.component"
|
21338
|
+
},
|
21339
|
+
"tagName": "mdc-navmenuitem",
|
21340
|
+
"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 * @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 */",
|
21341
|
+
"customElement": true,
|
21342
|
+
"slots": [
|
21343
|
+
{
|
21344
|
+
"description": "slot for menu item controls to appear of leading end.",
|
21345
|
+
"name": "leading-controls",
|
21642
21346
|
"inheritedFrom": {
|
21643
|
-
"name": "
|
21644
|
-
"module": "components/
|
21347
|
+
"name": "ListItem",
|
21348
|
+
"module": "src/components/listitem/listitem.component.ts"
|
21645
21349
|
}
|
21646
21350
|
},
|
21647
21351
|
{
|
21648
|
-
"
|
21649
|
-
"name": "
|
21650
|
-
"privacy": "private",
|
21352
|
+
"description": "slot for menu item primary label.",
|
21353
|
+
"name": "leading-text-primary-label",
|
21651
21354
|
"inheritedFrom": {
|
21652
|
-
"name": "
|
21653
|
-
"module": "components/
|
21355
|
+
"name": "ListItem",
|
21356
|
+
"module": "src/components/listitem/listitem.component.ts"
|
21654
21357
|
}
|
21655
21358
|
},
|
21656
21359
|
{
|
21657
|
-
"
|
21658
|
-
"name": "
|
21659
|
-
"privacy": "private",
|
21660
|
-
"return": {
|
21661
|
-
"type": {
|
21662
|
-
"text": "Promise<void>"
|
21663
|
-
}
|
21664
|
-
},
|
21665
|
-
"parameters": [
|
21666
|
-
{
|
21667
|
-
"name": "element",
|
21668
|
-
"type": {
|
21669
|
-
"text": "HTMLElement"
|
21670
|
-
}
|
21671
|
-
}
|
21672
|
-
],
|
21360
|
+
"description": "slot for menu item secondary label.",
|
21361
|
+
"name": "leading-text-secondary-label",
|
21673
21362
|
"inheritedFrom": {
|
21674
|
-
"name": "
|
21675
|
-
"module": "components/
|
21363
|
+
"name": "ListItem",
|
21364
|
+
"module": "src/components/listitem/listitem.component.ts"
|
21676
21365
|
}
|
21677
21366
|
},
|
21678
21367
|
{
|
21679
|
-
"
|
21680
|
-
"name": "
|
21681
|
-
"privacy": "private",
|
21682
|
-
"return": {
|
21683
|
-
"type": {
|
21684
|
-
"text": "Promise<void>"
|
21685
|
-
}
|
21686
|
-
},
|
21687
|
-
"parameters": [
|
21688
|
-
{
|
21689
|
-
"name": "element",
|
21690
|
-
"type": {
|
21691
|
-
"text": "HTMLElement"
|
21692
|
-
}
|
21693
|
-
}
|
21694
|
-
],
|
21368
|
+
"description": "slot for menu item tertiary label.",
|
21369
|
+
"name": "leading-text-tertiary-label",
|
21695
21370
|
"inheritedFrom": {
|
21696
|
-
"name": "
|
21697
|
-
"module": "components/
|
21371
|
+
"name": "ListItem",
|
21372
|
+
"module": "src/components/listitem/listitem.component.ts"
|
21698
21373
|
}
|
21699
21374
|
},
|
21700
21375
|
{
|
21701
|
-
"
|
21702
|
-
"name": "
|
21703
|
-
"privacy": "private",
|
21704
|
-
"return": {
|
21705
|
-
"type": {
|
21706
|
-
"text": "boolean"
|
21707
|
-
}
|
21708
|
-
},
|
21709
|
-
"parameters": [
|
21710
|
-
{
|
21711
|
-
"name": "triggerId",
|
21712
|
-
"type": {
|
21713
|
-
"text": "string | null"
|
21714
|
-
}
|
21715
|
-
}
|
21716
|
-
],
|
21376
|
+
"description": "slot for menu item side header text.",
|
21377
|
+
"name": "trailing-text-side-header",
|
21717
21378
|
"inheritedFrom": {
|
21718
|
-
"name": "
|
21719
|
-
"module": "components/
|
21379
|
+
"name": "ListItem",
|
21380
|
+
"module": "src/components/listitem/listitem.component.ts"
|
21720
21381
|
}
|
21721
21382
|
},
|
21722
21383
|
{
|
21723
|
-
"
|
21724
|
-
"name": "
|
21725
|
-
"privacy": "private",
|
21726
|
-
"return": {
|
21727
|
-
"type": {
|
21728
|
-
"text": "number"
|
21729
|
-
}
|
21730
|
-
},
|
21731
|
-
"parameters": [
|
21732
|
-
{
|
21733
|
-
"name": "element",
|
21734
|
-
"type": {
|
21735
|
-
"text": "HTMLElement"
|
21736
|
-
}
|
21737
|
-
}
|
21738
|
-
],
|
21384
|
+
"description": "slot for menu item subline text.",
|
21385
|
+
"name": "trailing-text-subline",
|
21739
21386
|
"inheritedFrom": {
|
21740
|
-
"name": "
|
21741
|
-
"module": "components/
|
21387
|
+
"name": "ListItem",
|
21388
|
+
"module": "src/components/listitem/listitem.component.ts"
|
21742
21389
|
}
|
21743
21390
|
},
|
21744
21391
|
{
|
21745
|
-
"
|
21746
|
-
"name": "
|
21747
|
-
"privacy": "private",
|
21748
|
-
"return": {
|
21749
|
-
"type": {
|
21750
|
-
"text": "Promise<void>"
|
21751
|
-
}
|
21752
|
-
},
|
21753
|
-
"parameters": [
|
21754
|
-
{
|
21755
|
-
"name": "event",
|
21756
|
-
"type": {
|
21757
|
-
"text": "KeyboardEvent"
|
21758
|
-
}
|
21759
|
-
}
|
21760
|
-
],
|
21392
|
+
"description": "slot for menu item controls to appear of trailing end.",
|
21393
|
+
"name": "trailing-controls",
|
21761
21394
|
"inheritedFrom": {
|
21762
|
-
"name": "
|
21763
|
-
"module": "components/
|
21395
|
+
"name": "ListItem",
|
21396
|
+
"module": "src/components/listitem/listitem.component.ts"
|
21764
21397
|
}
|
21765
21398
|
}
|
21766
|
-
]
|
21767
|
-
"attributes": [
|
21768
|
-
{
|
21769
|
-
"name": "aria-label",
|
21770
|
-
"type": {
|
21771
|
-
"text": "string | null"
|
21772
|
-
},
|
21773
|
-
"default": "null",
|
21774
|
-
"description": "Aria-label attribute to be set for accessibility",
|
21775
|
-
"fieldName": "ariaLabel"
|
21776
|
-
}
|
21777
|
-
],
|
21778
|
-
"superclass": {
|
21779
|
-
"name": "MenuBar",
|
21780
|
-
"module": "/src/components/menubar/menubar.component"
|
21781
|
-
},
|
21782
|
-
"tagName": "mdc-navitemlist",
|
21783
|
-
"jsDoc": "/**\n * `mdc-navitemlist` is a container component used to group multiple mdc-navitem elements into a navigation list.\n * It provides the structural foundation for organizing vertical nav items and\n * ensures consistent behavior and layout within side navigation patterns.\n *\n * Note: mdc-navitemlist is typically used within the sidenavigation component.\n * @tagname mdc-navitemlist\n *\n * @slot default - Slot for projecting one or more navigation items, optional section headers and dividers.\n */",
|
21784
|
-
"customElement": true
|
21399
|
+
]
|
21785
21400
|
}
|
21786
21401
|
],
|
21787
21402
|
"exports": [
|
@@ -21789,8 +21404,8 @@
|
|
21789
21404
|
"kind": "js",
|
21790
21405
|
"name": "default",
|
21791
21406
|
"declaration": {
|
21792
|
-
"name": "
|
21793
|
-
"module": "components/
|
21407
|
+
"name": "NavMenuItem",
|
21408
|
+
"module": "components/navmenuitem/navmenuitem.component.js"
|
21794
21409
|
}
|
21795
21410
|
}
|
21796
21411
|
]
|
@@ -30344,7 +29959,7 @@
|
|
30344
29959
|
"declarations": [
|
30345
29960
|
{
|
30346
29961
|
"kind": "class",
|
30347
|
-
"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 four layout variants: `fixed-collapsed`, `fixed-expanded`, `flexible`, and `hidden`\n- Toggleable expand/collapse behavior\n- Displays brand logo and customer name\n- Serves as a context provider for descendant components - `mdc-
|
29962
|
+
"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 four layout variants: `fixed-collapsed`, `fixed-expanded`, `flexible`, 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",
|
30348
29963
|
"name": "SideNavigation",
|
30349
29964
|
"cssProperties": [
|
30350
29965
|
{
|
@@ -30391,13 +30006,13 @@
|
|
30391
30006
|
},
|
30392
30007
|
{
|
30393
30008
|
"kind": "field",
|
30394
|
-
"name": "
|
30009
|
+
"name": "footerText",
|
30395
30010
|
"type": {
|
30396
30011
|
"text": "string"
|
30397
30012
|
},
|
30398
30013
|
"default": "''",
|
30399
|
-
"description": "
|
30400
|
-
"attribute": "
|
30014
|
+
"description": "Displays footer text in the bottom section of the sidenavigation.",
|
30015
|
+
"attribute": "footer-text",
|
30401
30016
|
"reflects": true
|
30402
30017
|
},
|
30403
30018
|
{
|
@@ -30431,11 +30046,39 @@
|
|
30431
30046
|
}
|
30432
30047
|
},
|
30433
30048
|
"description": "Update all observing components of this\nprovider to update the values\n\nIs called on every re-render, see Provider class"
|
30049
|
+
},
|
30050
|
+
{
|
30051
|
+
"kind": "field",
|
30052
|
+
"name": "navMenuItems",
|
30053
|
+
"type": {
|
30054
|
+
"text": "NavMenuItem[]"
|
30055
|
+
},
|
30056
|
+
"privacy": "private",
|
30057
|
+
"description": "Returns all nested, non-disabled mdc-navmenuitem elements inside this component.",
|
30058
|
+
"readonly": true
|
30059
|
+
},
|
30060
|
+
{
|
30061
|
+
"kind": "method",
|
30062
|
+
"name": "preventScrollOnSpace",
|
30063
|
+
"privacy": "private",
|
30064
|
+
"return": {
|
30065
|
+
"type": {
|
30066
|
+
"text": "void"
|
30067
|
+
}
|
30068
|
+
},
|
30069
|
+
"parameters": [
|
30070
|
+
{
|
30071
|
+
"name": "event",
|
30072
|
+
"type": {
|
30073
|
+
"text": "KeyboardEvent"
|
30074
|
+
}
|
30075
|
+
}
|
30076
|
+
]
|
30434
30077
|
}
|
30435
30078
|
],
|
30436
30079
|
"events": [
|
30437
30080
|
{
|
30438
|
-
"description": "(React: onActiveChange) Dispatched when the active state of the
|
30081
|
+
"description": "(React: onActiveChange) Dispatched when the active state of the navmenuitem changes.",
|
30439
30082
|
"name": "activechange",
|
30440
30083
|
"reactName": "onActiveChange"
|
30441
30084
|
}
|
@@ -30451,13 +30094,13 @@
|
|
30451
30094
|
"fieldName": "variant"
|
30452
30095
|
},
|
30453
30096
|
{
|
30454
|
-
"name": "
|
30097
|
+
"name": "footer-text",
|
30455
30098
|
"type": {
|
30456
30099
|
"text": "string"
|
30457
30100
|
},
|
30458
30101
|
"default": "''",
|
30459
|
-
"description": "
|
30460
|
-
"fieldName": "
|
30102
|
+
"description": "Displays footer text in the bottom section of the sidenavigation.",
|
30103
|
+
"fieldName": "footerText"
|
30461
30104
|
},
|
30462
30105
|
{
|
30463
30106
|
"name": "grabber-btn-aria-label",
|
@@ -30482,7 +30125,7 @@
|
|
30482
30125
|
"module": "/src/models"
|
30483
30126
|
},
|
30484
30127
|
"tagName": "mdc-sidenavigation",
|
30485
|
-
"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 four layout variants: `fixed-collapsed`, `fixed-expanded`, `flexible`, and `hidden`\n * - Toggleable expand/collapse behavior\n * - Displays brand logo and customer name\n * - Serves as a context provider for descendant components - `mdc-
|
30128
|
+
"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 four layout variants: `fixed-collapsed`, `fixed-expanded`, `flexible`, 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 fixed-section - Slot for the fixed content area of the side navigation.\n * @slot brand-logo - Slot for the brand logo (e.g., icon or img).\n *\n * @cssproperty --mdc-sidenavigation-expanded-width - width of the sideNavigation when expanded\n * @cssproperty --mdc-sidenavigation-collapsed-width - width of the sideNavigation when collpased\n */",
|
30486
30129
|
"customElement": true
|
30487
30130
|
}
|
30488
30131
|
],
|