@momentum-design/components 0.91.2 → 0.92.1
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 +261 -241
- package/dist/browser/index.js.map +3 -3
- package/dist/components/menuitem/menuitem.component.d.ts +11 -0
- package/dist/components/menuitem/menuitem.component.js +11 -0
- package/dist/components/menuitemcheckbox/menuitemcheckbox.component.js +11 -4
- package/dist/components/menuitemcheckbox/menuitemcheckbox.styles.js +3 -0
- package/dist/components/menuitemradio/menuitemradio.component.js +11 -4
- package/dist/components/menuitemradio/menuitemradio.styles.js +3 -0
- package/dist/components/menupopover/menupopover.component.d.ts +49 -1
- package/dist/components/menupopover/menupopover.component.js +125 -17
- package/dist/components/menupopover/menupopover.utils.d.ts +1 -2
- package/dist/components/menupopover/menupopover.utils.js +1 -6
- package/dist/components/popover/popover.component.d.ts +5 -0
- package/dist/components/popover/popover.component.js +10 -1
- package/dist/components/popover/popover.constants.d.ts +1 -0
- package/dist/components/popover/popover.constants.js +1 -0
- package/dist/custom-elements.json +460 -269
- package/dist/react/index.d.ts +2 -2
- package/dist/react/index.js +2 -2
- package/dist/react/menupopover/index.d.ts +18 -0
- package/dist/react/menupopover/index.js +18 -0
- package/package.json +1 -1
@@ -2190,6 +2190,77 @@
|
|
2190
2190
|
}
|
2191
2191
|
]
|
2192
2192
|
},
|
2193
|
+
{
|
2194
|
+
"kind": "javascript-module",
|
2195
|
+
"path": "components/bullet/bullet.component.js",
|
2196
|
+
"declarations": [
|
2197
|
+
{
|
2198
|
+
"kind": "class",
|
2199
|
+
"description": "Bullet component, which is a visual marker\nand be used to organize and present items in a list format.",
|
2200
|
+
"name": "Bullet",
|
2201
|
+
"cssProperties": [
|
2202
|
+
{
|
2203
|
+
"description": "background color of the bullet",
|
2204
|
+
"name": "--mdc-bullet-background-color"
|
2205
|
+
},
|
2206
|
+
{
|
2207
|
+
"description": "small size value of the bullet",
|
2208
|
+
"name": "--mdc-bullet-size-small"
|
2209
|
+
},
|
2210
|
+
{
|
2211
|
+
"description": "medium size value of the bullet",
|
2212
|
+
"name": "--mdc-bullet-size-medium"
|
2213
|
+
},
|
2214
|
+
{
|
2215
|
+
"description": "large size value of the bullet",
|
2216
|
+
"name": "--mdc-bullet-size-large"
|
2217
|
+
}
|
2218
|
+
],
|
2219
|
+
"members": [
|
2220
|
+
{
|
2221
|
+
"kind": "field",
|
2222
|
+
"name": "size",
|
2223
|
+
"type": {
|
2224
|
+
"text": "Size"
|
2225
|
+
},
|
2226
|
+
"privacy": "public",
|
2227
|
+
"description": "Size of the bullet\n\nPossible values: 'small', 'medium', 'large'",
|
2228
|
+
"default": "small",
|
2229
|
+
"attribute": "size",
|
2230
|
+
"reflects": true
|
2231
|
+
}
|
2232
|
+
],
|
2233
|
+
"attributes": [
|
2234
|
+
{
|
2235
|
+
"name": "size",
|
2236
|
+
"type": {
|
2237
|
+
"text": "Size"
|
2238
|
+
},
|
2239
|
+
"description": "Size of the bullet\n\nPossible values: 'small', 'medium', 'large'",
|
2240
|
+
"default": "small",
|
2241
|
+
"fieldName": "size"
|
2242
|
+
}
|
2243
|
+
],
|
2244
|
+
"superclass": {
|
2245
|
+
"name": "Component",
|
2246
|
+
"module": "/src/models"
|
2247
|
+
},
|
2248
|
+
"tagName": "mdc-bullet",
|
2249
|
+
"jsDoc": "/**\n * Bullet component, which is a visual marker\n * and be used to organize and present items in a list format.\n *\n * @tagname mdc-bullet\n *\n * @cssproperty --mdc-bullet-background-color - background color of the bullet\n * @cssproperty --mdc-bullet-size-small - small size value of the bullet\n * @cssproperty --mdc-bullet-size-medium - medium size value of the bullet\n * @cssproperty --mdc-bullet-size-large - large size value of the bullet\n */",
|
2250
|
+
"customElement": true
|
2251
|
+
}
|
2252
|
+
],
|
2253
|
+
"exports": [
|
2254
|
+
{
|
2255
|
+
"kind": "js",
|
2256
|
+
"name": "default",
|
2257
|
+
"declaration": {
|
2258
|
+
"name": "Bullet",
|
2259
|
+
"module": "components/bullet/bullet.component.js"
|
2260
|
+
}
|
2261
|
+
}
|
2262
|
+
]
|
2263
|
+
},
|
2193
2264
|
{
|
2194
2265
|
"kind": "javascript-module",
|
2195
2266
|
"path": "components/button/button.component.js",
|
@@ -2885,77 +2956,6 @@
|
|
2885
2956
|
}
|
2886
2957
|
]
|
2887
2958
|
},
|
2888
|
-
{
|
2889
|
-
"kind": "javascript-module",
|
2890
|
-
"path": "components/bullet/bullet.component.js",
|
2891
|
-
"declarations": [
|
2892
|
-
{
|
2893
|
-
"kind": "class",
|
2894
|
-
"description": "Bullet component, which is a visual marker\nand be used to organize and present items in a list format.",
|
2895
|
-
"name": "Bullet",
|
2896
|
-
"cssProperties": [
|
2897
|
-
{
|
2898
|
-
"description": "background color of the bullet",
|
2899
|
-
"name": "--mdc-bullet-background-color"
|
2900
|
-
},
|
2901
|
-
{
|
2902
|
-
"description": "small size value of the bullet",
|
2903
|
-
"name": "--mdc-bullet-size-small"
|
2904
|
-
},
|
2905
|
-
{
|
2906
|
-
"description": "medium size value of the bullet",
|
2907
|
-
"name": "--mdc-bullet-size-medium"
|
2908
|
-
},
|
2909
|
-
{
|
2910
|
-
"description": "large size value of the bullet",
|
2911
|
-
"name": "--mdc-bullet-size-large"
|
2912
|
-
}
|
2913
|
-
],
|
2914
|
-
"members": [
|
2915
|
-
{
|
2916
|
-
"kind": "field",
|
2917
|
-
"name": "size",
|
2918
|
-
"type": {
|
2919
|
-
"text": "Size"
|
2920
|
-
},
|
2921
|
-
"privacy": "public",
|
2922
|
-
"description": "Size of the bullet\n\nPossible values: 'small', 'medium', 'large'",
|
2923
|
-
"default": "small",
|
2924
|
-
"attribute": "size",
|
2925
|
-
"reflects": true
|
2926
|
-
}
|
2927
|
-
],
|
2928
|
-
"attributes": [
|
2929
|
-
{
|
2930
|
-
"name": "size",
|
2931
|
-
"type": {
|
2932
|
-
"text": "Size"
|
2933
|
-
},
|
2934
|
-
"description": "Size of the bullet\n\nPossible values: 'small', 'medium', 'large'",
|
2935
|
-
"default": "small",
|
2936
|
-
"fieldName": "size"
|
2937
|
-
}
|
2938
|
-
],
|
2939
|
-
"superclass": {
|
2940
|
-
"name": "Component",
|
2941
|
-
"module": "/src/models"
|
2942
|
-
},
|
2943
|
-
"tagName": "mdc-bullet",
|
2944
|
-
"jsDoc": "/**\n * Bullet component, which is a visual marker\n * and be used to organize and present items in a list format.\n *\n * @tagname mdc-bullet\n *\n * @cssproperty --mdc-bullet-background-color - background color of the bullet\n * @cssproperty --mdc-bullet-size-small - small size value of the bullet\n * @cssproperty --mdc-bullet-size-medium - medium size value of the bullet\n * @cssproperty --mdc-bullet-size-large - large size value of the bullet\n */",
|
2945
|
-
"customElement": true
|
2946
|
-
}
|
2947
|
-
],
|
2948
|
-
"exports": [
|
2949
|
-
{
|
2950
|
-
"kind": "js",
|
2951
|
-
"name": "default",
|
2952
|
-
"declaration": {
|
2953
|
-
"name": "Bullet",
|
2954
|
-
"module": "components/bullet/bullet.component.js"
|
2955
|
-
}
|
2956
|
-
}
|
2957
|
-
]
|
2958
|
-
},
|
2959
2959
|
{
|
2960
2960
|
"kind": "javascript-module",
|
2961
2961
|
"path": "components/buttongroup/buttongroup.component.js",
|
@@ -8554,6 +8554,21 @@
|
|
8554
8554
|
"module": "components/popover/popover.component.js"
|
8555
8555
|
}
|
8556
8556
|
},
|
8557
|
+
{
|
8558
|
+
"kind": "field",
|
8559
|
+
"name": "boundaryPadding",
|
8560
|
+
"type": {
|
8561
|
+
"text": "number"
|
8562
|
+
},
|
8563
|
+
"description": "Virtual padding around the boundary to check for overflow.",
|
8564
|
+
"default": "16",
|
8565
|
+
"attribute": "boundary-padding",
|
8566
|
+
"reflects": true,
|
8567
|
+
"inheritedFrom": {
|
8568
|
+
"name": "Popover",
|
8569
|
+
"module": "components/popover/popover.component.js"
|
8570
|
+
}
|
8571
|
+
},
|
8557
8572
|
{
|
8558
8573
|
"kind": "field",
|
8559
8574
|
"name": "interactive",
|
@@ -9235,6 +9250,19 @@
|
|
9235
9250
|
"module": "src/components/popover/popover.component.ts"
|
9236
9251
|
}
|
9237
9252
|
},
|
9253
|
+
{
|
9254
|
+
"name": "boundary-padding",
|
9255
|
+
"type": {
|
9256
|
+
"text": "number"
|
9257
|
+
},
|
9258
|
+
"description": "Virtual padding around the boundary to check for overflow.",
|
9259
|
+
"default": "16",
|
9260
|
+
"fieldName": "boundaryPadding",
|
9261
|
+
"inheritedFrom": {
|
9262
|
+
"name": "Popover",
|
9263
|
+
"module": "src/components/popover/popover.component.ts"
|
9264
|
+
}
|
9265
|
+
},
|
9238
9266
|
{
|
9239
9267
|
"name": "focus-trap",
|
9240
9268
|
"type": {
|
@@ -15800,7 +15828,7 @@
|
|
15800
15828
|
"description": "The keyboard event that triggered the action."
|
15801
15829
|
}
|
15802
15830
|
],
|
15803
|
-
"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.",
|
15831
|
+
"description": "Handles the keydown event for the menu item.\nIf the Enter key is pressed, it triggers a click event on the menu item.\nThis allows keyboard users to activate the menu item using the Enter key.\n\nThis follows the native behaviour, actionable element can be triggered by Enter\nkey on the keydown event.\n\nNote: Action triggered by Space on the keyup event.",
|
15804
15832
|
"inheritedFrom": {
|
15805
15833
|
"name": "ListItem",
|
15806
15834
|
"module": "components/listitem/listitem.component.js"
|
@@ -15824,7 +15852,7 @@
|
|
15824
15852
|
"description": "The keyboard event that triggered the action."
|
15825
15853
|
}
|
15826
15854
|
],
|
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."
|
15855
|
+
"description": "Handles the keyup event for the menu item.\nIf the Space key is released, it triggers a click event on the menu item.\nThis allows keyboard users to activate the menu item using the Space key.\nIt also prevents the default action of the Space key to avoid scrolling the page.\n\nThis follows the native behaviour, actionable element can be triggered by Space\nkey on the keyup event.\n\nNote: Action triggered by Enter on the keydown event."
|
15828
15856
|
},
|
15829
15857
|
{
|
15830
15858
|
"kind": "method",
|
@@ -16660,7 +16688,7 @@
|
|
16660
16688
|
"description": "The keyboard event that triggered the action."
|
16661
16689
|
}
|
16662
16690
|
],
|
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.",
|
16691
|
+
"description": "Handles the keydown event for the menu item.\nIf the Enter key is pressed, it triggers a click event on the menu item.\nThis allows keyboard users to activate the menu item using the Enter key.\n\nThis follows the native behaviour, actionable element can be triggered by Enter\nkey on the keydown event.\n\nNote: Action triggered by Space on the keyup event.",
|
16664
16692
|
"inheritedFrom": {
|
16665
16693
|
"name": "ListItem",
|
16666
16694
|
"module": "components/listitem/listitem.component.js"
|
@@ -16684,7 +16712,7 @@
|
|
16684
16712
|
"description": "The keyboard event that triggered the action."
|
16685
16713
|
}
|
16686
16714
|
],
|
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.",
|
16715
|
+
"description": "Handles the keyup event for the menu item.\nIf the Space key is released, it triggers a click event on the menu item.\nThis allows keyboard users to activate the menu item using the Space key.\nIt also prevents the default action of the Space key to avoid scrolling the page.\n\nThis follows the native behaviour, actionable element can be triggered by Space\nkey on the keyup event.\n\nNote: Action triggered by Enter on the keydown event.",
|
16688
16716
|
"inheritedFrom": {
|
16689
16717
|
"name": "MenuItem",
|
16690
16718
|
"module": "components/menuitem/menuitem.component.js"
|
@@ -17574,7 +17602,7 @@
|
|
17574
17602
|
"description": "The keyboard event that triggered the action."
|
17575
17603
|
}
|
17576
17604
|
],
|
17577
|
-
"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.",
|
17605
|
+
"description": "Handles the keydown event for the menu item.\nIf the Enter key is pressed, it triggers a click event on the menu item.\nThis allows keyboard users to activate the menu item using the Enter key.\n\nThis follows the native behaviour, actionable element can be triggered by Enter\nkey on the keydown event.\n\nNote: Action triggered by Space on the keyup event.",
|
17578
17606
|
"inheritedFrom": {
|
17579
17607
|
"name": "ListItem",
|
17580
17608
|
"module": "components/listitem/listitem.component.js"
|
@@ -17598,7 +17626,7 @@
|
|
17598
17626
|
"description": "The keyboard event that triggered the action."
|
17599
17627
|
}
|
17600
17628
|
],
|
17601
|
-
"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.",
|
17629
|
+
"description": "Handles the keyup event for the menu item.\nIf the Space key is released, it triggers a click event on the menu item.\nThis allows keyboard users to activate the menu item using the Space key.\nIt also prevents the default action of the Space key to avoid scrolling the page.\n\nThis follows the native behaviour, actionable element can be triggered by Space\nkey on the keyup event.\n\nNote: Action triggered by Enter on the keydown event.",
|
17602
17630
|
"inheritedFrom": {
|
17603
17631
|
"name": "MenuItem",
|
17604
17632
|
"module": "components/menuitem/menuitem.component.js"
|
@@ -18279,7 +18307,7 @@
|
|
18279
18307
|
"declarations": [
|
18280
18308
|
{
|
18281
18309
|
"kind": "class",
|
18282
|
-
"description": "A popover menu component that displays a list of menu items in a floating container.\nIt's designed to work in conjunction with `mdc-menubar` and `mdc-menuitem` to create\naccessible, nested menu structures with the following features:\n- Appears adjacent to the triggering menu item\n- Supports keyboard navigation (arrow keys, Home, End)\n- Manages focus trapping when open\n- Closes on Escape key or outside click\n- Supports both mouse and keyboard interactions\n- Automatically handles ARIA attributes for accessibility\n\nThe component extends `mdc-popover` and adds menu-specific behaviors and styling.\nWhen nested within another `mdc-menupopover`, it automatically adjusts its behavior\nto work as a submenu (right-aligned, shows on hover).\n\nThe orientation of the menu popover is always set to `vertical
|
18310
|
+
"description": "A popover menu component that displays a list of menu items in a floating container.\nIt's designed to work in conjunction with `mdc-menubar` and `mdc-menuitem` to create\naccessible, nested menu structures with the following features:\n- Appears adjacent to the triggering menu item\n- Supports keyboard navigation (arrow keys, Home, End)\n- Manages focus trapping when open\n- Closes on Escape key or outside click\n- Supports both mouse and keyboard interactions\n- Automatically handles ARIA attributes for accessibility\n\nThe component extends `mdc-popover` and adds menu-specific behaviors and styling.\nWhen nested within another `mdc-menupopover`, it automatically adjusts its behavior\nto work as a submenu (right-aligned, shows on hover).\n\nThe orientation of the menu popover is always set to `vertical`.\n\nSubmenu opens when:\n- Clicked on a menu item with a submenu\n- Enter or Space key pressed on a menu item with a submenu\n\nMenu closes completely (with all sub menus) when:\n- A menu item is clicked that does not have a submenu\n- Enter key pressed on a menu item (not a submenu trigger), menu item radio or menu item checkbox\n- Click outside the menu popover (on the backdrop)\n\nClose submenus when:\n- Esc key pressed, only the current submenu closed\n- Arrow Left key pressed, only the current submenu closed\n- Open another submenu with Click, Enter or Space key,\n closes recursively all submenus until the selected item's submenu\n\nMenu does not close when:\n- Space key pressed on a menu item radio or menu item checkbox",
|
18283
18311
|
"name": "MenuPopover",
|
18284
18312
|
"slots": [
|
18285
18313
|
{
|
@@ -18311,6 +18339,15 @@
|
|
18311
18339
|
"module": "components/popover/popover.component.js"
|
18312
18340
|
}
|
18313
18341
|
},
|
18342
|
+
{
|
18343
|
+
"kind": "field",
|
18344
|
+
"name": "menuItems",
|
18345
|
+
"type": {
|
18346
|
+
"text": "Array<HTMLElement>"
|
18347
|
+
},
|
18348
|
+
"privacy": "private",
|
18349
|
+
"default": "[]"
|
18350
|
+
},
|
18314
18351
|
{
|
18315
18352
|
"kind": "method",
|
18316
18353
|
"name": "isOpenUpdated",
|
@@ -18340,6 +18377,21 @@
|
|
18340
18377
|
"module": "components/popover/popover.component.js"
|
18341
18378
|
}
|
18342
18379
|
},
|
18380
|
+
{
|
18381
|
+
"kind": "method",
|
18382
|
+
"name": "resetTabIndexes",
|
18383
|
+
"privacy": "private",
|
18384
|
+
"parameters": [
|
18385
|
+
{
|
18386
|
+
"name": "currentIndex",
|
18387
|
+
"type": {
|
18388
|
+
"text": "number"
|
18389
|
+
},
|
18390
|
+
"description": "The index of the currently focused menu item."
|
18391
|
+
}
|
18392
|
+
],
|
18393
|
+
"description": "Reset all tabindex to -1 and set the tabindex of the current menu item to 0"
|
18394
|
+
},
|
18343
18395
|
{
|
18344
18396
|
"kind": "method",
|
18345
18397
|
"name": "getCurrentIndex",
|
@@ -18454,6 +18506,21 @@
|
|
18454
18506
|
"module": "components/popover/popover.component.js"
|
18455
18507
|
}
|
18456
18508
|
},
|
18509
|
+
{
|
18510
|
+
"kind": "method",
|
18511
|
+
"name": "closeMenu",
|
18512
|
+
"privacy": "private",
|
18513
|
+
"parameters": [
|
18514
|
+
{
|
18515
|
+
"name": "target",
|
18516
|
+
"type": {
|
18517
|
+
"text": "HTMLElement"
|
18518
|
+
},
|
18519
|
+
"description": "The target element that was clicked."
|
18520
|
+
}
|
18521
|
+
],
|
18522
|
+
"description": "Determines whether to close the menu based on the clicked target."
|
18523
|
+
},
|
18457
18524
|
{
|
18458
18525
|
"kind": "method",
|
18459
18526
|
"name": "handleMouseClick",
|
@@ -18514,7 +18581,27 @@
|
|
18514
18581
|
"description": "The keyboard event that triggered the keydown action."
|
18515
18582
|
}
|
18516
18583
|
],
|
18517
|
-
"description": "Handles keydown events for keyboard navigation within the menu popover.\nThis method allows users to navigate through the menu items using the keyboard.\nIt supports Home, End, Arrow Up, Arrow Down, Arrow Left, Arrow Right, and Escape keys
|
18584
|
+
"description": "Handles keydown events for keyboard navigation within the menu popover.\nThis method allows users to navigate through the menu items using the keyboard.\nIt supports Home, End, Arrow Up, Arrow Down, Arrow Left, Arrow Right, and Escape keys.\n\nAlso, it handles Enter key to close the menu popover",
|
18585
|
+
"return": {
|
18586
|
+
"type": {
|
18587
|
+
"text": ""
|
18588
|
+
}
|
18589
|
+
}
|
18590
|
+
},
|
18591
|
+
{
|
18592
|
+
"kind": "method",
|
18593
|
+
"name": "handleKeyUp",
|
18594
|
+
"privacy": "private",
|
18595
|
+
"parameters": [
|
18596
|
+
{
|
18597
|
+
"name": "event",
|
18598
|
+
"type": {
|
18599
|
+
"text": "KeyboardEvent"
|
18600
|
+
},
|
18601
|
+
"description": "The keyboard event that triggered the keydown action."
|
18602
|
+
}
|
18603
|
+
],
|
18604
|
+
"description": "Handles keyup events for keyboard navigation within the menu popover.\n\nSome keys must be handled with keyup event to prevent default action.\n\nSpace key closes the menu when the user presses it on a menu item,\nbut the same key will trigger a click on the menu opener button.\nThe button uses the keyup event so we have to handle it here as well\nto prevent the meu opener action which would re-open the menu.",
|
18518
18605
|
"return": {
|
18519
18606
|
"type": {
|
18520
18607
|
"text": ""
|
@@ -19157,6 +19244,21 @@
|
|
19157
19244
|
"module": "components/popover/popover.component.js"
|
19158
19245
|
}
|
19159
19246
|
},
|
19247
|
+
{
|
19248
|
+
"kind": "field",
|
19249
|
+
"name": "boundaryPadding",
|
19250
|
+
"type": {
|
19251
|
+
"text": "number"
|
19252
|
+
},
|
19253
|
+
"description": "Virtual padding around the boundary to check for overflow.",
|
19254
|
+
"default": "16",
|
19255
|
+
"attribute": "boundary-padding",
|
19256
|
+
"reflects": true,
|
19257
|
+
"inheritedFrom": {
|
19258
|
+
"name": "Popover",
|
19259
|
+
"module": "components/popover/popover.component.js"
|
19260
|
+
}
|
19261
|
+
},
|
19160
19262
|
{
|
19161
19263
|
"kind": "field",
|
19162
19264
|
"name": "showArrow",
|
@@ -19802,6 +19904,19 @@
|
|
19802
19904
|
"module": "src/components/popover/popover.component.ts"
|
19803
19905
|
}
|
19804
19906
|
},
|
19907
|
+
{
|
19908
|
+
"name": "boundary-padding",
|
19909
|
+
"type": {
|
19910
|
+
"text": "number"
|
19911
|
+
},
|
19912
|
+
"description": "Virtual padding around the boundary to check for overflow.",
|
19913
|
+
"default": "16",
|
19914
|
+
"fieldName": "boundaryPadding",
|
19915
|
+
"inheritedFrom": {
|
19916
|
+
"name": "Popover",
|
19917
|
+
"module": "src/components/popover/popover.component.ts"
|
19918
|
+
}
|
19919
|
+
},
|
19805
19920
|
{
|
19806
19921
|
"name": "focus-trap",
|
19807
19922
|
"type": {
|
@@ -20094,7 +20209,7 @@
|
|
20094
20209
|
"module": "/src/components/popover/popover.component"
|
20095
20210
|
},
|
20096
20211
|
"tagName": "mdc-menupopover",
|
20097
|
-
"jsDoc": "/**\n * A popover menu component that displays a list of menu items in a floating container.\n * It's designed to work in conjunction with `mdc-menubar` and `mdc-menuitem` to create\n * accessible, nested menu structures with the following features:\n * - Appears adjacent to the triggering menu item\n * - Supports keyboard navigation (arrow keys, Home, End)\n * - Manages focus trapping when open\n * - Closes on Escape key or outside click\n * - Supports both mouse and keyboard interactions\n * - Automatically handles ARIA attributes for accessibility\n *\n * The component extends `mdc-popover` and adds menu-specific behaviors and styling.\n * When nested within another `mdc-menupopover`, it automatically adjusts its behavior\n * to work as a submenu (right-aligned, shows on hover).\n *\n * The orientation of the menu popover is always set to `vertical`.\n *\n * @tagname mdc-menupopover\n *\n * @slot - Default slot for the menu popover content\n *\n * @event change - (React: onChange) This event is dispatched when a `menuitemcheckbox`, or `menuitemradio` changes.\n * @event action - (React: onAction) This event is dispatched when a menuItem selected and the menu closes.\n *\n * @slot default - Contains the menu items to be displayed in the popover\n */",
|
20212
|
+
"jsDoc": "/**\n * A popover menu component that displays a list of menu items in a floating container.\n * It's designed to work in conjunction with `mdc-menubar` and `mdc-menuitem` to create\n * accessible, nested menu structures with the following features:\n * - Appears adjacent to the triggering menu item\n * - Supports keyboard navigation (arrow keys, Home, End)\n * - Manages focus trapping when open\n * - Closes on Escape key or outside click\n * - Supports both mouse and keyboard interactions\n * - Automatically handles ARIA attributes for accessibility\n *\n * The component extends `mdc-popover` and adds menu-specific behaviors and styling.\n * When nested within another `mdc-menupopover`, it automatically adjusts its behavior\n * to work as a submenu (right-aligned, shows on hover).\n *\n * The orientation of the menu popover is always set to `vertical`.\n *\n * Submenu opens when:\n * - Clicked on a menu item with a submenu\n * - Enter or Space key pressed on a menu item with a submenu\n *\n * Menu closes completely (with all sub menus) when:\n * - A menu item is clicked that does not have a submenu\n * - Enter key pressed on a menu item (not a submenu trigger), menu item radio or menu item checkbox\n * - Click outside the menu popover (on the backdrop)\n *\n * Close submenus when:\n * - Esc key pressed, only the current submenu closed\n * - Arrow Left key pressed, only the current submenu closed\n * - Open another submenu with Click, Enter or Space key,\n * closes recursively all submenus until the selected item's submenu\n *\n * Menu does not close when:\n * - Space key pressed on a menu item radio or menu item checkbox\n *\n * @tagname mdc-menupopover\n *\n * @slot - Default slot for the menu popover content\n *\n * @event change - (React: onChange) This event is dispatched when a `menuitemcheckbox`, or `menuitemradio` changes.\n * @event action - (React: onAction) This event is dispatched when a menuItem selected and the menu closes.\n *\n * @slot default - Contains the menu items to be displayed in the popover\n */",
|
20098
20213
|
"customElement": true,
|
20099
20214
|
"cssProperties": [
|
20100
20215
|
{
|
@@ -20659,7 +20774,7 @@
|
|
20659
20774
|
"description": "The keyboard event that triggered the action."
|
20660
20775
|
}
|
20661
20776
|
],
|
20662
|
-
"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.",
|
20777
|
+
"description": "Handles the keydown event for the menu item.\nIf the Enter key is pressed, it triggers a click event on the menu item.\nThis allows keyboard users to activate the menu item using the Enter key.\n\nThis follows the native behaviour, actionable element can be triggered by Enter\nkey on the keydown event.\n\nNote: Action triggered by Space on the keyup event.",
|
20663
20778
|
"inheritedFrom": {
|
20664
20779
|
"name": "ListItem",
|
20665
20780
|
"module": "components/listitem/listitem.component.js"
|
@@ -20683,7 +20798,7 @@
|
|
20683
20798
|
"description": "The keyboard event that triggered the action."
|
20684
20799
|
}
|
20685
20800
|
],
|
20686
|
-
"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.",
|
20801
|
+
"description": "Handles the keyup event for the menu item.\nIf the Space key is released, it triggers a click event on the menu item.\nThis allows keyboard users to activate the menu item using the Space key.\nIt also prevents the default action of the Space key to avoid scrolling the page.\n\nThis follows the native behaviour, actionable element can be triggered by Space\nkey on the keyup event.\n\nNote: Action triggered by Enter on the keydown event.",
|
20687
20802
|
"inheritedFrom": {
|
20688
20803
|
"name": "MenuItem",
|
20689
20804
|
"module": "components/menuitem/menuitem.component.js"
|
@@ -23856,6 +23971,17 @@
|
|
23856
23971
|
"attribute": "offset",
|
23857
23972
|
"reflects": true
|
23858
23973
|
},
|
23974
|
+
{
|
23975
|
+
"kind": "field",
|
23976
|
+
"name": "boundaryPadding",
|
23977
|
+
"type": {
|
23978
|
+
"text": "number"
|
23979
|
+
},
|
23980
|
+
"description": "Virtual padding around the boundary to check for overflow.",
|
23981
|
+
"default": "16",
|
23982
|
+
"attribute": "boundary-padding",
|
23983
|
+
"reflects": true
|
23984
|
+
},
|
23859
23985
|
{
|
23860
23986
|
"kind": "field",
|
23861
23987
|
"name": "focusTrap",
|
@@ -24876,6 +25002,15 @@
|
|
24876
25002
|
"default": "4",
|
24877
25003
|
"fieldName": "offset"
|
24878
25004
|
},
|
25005
|
+
{
|
25006
|
+
"name": "boundary-padding",
|
25007
|
+
"type": {
|
25008
|
+
"text": "number"
|
25009
|
+
},
|
25010
|
+
"description": "Virtual padding around the boundary to check for overflow.",
|
25011
|
+
"default": "16",
|
25012
|
+
"fieldName": "boundaryPadding"
|
25013
|
+
},
|
24879
25014
|
{
|
24880
25015
|
"name": "focus-trap",
|
24881
25016
|
"type": {
|
@@ -29953,6 +30088,193 @@
|
|
29953
30088
|
}
|
29954
30089
|
]
|
29955
30090
|
},
|
30091
|
+
{
|
30092
|
+
"kind": "javascript-module",
|
30093
|
+
"path": "components/sidenavigation/sidenavigation.component.js",
|
30094
|
+
"declarations": [
|
30095
|
+
{
|
30096
|
+
"kind": "class",
|
30097
|
+
"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",
|
30098
|
+
"name": "SideNavigation",
|
30099
|
+
"cssProperties": [
|
30100
|
+
{
|
30101
|
+
"description": "width of the sideNavigation when expanded",
|
30102
|
+
"name": "--mdc-sidenavigation-expanded-width"
|
30103
|
+
},
|
30104
|
+
{
|
30105
|
+
"description": "width of the sideNavigation when collpased",
|
30106
|
+
"name": "--mdc-sidenavigation-collapsed-width"
|
30107
|
+
}
|
30108
|
+
],
|
30109
|
+
"slots": [
|
30110
|
+
{
|
30111
|
+
"description": "Slot for the scrollable content area of the side navigation.",
|
30112
|
+
"name": "scrollable-section"
|
30113
|
+
},
|
30114
|
+
{
|
30115
|
+
"description": "Slot for the fixed content area of the side navigation.",
|
30116
|
+
"name": "fixed-section"
|
30117
|
+
},
|
30118
|
+
{
|
30119
|
+
"description": "Slot for the brand logo (e.g., icon or img).",
|
30120
|
+
"name": "brand-logo"
|
30121
|
+
}
|
30122
|
+
],
|
30123
|
+
"members": [
|
30124
|
+
{
|
30125
|
+
"kind": "field",
|
30126
|
+
"name": "Context",
|
30127
|
+
"privacy": "public",
|
30128
|
+
"static": true,
|
30129
|
+
"readonly": true
|
30130
|
+
},
|
30131
|
+
{
|
30132
|
+
"kind": "field",
|
30133
|
+
"name": "variant",
|
30134
|
+
"type": {
|
30135
|
+
"text": "SideNavigationVariant"
|
30136
|
+
},
|
30137
|
+
"description": "Four variants of the sideNavigation\n- **fixed-collapsed**: Shows icons without labels and has fixed width, 4.5rem.\n- **fixed-expanded**: Shows icons with labels and has fixed width, 15rem.\n- **flexible**: Toggles between collapsed/expanded states.\n- **hidden**: Removes the sidenavigation from the DOM.",
|
30138
|
+
"default": "flexible",
|
30139
|
+
"attribute": "variant",
|
30140
|
+
"reflects": true
|
30141
|
+
},
|
30142
|
+
{
|
30143
|
+
"kind": "field",
|
30144
|
+
"name": "footerText",
|
30145
|
+
"type": {
|
30146
|
+
"text": "string"
|
30147
|
+
},
|
30148
|
+
"default": "''",
|
30149
|
+
"description": "Displays footer text in the bottom section of the sidenavigation.",
|
30150
|
+
"attribute": "footer-text",
|
30151
|
+
"reflects": true
|
30152
|
+
},
|
30153
|
+
{
|
30154
|
+
"kind": "field",
|
30155
|
+
"name": "grabberBtnAriaLabel",
|
30156
|
+
"type": {
|
30157
|
+
"text": "string | undefined"
|
30158
|
+
},
|
30159
|
+
"description": "Provides an accessible label for the grabber button.\nThis value is used to set the `aria-label` attribute for the button.",
|
30160
|
+
"default": "''",
|
30161
|
+
"attribute": "grabber-btn-aria-label",
|
30162
|
+
"reflects": true
|
30163
|
+
},
|
30164
|
+
{
|
30165
|
+
"kind": "field",
|
30166
|
+
"name": "parentNavTooltipText",
|
30167
|
+
"type": {
|
30168
|
+
"text": "string | undefined"
|
30169
|
+
},
|
30170
|
+
"description": "Tooltip text shown on parent nav items when a child is active.",
|
30171
|
+
"attribute": "parent-nav-tooltip-text",
|
30172
|
+
"reflects": true
|
30173
|
+
},
|
30174
|
+
{
|
30175
|
+
"kind": "method",
|
30176
|
+
"name": "updateContext",
|
30177
|
+
"privacy": "protected",
|
30178
|
+
"return": {
|
30179
|
+
"type": {
|
30180
|
+
"text": "void"
|
30181
|
+
}
|
30182
|
+
},
|
30183
|
+
"description": "Update all observing components of this\nprovider to update the values\n\nIs called on every re-render, see Provider class"
|
30184
|
+
},
|
30185
|
+
{
|
30186
|
+
"kind": "field",
|
30187
|
+
"name": "navMenuItems",
|
30188
|
+
"type": {
|
30189
|
+
"text": "NavMenuItem[]"
|
30190
|
+
},
|
30191
|
+
"privacy": "private",
|
30192
|
+
"description": "Returns all nested, non-disabled mdc-navmenuitem elements inside this component.",
|
30193
|
+
"readonly": true
|
30194
|
+
},
|
30195
|
+
{
|
30196
|
+
"kind": "method",
|
30197
|
+
"name": "preventScrollOnSpace",
|
30198
|
+
"privacy": "private",
|
30199
|
+
"return": {
|
30200
|
+
"type": {
|
30201
|
+
"text": "void"
|
30202
|
+
}
|
30203
|
+
},
|
30204
|
+
"parameters": [
|
30205
|
+
{
|
30206
|
+
"name": "event",
|
30207
|
+
"type": {
|
30208
|
+
"text": "KeyboardEvent"
|
30209
|
+
}
|
30210
|
+
}
|
30211
|
+
]
|
30212
|
+
}
|
30213
|
+
],
|
30214
|
+
"events": [
|
30215
|
+
{
|
30216
|
+
"description": "(React: onActiveChange) Dispatched when the active state of the navmenuitem changes.",
|
30217
|
+
"name": "activechange",
|
30218
|
+
"reactName": "onActiveChange"
|
30219
|
+
}
|
30220
|
+
],
|
30221
|
+
"attributes": [
|
30222
|
+
{
|
30223
|
+
"name": "variant",
|
30224
|
+
"type": {
|
30225
|
+
"text": "SideNavigationVariant"
|
30226
|
+
},
|
30227
|
+
"description": "Four variants of the sideNavigation\n- **fixed-collapsed**: Shows icons without labels and has fixed width, 4.5rem.\n- **fixed-expanded**: Shows icons with labels and has fixed width, 15rem.\n- **flexible**: Toggles between collapsed/expanded states.\n- **hidden**: Removes the sidenavigation from the DOM.",
|
30228
|
+
"default": "flexible",
|
30229
|
+
"fieldName": "variant"
|
30230
|
+
},
|
30231
|
+
{
|
30232
|
+
"name": "footer-text",
|
30233
|
+
"type": {
|
30234
|
+
"text": "string"
|
30235
|
+
},
|
30236
|
+
"default": "''",
|
30237
|
+
"description": "Displays footer text in the bottom section of the sidenavigation.",
|
30238
|
+
"fieldName": "footerText"
|
30239
|
+
},
|
30240
|
+
{
|
30241
|
+
"name": "grabber-btn-aria-label",
|
30242
|
+
"type": {
|
30243
|
+
"text": "string | undefined"
|
30244
|
+
},
|
30245
|
+
"description": "Provides an accessible label for the grabber button.\nThis value is used to set the `aria-label` attribute for the button.",
|
30246
|
+
"default": "''",
|
30247
|
+
"fieldName": "grabberBtnAriaLabel"
|
30248
|
+
},
|
30249
|
+
{
|
30250
|
+
"name": "parent-nav-tooltip-text",
|
30251
|
+
"type": {
|
30252
|
+
"text": "string | undefined"
|
30253
|
+
},
|
30254
|
+
"description": "Tooltip text shown on parent nav items when a child is active.",
|
30255
|
+
"fieldName": "parentNavTooltipText"
|
30256
|
+
}
|
30257
|
+
],
|
30258
|
+
"superclass": {
|
30259
|
+
"name": "Provider",
|
30260
|
+
"module": "/src/models"
|
30261
|
+
},
|
30262
|
+
"tagName": "mdc-sidenavigation",
|
30263
|
+
"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 */",
|
30264
|
+
"customElement": true
|
30265
|
+
}
|
30266
|
+
],
|
30267
|
+
"exports": [
|
30268
|
+
{
|
30269
|
+
"kind": "js",
|
30270
|
+
"name": "default",
|
30271
|
+
"declaration": {
|
30272
|
+
"name": "SideNavigation",
|
30273
|
+
"module": "components/sidenavigation/sidenavigation.component.js"
|
30274
|
+
}
|
30275
|
+
}
|
30276
|
+
]
|
30277
|
+
},
|
29956
30278
|
{
|
29957
30279
|
"kind": "javascript-module",
|
29958
30280
|
"path": "components/skeleton/skeleton.component.js",
|
@@ -30168,193 +30490,6 @@
|
|
30168
30490
|
}
|
30169
30491
|
]
|
30170
30492
|
},
|
30171
|
-
{
|
30172
|
-
"kind": "javascript-module",
|
30173
|
-
"path": "components/sidenavigation/sidenavigation.component.js",
|
30174
|
-
"declarations": [
|
30175
|
-
{
|
30176
|
-
"kind": "class",
|
30177
|
-
"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",
|
30178
|
-
"name": "SideNavigation",
|
30179
|
-
"cssProperties": [
|
30180
|
-
{
|
30181
|
-
"description": "width of the sideNavigation when expanded",
|
30182
|
-
"name": "--mdc-sidenavigation-expanded-width"
|
30183
|
-
},
|
30184
|
-
{
|
30185
|
-
"description": "width of the sideNavigation when collpased",
|
30186
|
-
"name": "--mdc-sidenavigation-collapsed-width"
|
30187
|
-
}
|
30188
|
-
],
|
30189
|
-
"slots": [
|
30190
|
-
{
|
30191
|
-
"description": "Slot for the scrollable content area of the side navigation.",
|
30192
|
-
"name": "scrollable-section"
|
30193
|
-
},
|
30194
|
-
{
|
30195
|
-
"description": "Slot for the fixed content area of the side navigation.",
|
30196
|
-
"name": "fixed-section"
|
30197
|
-
},
|
30198
|
-
{
|
30199
|
-
"description": "Slot for the brand logo (e.g., icon or img).",
|
30200
|
-
"name": "brand-logo"
|
30201
|
-
}
|
30202
|
-
],
|
30203
|
-
"members": [
|
30204
|
-
{
|
30205
|
-
"kind": "field",
|
30206
|
-
"name": "Context",
|
30207
|
-
"privacy": "public",
|
30208
|
-
"static": true,
|
30209
|
-
"readonly": true
|
30210
|
-
},
|
30211
|
-
{
|
30212
|
-
"kind": "field",
|
30213
|
-
"name": "variant",
|
30214
|
-
"type": {
|
30215
|
-
"text": "SideNavigationVariant"
|
30216
|
-
},
|
30217
|
-
"description": "Four variants of the sideNavigation\n- **fixed-collapsed**: Shows icons without labels and has fixed width, 4.5rem.\n- **fixed-expanded**: Shows icons with labels and has fixed width, 15rem.\n- **flexible**: Toggles between collapsed/expanded states.\n- **hidden**: Removes the sidenavigation from the DOM.",
|
30218
|
-
"default": "flexible",
|
30219
|
-
"attribute": "variant",
|
30220
|
-
"reflects": true
|
30221
|
-
},
|
30222
|
-
{
|
30223
|
-
"kind": "field",
|
30224
|
-
"name": "footerText",
|
30225
|
-
"type": {
|
30226
|
-
"text": "string"
|
30227
|
-
},
|
30228
|
-
"default": "''",
|
30229
|
-
"description": "Displays footer text in the bottom section of the sidenavigation.",
|
30230
|
-
"attribute": "footer-text",
|
30231
|
-
"reflects": true
|
30232
|
-
},
|
30233
|
-
{
|
30234
|
-
"kind": "field",
|
30235
|
-
"name": "grabberBtnAriaLabel",
|
30236
|
-
"type": {
|
30237
|
-
"text": "string | undefined"
|
30238
|
-
},
|
30239
|
-
"description": "Provides an accessible label for the grabber button.\nThis value is used to set the `aria-label` attribute for the button.",
|
30240
|
-
"default": "''",
|
30241
|
-
"attribute": "grabber-btn-aria-label",
|
30242
|
-
"reflects": true
|
30243
|
-
},
|
30244
|
-
{
|
30245
|
-
"kind": "field",
|
30246
|
-
"name": "parentNavTooltipText",
|
30247
|
-
"type": {
|
30248
|
-
"text": "string | undefined"
|
30249
|
-
},
|
30250
|
-
"description": "Tooltip text shown on parent nav items when a child is active.",
|
30251
|
-
"attribute": "parent-nav-tooltip-text",
|
30252
|
-
"reflects": true
|
30253
|
-
},
|
30254
|
-
{
|
30255
|
-
"kind": "method",
|
30256
|
-
"name": "updateContext",
|
30257
|
-
"privacy": "protected",
|
30258
|
-
"return": {
|
30259
|
-
"type": {
|
30260
|
-
"text": "void"
|
30261
|
-
}
|
30262
|
-
},
|
30263
|
-
"description": "Update all observing components of this\nprovider to update the values\n\nIs called on every re-render, see Provider class"
|
30264
|
-
},
|
30265
|
-
{
|
30266
|
-
"kind": "field",
|
30267
|
-
"name": "navMenuItems",
|
30268
|
-
"type": {
|
30269
|
-
"text": "NavMenuItem[]"
|
30270
|
-
},
|
30271
|
-
"privacy": "private",
|
30272
|
-
"description": "Returns all nested, non-disabled mdc-navmenuitem elements inside this component.",
|
30273
|
-
"readonly": true
|
30274
|
-
},
|
30275
|
-
{
|
30276
|
-
"kind": "method",
|
30277
|
-
"name": "preventScrollOnSpace",
|
30278
|
-
"privacy": "private",
|
30279
|
-
"return": {
|
30280
|
-
"type": {
|
30281
|
-
"text": "void"
|
30282
|
-
}
|
30283
|
-
},
|
30284
|
-
"parameters": [
|
30285
|
-
{
|
30286
|
-
"name": "event",
|
30287
|
-
"type": {
|
30288
|
-
"text": "KeyboardEvent"
|
30289
|
-
}
|
30290
|
-
}
|
30291
|
-
]
|
30292
|
-
}
|
30293
|
-
],
|
30294
|
-
"events": [
|
30295
|
-
{
|
30296
|
-
"description": "(React: onActiveChange) Dispatched when the active state of the navmenuitem changes.",
|
30297
|
-
"name": "activechange",
|
30298
|
-
"reactName": "onActiveChange"
|
30299
|
-
}
|
30300
|
-
],
|
30301
|
-
"attributes": [
|
30302
|
-
{
|
30303
|
-
"name": "variant",
|
30304
|
-
"type": {
|
30305
|
-
"text": "SideNavigationVariant"
|
30306
|
-
},
|
30307
|
-
"description": "Four variants of the sideNavigation\n- **fixed-collapsed**: Shows icons without labels and has fixed width, 4.5rem.\n- **fixed-expanded**: Shows icons with labels and has fixed width, 15rem.\n- **flexible**: Toggles between collapsed/expanded states.\n- **hidden**: Removes the sidenavigation from the DOM.",
|
30308
|
-
"default": "flexible",
|
30309
|
-
"fieldName": "variant"
|
30310
|
-
},
|
30311
|
-
{
|
30312
|
-
"name": "footer-text",
|
30313
|
-
"type": {
|
30314
|
-
"text": "string"
|
30315
|
-
},
|
30316
|
-
"default": "''",
|
30317
|
-
"description": "Displays footer text in the bottom section of the sidenavigation.",
|
30318
|
-
"fieldName": "footerText"
|
30319
|
-
},
|
30320
|
-
{
|
30321
|
-
"name": "grabber-btn-aria-label",
|
30322
|
-
"type": {
|
30323
|
-
"text": "string | undefined"
|
30324
|
-
},
|
30325
|
-
"description": "Provides an accessible label for the grabber button.\nThis value is used to set the `aria-label` attribute for the button.",
|
30326
|
-
"default": "''",
|
30327
|
-
"fieldName": "grabberBtnAriaLabel"
|
30328
|
-
},
|
30329
|
-
{
|
30330
|
-
"name": "parent-nav-tooltip-text",
|
30331
|
-
"type": {
|
30332
|
-
"text": "string | undefined"
|
30333
|
-
},
|
30334
|
-
"description": "Tooltip text shown on parent nav items when a child is active.",
|
30335
|
-
"fieldName": "parentNavTooltipText"
|
30336
|
-
}
|
30337
|
-
],
|
30338
|
-
"superclass": {
|
30339
|
-
"name": "Provider",
|
30340
|
-
"module": "/src/models"
|
30341
|
-
},
|
30342
|
-
"tagName": "mdc-sidenavigation",
|
30343
|
-
"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 */",
|
30344
|
-
"customElement": true
|
30345
|
-
}
|
30346
|
-
],
|
30347
|
-
"exports": [
|
30348
|
-
{
|
30349
|
-
"kind": "js",
|
30350
|
-
"name": "default",
|
30351
|
-
"declaration": {
|
30352
|
-
"name": "SideNavigation",
|
30353
|
-
"module": "components/sidenavigation/sidenavigation.component.js"
|
30354
|
-
}
|
30355
|
-
}
|
30356
|
-
]
|
30357
|
-
},
|
30358
30493
|
{
|
30359
30494
|
"kind": "javascript-module",
|
30360
30495
|
"path": "components/staticcheckbox/staticcheckbox.component.js",
|
@@ -34370,6 +34505,21 @@
|
|
34370
34505
|
"module": "components/popover/popover.component.js"
|
34371
34506
|
}
|
34372
34507
|
},
|
34508
|
+
{
|
34509
|
+
"kind": "field",
|
34510
|
+
"name": "boundaryPadding",
|
34511
|
+
"type": {
|
34512
|
+
"text": "number"
|
34513
|
+
},
|
34514
|
+
"description": "Virtual padding around the boundary to check for overflow.",
|
34515
|
+
"default": "16",
|
34516
|
+
"attribute": "boundary-padding",
|
34517
|
+
"reflects": true,
|
34518
|
+
"inheritedFrom": {
|
34519
|
+
"name": "Popover",
|
34520
|
+
"module": "components/popover/popover.component.js"
|
34521
|
+
}
|
34522
|
+
},
|
34373
34523
|
{
|
34374
34524
|
"kind": "field",
|
34375
34525
|
"name": "showArrow",
|
@@ -35065,6 +35215,19 @@
|
|
35065
35215
|
"module": "src/components/popover/popover.component.ts"
|
35066
35216
|
}
|
35067
35217
|
},
|
35218
|
+
{
|
35219
|
+
"name": "boundary-padding",
|
35220
|
+
"type": {
|
35221
|
+
"text": "number"
|
35222
|
+
},
|
35223
|
+
"description": "Virtual padding around the boundary to check for overflow.",
|
35224
|
+
"default": "16",
|
35225
|
+
"fieldName": "boundaryPadding",
|
35226
|
+
"inheritedFrom": {
|
35227
|
+
"name": "Popover",
|
35228
|
+
"module": "src/components/popover/popover.component.ts"
|
35229
|
+
}
|
35230
|
+
},
|
35068
35231
|
{
|
35069
35232
|
"name": "focus-trap",
|
35070
35233
|
"type": {
|
@@ -36221,6 +36384,21 @@
|
|
36221
36384
|
"module": "components/popover/popover.component.js"
|
36222
36385
|
}
|
36223
36386
|
},
|
36387
|
+
{
|
36388
|
+
"kind": "field",
|
36389
|
+
"name": "boundaryPadding",
|
36390
|
+
"type": {
|
36391
|
+
"text": "number"
|
36392
|
+
},
|
36393
|
+
"description": "Virtual padding around the boundary to check for overflow.",
|
36394
|
+
"default": "16",
|
36395
|
+
"attribute": "boundary-padding",
|
36396
|
+
"reflects": true,
|
36397
|
+
"inheritedFrom": {
|
36398
|
+
"name": "Popover",
|
36399
|
+
"module": "components/popover/popover.component.js"
|
36400
|
+
}
|
36401
|
+
},
|
36224
36402
|
{
|
36225
36403
|
"kind": "field",
|
36226
36404
|
"name": "showArrow",
|
@@ -36917,6 +37095,19 @@
|
|
36917
37095
|
"module": "src/components/popover/popover.component.ts"
|
36918
37096
|
}
|
36919
37097
|
},
|
37098
|
+
{
|
37099
|
+
"name": "boundary-padding",
|
37100
|
+
"type": {
|
37101
|
+
"text": "number"
|
37102
|
+
},
|
37103
|
+
"description": "Virtual padding around the boundary to check for overflow.",
|
37104
|
+
"default": "16",
|
37105
|
+
"fieldName": "boundaryPadding",
|
37106
|
+
"inheritedFrom": {
|
37107
|
+
"name": "Popover",
|
37108
|
+
"module": "src/components/popover/popover.component.ts"
|
37109
|
+
}
|
37110
|
+
},
|
36920
37111
|
{
|
36921
37112
|
"name": "focus-trap",
|
36922
37113
|
"type": {
|