@momentum-design/components 0.91.0 → 0.91.2
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 +413 -404
- package/dist/browser/index.js.map +4 -4
- package/dist/components/badge/badge.styles.js +5 -0
- 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 +441 -798
- 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
@@ -2190,77 +2190,6 @@
|
|
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
|
-
},
|
2264
2193
|
{
|
2265
2194
|
"kind": "javascript-module",
|
2266
2195
|
"path": "components/button/button.component.js",
|
@@ -2956,6 +2885,77 @@
|
|
2956
2885
|
}
|
2957
2886
|
]
|
2958
2887
|
},
|
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",
|
@@ -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",
|
@@ -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
|
{
|
@@ -21305,8 +21336,8 @@
|
|
21305
21336
|
"name": "MenuItem",
|
21306
21337
|
"module": "/src/components/menuitem/menuitem.component"
|
21307
21338
|
},
|
21308
|
-
"tagName": "mdc-
|
21309
|
-
"jsDoc": "/**\n * `mdc-
|
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 */",
|
21310
21341
|
"customElement": true,
|
21311
21342
|
"slots": [
|
21312
21343
|
{
|
@@ -21373,454 +21404,38 @@
|
|
21373
21404
|
"kind": "js",
|
21374
21405
|
"name": "default",
|
21375
21406
|
"declaration": {
|
21376
|
-
"name": "
|
21377
|
-
"module": "components/
|
21407
|
+
"name": "NavMenuItem",
|
21408
|
+
"module": "components/navmenuitem/navmenuitem.component.js"
|
21378
21409
|
}
|
21379
21410
|
}
|
21380
21411
|
]
|
21381
21412
|
},
|
21382
21413
|
{
|
21383
21414
|
"kind": "javascript-module",
|
21384
|
-
"path": "components/
|
21415
|
+
"path": "components/optgroup/optgroup.component.js",
|
21385
21416
|
"declarations": [
|
21386
21417
|
{
|
21387
21418
|
"kind": "class",
|
21388
|
-
"description": "
|
21389
|
-
"name": "
|
21419
|
+
"description": "optgroup component, which creates a grouping of mdc-option within a listbox element.",
|
21420
|
+
"name": "OptGroup",
|
21421
|
+
"cssProperties": [
|
21422
|
+
{
|
21423
|
+
"description": "Allows customization of the disabled option color.",
|
21424
|
+
"name": "--mdc-optgroup-disabled-color"
|
21425
|
+
}
|
21426
|
+
],
|
21390
21427
|
"slots": [
|
21391
21428
|
{
|
21392
|
-
"description": "
|
21393
|
-
"name": "default"
|
21394
|
-
"inheritedFrom": {
|
21395
|
-
"name": "MenuBar",
|
21396
|
-
"module": "src/components/menubar/menubar.component.ts"
|
21397
|
-
}
|
21429
|
+
"description": "This is a default slot for mdc-option elements.",
|
21430
|
+
"name": "default"
|
21398
21431
|
}
|
21399
21432
|
],
|
21400
21433
|
"members": [
|
21401
21434
|
{
|
21402
21435
|
"kind": "field",
|
21403
|
-
"name": "
|
21436
|
+
"name": "label",
|
21404
21437
|
"type": {
|
21405
|
-
"text": "string |
|
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
|
-
],
|
21553
|
-
"inheritedFrom": {
|
21554
|
-
"name": "MenuBar",
|
21555
|
-
"module": "components/menubar/menubar.component.js"
|
21556
|
-
}
|
21557
|
-
},
|
21558
|
-
{
|
21559
|
-
"kind": "method",
|
21560
|
-
"name": "showSubmenu",
|
21561
|
-
"privacy": "private",
|
21562
|
-
"return": {
|
21563
|
-
"type": {
|
21564
|
-
"text": "void"
|
21565
|
-
}
|
21566
|
-
},
|
21567
|
-
"parameters": [
|
21568
|
-
{
|
21569
|
-
"name": "triggerId",
|
21570
|
-
"type": {
|
21571
|
-
"text": "string | null"
|
21572
|
-
}
|
21573
|
-
}
|
21574
|
-
],
|
21575
|
-
"inheritedFrom": {
|
21576
|
-
"name": "MenuBar",
|
21577
|
-
"module": "components/menubar/menubar.component.js"
|
21578
|
-
}
|
21579
|
-
},
|
21580
|
-
{
|
21581
|
-
"kind": "method",
|
21582
|
-
"name": "getKeyWithDirectionFix",
|
21583
|
-
"privacy": "private",
|
21584
|
-
"return": {
|
21585
|
-
"type": {
|
21586
|
-
"text": "string"
|
21587
|
-
}
|
21588
|
-
},
|
21589
|
-
"parameters": [
|
21590
|
-
{
|
21591
|
-
"name": "originalKey",
|
21592
|
-
"type": {
|
21593
|
-
"text": "string"
|
21594
|
-
}
|
21595
|
-
}
|
21596
|
-
],
|
21597
|
-
"inheritedFrom": {
|
21598
|
-
"name": "MenuBar",
|
21599
|
-
"module": "components/menubar/menubar.component.js"
|
21600
|
-
}
|
21601
|
-
},
|
21602
|
-
{
|
21603
|
-
"kind": "method",
|
21604
|
-
"name": "isTopLevelMenuItem",
|
21605
|
-
"privacy": "private",
|
21606
|
-
"return": {
|
21607
|
-
"type": {
|
21608
|
-
"text": "boolean"
|
21609
|
-
}
|
21610
|
-
},
|
21611
|
-
"parameters": [
|
21612
|
-
{
|
21613
|
-
"name": "element",
|
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)",
|
21620
|
-
"inheritedFrom": {
|
21621
|
-
"name": "MenuBar",
|
21622
|
-
"module": "components/menubar/menubar.component.js"
|
21623
|
-
}
|
21624
|
-
},
|
21625
|
-
{
|
21626
|
-
"kind": "method",
|
21627
|
-
"name": "isNestedMenuItem",
|
21628
|
-
"privacy": "private",
|
21629
|
-
"return": {
|
21630
|
-
"type": {
|
21631
|
-
"text": "boolean"
|
21632
|
-
}
|
21633
|
-
},
|
21634
|
-
"parameters": [
|
21635
|
-
{
|
21636
|
-
"name": "element",
|
21637
|
-
"type": {
|
21638
|
-
"text": "HTMLElement"
|
21639
|
-
}
|
21640
|
-
}
|
21641
|
-
],
|
21642
|
-
"inheritedFrom": {
|
21643
|
-
"name": "MenuBar",
|
21644
|
-
"module": "components/menubar/menubar.component.js"
|
21645
|
-
}
|
21646
|
-
},
|
21647
|
-
{
|
21648
|
-
"kind": "method",
|
21649
|
-
"name": "closeAllMenuPopovers",
|
21650
|
-
"privacy": "private",
|
21651
|
-
"inheritedFrom": {
|
21652
|
-
"name": "MenuBar",
|
21653
|
-
"module": "components/menubar/menubar.component.js"
|
21654
|
-
}
|
21655
|
-
},
|
21656
|
-
{
|
21657
|
-
"kind": "method",
|
21658
|
-
"name": "crossMenubarNavigationOnLeft",
|
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
|
-
],
|
21673
|
-
"inheritedFrom": {
|
21674
|
-
"name": "MenuBar",
|
21675
|
-
"module": "components/menubar/menubar.component.js"
|
21676
|
-
}
|
21677
|
-
},
|
21678
|
-
{
|
21679
|
-
"kind": "method",
|
21680
|
-
"name": "crossMenubarNavigationOnRight",
|
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
|
-
],
|
21695
|
-
"inheritedFrom": {
|
21696
|
-
"name": "MenuBar",
|
21697
|
-
"module": "components/menubar/menubar.component.js"
|
21698
|
-
}
|
21699
|
-
},
|
21700
|
-
{
|
21701
|
-
"kind": "method",
|
21702
|
-
"name": "hasSubmenu",
|
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
|
-
],
|
21717
|
-
"inheritedFrom": {
|
21718
|
-
"name": "MenuBar",
|
21719
|
-
"module": "components/menubar/menubar.component.js"
|
21720
|
-
}
|
21721
|
-
},
|
21722
|
-
{
|
21723
|
-
"kind": "method",
|
21724
|
-
"name": "getParentMenuItemIndex",
|
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
|
-
],
|
21739
|
-
"inheritedFrom": {
|
21740
|
-
"name": "MenuBar",
|
21741
|
-
"module": "components/menubar/menubar.component.js"
|
21742
|
-
}
|
21743
|
-
},
|
21744
|
-
{
|
21745
|
-
"kind": "method",
|
21746
|
-
"name": "handleKeyDown",
|
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
|
-
],
|
21761
|
-
"inheritedFrom": {
|
21762
|
-
"name": "MenuBar",
|
21763
|
-
"module": "components/menubar/menubar.component.js"
|
21764
|
-
}
|
21765
|
-
}
|
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
|
21785
|
-
}
|
21786
|
-
],
|
21787
|
-
"exports": [
|
21788
|
-
{
|
21789
|
-
"kind": "js",
|
21790
|
-
"name": "default",
|
21791
|
-
"declaration": {
|
21792
|
-
"name": "NavItemList",
|
21793
|
-
"module": "components/navitemlist/navitemlist.component.js"
|
21794
|
-
}
|
21795
|
-
}
|
21796
|
-
]
|
21797
|
-
},
|
21798
|
-
{
|
21799
|
-
"kind": "javascript-module",
|
21800
|
-
"path": "components/optgroup/optgroup.component.js",
|
21801
|
-
"declarations": [
|
21802
|
-
{
|
21803
|
-
"kind": "class",
|
21804
|
-
"description": "optgroup component, which creates a grouping of mdc-option within a listbox element.",
|
21805
|
-
"name": "OptGroup",
|
21806
|
-
"cssProperties": [
|
21807
|
-
{
|
21808
|
-
"description": "Allows customization of the disabled option color.",
|
21809
|
-
"name": "--mdc-optgroup-disabled-color"
|
21810
|
-
}
|
21811
|
-
],
|
21812
|
-
"slots": [
|
21813
|
-
{
|
21814
|
-
"description": "This is a default slot for mdc-option elements.",
|
21815
|
-
"name": "default"
|
21816
|
-
}
|
21817
|
-
],
|
21818
|
-
"members": [
|
21819
|
-
{
|
21820
|
-
"kind": "field",
|
21821
|
-
"name": "label",
|
21822
|
-
"type": {
|
21823
|
-
"text": "string | undefined"
|
21438
|
+
"text": "string | undefined"
|
21824
21439
|
},
|
21825
21440
|
"description": "The header text to be displayed on the top of the options list.",
|
21826
21441
|
"attribute": "label",
|
@@ -30242,247 +29857,88 @@
|
|
30242
29857
|
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
30243
29858
|
"fieldName": "id",
|
30244
29859
|
"inheritedFrom": {
|
30245
|
-
"name": "FormfieldWrapper",
|
30246
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
30247
|
-
}
|
30248
|
-
},
|
30249
|
-
{
|
30250
|
-
"name": "help-text-type",
|
30251
|
-
"type": {
|
30252
|
-
"text": "ValidationType"
|
30253
|
-
},
|
30254
|
-
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
30255
|
-
"fieldName": "helpTextType",
|
30256
|
-
"inheritedFrom": {
|
30257
|
-
"name": "FormfieldWrapper",
|
30258
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
30259
|
-
}
|
30260
|
-
},
|
30261
|
-
{
|
30262
|
-
"name": "help-text",
|
30263
|
-
"type": {
|
30264
|
-
"text": "string | undefined"
|
30265
|
-
},
|
30266
|
-
"description": "The help text that is displayed below the input field.",
|
30267
|
-
"fieldName": "helpText",
|
30268
|
-
"inheritedFrom": {
|
30269
|
-
"name": "FormfieldWrapper",
|
30270
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
30271
|
-
}
|
30272
|
-
},
|
30273
|
-
{
|
30274
|
-
"name": "toggletip-text",
|
30275
|
-
"type": {
|
30276
|
-
"text": "string | undefined"
|
30277
|
-
},
|
30278
|
-
"description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
|
30279
|
-
"fieldName": "toggletipText",
|
30280
|
-
"inheritedFrom": {
|
30281
|
-
"name": "FormfieldWrapper",
|
30282
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
30283
|
-
}
|
30284
|
-
},
|
30285
|
-
{
|
30286
|
-
"name": "toggletip-placement",
|
30287
|
-
"type": {
|
30288
|
-
"text": "PopoverPlacement"
|
30289
|
-
},
|
30290
|
-
"description": "The placement of the toggletip that is displayed when the info icon is hovered.",
|
30291
|
-
"default": "'top'",
|
30292
|
-
"fieldName": "toggletipPlacement",
|
30293
|
-
"inheritedFrom": {
|
30294
|
-
"name": "FormfieldWrapper",
|
30295
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
30296
|
-
}
|
30297
|
-
},
|
30298
|
-
{
|
30299
|
-
"name": "info-icon-aria-label",
|
30300
|
-
"type": {
|
30301
|
-
"text": "string | undefined"
|
30302
|
-
},
|
30303
|
-
"description": "Aria label for the info icon that is displayed next to the label when `toggletipText` is set.\nThis is used for accessibility purposes to provide a description of the icon.",
|
30304
|
-
"fieldName": "infoIconAriaLabel",
|
30305
|
-
"inheritedFrom": {
|
30306
|
-
"name": "FormfieldWrapper",
|
30307
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
30308
|
-
}
|
30309
|
-
}
|
30310
|
-
],
|
30311
|
-
"mixins": [
|
30312
|
-
{
|
30313
|
-
"name": "FormInternalsMixin",
|
30314
|
-
"module": "/src/utils/mixins/FormInternalsMixin"
|
30315
|
-
},
|
30316
|
-
{
|
30317
|
-
"name": "DataAriaLabelMixin",
|
30318
|
-
"module": "/src/utils/mixins/DataAriaLabelMixin"
|
30319
|
-
}
|
30320
|
-
],
|
30321
|
-
"superclass": {
|
30322
|
-
"name": "FormfieldWrapper",
|
30323
|
-
"module": "/src/components/formfieldwrapper/formfieldwrapper.component"
|
30324
|
-
},
|
30325
|
-
"tagName": "mdc-select",
|
30326
|
-
"jsDoc": "/**\n * The mdc-select component is a dropdown selection control that allows users to pick an option from a predefined list.\n * It is designed to work with `mdc-option` for individual options and `mdc-optgroup` for grouping related options.\n * The component ensures accessibility and usability while handling various use cases,\n * including long text truncation with tooltip support.\n *\n * To set a default option, use the `selected` attribute on the `mdc-option` element.\n *\n * @dependency mdc-button\n * @dependency mdc-icon\n * @dependency mdc-popover\n * @dependency mdc-text\n * @dependency mdc-toggletip\n *\n * @tagname mdc-select\n *\n * @slot default - This is a default/unnamed slot for options and/or option group.\n *\n * @event click - (React: onClick) This event is dispatched when the select is clicked.\n * @event change - (React: onChange) This event is dispatched when the select is changed.\n * @event input - (React: onInput) This event is dispatched when the select is changed.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the select.\n * @event focus - (React: onFocus) This event is dispatched when the select receives focus.\n */",
|
30327
|
-
"customElement": true
|
30328
|
-
}
|
30329
|
-
],
|
30330
|
-
"exports": [
|
30331
|
-
{
|
30332
|
-
"kind": "js",
|
30333
|
-
"name": "default",
|
30334
|
-
"declaration": {
|
30335
|
-
"name": "Select",
|
30336
|
-
"module": "components/select/select.component.js"
|
30337
|
-
}
|
30338
|
-
}
|
30339
|
-
]
|
30340
|
-
},
|
30341
|
-
{
|
30342
|
-
"kind": "javascript-module",
|
30343
|
-
"path": "components/sidenavigation/sidenavigation.component.js",
|
30344
|
-
"declarations": [
|
30345
|
-
{
|
30346
|
-
"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-navitemlist` and `mdc-navitem`\n\n### Usage:\nIn a sidenavigation, navitems can be used in the following ways:\n\n1. **Simple navitem** – No submenu or interaction beyond selection.\n\n2. **Navitem with submenu**:\n - Provide an `id` on the `mdc-navitem`\n - Set the `triggerId` on the corresponding `mdc-menupopover` to match the navitem'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 navitem (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-navitem` and `mdc-navitemlist`\nto ensure screen reader support\n- Set `grabber-btn-aria-label` to provide accessible labels for the expand/collapse grabber button",
|
30348
|
-
"name": "SideNavigation",
|
30349
|
-
"cssProperties": [
|
30350
|
-
{
|
30351
|
-
"description": "width of the sideNavigation when expanded",
|
30352
|
-
"name": "--mdc-sidenavigation-expanded-width"
|
30353
|
-
},
|
30354
|
-
{
|
30355
|
-
"description": "width of the sideNavigation when collpased",
|
30356
|
-
"name": "--mdc-sidenavigation-collapsed-width"
|
30357
|
-
}
|
30358
|
-
],
|
30359
|
-
"slots": [
|
30360
|
-
{
|
30361
|
-
"description": "Slot for the scrollable content area of the side navigation.",
|
30362
|
-
"name": "scrollable-section"
|
30363
|
-
},
|
30364
|
-
{
|
30365
|
-
"description": "Slot for the fixed content area of the side navigation.",
|
30366
|
-
"name": "fixed-section"
|
30367
|
-
},
|
30368
|
-
{
|
30369
|
-
"description": "Slot for the brand logo (e.g., icon or img).",
|
30370
|
-
"name": "brand-logo"
|
30371
|
-
}
|
30372
|
-
],
|
30373
|
-
"members": [
|
30374
|
-
{
|
30375
|
-
"kind": "field",
|
30376
|
-
"name": "Context",
|
30377
|
-
"privacy": "public",
|
30378
|
-
"static": true,
|
30379
|
-
"readonly": true
|
30380
|
-
},
|
30381
|
-
{
|
30382
|
-
"kind": "field",
|
30383
|
-
"name": "variant",
|
30384
|
-
"type": {
|
30385
|
-
"text": "SideNavigationVariant"
|
30386
|
-
},
|
30387
|
-
"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.",
|
30388
|
-
"default": "flexible",
|
30389
|
-
"attribute": "variant",
|
30390
|
-
"reflects": true
|
30391
|
-
},
|
30392
|
-
{
|
30393
|
-
"kind": "field",
|
30394
|
-
"name": "customerName",
|
30395
|
-
"type": {
|
30396
|
-
"text": "string"
|
30397
|
-
},
|
30398
|
-
"default": "''",
|
30399
|
-
"description": "Name of the customer. This is displayed in the bottom section of the side-navigation component.",
|
30400
|
-
"attribute": "customer-name",
|
30401
|
-
"reflects": true
|
30402
|
-
},
|
30403
|
-
{
|
30404
|
-
"kind": "field",
|
30405
|
-
"name": "grabberBtnAriaLabel",
|
30406
|
-
"type": {
|
30407
|
-
"text": "string | undefined"
|
30408
|
-
},
|
30409
|
-
"description": "Provides an accessible label for the grabber button.\nThis value is used to set the `aria-label` attribute for the button.",
|
30410
|
-
"default": "''",
|
30411
|
-
"attribute": "grabber-btn-aria-label",
|
30412
|
-
"reflects": true
|
30413
|
-
},
|
30414
|
-
{
|
30415
|
-
"kind": "field",
|
30416
|
-
"name": "parentNavTooltipText",
|
30417
|
-
"type": {
|
30418
|
-
"text": "string | undefined"
|
30419
|
-
},
|
30420
|
-
"description": "Tooltip text shown on parent nav items when a child is active.",
|
30421
|
-
"attribute": "parent-nav-tooltip-text",
|
30422
|
-
"reflects": true
|
30423
|
-
},
|
30424
|
-
{
|
30425
|
-
"kind": "method",
|
30426
|
-
"name": "updateContext",
|
30427
|
-
"privacy": "protected",
|
30428
|
-
"return": {
|
30429
|
-
"type": {
|
30430
|
-
"text": "void"
|
30431
|
-
}
|
30432
|
-
},
|
30433
|
-
"description": "Update all observing components of this\nprovider to update the values\n\nIs called on every re-render, see Provider class"
|
30434
|
-
}
|
30435
|
-
],
|
30436
|
-
"events": [
|
30437
|
-
{
|
30438
|
-
"description": "(React: onActiveChange) Dispatched when the active state of the navitem changes.",
|
30439
|
-
"name": "activechange",
|
30440
|
-
"reactName": "onActiveChange"
|
30441
|
-
}
|
30442
|
-
],
|
30443
|
-
"attributes": [
|
29860
|
+
"name": "FormfieldWrapper",
|
29861
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
29862
|
+
}
|
29863
|
+
},
|
30444
29864
|
{
|
30445
|
-
"name": "
|
29865
|
+
"name": "help-text-type",
|
30446
29866
|
"type": {
|
30447
|
-
"text": "
|
29867
|
+
"text": "ValidationType"
|
30448
29868
|
},
|
30449
|
-
"description": "
|
30450
|
-
"
|
30451
|
-
"
|
29869
|
+
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
29870
|
+
"fieldName": "helpTextType",
|
29871
|
+
"inheritedFrom": {
|
29872
|
+
"name": "FormfieldWrapper",
|
29873
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
29874
|
+
}
|
30452
29875
|
},
|
30453
29876
|
{
|
30454
|
-
"name": "
|
29877
|
+
"name": "help-text",
|
30455
29878
|
"type": {
|
30456
|
-
"text": "string"
|
29879
|
+
"text": "string | undefined"
|
30457
29880
|
},
|
30458
|
-
"
|
30459
|
-
"
|
30460
|
-
"
|
29881
|
+
"description": "The help text that is displayed below the input field.",
|
29882
|
+
"fieldName": "helpText",
|
29883
|
+
"inheritedFrom": {
|
29884
|
+
"name": "FormfieldWrapper",
|
29885
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
29886
|
+
}
|
30461
29887
|
},
|
30462
29888
|
{
|
30463
|
-
"name": "
|
29889
|
+
"name": "toggletip-text",
|
30464
29890
|
"type": {
|
30465
29891
|
"text": "string | undefined"
|
30466
29892
|
},
|
30467
|
-
"description": "
|
30468
|
-
"
|
30469
|
-
"
|
29893
|
+
"description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
|
29894
|
+
"fieldName": "toggletipText",
|
29895
|
+
"inheritedFrom": {
|
29896
|
+
"name": "FormfieldWrapper",
|
29897
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
29898
|
+
}
|
30470
29899
|
},
|
30471
29900
|
{
|
30472
|
-
"name": "
|
29901
|
+
"name": "toggletip-placement",
|
29902
|
+
"type": {
|
29903
|
+
"text": "PopoverPlacement"
|
29904
|
+
},
|
29905
|
+
"description": "The placement of the toggletip that is displayed when the info icon is hovered.",
|
29906
|
+
"default": "'top'",
|
29907
|
+
"fieldName": "toggletipPlacement",
|
29908
|
+
"inheritedFrom": {
|
29909
|
+
"name": "FormfieldWrapper",
|
29910
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
29911
|
+
}
|
29912
|
+
},
|
29913
|
+
{
|
29914
|
+
"name": "info-icon-aria-label",
|
30473
29915
|
"type": {
|
30474
29916
|
"text": "string | undefined"
|
30475
29917
|
},
|
30476
|
-
"description": "
|
30477
|
-
"fieldName": "
|
29918
|
+
"description": "Aria label for the info icon that is displayed next to the label when `toggletipText` is set.\nThis is used for accessibility purposes to provide a description of the icon.",
|
29919
|
+
"fieldName": "infoIconAriaLabel",
|
29920
|
+
"inheritedFrom": {
|
29921
|
+
"name": "FormfieldWrapper",
|
29922
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
29923
|
+
}
|
29924
|
+
}
|
29925
|
+
],
|
29926
|
+
"mixins": [
|
29927
|
+
{
|
29928
|
+
"name": "FormInternalsMixin",
|
29929
|
+
"module": "/src/utils/mixins/FormInternalsMixin"
|
29930
|
+
},
|
29931
|
+
{
|
29932
|
+
"name": "DataAriaLabelMixin",
|
29933
|
+
"module": "/src/utils/mixins/DataAriaLabelMixin"
|
30478
29934
|
}
|
30479
29935
|
],
|
30480
29936
|
"superclass": {
|
30481
|
-
"name": "
|
30482
|
-
"module": "/src/
|
29937
|
+
"name": "FormfieldWrapper",
|
29938
|
+
"module": "/src/components/formfieldwrapper/formfieldwrapper.component"
|
30483
29939
|
},
|
30484
|
-
"tagName": "mdc-
|
30485
|
-
"jsDoc": "/**\n * The
|
29940
|
+
"tagName": "mdc-select",
|
29941
|
+
"jsDoc": "/**\n * The mdc-select component is a dropdown selection control that allows users to pick an option from a predefined list.\n * It is designed to work with `mdc-option` for individual options and `mdc-optgroup` for grouping related options.\n * The component ensures accessibility and usability while handling various use cases,\n * including long text truncation with tooltip support.\n *\n * To set a default option, use the `selected` attribute on the `mdc-option` element.\n *\n * @dependency mdc-button\n * @dependency mdc-icon\n * @dependency mdc-popover\n * @dependency mdc-text\n * @dependency mdc-toggletip\n *\n * @tagname mdc-select\n *\n * @slot default - This is a default/unnamed slot for options and/or option group.\n *\n * @event click - (React: onClick) This event is dispatched when the select is clicked.\n * @event change - (React: onChange) This event is dispatched when the select is changed.\n * @event input - (React: onInput) This event is dispatched when the select is changed.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the select.\n * @event focus - (React: onFocus) This event is dispatched when the select receives focus.\n */",
|
30486
29942
|
"customElement": true
|
30487
29943
|
}
|
30488
29944
|
],
|
@@ -30491,8 +29947,8 @@
|
|
30491
29947
|
"kind": "js",
|
30492
29948
|
"name": "default",
|
30493
29949
|
"declaration": {
|
30494
|
-
"name": "
|
30495
|
-
"module": "components/
|
29950
|
+
"name": "Select",
|
29951
|
+
"module": "components/select/select.component.js"
|
30496
29952
|
}
|
30497
29953
|
}
|
30498
29954
|
]
|
@@ -30712,6 +30168,193 @@
|
|
30712
30168
|
}
|
30713
30169
|
]
|
30714
30170
|
},
|
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
|
+
},
|
30715
30358
|
{
|
30716
30359
|
"kind": "javascript-module",
|
30717
30360
|
"path": "components/staticcheckbox/staticcheckbox.component.js",
|