@momentum-design/components 0.85.3 → 0.85.4

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.
Files changed (30) hide show
  1. package/dist/browser/index.js +237 -229
  2. package/dist/browser/index.js.map +4 -4
  3. package/dist/components/formfieldwrapper/formfieldwrapper.component.d.ts +1 -1
  4. package/dist/components/formfieldwrapper/formfieldwrapper.component.js +1 -1
  5. package/dist/components/listitem/listitem.component.d.ts +11 -0
  6. package/dist/components/listitem/listitem.component.js +11 -3
  7. package/dist/components/listitem/listitem.constants.d.ts +2 -2
  8. package/dist/components/listitem/listitem.constants.js +3 -2
  9. package/dist/components/listitem/listitem.styles.js +9 -1
  10. package/dist/components/menubar/menubar.component.d.ts +31 -5
  11. package/dist/components/menubar/menubar.component.js +198 -9
  12. package/dist/components/menubar/menubar.constants.d.ts +3 -4
  13. package/dist/components/menubar/menubar.constants.js +3 -4
  14. package/dist/components/menupopover/menupopover.component.d.ts +1 -0
  15. package/dist/components/menupopover/menupopover.component.js +13 -2
  16. package/dist/components/menupopover/menupopover.constants.d.ts +1 -0
  17. package/dist/components/menupopover/menupopover.constants.js +1 -0
  18. package/dist/components/navitemlist/navitemlist.component.d.ts +1 -2
  19. package/dist/components/navitemlist/navitemlist.component.js +1 -4
  20. package/dist/components/popover/popover.component.js +8 -2
  21. package/dist/custom-elements.json +620 -1739
  22. package/dist/react/index.d.ts +1 -1
  23. package/dist/react/index.js +1 -1
  24. package/dist/react/menubar/index.d.ts +6 -3
  25. package/dist/react/menubar/index.js +6 -3
  26. package/package.json +1 -1
  27. package/dist/components/menubar/menubar.types.d.ts +0 -4
  28. package/dist/components/menubar/menubar.types.js +0 -1
  29. package/dist/utils/mixins/MenuMixin.d.ts +0 -10
  30. package/dist/utils/mixins/MenuMixin.js +0 -479
@@ -14698,6 +14698,17 @@
14698
14698
  "attribute": "subline-text",
14699
14699
  "reflects": true
14700
14700
  },
14701
+ {
14702
+ "kind": "field",
14703
+ "name": "softDisabled",
14704
+ "type": {
14705
+ "text": "boolean | undefined"
14706
+ },
14707
+ "description": "Indicates whether the element is soft disabled.\nWhen set to `true`, the element appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe element behaves like a disabled element, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
14708
+ "default": "undefined",
14709
+ "attribute": "soft-disabled",
14710
+ "reflects": true
14711
+ },
14701
14712
  {
14702
14713
  "kind": "field",
14703
14714
  "name": "tooltipText",
@@ -14825,6 +14836,7 @@
14825
14836
  "parameters": [
14826
14837
  {
14827
14838
  "name": "disabled",
14839
+ "default": "false",
14828
14840
  "type": {
14829
14841
  "text": "boolean"
14830
14842
  },
@@ -14978,6 +14990,15 @@
14978
14990
  "description": "The subline text of the list item.\nThis appears on the trailing side of the list item.",
14979
14991
  "fieldName": "sublineText"
14980
14992
  },
14993
+ {
14994
+ "name": "soft-disabled",
14995
+ "type": {
14996
+ "text": "boolean | undefined"
14997
+ },
14998
+ "description": "Indicates whether the element is soft disabled.\nWhen set to `true`, the element appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe element behaves like a disabled element, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
14999
+ "default": "undefined",
15000
+ "fieldName": "softDisabled"
15001
+ },
14981
15002
  {
14982
15003
  "name": "tooltip-text",
14983
15004
  "type": {
@@ -15129,7 +15150,7 @@
15129
15150
  "declarations": [
15130
15151
  {
15131
15152
  "kind": "class",
15132
- "description": "Menubar is a navigational menu component that provides a horizontal (default) or vertical fixed list of menu items,\nwith support for nested submenus and keyboard navigation. It serves as a container\nfor menu items and manages their interaction patterns, including:\n- Keyboard navigation (arrow keys, Home, End)\n- Menu item activation (Enter/Space)\n- Submenu toggling (Right/Left arrow keys)\n- Focus management\n- Support for both horizontal and vertical orientations\n- Integration with MenuPopover for nested menus\n\nA menubar will contain a set of menu items and their associated popovers.\nEach menu item can have a popover for nested menus.\n\nThe component automatically handles ARIA attributes and follows WAI-ARIA menu design patterns.\nIt works in conjunction with `mdc-menuitem` and `mdc-menupopover` to create accessible menu structures.",
15153
+ "description": "Menubar is a navigational menu component that provides a vertical fixed list of menu items,\nwith support for nested submenus and keyboard navigation. It serves as a container\nfor menu items and manages their interaction patterns, including:\n- Keyboard navigation (Arrow keys, Home, End)\n- Menu item activation (Enter/Space)\n- Submenu toggling (Right/Left arrow keys)\n- Focus management\n- Integration with MenuPopover for nested menus\n\nA menubar will contain a set of menu items and their associated popovers.\nEach menu item can have a popover for nested menus.\n\nThe component automatically handles ARIA attributes and follows WAI-ARIA menu design patterns.\nIt works in conjunction with `mdc-menuitem` and `mdc-menupopover` to create accessible menu structures.\n\n**Note:** A menubar contains three types of menu items, including menuitem, menuitemradio and menuitemcheckbox. These menu items may optionally be nested in one or more group containers. Groups or items may optionally by separated with separator elements.\n\n`mdc-menubar` contains a group that wraps all its chilren passed within the default slot. This has been added to ensure the right accessibility behavior while using screen readers.",
15133
15154
  "name": "MenuBar",
15134
15155
  "slots": [
15135
15156
  {
@@ -15140,52 +15161,28 @@
15140
15161
  "members": [
15141
15162
  {
15142
15163
  "kind": "field",
15143
- "name": "ariaOrientation",
15164
+ "name": "menuItems",
15144
15165
  "type": {
15145
- "text": "Orientation"
15146
- },
15147
- "description": "Defines the orientation of the menu. This value is reflected to\nthe `aria-orientation` attribute and can be either `'horizontal'` or `'vertical'`.",
15148
- "default": "'horizontal'",
15149
- "attribute": "aria-orientation",
15150
- "reflects": true,
15151
- "inheritedFrom": {
15152
- "name": "MenuMixin",
15153
- "module": "utils/mixins/MenuMixin.js"
15166
+ "text": "Array<HTMLElement>"
15154
15167
  }
15155
15168
  },
15156
15169
  {
15157
15170
  "kind": "method",
15158
- "name": "setMenuBarPopoverValue",
15171
+ "name": "resetTabIndexAndSetActiveTabIndex",
15159
15172
  "privacy": "private",
15160
15173
  "parameters": [
15161
15174
  {
15162
- "name": "value",
15175
+ "name": "menuItems",
15163
15176
  "type": {
15164
- "text": "boolean"
15165
- },
15166
- "description": "The value to set."
15177
+ "text": "Array<HTMLElement>"
15178
+ }
15179
+ },
15180
+ {
15181
+ "description": "The index of the new active element in the list.",
15182
+ "name": "newIndex"
15167
15183
  }
15168
15184
  ],
15169
- "description": "Sets the value of the data-menu-popover-open attribute on the menu element.",
15170
- "inheritedFrom": {
15171
- "name": "MenuMixin",
15172
- "module": "utils/mixins/MenuMixin.js"
15173
- }
15174
- },
15175
- {
15176
- "kind": "method",
15177
- "name": "isMenuPopoverOpen",
15178
- "privacy": "private",
15179
- "return": {
15180
- "type": {
15181
- "text": "boolean"
15182
- }
15183
- },
15184
- "description": "Returns true if the data-menu-popover-open attribute on the menu element is set to 'true', false otherwise.",
15185
- "inheritedFrom": {
15186
- "name": "MenuMixin",
15187
- "module": "utils/mixins/MenuMixin.js"
15188
- }
15185
+ "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."
15189
15186
  },
15190
15187
  {
15191
15188
  "kind": "method",
@@ -15193,7 +15190,7 @@
15193
15190
  "privacy": "private",
15194
15191
  "return": {
15195
15192
  "type": {
15196
- "text": ""
15193
+ "text": "number"
15197
15194
  }
15198
15195
  },
15199
15196
  "parameters": [
@@ -15201,565 +15198,244 @@
15201
15198
  "name": "target",
15202
15199
  "type": {
15203
15200
  "text": "EventTarget | null"
15204
- },
15205
- "description": "The target element to find the index of."
15201
+ }
15206
15202
  }
15207
- ],
15208
- "description": "Returns the index of the given target in the menuItems array.\nIf the target is not a menu item, but a child element of a menu item,\nit returns the index of the parent menu item.",
15209
- "inheritedFrom": {
15210
- "name": "MenuMixin",
15211
- "module": "utils/mixins/MenuMixin.js"
15212
- }
15203
+ ]
15213
15204
  },
15214
15205
  {
15215
15206
  "kind": "method",
15216
- "name": "updatePopoverPlacementBasedOnOrientation",
15217
- "privacy": "protected",
15207
+ "name": "updatePopoverPlacement",
15208
+ "privacy": "private",
15218
15209
  "return": {
15219
15210
  "type": {
15220
15211
  "text": "void"
15221
15212
  }
15222
- },
15223
- "description": "Updates the placement of the popover based on the aria-orientation property.",
15224
- "inheritedFrom": {
15225
- "name": "MenuMixin",
15226
- "module": "utils/mixins/MenuMixin.js"
15227
15213
  }
15228
15214
  },
15229
15215
  {
15230
15216
  "kind": "method",
15231
- "name": "updateTabIndexAndFocusNewIndex",
15217
+ "name": "updateTabIndexAndFocus",
15232
15218
  "privacy": "private",
15219
+ "return": {
15220
+ "type": {
15221
+ "text": "void"
15222
+ }
15223
+ },
15233
15224
  "parameters": [
15234
15225
  {
15235
15226
  "name": "menuItems",
15236
15227
  "type": {
15237
- "text": "Array<HTMLElement>"
15238
- },
15239
- "description": "The list of menu items."
15228
+ "text": "HTMLElement[]"
15229
+ }
15240
15230
  },
15241
15231
  {
15242
15232
  "name": "currentIndex",
15243
15233
  "type": {
15244
15234
  "text": "number"
15245
- },
15246
- "description": "The current index of the focused menu item."
15235
+ }
15247
15236
  },
15248
15237
  {
15249
15238
  "name": "newIndex",
15250
15239
  "type": {
15251
15240
  "text": "number"
15252
- },
15253
- "description": "The index of the new active element in the list."
15241
+ }
15254
15242
  }
15255
- ],
15256
- "description": "Updates the tabindex of the current index to -1 and the tabindex of the new index to 0,\neffectively setting the active element. This is used when navigating the menu via keyboard.",
15257
- "inheritedFrom": {
15258
- "name": "MenuMixin",
15259
- "module": "utils/mixins/MenuMixin.js"
15260
- }
15243
+ ]
15261
15244
  },
15262
15245
  {
15263
15246
  "kind": "method",
15264
- "name": "isValidMenu",
15247
+ "name": "navigateToMenuItem",
15265
15248
  "privacy": "private",
15266
15249
  "return": {
15267
15250
  "type": {
15268
- "text": ""
15251
+ "text": "void"
15269
15252
  }
15270
15253
  },
15271
15254
  "parameters": [
15272
15255
  {
15273
- "name": "tagName",
15274
- "optional": true,
15256
+ "name": "currentIndex",
15275
15257
  "type": {
15276
- "text": "string"
15277
- },
15278
- "description": "The tag name to check."
15258
+ "text": "number"
15259
+ }
15260
+ },
15261
+ {
15262
+ "name": "direction",
15263
+ "type": {
15264
+ "text": "'prev' | 'next'"
15265
+ }
15266
+ },
15267
+ {
15268
+ "name": "shouldOpenSubmenu",
15269
+ "default": "false"
15279
15270
  }
15280
- ],
15281
- "description": "Checks if the given tag name is a valid menu tag name.",
15282
- "inheritedFrom": {
15283
- "name": "MenuMixin",
15284
- "module": "utils/mixins/MenuMixin.js"
15285
- }
15271
+ ]
15286
15272
  },
15287
15273
  {
15288
15274
  "kind": "method",
15289
- "name": "isValidNavItemList",
15275
+ "name": "showSubmenu",
15290
15276
  "privacy": "private",
15291
15277
  "return": {
15292
15278
  "type": {
15293
- "text": ""
15279
+ "text": "void"
15294
15280
  }
15295
15281
  },
15296
15282
  "parameters": [
15297
15283
  {
15298
- "name": "tagName",
15299
- "optional": true,
15284
+ "name": "triggerId",
15300
15285
  "type": {
15301
- "text": "string"
15302
- },
15303
- "description": "The tag name to check."
15286
+ "text": "string | null"
15287
+ }
15304
15288
  }
15305
- ],
15306
- "description": "Checks if the given tag name is a valid navitemlist tag name.",
15307
- "inheritedFrom": {
15308
- "name": "MenuMixin",
15309
- "module": "utils/mixins/MenuMixin.js"
15310
- }
15289
+ ]
15311
15290
  },
15312
15291
  {
15313
15292
  "kind": "method",
15314
- "name": "isValidPopover",
15293
+ "name": "getKeyWithDirectionFix",
15315
15294
  "privacy": "private",
15316
15295
  "return": {
15317
15296
  "type": {
15318
- "text": ""
15297
+ "text": "string"
15319
15298
  }
15320
15299
  },
15321
15300
  "parameters": [
15322
15301
  {
15323
- "name": "tagName",
15324
- "optional": true,
15302
+ "name": "originalKey",
15325
15303
  "type": {
15326
15304
  "text": "string"
15327
- },
15328
- "description": "The tag name to check."
15305
+ }
15329
15306
  }
15330
- ],
15331
- "description": "Checks if the given tag name is a valid menu popover tag name.",
15332
- "inheritedFrom": {
15333
- "name": "MenuMixin",
15334
- "module": "utils/mixins/MenuMixin.js"
15335
- }
15307
+ ]
15336
15308
  },
15337
15309
  {
15338
15310
  "kind": "method",
15339
- "name": "openPopover",
15311
+ "name": "isTopLevelMenuItem",
15340
15312
  "privacy": "private",
15341
15313
  "return": {
15342
15314
  "type": {
15343
- "text": ""
15315
+ "text": "boolean"
15344
15316
  }
15345
15317
  },
15346
15318
  "parameters": [
15347
15319
  {
15348
- "name": "index",
15320
+ "name": "element",
15349
15321
  "type": {
15350
- "text": "number"
15351
- },
15352
- "description": "The index of the menu item to open the popover for."
15322
+ "text": "HTMLElement"
15323
+ }
15353
15324
  }
15354
- ],
15355
- "description": "Opens the popover at the given index if it exists.",
15356
- "inheritedFrom": {
15357
- "name": "MenuMixin",
15358
- "module": "utils/mixins/MenuMixin.js"
15359
- }
15325
+ ]
15360
15326
  },
15361
15327
  {
15362
15328
  "kind": "method",
15363
- "name": "navigateToPrevMenuItem",
15329
+ "name": "isNestedMenuItem",
15364
15330
  "privacy": "private",
15365
15331
  "return": {
15366
15332
  "type": {
15367
- "text": "void"
15333
+ "text": "boolean"
15368
15334
  }
15369
15335
  },
15370
15336
  "parameters": [
15371
15337
  {
15372
- "name": "currentIndex",
15373
- "type": {
15374
- "text": "number"
15375
- },
15376
- "description": "The current index of the focused menu item."
15377
- },
15378
- {
15379
- "name": "firstMenuIndex",
15380
- "type": {
15381
- "text": "number"
15382
- },
15383
- "description": "The index of the first menu item."
15384
- },
15385
- {
15386
- "name": "lastMenuIndex",
15387
- "type": {
15388
- "text": "number"
15389
- },
15390
- "description": "The index of the last menu item."
15391
- },
15392
- {
15393
- "name": "ariaOrientation",
15338
+ "name": "element",
15394
15339
  "type": {
15395
- "text": "Orientation"
15396
- },
15397
- "description": "The orientation of the menu."
15340
+ "text": "HTMLElement"
15341
+ }
15398
15342
  }
15399
- ],
15400
- "description": "Navigates to the previous menu item and updates the tabindex of the current index\nto -1 and the tabindex of the new index to 0.",
15401
- "inheritedFrom": {
15402
- "name": "MenuMixin",
15403
- "module": "utils/mixins/MenuMixin.js"
15404
- }
15343
+ ]
15405
15344
  },
15406
15345
  {
15407
15346
  "kind": "method",
15408
- "name": "navigateToNextMenuItem",
15409
- "privacy": "private",
15410
- "return": {
15411
- "type": {
15412
- "text": "void"
15413
- }
15414
- },
15415
- "parameters": [
15416
- {
15417
- "name": "currentIndex",
15418
- "type": {
15419
- "text": "number"
15420
- },
15421
- "description": "The current index of the focused menu item."
15422
- },
15423
- {
15424
- "name": "firstMenuIndex",
15425
- "type": {
15426
- "text": "number"
15427
- },
15428
- "description": "The index of the first menu item."
15429
- },
15430
- {
15431
- "name": "lastMenuIndex",
15432
- "type": {
15433
- "text": "number"
15434
- },
15435
- "description": "The index of the last menu item."
15436
- },
15437
- {
15438
- "name": "ariaOrientation",
15439
- "type": {
15440
- "text": "Orientation"
15441
- },
15442
- "description": "The orientation of the menu."
15443
- }
15444
- ],
15445
- "description": "Navigates to the next menu item and updates the tabindex of the current index\nto -1 and the tabindex of the new index to 0.",
15446
- "inheritedFrom": {
15447
- "name": "MenuMixin",
15448
- "module": "utils/mixins/MenuMixin.js"
15449
- }
15347
+ "name": "closeAllMenuPopovers",
15348
+ "privacy": "private"
15450
15349
  },
15451
15350
  {
15452
15351
  "kind": "method",
15453
- "name": "getParentMenuItemDetails",
15352
+ "name": "crossMenubarNavigationOnLeft",
15454
15353
  "privacy": "private",
15455
15354
  "return": {
15456
15355
  "type": {
15457
- "text": ""
15356
+ "text": "Promise<void>"
15458
15357
  }
15459
15358
  },
15460
15359
  "parameters": [
15461
15360
  {
15462
- "name": "menuChildId",
15463
- "type": {
15464
- "text": "string"
15465
- },
15466
- "description": "The id of the menu child element."
15467
- },
15468
- {
15469
- "name": "menu",
15470
- "optional": true,
15361
+ "name": "element",
15471
15362
  "type": {
15472
- "text": "HTMLElement | null"
15473
- },
15474
- "description": "The current menu element to start traversing from."
15363
+ "text": "HTMLElement"
15364
+ }
15475
15365
  }
15476
- ],
15477
- "description": "Returns the parent menu item details for the given menu child id.\nIt recursively traverses up the DOM tree until it finds a menu or menubar element.",
15478
- "inheritedFrom": {
15479
- "name": "MenuMixin",
15480
- "module": "utils/mixins/MenuMixin.js"
15481
- }
15366
+ ]
15482
15367
  },
15483
15368
  {
15484
15369
  "kind": "method",
15485
- "name": "hideAllPopovers",
15370
+ "name": "crossMenubarNavigationOnRight",
15486
15371
  "privacy": "private",
15487
15372
  "return": {
15488
15373
  "type": {
15489
- "text": "void"
15374
+ "text": "Promise<void>"
15490
15375
  }
15491
15376
  },
15492
15377
  "parameters": [
15493
15378
  {
15494
- "name": "menu",
15495
- "optional": true,
15379
+ "name": "element",
15496
15380
  "type": {
15497
- "text": "HTMLElement | null"
15498
- },
15499
- "description": "The current menu element to start traversing from."
15381
+ "text": "HTMLElement"
15382
+ }
15500
15383
  }
15501
- ],
15502
- "description": "Recursively hides all the popovers up the DOM tree until it finds a menu or menubar element.",
15503
- "inheritedFrom": {
15504
- "name": "MenuMixin",
15505
- "module": "utils/mixins/MenuMixin.js"
15506
- }
15384
+ ]
15507
15385
  },
15508
15386
  {
15509
15387
  "kind": "method",
15510
- "name": "navigateToPrevParentMenuItem",
15388
+ "name": "hasSubmenu",
15511
15389
  "privacy": "private",
15512
15390
  "return": {
15513
15391
  "type": {
15514
- "text": "void"
15392
+ "text": "boolean"
15515
15393
  }
15516
15394
  },
15517
15395
  "parameters": [
15518
15396
  {
15519
- "name": "currentIndex",
15520
- "type": {
15521
- "text": "number"
15522
- },
15523
- "description": "The current index of the focused menu item."
15524
- },
15525
- {
15526
- "name": "key",
15397
+ "name": "triggerId",
15527
15398
  "type": {
15528
- "text": "string"
15399
+ "text": "string | null"
15529
15400
  }
15530
15401
  }
15531
- ],
15532
- "description": "Recursively navigates up the DOM tree until it finds the previous menu item\nand updates the tabindex of the current index to -1 and the tabindex of the new index to 0.\nAlso opens the popover of the previous menu item.",
15533
- "inheritedFrom": {
15534
- "name": "MenuMixin",
15535
- "module": "utils/mixins/MenuMixin.js"
15536
- }
15402
+ ]
15537
15403
  },
15538
15404
  {
15539
15405
  "kind": "method",
15540
- "name": "closePopoverAndNavigateToPrevParentMenuItem",
15406
+ "name": "getParentMenuItemIndex",
15541
15407
  "privacy": "private",
15542
15408
  "return": {
15543
15409
  "type": {
15544
- "text": "void"
15410
+ "text": "number"
15545
15411
  }
15546
15412
  },
15547
15413
  "parameters": [
15548
15414
  {
15549
- "name": "currentIndex",
15550
- "type": {
15551
- "text": "number"
15552
- },
15553
- "description": "The current index of the focused menu item."
15554
- },
15555
- {
15556
- "name": "key",
15415
+ "name": "element",
15557
15416
  "type": {
15558
- "text": "string"
15417
+ "text": "HTMLElement"
15559
15418
  }
15560
15419
  }
15561
- ],
15562
- "description": "Closes the current menu popover and navigates to the previous parent menu item.",
15563
- "inheritedFrom": {
15564
- "name": "MenuMixin",
15565
- "module": "utils/mixins/MenuMixin.js"
15566
- }
15420
+ ]
15567
15421
  },
15568
15422
  {
15569
15423
  "kind": "method",
15570
- "name": "getParentMenuContents",
15424
+ "name": "handleKeyDown",
15571
15425
  "privacy": "private",
15572
15426
  "return": {
15573
15427
  "type": {
15574
- "text": ""
15428
+ "text": "Promise<void>"
15575
15429
  }
15576
15430
  },
15577
15431
  "parameters": [
15578
15432
  {
15579
- "name": "currentMenuItem",
15433
+ "name": "event",
15580
15434
  "type": {
15581
- "text": "HTMLElement | null"
15582
- },
15583
- "description": "The current menu item to start traversing from."
15435
+ "text": "KeyboardEvent"
15436
+ }
15584
15437
  }
15585
- ],
15586
- "description": "Gets the parent menu contents of the given current menu item.\nIt recursively traverses up the DOM tree until it finds the parent menu element\nand gets the parent menu item details and the children of the parent menu item.",
15587
- "inheritedFrom": {
15588
- "name": "MenuMixin",
15589
- "module": "utils/mixins/MenuMixin.js"
15590
- }
15591
- },
15592
- {
15593
- "kind": "method",
15594
- "name": "openPopoverAndNavigateToNextChildrenMenuItem",
15595
- "privacy": "private",
15596
- "return": {
15597
- "type": {
15598
- "text": "void"
15599
- }
15600
- },
15601
- "parameters": [
15602
- {
15603
- "name": "currentIndex",
15604
- "type": {
15605
- "text": "number"
15606
- },
15607
- "description": "The current index of the focused menu item."
15608
- }
15609
- ],
15610
- "description": "Opens the popover of the next children menu item if there are children.\nIf there are no children, then it closes all popovers recursively and\nnavigates to the next menu item from the menu bar.\nIf the parent menu item does not have any children, then we will go to the next menu item.",
15611
- "inheritedFrom": {
15612
- "name": "MenuMixin",
15613
- "module": "utils/mixins/MenuMixin.js"
15614
- }
15615
- },
15616
- {
15617
- "kind": "method",
15618
- "name": "isValidMenuItem",
15619
- "privacy": "private",
15620
- "return": {
15621
- "type": {
15622
- "text": ""
15623
- }
15624
- },
15625
- "parameters": [
15626
- {
15627
- "name": "menuItem",
15628
- "type": {
15629
- "text": "HTMLElement"
15630
- },
15631
- "description": "The menu item to check."
15632
- }
15633
- ],
15634
- "description": "Checks if the given menu item is a valid menu item.",
15635
- "inheritedFrom": {
15636
- "name": "MenuMixin",
15637
- "module": "utils/mixins/MenuMixin.js"
15638
- }
15639
- },
15640
- {
15641
- "kind": "method",
15642
- "name": "resetTabIndexAndSetActiveTabIndex",
15643
- "privacy": "private",
15644
- "parameters": [
15645
- {
15646
- "name": "menuItems",
15647
- "type": {
15648
- "text": "Array<HTMLElement>"
15649
- }
15650
- },
15651
- {
15652
- "description": "The index of the new active element in the list.",
15653
- "name": "newIndex"
15654
- }
15655
- ],
15656
- "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.",
15657
- "inheritedFrom": {
15658
- "name": "MenuMixin",
15659
- "module": "utils/mixins/MenuMixin.js"
15660
- }
15661
- },
15662
- {
15663
- "kind": "method",
15664
- "name": "getKeyBasedOnDirection",
15665
- "privacy": "private",
15666
- "return": {
15667
- "type": {
15668
- "text": ""
15669
- }
15670
- },
15671
- "parameters": [
15672
- {
15673
- "name": "originalKey",
15674
- "type": {
15675
- "text": "string"
15676
- },
15677
- "description": "The original key pressed."
15678
- }
15679
- ],
15680
- "description": "Returns the key based on the direction of the document.\nIf the document is in RTL mode and the key is ARROW_LEFT or ARROW_RIGHT,\nit will swap them to maintain the correct navigation direction.",
15681
- "inheritedFrom": {
15682
- "name": "MenuMixin",
15683
- "module": "utils/mixins/MenuMixin.js"
15684
- }
15685
- },
15686
- {
15687
- "kind": "method",
15688
- "name": "handleKeyDown",
15689
- "privacy": "protected",
15690
- "return": {
15691
- "type": {
15692
- "text": "void"
15693
- }
15694
- },
15695
- "parameters": [
15696
- {
15697
- "name": "event",
15698
- "type": {
15699
- "text": "KeyboardEvent"
15700
- },
15701
- "description": "The keyboard event."
15702
- }
15703
- ],
15704
- "description": "Handles the keydown event on the menu bar.\nThe keys are as follows:\n- HOME: Sets focus to the first menu item.\n- END: Sets focus to the last menu item.\n- ARROW_LEFT:\n - If orientation is horizontal, then it navigates to the previous menu item.\n - If orientation is vertical, then it closes the popover of the current menu item and\n navigates to the previous parent menu item.\n- ARROW_RIGHT:\n - If orientation is horizontal, then it navigates to the next menu item.\n - If orientation is vertical, then it opens the popover of the current menu item and\n navigates to the next children menu item.\n- ARROW_UP:\n - If orientation is horizontal, then it opens the popover of the current menu item.\n - If orientation is vertical, then it navigates to the previous menu item.\n- ARROW_DOWN:\n - If orientation is horizontal, then it opens the popover of the current menu item.\n - If orientation is vertical, then it navigates to the next menu item.\n- SPACE:\n- ENTER:\n - If the next element sibling is a menu popover, then it opens the popover of the current\n menu item and navigates to the next children menu item.\n - If the target element is a menu item, then it closes all popovers recursively and\n navigates to the previous parent menu item.\n- ESCAPE:\n - If a popover is already open then we close it and navigate to the parent menu item.\n - If the current menuitem is a child of menubar, then we will set the value of isMenuPopoverOpen to false.,",
15705
- "inheritedFrom": {
15706
- "name": "MenuMixin",
15707
- "module": "utils/mixins/MenuMixin.js"
15708
- }
15709
- },
15710
- {
15711
- "kind": "method",
15712
- "name": "closeAllPopoversExceptCurrent",
15713
- "privacy": "private",
15714
- "return": {
15715
- "type": {
15716
- "text": "void"
15717
- }
15718
- },
15719
- "parameters": [
15720
- {
15721
- "name": "currentIndex",
15722
- "type": {
15723
- "text": "number"
15724
- },
15725
- "description": "The index of the current menu item."
15726
- }
15727
- ],
15728
- "description": "Closes all popovers except the current one.",
15729
- "inheritedFrom": {
15730
- "name": "MenuMixin",
15731
- "module": "utils/mixins/MenuMixin.js"
15732
- }
15733
- },
15734
- {
15735
- "kind": "method",
15736
- "name": "handleMouseClick",
15737
- "privacy": "protected",
15738
- "return": {
15739
- "type": {
15740
- "text": "void"
15741
- }
15742
- },
15743
- "parameters": [
15744
- {
15745
- "name": "event",
15746
- "type": {
15747
- "text": "MouseEvent"
15748
- },
15749
- "description": "The mouse click event."
15750
- }
15751
- ],
15752
- "description": "Handles the mouse click event on the menu items.\n- If the menuitem has children, then it opens the popover of the next children menu item.\n- If the menuitem does not have children, then it closes all popovers recursively.",
15753
- "inheritedFrom": {
15754
- "name": "MenuMixin",
15755
- "module": "utils/mixins/MenuMixin.js"
15756
- }
15757
- }
15758
- ],
15759
- "mixins": [
15760
- {
15761
- "name": "MenuMixin",
15762
- "module": "/src/utils/mixins/MenuMixin"
15438
+ ]
15763
15439
  }
15764
15440
  ],
15765
15441
  "superclass": {
@@ -15767,23 +15443,8 @@
15767
15443
  "module": "/src/models"
15768
15444
  },
15769
15445
  "tagName": "mdc-menubar",
15770
- "jsDoc": "/**\n * Menubar is a navigational menu component that provides a horizontal (default) or vertical fixed list of menu items,\n * with support for nested submenus and keyboard navigation. It serves as a container\n * for menu items and manages their interaction patterns, including:\n * - Keyboard navigation (arrow keys, Home, End)\n * - Menu item activation (Enter/Space)\n * - Submenu toggling (Right/Left arrow keys)\n * - Focus management\n * - Support for both horizontal and vertical orientations\n * - Integration with MenuPopover for nested menus\n *\n * A menubar will contain a set of menu items and their associated popovers.\n * Each menu item can have a popover for nested menus.\n *\n * The component automatically handles ARIA attributes and follows WAI-ARIA menu design patterns.\n * It works in conjunction with `mdc-menuitem` and `mdc-menupopover` to create accessible menu structures.\n *\n * @tagname mdc-menubar\n * @slot default - Contains the menu items and their associated popovers\n */",
15771
- "customElement": true,
15772
- "attributes": [
15773
- {
15774
- "name": "aria-orientation",
15775
- "type": {
15776
- "text": "Orientation"
15777
- },
15778
- "description": "Defines the orientation of the menu. This value is reflected to\nthe `aria-orientation` attribute and can be either `'horizontal'` or `'vertical'`.",
15779
- "default": "'horizontal'",
15780
- "fieldName": "ariaOrientation",
15781
- "inheritedFrom": {
15782
- "name": "MenuMixin",
15783
- "module": "src/utils/mixins/MenuMixin.ts"
15784
- }
15785
- }
15786
- ]
15446
+ "jsDoc": "/**\n * Menubar is a navigational menu component that provides a vertical fixed list of menu items,\n * with support for nested submenus and keyboard navigation. It serves as a container\n * for menu items and manages their interaction patterns, including:\n * - Keyboard navigation (Arrow keys, Home, End)\n * - Menu item activation (Enter/Space)\n * - Submenu toggling (Right/Left arrow keys)\n * - Focus management\n * - Integration with MenuPopover for nested menus\n *\n * A menubar will contain a set of menu items and their associated popovers.\n * Each menu item can have a popover for nested menus.\n *\n * The component automatically handles ARIA attributes and follows WAI-ARIA menu design patterns.\n * It works in conjunction with `mdc-menuitem` and `mdc-menupopover` to create accessible menu structures.\n *\n * **Note:** A menubar contains three types of menu items, including menuitem, menuitemradio and menuitemcheckbox. These menu items may optionally be nested in one or more group containers. Groups or items may optionally by separated with separator elements.\n *\n * `mdc-menubar` contains a group that wraps all its chilren passed within the default slot. This has been added to ensure the right accessibility behavior while using screen readers.\n *\n * @tagname mdc-menubar\n * @slot default - Contains the menu items and their associated popovers\n */",
15447
+ "customElement": true
15787
15448
  }
15788
15449
  ],
15789
15450
  "exports": [
@@ -16015,6 +15676,21 @@
16015
15676
  "module": "components/listitem/listitem.component.js"
16016
15677
  }
16017
15678
  },
15679
+ {
15680
+ "kind": "field",
15681
+ "name": "softDisabled",
15682
+ "type": {
15683
+ "text": "boolean | undefined"
15684
+ },
15685
+ "description": "Indicates whether the element is soft disabled.\nWhen set to `true`, the element appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe element behaves like a disabled element, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
15686
+ "default": "undefined",
15687
+ "attribute": "soft-disabled",
15688
+ "reflects": true,
15689
+ "inheritedFrom": {
15690
+ "name": "ListItem",
15691
+ "module": "components/listitem/listitem.component.js"
15692
+ }
15693
+ },
16018
15694
  {
16019
15695
  "kind": "field",
16020
15696
  "name": "tooltipText",
@@ -16150,6 +15826,7 @@
16150
15826
  "parameters": [
16151
15827
  {
16152
15828
  "name": "disabled",
15829
+ "default": "false",
16153
15830
  "type": {
16154
15831
  "text": "boolean"
16155
15832
  },
@@ -16341,6 +16018,19 @@
16341
16018
  "module": "src/components/listitem/listitem.component.ts"
16342
16019
  }
16343
16020
  },
16021
+ {
16022
+ "name": "soft-disabled",
16023
+ "type": {
16024
+ "text": "boolean | undefined"
16025
+ },
16026
+ "description": "Indicates whether the element is soft disabled.\nWhen set to `true`, the element appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe element behaves like a disabled element, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
16027
+ "default": "undefined",
16028
+ "fieldName": "softDisabled",
16029
+ "inheritedFrom": {
16030
+ "name": "ListItem",
16031
+ "module": "src/components/listitem/listitem.component.ts"
16032
+ }
16033
+ },
16344
16034
  {
16345
16035
  "name": "tooltip-text",
16346
16036
  "type": {
@@ -16872,6 +16562,21 @@
16872
16562
  "module": "components/listitem/listitem.component.js"
16873
16563
  }
16874
16564
  },
16565
+ {
16566
+ "kind": "field",
16567
+ "name": "softDisabled",
16568
+ "type": {
16569
+ "text": "boolean | undefined"
16570
+ },
16571
+ "description": "Indicates whether the element is soft disabled.\nWhen set to `true`, the element appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe element behaves like a disabled element, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
16572
+ "default": "undefined",
16573
+ "attribute": "soft-disabled",
16574
+ "reflects": true,
16575
+ "inheritedFrom": {
16576
+ "name": "ListItem",
16577
+ "module": "components/listitem/listitem.component.js"
16578
+ }
16579
+ },
16875
16580
  {
16876
16581
  "kind": "field",
16877
16582
  "name": "tooltipText",
@@ -17007,6 +16712,7 @@
17007
16712
  "parameters": [
17008
16713
  {
17009
16714
  "name": "disabled",
16715
+ "default": "false",
17010
16716
  "type": {
17011
16717
  "text": "boolean"
17012
16718
  },
@@ -17229,6 +16935,19 @@
17229
16935
  "module": "src/components/listitem/listitem.component.ts"
17230
16936
  }
17231
16937
  },
16938
+ {
16939
+ "name": "soft-disabled",
16940
+ "type": {
16941
+ "text": "boolean | undefined"
16942
+ },
16943
+ "description": "Indicates whether the element is soft disabled.\nWhen set to `true`, the element appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe element behaves like a disabled element, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
16944
+ "default": "undefined",
16945
+ "fieldName": "softDisabled",
16946
+ "inheritedFrom": {
16947
+ "name": "ListItem",
16948
+ "module": "src/components/listitem/listitem.component.ts"
16949
+ }
16950
+ },
17232
16951
  {
17233
16952
  "name": "tooltip-text",
17234
16953
  "type": {
@@ -17591,6 +17310,21 @@
17591
17310
  "module": "components/listitem/listitem.component.js"
17592
17311
  }
17593
17312
  },
17313
+ {
17314
+ "kind": "field",
17315
+ "name": "softDisabled",
17316
+ "type": {
17317
+ "text": "boolean | undefined"
17318
+ },
17319
+ "description": "Indicates whether the element is soft disabled.\nWhen set to `true`, the element appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe element behaves like a disabled element, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
17320
+ "default": "undefined",
17321
+ "attribute": "soft-disabled",
17322
+ "reflects": true,
17323
+ "inheritedFrom": {
17324
+ "name": "ListItem",
17325
+ "module": "components/listitem/listitem.component.js"
17326
+ }
17327
+ },
17594
17328
  {
17595
17329
  "kind": "field",
17596
17330
  "name": "tooltipText",
@@ -17726,6 +17460,7 @@
17726
17460
  "parameters": [
17727
17461
  {
17728
17462
  "name": "disabled",
17463
+ "default": "false",
17729
17464
  "type": {
17730
17465
  "text": "boolean"
17731
17466
  },
@@ -17948,6 +17683,19 @@
17948
17683
  "module": "src/components/listitem/listitem.component.ts"
17949
17684
  }
17950
17685
  },
17686
+ {
17687
+ "name": "soft-disabled",
17688
+ "type": {
17689
+ "text": "boolean | undefined"
17690
+ },
17691
+ "description": "Indicates whether the element is soft disabled.\nWhen set to `true`, the element appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe element behaves like a disabled element, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
17692
+ "default": "undefined",
17693
+ "fieldName": "softDisabled",
17694
+ "inheritedFrom": {
17695
+ "name": "ListItem",
17696
+ "module": "src/components/listitem/listitem.component.ts"
17697
+ }
17698
+ },
17951
17699
  {
17952
17700
  "name": "tooltip-text",
17953
17701
  "type": {
@@ -18255,6 +18003,16 @@
18255
18003
  ],
18256
18004
  "description": "Checks if the menu popover has a submenu with the specified trigger ID.\nThis method is used to determine if a menu item has a submenu associated with it,\nwhich is indicated by the presence of a `triggerid` attribute in the submenu popover.\nIt queries the parent element for any popover with the specified trigger ID."
18257
18005
  },
18006
+ {
18007
+ "kind": "field",
18008
+ "name": "togglePopoverVisible",
18009
+ "privacy": "public",
18010
+ "description": "Toggles the popover visibility.",
18011
+ "inheritedFrom": {
18012
+ "name": "Popover",
18013
+ "module": "components/popover/popover.component.js"
18014
+ }
18015
+ },
18258
18016
  {
18259
18017
  "kind": "method",
18260
18018
  "name": "handleMouseClick",
@@ -19432,16 +19190,6 @@
19432
19190
  "module": "components/popover/popover.component.js"
19433
19191
  }
19434
19192
  },
19435
- {
19436
- "kind": "field",
19437
- "name": "togglePopoverVisible",
19438
- "privacy": "public",
19439
- "description": "Toggles the popover visibility.",
19440
- "inheritedFrom": {
19441
- "name": "Popover",
19442
- "module": "components/popover/popover.component.js"
19443
- }
19444
- },
19445
19193
  {
19446
19194
  "kind": "method",
19447
19195
  "name": "positionPopover",
@@ -20517,12 +20265,13 @@
20517
20265
  },
20518
20266
  {
20519
20267
  "kind": "field",
20520
- "name": "tooltipText",
20268
+ "name": "softDisabled",
20521
20269
  "type": {
20522
- "text": "string | undefined"
20270
+ "text": "boolean | undefined"
20523
20271
  },
20524
- "description": "The tooltip text is displayed on hover of the list item.",
20525
- "attribute": "tooltip-text",
20272
+ "description": "Indicates whether the element is soft disabled.\nWhen set to `true`, the element appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe element behaves like a disabled element, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
20273
+ "default": "undefined",
20274
+ "attribute": "soft-disabled",
20526
20275
  "reflects": true,
20527
20276
  "inheritedFrom": {
20528
20277
  "name": "ListItem",
@@ -20531,9 +20280,23 @@
20531
20280
  },
20532
20281
  {
20533
20282
  "kind": "field",
20534
- "name": "tooltipPlacement",
20283
+ "name": "tooltipText",
20535
20284
  "type": {
20536
- "text": "PopoverPlacement"
20285
+ "text": "string | undefined"
20286
+ },
20287
+ "description": "The tooltip text is displayed on hover of the list item.",
20288
+ "attribute": "tooltip-text",
20289
+ "reflects": true,
20290
+ "inheritedFrom": {
20291
+ "name": "ListItem",
20292
+ "module": "components/listitem/listitem.component.js"
20293
+ }
20294
+ },
20295
+ {
20296
+ "kind": "field",
20297
+ "name": "tooltipPlacement",
20298
+ "type": {
20299
+ "text": "PopoverPlacement"
20537
20300
  },
20538
20301
  "description": "The tooltip placement of the list item. If the tooltip text is present,\nthen this tooltip placement will be applied.",
20539
20302
  "default": "'top'",
@@ -20650,6 +20413,7 @@
20650
20413
  "parameters": [
20651
20414
  {
20652
20415
  "name": "disabled",
20416
+ "default": "false",
20653
20417
  "type": {
20654
20418
  "text": "boolean"
20655
20419
  },
@@ -20926,6 +20690,19 @@
20926
20690
  "module": "src/components/listitem/listitem.component.ts"
20927
20691
  }
20928
20692
  },
20693
+ {
20694
+ "name": "soft-disabled",
20695
+ "type": {
20696
+ "text": "boolean | undefined"
20697
+ },
20698
+ "description": "Indicates whether the element is soft disabled.\nWhen set to `true`, the element appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe element behaves like a disabled element, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
20699
+ "default": "undefined",
20700
+ "fieldName": "softDisabled",
20701
+ "inheritedFrom": {
20702
+ "name": "ListItem",
20703
+ "module": "src/components/listitem/listitem.component.ts"
20704
+ }
20705
+ },
20929
20706
  {
20930
20707
  "name": "tooltip-text",
20931
20708
  "type": {
@@ -21077,14 +20854,10 @@
21077
20854
  },
21078
20855
  {
21079
20856
  "kind": "field",
21080
- "name": "ariaOrientation",
20857
+ "name": "menuItems",
21081
20858
  "type": {
21082
- "text": "Orientation"
20859
+ "text": "Array<HTMLElement>"
21083
20860
  },
21084
- "description": "Defines the orientation of the menu. This value is reflected to\nthe `aria-orientation` attribute and can be either `'horizontal'` or `'vertical'`.",
21085
- "default": "'horizontal'",
21086
- "attribute": "aria-orientation",
21087
- "reflects": true,
21088
20861
  "inheritedFrom": {
21089
20862
  "name": "MenuBar",
21090
20863
  "module": "components/menubar/menubar.component.js"
@@ -21092,33 +20865,21 @@
21092
20865
  },
21093
20866
  {
21094
20867
  "kind": "method",
21095
- "name": "setMenuBarPopoverValue",
20868
+ "name": "resetTabIndexAndSetActiveTabIndex",
21096
20869
  "privacy": "private",
21097
20870
  "parameters": [
21098
20871
  {
21099
- "name": "value",
20872
+ "name": "menuItems",
21100
20873
  "type": {
21101
- "text": "boolean"
21102
- },
21103
- "description": "The value to set."
20874
+ "text": "Array<HTMLElement>"
20875
+ }
20876
+ },
20877
+ {
20878
+ "description": "The index of the new active element in the list.",
20879
+ "name": "newIndex"
21104
20880
  }
21105
20881
  ],
21106
- "description": "Sets the value of the data-menu-popover-open attribute on the menu element.",
21107
- "inheritedFrom": {
21108
- "name": "MenuBar",
21109
- "module": "components/menubar/menubar.component.js"
21110
- }
21111
- },
21112
- {
21113
- "kind": "method",
21114
- "name": "isMenuPopoverOpen",
21115
- "privacy": "private",
21116
- "return": {
21117
- "type": {
21118
- "text": "boolean"
21119
- }
21120
- },
21121
- "description": "Returns true if the data-menu-popover-open attribute on the menu element is set to 'true', false otherwise.",
20882
+ "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.",
21122
20883
  "inheritedFrom": {
21123
20884
  "name": "MenuBar",
21124
20885
  "module": "components/menubar/menubar.component.js"
@@ -21130,7 +20891,7 @@
21130
20891
  "privacy": "private",
21131
20892
  "return": {
21132
20893
  "type": {
21133
- "text": ""
20894
+ "text": "number"
21134
20895
  }
21135
20896
  },
21136
20897
  "parameters": [
@@ -21138,11 +20899,9 @@
21138
20899
  "name": "target",
21139
20900
  "type": {
21140
20901
  "text": "EventTarget | null"
21141
- },
21142
- "description": "The target element to find the index of."
20902
+ }
21143
20903
  }
21144
20904
  ],
21145
- "description": "Returns the index of the given target in the menuItems array.\nIf the target is not a menu item, but a child element of a menu item,\nit returns the index of the parent menu item.",
21146
20905
  "inheritedFrom": {
21147
20906
  "name": "MenuBar",
21148
20907
  "module": "components/menubar/menubar.component.js"
@@ -21150,14 +20909,13 @@
21150
20909
  },
21151
20910
  {
21152
20911
  "kind": "method",
21153
- "name": "updatePopoverPlacementBasedOnOrientation",
21154
- "privacy": "protected",
20912
+ "name": "updatePopoverPlacement",
20913
+ "privacy": "private",
21155
20914
  "return": {
21156
20915
  "type": {
21157
20916
  "text": "void"
21158
20917
  }
21159
20918
  },
21160
- "description": "Updates the placement of the popover based on the aria-orientation property.",
21161
20919
  "inheritedFrom": {
21162
20920
  "name": "MenuBar",
21163
20921
  "module": "components/menubar/menubar.component.js"
@@ -21165,32 +20923,33 @@
21165
20923
  },
21166
20924
  {
21167
20925
  "kind": "method",
21168
- "name": "updateTabIndexAndFocusNewIndex",
20926
+ "name": "updateTabIndexAndFocus",
21169
20927
  "privacy": "private",
20928
+ "return": {
20929
+ "type": {
20930
+ "text": "void"
20931
+ }
20932
+ },
21170
20933
  "parameters": [
21171
20934
  {
21172
20935
  "name": "menuItems",
21173
20936
  "type": {
21174
- "text": "Array<HTMLElement>"
21175
- },
21176
- "description": "The list of menu items."
20937
+ "text": "HTMLElement[]"
20938
+ }
21177
20939
  },
21178
20940
  {
21179
20941
  "name": "currentIndex",
21180
20942
  "type": {
21181
20943
  "text": "number"
21182
- },
21183
- "description": "The current index of the focused menu item."
20944
+ }
21184
20945
  },
21185
20946
  {
21186
20947
  "name": "newIndex",
21187
20948
  "type": {
21188
20949
  "text": "number"
21189
- },
21190
- "description": "The index of the new active element in the list."
20950
+ }
21191
20951
  }
21192
20952
  ],
21193
- "description": "Updates the tabindex of the current index to -1 and the tabindex of the new index to 0,\neffectively setting the active element. This is used when navigating the menu via keyboard.",
21194
20953
  "inheritedFrom": {
21195
20954
  "name": "MenuBar",
21196
20955
  "module": "components/menubar/menubar.component.js"
@@ -21198,74 +20957,31 @@
21198
20957
  },
21199
20958
  {
21200
20959
  "kind": "method",
21201
- "name": "isValidMenu",
20960
+ "name": "navigateToMenuItem",
21202
20961
  "privacy": "private",
21203
20962
  "return": {
21204
20963
  "type": {
21205
- "text": ""
20964
+ "text": "void"
21206
20965
  }
21207
20966
  },
21208
20967
  "parameters": [
21209
20968
  {
21210
- "name": "tagName",
21211
- "optional": true,
20969
+ "name": "currentIndex",
21212
20970
  "type": {
21213
- "text": "string"
21214
- },
21215
- "description": "The tag name to check."
21216
- }
21217
- ],
21218
- "description": "Checks if the given tag name is a valid menu tag name.",
21219
- "inheritedFrom": {
21220
- "name": "MenuBar",
21221
- "module": "components/menubar/menubar.component.js"
21222
- }
21223
- },
21224
- {
21225
- "kind": "method",
21226
- "name": "isValidNavItemList",
21227
- "privacy": "private",
21228
- "return": {
21229
- "type": {
21230
- "text": ""
21231
- }
21232
- },
21233
- "parameters": [
20971
+ "text": "number"
20972
+ }
20973
+ },
21234
20974
  {
21235
- "name": "tagName",
21236
- "optional": true,
20975
+ "name": "direction",
21237
20976
  "type": {
21238
- "text": "string"
21239
- },
21240
- "description": "The tag name to check."
21241
- }
21242
- ],
21243
- "description": "Checks if the given tag name is a valid navitemlist tag name.",
21244
- "inheritedFrom": {
21245
- "name": "MenuBar",
21246
- "module": "components/menubar/menubar.component.js"
21247
- }
21248
- },
21249
- {
21250
- "kind": "method",
21251
- "name": "isValidPopover",
21252
- "privacy": "private",
21253
- "return": {
21254
- "type": {
21255
- "text": ""
21256
- }
21257
- },
21258
- "parameters": [
20977
+ "text": "'prev' | 'next'"
20978
+ }
20979
+ },
21259
20980
  {
21260
- "name": "tagName",
21261
- "optional": true,
21262
- "type": {
21263
- "text": "string"
21264
- },
21265
- "description": "The tag name to check."
20981
+ "name": "shouldOpenSubmenu",
20982
+ "default": "false"
21266
20983
  }
21267
20984
  ],
21268
- "description": "Checks if the given tag name is a valid menu popover tag name.",
21269
20985
  "inheritedFrom": {
21270
20986
  "name": "MenuBar",
21271
20987
  "module": "components/menubar/menubar.component.js"
@@ -21273,23 +20989,21 @@
21273
20989
  },
21274
20990
  {
21275
20991
  "kind": "method",
21276
- "name": "openPopover",
20992
+ "name": "showSubmenu",
21277
20993
  "privacy": "private",
21278
20994
  "return": {
21279
20995
  "type": {
21280
- "text": ""
20996
+ "text": "void"
21281
20997
  }
21282
20998
  },
21283
20999
  "parameters": [
21284
21000
  {
21285
- "name": "index",
21001
+ "name": "triggerId",
21286
21002
  "type": {
21287
- "text": "number"
21288
- },
21289
- "description": "The index of the menu item to open the popover for."
21003
+ "text": "string | null"
21004
+ }
21290
21005
  }
21291
21006
  ],
21292
- "description": "Opens the popover at the given index if it exists.",
21293
21007
  "inheritedFrom": {
21294
21008
  "name": "MenuBar",
21295
21009
  "module": "components/menubar/menubar.component.js"
@@ -21297,44 +21011,21 @@
21297
21011
  },
21298
21012
  {
21299
21013
  "kind": "method",
21300
- "name": "navigateToPrevMenuItem",
21014
+ "name": "getKeyWithDirectionFix",
21301
21015
  "privacy": "private",
21302
21016
  "return": {
21303
21017
  "type": {
21304
- "text": "void"
21018
+ "text": "string"
21305
21019
  }
21306
21020
  },
21307
21021
  "parameters": [
21308
21022
  {
21309
- "name": "currentIndex",
21310
- "type": {
21311
- "text": "number"
21312
- },
21313
- "description": "The current index of the focused menu item."
21314
- },
21315
- {
21316
- "name": "firstMenuIndex",
21317
- "type": {
21318
- "text": "number"
21319
- },
21320
- "description": "The index of the first menu item."
21321
- },
21322
- {
21323
- "name": "lastMenuIndex",
21324
- "type": {
21325
- "text": "number"
21326
- },
21327
- "description": "The index of the last menu item."
21328
- },
21329
- {
21330
- "name": "ariaOrientation",
21023
+ "name": "originalKey",
21331
21024
  "type": {
21332
- "text": "Orientation"
21333
- },
21334
- "description": "The orientation of the menu."
21025
+ "text": "string"
21026
+ }
21335
21027
  }
21336
21028
  ],
21337
- "description": "Navigates to the previous menu item and updates the tabindex of the current index\nto -1 and the tabindex of the new index to 0.",
21338
21029
  "inheritedFrom": {
21339
21030
  "name": "MenuBar",
21340
21031
  "module": "components/menubar/menubar.component.js"
@@ -21342,44 +21033,21 @@
21342
21033
  },
21343
21034
  {
21344
21035
  "kind": "method",
21345
- "name": "navigateToNextMenuItem",
21036
+ "name": "isTopLevelMenuItem",
21346
21037
  "privacy": "private",
21347
21038
  "return": {
21348
21039
  "type": {
21349
- "text": "void"
21040
+ "text": "boolean"
21350
21041
  }
21351
21042
  },
21352
21043
  "parameters": [
21353
21044
  {
21354
- "name": "currentIndex",
21355
- "type": {
21356
- "text": "number"
21357
- },
21358
- "description": "The current index of the focused menu item."
21359
- },
21360
- {
21361
- "name": "firstMenuIndex",
21362
- "type": {
21363
- "text": "number"
21364
- },
21365
- "description": "The index of the first menu item."
21366
- },
21367
- {
21368
- "name": "lastMenuIndex",
21369
- "type": {
21370
- "text": "number"
21371
- },
21372
- "description": "The index of the last menu item."
21373
- },
21374
- {
21375
- "name": "ariaOrientation",
21045
+ "name": "element",
21376
21046
  "type": {
21377
- "text": "Orientation"
21378
- },
21379
- "description": "The orientation of the menu."
21047
+ "text": "HTMLElement"
21048
+ }
21380
21049
  }
21381
21050
  ],
21382
- "description": "Navigates to the next menu item and updates the tabindex of the current index\nto -1 and the tabindex of the new index to 0.",
21383
21051
  "inheritedFrom": {
21384
21052
  "name": "MenuBar",
21385
21053
  "module": "components/menubar/menubar.component.js"
@@ -21387,31 +21055,21 @@
21387
21055
  },
21388
21056
  {
21389
21057
  "kind": "method",
21390
- "name": "getParentMenuItemDetails",
21058
+ "name": "isNestedMenuItem",
21391
21059
  "privacy": "private",
21392
21060
  "return": {
21393
21061
  "type": {
21394
- "text": ""
21062
+ "text": "boolean"
21395
21063
  }
21396
21064
  },
21397
21065
  "parameters": [
21398
21066
  {
21399
- "name": "menuChildId",
21400
- "type": {
21401
- "text": "string"
21402
- },
21403
- "description": "The id of the menu child element."
21404
- },
21405
- {
21406
- "name": "menu",
21407
- "optional": true,
21067
+ "name": "element",
21408
21068
  "type": {
21409
- "text": "HTMLElement | null"
21410
- },
21411
- "description": "The current menu element to start traversing from."
21069
+ "text": "HTMLElement"
21070
+ }
21412
21071
  }
21413
21072
  ],
21414
- "description": "Returns the parent menu item details for the given menu child id.\nIt recursively traverses up the DOM tree until it finds a menu or menubar element.",
21415
21073
  "inheritedFrom": {
21416
21074
  "name": "MenuBar",
21417
21075
  "module": "components/menubar/menubar.component.js"
@@ -21419,24 +21077,8 @@
21419
21077
  },
21420
21078
  {
21421
21079
  "kind": "method",
21422
- "name": "hideAllPopovers",
21080
+ "name": "closeAllMenuPopovers",
21423
21081
  "privacy": "private",
21424
- "return": {
21425
- "type": {
21426
- "text": "void"
21427
- }
21428
- },
21429
- "parameters": [
21430
- {
21431
- "name": "menu",
21432
- "optional": true,
21433
- "type": {
21434
- "text": "HTMLElement | null"
21435
- },
21436
- "description": "The current menu element to start traversing from."
21437
- }
21438
- ],
21439
- "description": "Recursively hides all the popovers up the DOM tree until it finds a menu or menubar element.",
21440
21082
  "inheritedFrom": {
21441
21083
  "name": "MenuBar",
21442
21084
  "module": "components/menubar/menubar.component.js"
@@ -21444,29 +21086,21 @@
21444
21086
  },
21445
21087
  {
21446
21088
  "kind": "method",
21447
- "name": "navigateToPrevParentMenuItem",
21089
+ "name": "crossMenubarNavigationOnLeft",
21448
21090
  "privacy": "private",
21449
21091
  "return": {
21450
21092
  "type": {
21451
- "text": "void"
21093
+ "text": "Promise<void>"
21452
21094
  }
21453
21095
  },
21454
21096
  "parameters": [
21455
21097
  {
21456
- "name": "currentIndex",
21457
- "type": {
21458
- "text": "number"
21459
- },
21460
- "description": "The current index of the focused menu item."
21461
- },
21462
- {
21463
- "name": "key",
21098
+ "name": "element",
21464
21099
  "type": {
21465
- "text": "string"
21100
+ "text": "HTMLElement"
21466
21101
  }
21467
21102
  }
21468
21103
  ],
21469
- "description": "Recursively navigates up the DOM tree until it finds the previous menu item\nand updates the tabindex of the current index to -1 and the tabindex of the new index to 0.\nAlso opens the popover of the previous menu item.",
21470
21104
  "inheritedFrom": {
21471
21105
  "name": "MenuBar",
21472
21106
  "module": "components/menubar/menubar.component.js"
@@ -21474,29 +21108,21 @@
21474
21108
  },
21475
21109
  {
21476
21110
  "kind": "method",
21477
- "name": "closePopoverAndNavigateToPrevParentMenuItem",
21111
+ "name": "crossMenubarNavigationOnRight",
21478
21112
  "privacy": "private",
21479
21113
  "return": {
21480
21114
  "type": {
21481
- "text": "void"
21115
+ "text": "Promise<void>"
21482
21116
  }
21483
21117
  },
21484
21118
  "parameters": [
21485
21119
  {
21486
- "name": "currentIndex",
21487
- "type": {
21488
- "text": "number"
21489
- },
21490
- "description": "The current index of the focused menu item."
21491
- },
21492
- {
21493
- "name": "key",
21120
+ "name": "element",
21494
21121
  "type": {
21495
- "text": "string"
21122
+ "text": "HTMLElement"
21496
21123
  }
21497
21124
  }
21498
21125
  ],
21499
- "description": "Closes the current menu popover and navigates to the previous parent menu item.",
21500
21126
  "inheritedFrom": {
21501
21127
  "name": "MenuBar",
21502
21128
  "module": "components/menubar/menubar.component.js"
@@ -21504,23 +21130,21 @@
21504
21130
  },
21505
21131
  {
21506
21132
  "kind": "method",
21507
- "name": "getParentMenuContents",
21133
+ "name": "hasSubmenu",
21508
21134
  "privacy": "private",
21509
21135
  "return": {
21510
21136
  "type": {
21511
- "text": ""
21137
+ "text": "boolean"
21512
21138
  }
21513
21139
  },
21514
21140
  "parameters": [
21515
21141
  {
21516
- "name": "currentMenuItem",
21142
+ "name": "triggerId",
21517
21143
  "type": {
21518
- "text": "HTMLElement | null"
21519
- },
21520
- "description": "The current menu item to start traversing from."
21144
+ "text": "string | null"
21145
+ }
21521
21146
  }
21522
21147
  ],
21523
- "description": "Gets the parent menu contents of the given current menu item.\nIt recursively traverses up the DOM tree until it finds the parent menu element\nand gets the parent menu item details and the children of the parent menu item.",
21524
21148
  "inheritedFrom": {
21525
21149
  "name": "MenuBar",
21526
21150
  "module": "components/menubar/menubar.component.js"
@@ -21528,23 +21152,21 @@
21528
21152
  },
21529
21153
  {
21530
21154
  "kind": "method",
21531
- "name": "openPopoverAndNavigateToNextChildrenMenuItem",
21155
+ "name": "getParentMenuItemIndex",
21532
21156
  "privacy": "private",
21533
21157
  "return": {
21534
21158
  "type": {
21535
- "text": "void"
21159
+ "text": "number"
21536
21160
  }
21537
21161
  },
21538
21162
  "parameters": [
21539
21163
  {
21540
- "name": "currentIndex",
21164
+ "name": "element",
21541
21165
  "type": {
21542
- "text": "number"
21543
- },
21544
- "description": "The current index of the focused menu item."
21166
+ "text": "HTMLElement"
21167
+ }
21545
21168
  }
21546
21169
  ],
21547
- "description": "Opens the popover of the next children menu item if there are children.\nIf there are no children, then it closes all popovers recursively and\nnavigates to the next menu item from the menu bar.\nIf the parent menu item does not have any children, then we will go to the next menu item.",
21548
21170
  "inheritedFrom": {
21549
21171
  "name": "MenuBar",
21550
21172
  "module": "components/menubar/menubar.component.js"
@@ -21552,148 +21174,28 @@
21552
21174
  },
21553
21175
  {
21554
21176
  "kind": "method",
21555
- "name": "isValidMenuItem",
21177
+ "name": "handleKeyDown",
21556
21178
  "privacy": "private",
21557
21179
  "return": {
21558
21180
  "type": {
21559
- "text": ""
21181
+ "text": "Promise<void>"
21560
21182
  }
21561
21183
  },
21562
21184
  "parameters": [
21563
21185
  {
21564
- "name": "menuItem",
21186
+ "name": "event",
21565
21187
  "type": {
21566
- "text": "HTMLElement"
21567
- },
21568
- "description": "The menu item to check."
21188
+ "text": "KeyboardEvent"
21189
+ }
21569
21190
  }
21570
21191
  ],
21571
- "description": "Checks if the given menu item is a valid menu item.",
21572
21192
  "inheritedFrom": {
21573
21193
  "name": "MenuBar",
21574
21194
  "module": "components/menubar/menubar.component.js"
21575
21195
  }
21576
- },
21577
- {
21578
- "kind": "method",
21579
- "name": "resetTabIndexAndSetActiveTabIndex",
21580
- "privacy": "private",
21581
- "parameters": [
21582
- {
21583
- "name": "menuItems",
21584
- "type": {
21585
- "text": "Array<HTMLElement>"
21586
- }
21587
- },
21588
- {
21589
- "description": "The index of the new active element in the list.",
21590
- "name": "newIndex"
21591
- }
21592
- ],
21593
- "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.",
21594
- "inheritedFrom": {
21595
- "name": "MenuBar",
21596
- "module": "components/menubar/menubar.component.js"
21597
- }
21598
- },
21599
- {
21600
- "kind": "method",
21601
- "name": "getKeyBasedOnDirection",
21602
- "privacy": "private",
21603
- "return": {
21604
- "type": {
21605
- "text": ""
21606
- }
21607
- },
21608
- "parameters": [
21609
- {
21610
- "name": "originalKey",
21611
- "type": {
21612
- "text": "string"
21613
- },
21614
- "description": "The original key pressed."
21615
- }
21616
- ],
21617
- "description": "Returns the key based on the direction of the document.\nIf the document is in RTL mode and the key is ARROW_LEFT or ARROW_RIGHT,\nit will swap them to maintain the correct navigation direction.",
21618
- "inheritedFrom": {
21619
- "name": "MenuBar",
21620
- "module": "components/menubar/menubar.component.js"
21621
- }
21622
- },
21623
- {
21624
- "kind": "method",
21625
- "name": "handleKeyDown",
21626
- "privacy": "protected",
21627
- "return": {
21628
- "type": {
21629
- "text": "void"
21630
- }
21631
- },
21632
- "parameters": [
21633
- {
21634
- "name": "event",
21635
- "type": {
21636
- "text": "KeyboardEvent"
21637
- },
21638
- "description": "The keyboard event."
21639
- }
21640
- ],
21641
- "description": "Handles the keydown event on the menu bar.\nThe keys are as follows:\n- HOME: Sets focus to the first menu item.\n- END: Sets focus to the last menu item.\n- ARROW_LEFT:\n - If orientation is horizontal, then it navigates to the previous menu item.\n - If orientation is vertical, then it closes the popover of the current menu item and\n navigates to the previous parent menu item.\n- ARROW_RIGHT:\n - If orientation is horizontal, then it navigates to the next menu item.\n - If orientation is vertical, then it opens the popover of the current menu item and\n navigates to the next children menu item.\n- ARROW_UP:\n - If orientation is horizontal, then it opens the popover of the current menu item.\n - If orientation is vertical, then it navigates to the previous menu item.\n- ARROW_DOWN:\n - If orientation is horizontal, then it opens the popover of the current menu item.\n - If orientation is vertical, then it navigates to the next menu item.\n- SPACE:\n- ENTER:\n - If the next element sibling is a menu popover, then it opens the popover of the current\n menu item and navigates to the next children menu item.\n - If the target element is a menu item, then it closes all popovers recursively and\n navigates to the previous parent menu item.\n- ESCAPE:\n - If a popover is already open then we close it and navigate to the parent menu item.\n - If the current menuitem is a child of menubar, then we will set the value of isMenuPopoverOpen to false.,",
21642
- "inheritedFrom": {
21643
- "name": "MenuBar",
21644
- "module": "components/menubar/menubar.component.js"
21645
- }
21646
- },
21647
- {
21648
- "kind": "method",
21649
- "name": "closeAllPopoversExceptCurrent",
21650
- "privacy": "private",
21651
- "return": {
21652
- "type": {
21653
- "text": "void"
21654
- }
21655
- },
21656
- "parameters": [
21657
- {
21658
- "name": "currentIndex",
21659
- "type": {
21660
- "text": "number"
21661
- },
21662
- "description": "The index of the current menu item."
21663
- }
21664
- ],
21665
- "description": "Closes all popovers except the current one.",
21666
- "inheritedFrom": {
21667
- "name": "MenuBar",
21668
- "module": "components/menubar/menubar.component.js"
21669
- }
21670
- },
21671
- {
21672
- "kind": "method",
21673
- "name": "handleMouseClick",
21674
- "privacy": "protected",
21675
- "return": {
21676
- "type": {
21677
- "text": "void"
21678
- }
21679
- },
21680
- "parameters": [
21681
- {
21682
- "name": "event",
21683
- "type": {
21684
- "text": "MouseEvent"
21685
- },
21686
- "description": "The mouse click event."
21687
- }
21688
- ],
21689
- "description": "Handles the mouse click event on the menu items.\n- If the menuitem has children, then it opens the popover of the next children menu item.\n- If the menuitem does not have children, then it closes all popovers recursively.",
21690
- "inheritedFrom": {
21691
- "name": "MenuBar",
21692
- "module": "components/menubar/menubar.component.js"
21693
- }
21694
- }
21695
- ],
21696
- "attributes": [
21196
+ }
21197
+ ],
21198
+ "attributes": [
21697
21199
  {
21698
21200
  "name": "aria-label",
21699
21201
  "type": {
@@ -21702,25 +21204,6 @@
21702
21204
  "default": "null",
21703
21205
  "description": "Aria-label attribute to be set for accessibility",
21704
21206
  "fieldName": "ariaLabel"
21705
- },
21706
- {
21707
- "name": "aria-orientation",
21708
- "type": {
21709
- "text": "Orientation"
21710
- },
21711
- "description": "Defines the orientation of the menu. This value is reflected to\nthe `aria-orientation` attribute and can be either `'horizontal'` or `'vertical'`.",
21712
- "default": "'horizontal'",
21713
- "fieldName": "ariaOrientation",
21714
- "inheritedFrom": {
21715
- "name": "MenuBar",
21716
- "module": "src/components/menubar/menubar.component.ts"
21717
- }
21718
- }
21719
- ],
21720
- "mixins": [
21721
- {
21722
- "name": "MenuMixin",
21723
- "module": "/src/utils/mixins/MenuMixin"
21724
21207
  }
21725
21208
  ],
21726
21209
  "superclass": {
@@ -22205,6 +21688,21 @@
22205
21688
  "module": "components/listitem/listitem.component.js"
22206
21689
  }
22207
21690
  },
21691
+ {
21692
+ "kind": "field",
21693
+ "name": "softDisabled",
21694
+ "type": {
21695
+ "text": "boolean | undefined"
21696
+ },
21697
+ "description": "Indicates whether the element is soft disabled.\nWhen set to `true`, the element appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe element behaves like a disabled element, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
21698
+ "default": "undefined",
21699
+ "attribute": "soft-disabled",
21700
+ "reflects": true,
21701
+ "inheritedFrom": {
21702
+ "name": "ListItem",
21703
+ "module": "components/listitem/listitem.component.js"
21704
+ }
21705
+ },
22208
21706
  {
22209
21707
  "kind": "field",
22210
21708
  "name": "tooltipText",
@@ -22364,6 +21862,7 @@
22364
21862
  "parameters": [
22365
21863
  {
22366
21864
  "name": "disabled",
21865
+ "default": "false",
22367
21866
  "type": {
22368
21867
  "text": "boolean"
22369
21868
  },
@@ -22633,6 +22132,19 @@
22633
22132
  "module": "src/components/listitem/listitem.component.ts"
22634
22133
  }
22635
22134
  },
22135
+ {
22136
+ "name": "soft-disabled",
22137
+ "type": {
22138
+ "text": "boolean | undefined"
22139
+ },
22140
+ "description": "Indicates whether the element is soft disabled.\nWhen set to `true`, the element appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe element behaves like a disabled element, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
22141
+ "default": "undefined",
22142
+ "fieldName": "softDisabled",
22143
+ "inheritedFrom": {
22144
+ "name": "ListItem",
22145
+ "module": "src/components/listitem/listitem.component.ts"
22146
+ }
22147
+ },
22636
22148
  {
22637
22149
  "name": "tooltip-text",
22638
22150
  "type": {
@@ -24299,179 +23811,69 @@
24299
23811
  },
24300
23812
  {
24301
23813
  "kind": "javascript-module",
24302
- "path": "components/progressspinner/progressspinner.component.js",
23814
+ "path": "components/progressbar/progressbar.component.js",
24303
23815
  "declarations": [
24304
23816
  {
24305
23817
  "kind": "class",
24306
- "description": "`mdc-progressspinner` is a customizable, circular progress indicator component.\nIt visually represents the current completion state of a process, such as loading,\nsyncing, uploading, or any ongoing task that has a measurable percentage.\n\nThe spinner is built using SVG with two concentric `<circle>` elements:\n- The `progress` arc represents the portion of work completed.\n- The `track` arc represents the remaining part.\n\nA visual gap is maintained between the progress and track arcs to clearly\ndistinguish the two segments. The component smoothly animates arc length\nand respects accessibility best practices with ARIA attributes.\n\nThe component supports different states:\n- **Default**: Circular spinner shows the progress.\n- **Success**: Displays a checkmark icon when progress reaches 100%.\n- **Error**: Displays an error icon when in an error state.",
24307
- "name": "Progressspinner",
23818
+ "description": "mdc-progressbar component visually represents a progress indicator, typically used to show\nthe completion state of an ongoing process (e.g., loading, file upload, etc.).\nIt contains an optional label and an optional helper text.\n\n- It supports mainly two types: Default and Inline\n- It supports three validation variants: Default, Success and Error.\n\nThis component is created by extending FormfieldWrapper.",
23819
+ "name": "Progressbar",
24308
23820
  "cssProperties": [
24309
- {
24310
- "description": "The size of the spinner.",
24311
- "name": "--mdc-spinner-size"
24312
- },
24313
- {
24314
- "description": "The color of the spinner track.",
24315
- "name": "--mdc-track-color"
24316
- },
24317
- {
24318
- "description": "The color of the spinner progress.",
24319
- "name": "--mdc-progress-color"
24320
- },
24321
- {
24322
- "description": "The color of the spinner when in success state.",
24323
- "name": "--mdc-progress-success-color"
24324
- },
24325
- {
24326
- "description": "The color of the spinner when in error state.",
24327
- "name": "--mdc-progress-error-color"
24328
- },
24329
23821
  {
24330
23822
  "description": "Background color of the progressbar when inactive.",
24331
- "name": "--mdc-progressbar-default-background-color",
24332
- "inheritedFrom": {
24333
- "name": "Progressbar",
24334
- "module": "src/components/progressbar/progressbar.component.ts"
24335
- }
23823
+ "name": "--mdc-progressbar-default-background-color"
24336
23824
  },
24337
23825
  {
24338
23826
  "description": "Background color of the progressbar when active.",
24339
- "name": "--mdc-progressbar-default-active-background-color",
24340
- "inheritedFrom": {
24341
- "name": "Progressbar",
24342
- "module": "src/components/progressbar/progressbar.component.ts"
24343
- }
23827
+ "name": "--mdc-progressbar-default-active-background-color"
24344
23828
  },
24345
23829
  {
24346
23830
  "description": "Background color of the progressbar when in success state.",
24347
- "name": "--mdc-progressbar-success-background-color",
24348
- "inheritedFrom": {
24349
- "name": "Progressbar",
24350
- "module": "src/components/progressbar/progressbar.component.ts"
24351
- }
23831
+ "name": "--mdc-progressbar-success-background-color"
24352
23832
  },
24353
23833
  {
24354
23834
  "description": "Background color of the progressbar when in error state.",
24355
- "name": "--mdc-progressbar-error-background-color",
24356
- "inheritedFrom": {
24357
- "name": "Progressbar",
24358
- "module": "src/components/progressbar/progressbar.component.ts"
24359
- }
23835
+ "name": "--mdc-progressbar-error-background-color"
24360
23836
  },
24361
23837
  {
24362
23838
  "description": "The height of the progressbar.",
24363
- "name": "--mdc-progressbar-height",
24364
- "inheritedFrom": {
24365
- "name": "Progressbar",
24366
- "module": "src/components/progressbar/progressbar.component.ts"
24367
- }
23839
+ "name": "--mdc-progressbar-height"
24368
23840
  },
24369
23841
  {
24370
23842
  "description": "The border radius of the progressbar.",
24371
- "name": "--mdc-progressbar-border-radius",
24372
- "inheritedFrom": {
24373
- "name": "Progressbar",
24374
- "module": "src/components/progressbar/progressbar.component.ts"
24375
- }
23843
+ "name": "--mdc-progressbar-border-radius"
24376
23844
  },
24377
23845
  {
24378
23846
  "description": "Color of the progressbar label text.",
24379
- "name": "--mdc-progressbar-label-color",
24380
- "inheritedFrom": {
24381
- "name": "Progressbar",
24382
- "module": "src/components/progressbar/progressbar.component.ts"
24383
- }
23847
+ "name": "--mdc-progressbar-label-color"
24384
23848
  },
24385
23849
  {
24386
23850
  "description": "Line height of the label text.",
24387
- "name": "--mdc-progressbar-label-lineheight",
24388
- "inheritedFrom": {
24389
- "name": "Progressbar",
24390
- "module": "src/components/progressbar/progressbar.component.ts"
24391
- }
23851
+ "name": "--mdc-progressbar-label-lineheight"
24392
23852
  },
24393
23853
  {
24394
23854
  "description": "Font size of the label text.",
24395
- "name": "--mdc-progressbar-label-fontsize",
24396
- "inheritedFrom": {
24397
- "name": "Progressbar",
24398
- "module": "src/components/progressbar/progressbar.component.ts"
24399
- }
23855
+ "name": "--mdc-progressbar-label-fontsize"
24400
23856
  },
24401
23857
  {
24402
23858
  "description": "Font weight of the label text.",
24403
- "name": "--mdc-progressbar-label-fontweight",
24404
- "inheritedFrom": {
24405
- "name": "Progressbar",
24406
- "module": "src/components/progressbar/progressbar.component.ts"
24407
- }
23859
+ "name": "--mdc-progressbar-label-fontweight"
24408
23860
  },
24409
23861
  {
24410
23862
  "description": "Color of the help text.",
24411
- "name": "--mdc-progressbar-help-text-color",
24412
- "inheritedFrom": {
24413
- "name": "Progressbar",
24414
- "module": "src/components/progressbar/progressbar.component.ts"
24415
- }
23863
+ "name": "--mdc-progressbar-help-text-color"
24416
23864
  }
24417
23865
  ],
24418
23866
  "members": [
24419
23867
  {
24420
- "kind": "method",
24421
- "name": "renderProgressSpinner",
24422
- "privacy": "private"
24423
- },
24424
- {
24425
- "kind": "method",
24426
- "name": "renderErrorState",
24427
- "privacy": "private",
24428
- "description": "Renders the error state of the progress spinner.",
24429
- "return": {
24430
- "type": {
24431
- "text": ""
24432
- }
24433
- }
24434
- },
24435
- {
24436
- "kind": "method",
24437
- "name": "renderSuccessState",
24438
- "privacy": "private",
24439
- "description": "Renders the success state of the progress spinner.",
24440
- "return": {
24441
- "type": {
24442
- "text": ""
24443
- }
24444
- }
24445
- },
24446
- {
24447
- "kind": "field",
24448
- "name": "dataAriaLabel",
24449
- "type": {
24450
- "text": "string | null"
24451
- },
24452
- "default": "null",
24453
- "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
24454
- "attribute": "data-aria-label",
24455
- "reflects": true,
24456
- "inheritedFrom": {
24457
- "name": "DataAriaLabelMixin",
24458
- "module": "utils/mixins/DataAriaLabelMixin.js"
24459
- }
24460
- },
24461
- {
24462
- "kind": "field",
24463
- "name": "variant",
24464
- "type": {
24465
- "text": "Variant"
24466
- },
24467
- "description": "Types of the progressbar\n- **Default**\n- **Inline**",
24468
- "default": "default",
24469
- "attribute": "variant",
24470
- "reflects": true,
24471
- "inheritedFrom": {
24472
- "name": "Progressbar",
24473
- "module": "components/progressbar/progressbar.component.js"
24474
- }
23868
+ "kind": "field",
23869
+ "name": "variant",
23870
+ "type": {
23871
+ "text": "Variant"
23872
+ },
23873
+ "description": "Types of the progressbar\n- **Default**\n- **Inline**",
23874
+ "default": "default",
23875
+ "attribute": "variant",
23876
+ "reflects": true
24475
23877
  },
24476
23878
  {
24477
23879
  "kind": "field",
@@ -24482,11 +23884,7 @@
24482
23884
  "default": "'0'",
24483
23885
  "description": "The current progress as a percentage, 0 to 100.\nThe value will be clamped between 0 and 100.",
24484
23886
  "attribute": "value",
24485
- "reflects": true,
24486
- "inheritedFrom": {
24487
- "name": "Progressbar",
24488
- "module": "components/progressbar/progressbar.component.js"
24489
- }
23887
+ "reflects": true
24490
23888
  },
24491
23889
  {
24492
23890
  "kind": "field",
@@ -24496,11 +23894,7 @@
24496
23894
  },
24497
23895
  "default": "false",
24498
23896
  "description": "Define error state of the progressbar\n- **true**\n- **false**",
24499
- "attribute": "error",
24500
- "inheritedFrom": {
24501
- "name": "Progressbar",
24502
- "module": "components/progressbar/progressbar.component.js"
24503
- }
23897
+ "attribute": "error"
24504
23898
  },
24505
23899
  {
24506
23900
  "kind": "method",
@@ -24511,10 +23905,21 @@
24511
23905
  "type": {
24512
23906
  "text": ""
24513
23907
  }
23908
+ }
23909
+ },
23910
+ {
23911
+ "kind": "field",
23912
+ "name": "dataAriaLabel",
23913
+ "type": {
23914
+ "text": "string | null"
24514
23915
  },
23916
+ "default": "null",
23917
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
23918
+ "attribute": "data-aria-label",
23919
+ "reflects": true,
24515
23920
  "inheritedFrom": {
24516
- "name": "Progressbar",
24517
- "module": "components/progressbar/progressbar.component.js"
23921
+ "name": "DataAriaLabelMixin",
23922
+ "module": "utils/mixins/DataAriaLabelMixin.js"
24518
23923
  }
24519
23924
  },
24520
23925
  {
@@ -24722,27 +24127,7 @@
24722
24127
  }
24723
24128
  }
24724
24129
  ],
24725
- "superclass": {
24726
- "name": "Progressbar",
24727
- "module": "/src/components/progressbar/progressbar.component"
24728
- },
24729
- "tagName": "mdc-progressspinner",
24730
- "jsDoc": "/**\n * `mdc-progressspinner` is a customizable, circular progress indicator component.\n * It visually represents the current completion state of a process, such as loading,\n * syncing, uploading, or any ongoing task that has a measurable percentage.\n *\n * The spinner is built using SVG with two concentric `<circle>` elements:\n * - The `progress` arc represents the portion of work completed.\n * - The `track` arc represents the remaining part.\n *\n * A visual gap is maintained between the progress and track arcs to clearly\n * distinguish the two segments. The component smoothly animates arc length\n * and respects accessibility best practices with ARIA attributes.\n *\n * The component supports different states:\n * - **Default**: Circular spinner shows the progress.\n * - **Success**: Displays a checkmark icon when progress reaches 100%.\n * - **Error**: Displays an error icon when in an error state.\n *\n * @tagname mdc-progressspinner\n *\n * @cssproperty --mdc-spinner-size - The size of the spinner.\n * @cssproperty --mdc-track-color - The color of the spinner track.\n * @cssproperty --mdc-progress-color - The color of the spinner progress.\n * @cssproperty --mdc-progress-success-color - The color of the spinner when in success state.\n * @cssproperty --mdc-progress-error-color - The color of the spinner when in error state.\n *\n */",
24731
- "customElement": true,
24732
24130
  "attributes": [
24733
- {
24734
- "name": "data-aria-label",
24735
- "type": {
24736
- "text": "string | null"
24737
- },
24738
- "default": "null",
24739
- "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
24740
- "fieldName": "dataAriaLabel",
24741
- "inheritedFrom": {
24742
- "name": "DataAriaLabelMixin",
24743
- "module": "src/utils/mixins/DataAriaLabelMixin.ts"
24744
- }
24745
- },
24746
24131
  {
24747
24132
  "name": "variant",
24748
24133
  "type": {
@@ -24750,11 +24135,7 @@
24750
24135
  },
24751
24136
  "description": "Types of the progressbar\n- **Default**\n- **Inline**",
24752
24137
  "default": "default",
24753
- "fieldName": "variant",
24754
- "inheritedFrom": {
24755
- "name": "Progressbar",
24756
- "module": "src/components/progressbar/progressbar.component.ts"
24757
- }
24138
+ "fieldName": "variant"
24758
24139
  },
24759
24140
  {
24760
24141
  "name": "value",
@@ -24763,11 +24144,7 @@
24763
24144
  },
24764
24145
  "default": "'0'",
24765
24146
  "description": "The current progress as a percentage, 0 to 100.\nThe value will be clamped between 0 and 100.",
24766
- "fieldName": "value",
24767
- "inheritedFrom": {
24768
- "name": "Progressbar",
24769
- "module": "src/components/progressbar/progressbar.component.ts"
24770
- }
24147
+ "fieldName": "value"
24771
24148
  },
24772
24149
  {
24773
24150
  "name": "error",
@@ -24776,10 +24153,19 @@
24776
24153
  },
24777
24154
  "default": "false",
24778
24155
  "description": "Define error state of the progressbar\n- **true**\n- **false**",
24779
- "fieldName": "error",
24156
+ "fieldName": "error"
24157
+ },
24158
+ {
24159
+ "name": "data-aria-label",
24160
+ "type": {
24161
+ "text": "string | null"
24162
+ },
24163
+ "default": "null",
24164
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
24165
+ "fieldName": "dataAriaLabel",
24780
24166
  "inheritedFrom": {
24781
- "name": "Progressbar",
24782
- "module": "src/components/progressbar/progressbar.component.ts"
24167
+ "name": "DataAriaLabelMixin",
24168
+ "module": "src/utils/mixins/DataAriaLabelMixin.ts"
24783
24169
  }
24784
24170
  },
24785
24171
  {
@@ -24894,7 +24280,20 @@
24894
24280
  "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
24895
24281
  }
24896
24282
  }
24897
- ]
24283
+ ],
24284
+ "mixins": [
24285
+ {
24286
+ "name": "DataAriaLabelMixin",
24287
+ "module": "/src/utils/mixins/DataAriaLabelMixin"
24288
+ }
24289
+ ],
24290
+ "superclass": {
24291
+ "name": "FormfieldWrapper",
24292
+ "module": "/src/components/formfieldwrapper"
24293
+ },
24294
+ "tagName": "mdc-progressbar",
24295
+ "jsDoc": "/**\n * mdc-progressbar component visually represents a progress indicator, typically used to show\n * the completion state of an ongoing process (e.g., loading, file upload, etc.).\n * It contains an optional label and an optional helper text.\n *\n * - It supports mainly two types: Default and Inline\n * - It supports three validation variants: Default, Success and Error.\n *\n * This component is created by extending FormfieldWrapper.\n *\n * @tagname mdc-progressbar\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @cssproperty --mdc-progressbar-default-background-color - Background color of the progressbar when inactive.\n * @cssproperty --mdc-progressbar-default-active-background-color - Background color of the progressbar when active.\n * @cssproperty --mdc-progressbar-success-background-color - Background color of the progressbar when in success state.\n * @cssproperty --mdc-progressbar-error-background-color - Background color of the progressbar when in error state.\n * @cssproperty --mdc-progressbar-height - The height of the progressbar.\n * @cssproperty --mdc-progressbar-border-radius - The border radius of the progressbar.\n * @cssproperty --mdc-progressbar-label-color - Color of the progressbar label text.\n * @cssproperty --mdc-progressbar-label-lineheight - Line height of the label text.\n * @cssproperty --mdc-progressbar-label-fontsize - Font size of the label text.\n * @cssproperty --mdc-progressbar-label-fontweight - Font weight of the label text.\n * @cssproperty --mdc-progressbar-help-text-color - Color of the help text.\n */",
24296
+ "customElement": true
24898
24297
  }
24899
24298
  ],
24900
24299
  "exports": [
@@ -24902,104 +24301,152 @@
24902
24301
  "kind": "js",
24903
24302
  "name": "default",
24904
24303
  "declaration": {
24905
- "name": "Progressspinner",
24906
- "module": "components/progressspinner/progressspinner.component.js"
24304
+ "name": "Progressbar",
24305
+ "module": "components/progressbar/progressbar.component.js"
24907
24306
  }
24908
24307
  }
24909
24308
  ]
24910
24309
  },
24911
24310
  {
24912
24311
  "kind": "javascript-module",
24913
- "path": "components/progressbar/progressbar.component.js",
24312
+ "path": "components/progressspinner/progressspinner.component.js",
24914
24313
  "declarations": [
24915
24314
  {
24916
24315
  "kind": "class",
24917
- "description": "mdc-progressbar component visually represents a progress indicator, typically used to show\nthe completion state of an ongoing process (e.g., loading, file upload, etc.).\nIt contains an optional label and an optional helper text.\n\n- It supports mainly two types: Default and Inline\n- It supports three validation variants: Default, Success and Error.\n\nThis component is created by extending FormfieldWrapper.",
24918
- "name": "Progressbar",
24316
+ "description": "`mdc-progressspinner` is a customizable, circular progress indicator component.\nIt visually represents the current completion state of a process, such as loading,\nsyncing, uploading, or any ongoing task that has a measurable percentage.\n\nThe spinner is built using SVG with two concentric `<circle>` elements:\n- The `progress` arc represents the portion of work completed.\n- The `track` arc represents the remaining part.\n\nA visual gap is maintained between the progress and track arcs to clearly\ndistinguish the two segments. The component smoothly animates arc length\nand respects accessibility best practices with ARIA attributes.\n\nThe component supports different states:\n- **Default**: Circular spinner shows the progress.\n- **Success**: Displays a checkmark icon when progress reaches 100%.\n- **Error**: Displays an error icon when in an error state.",
24317
+ "name": "Progressspinner",
24919
24318
  "cssProperties": [
24319
+ {
24320
+ "description": "The size of the spinner.",
24321
+ "name": "--mdc-spinner-size"
24322
+ },
24323
+ {
24324
+ "description": "The color of the spinner track.",
24325
+ "name": "--mdc-track-color"
24326
+ },
24327
+ {
24328
+ "description": "The color of the spinner progress.",
24329
+ "name": "--mdc-progress-color"
24330
+ },
24331
+ {
24332
+ "description": "The color of the spinner when in success state.",
24333
+ "name": "--mdc-progress-success-color"
24334
+ },
24335
+ {
24336
+ "description": "The color of the spinner when in error state.",
24337
+ "name": "--mdc-progress-error-color"
24338
+ },
24920
24339
  {
24921
24340
  "description": "Background color of the progressbar when inactive.",
24922
- "name": "--mdc-progressbar-default-background-color"
24341
+ "name": "--mdc-progressbar-default-background-color",
24342
+ "inheritedFrom": {
24343
+ "name": "Progressbar",
24344
+ "module": "src/components/progressbar/progressbar.component.ts"
24345
+ }
24923
24346
  },
24924
24347
  {
24925
24348
  "description": "Background color of the progressbar when active.",
24926
- "name": "--mdc-progressbar-default-active-background-color"
24349
+ "name": "--mdc-progressbar-default-active-background-color",
24350
+ "inheritedFrom": {
24351
+ "name": "Progressbar",
24352
+ "module": "src/components/progressbar/progressbar.component.ts"
24353
+ }
24927
24354
  },
24928
24355
  {
24929
24356
  "description": "Background color of the progressbar when in success state.",
24930
- "name": "--mdc-progressbar-success-background-color"
24357
+ "name": "--mdc-progressbar-success-background-color",
24358
+ "inheritedFrom": {
24359
+ "name": "Progressbar",
24360
+ "module": "src/components/progressbar/progressbar.component.ts"
24361
+ }
24931
24362
  },
24932
24363
  {
24933
24364
  "description": "Background color of the progressbar when in error state.",
24934
- "name": "--mdc-progressbar-error-background-color"
24365
+ "name": "--mdc-progressbar-error-background-color",
24366
+ "inheritedFrom": {
24367
+ "name": "Progressbar",
24368
+ "module": "src/components/progressbar/progressbar.component.ts"
24369
+ }
24935
24370
  },
24936
24371
  {
24937
24372
  "description": "The height of the progressbar.",
24938
- "name": "--mdc-progressbar-height"
24373
+ "name": "--mdc-progressbar-height",
24374
+ "inheritedFrom": {
24375
+ "name": "Progressbar",
24376
+ "module": "src/components/progressbar/progressbar.component.ts"
24377
+ }
24939
24378
  },
24940
24379
  {
24941
24380
  "description": "The border radius of the progressbar.",
24942
- "name": "--mdc-progressbar-border-radius"
24381
+ "name": "--mdc-progressbar-border-radius",
24382
+ "inheritedFrom": {
24383
+ "name": "Progressbar",
24384
+ "module": "src/components/progressbar/progressbar.component.ts"
24385
+ }
24943
24386
  },
24944
24387
  {
24945
24388
  "description": "Color of the progressbar label text.",
24946
- "name": "--mdc-progressbar-label-color"
24389
+ "name": "--mdc-progressbar-label-color",
24390
+ "inheritedFrom": {
24391
+ "name": "Progressbar",
24392
+ "module": "src/components/progressbar/progressbar.component.ts"
24393
+ }
24947
24394
  },
24948
24395
  {
24949
24396
  "description": "Line height of the label text.",
24950
- "name": "--mdc-progressbar-label-lineheight"
24397
+ "name": "--mdc-progressbar-label-lineheight",
24398
+ "inheritedFrom": {
24399
+ "name": "Progressbar",
24400
+ "module": "src/components/progressbar/progressbar.component.ts"
24401
+ }
24951
24402
  },
24952
24403
  {
24953
24404
  "description": "Font size of the label text.",
24954
- "name": "--mdc-progressbar-label-fontsize"
24405
+ "name": "--mdc-progressbar-label-fontsize",
24406
+ "inheritedFrom": {
24407
+ "name": "Progressbar",
24408
+ "module": "src/components/progressbar/progressbar.component.ts"
24409
+ }
24955
24410
  },
24956
24411
  {
24957
24412
  "description": "Font weight of the label text.",
24958
- "name": "--mdc-progressbar-label-fontweight"
24413
+ "name": "--mdc-progressbar-label-fontweight",
24414
+ "inheritedFrom": {
24415
+ "name": "Progressbar",
24416
+ "module": "src/components/progressbar/progressbar.component.ts"
24417
+ }
24959
24418
  },
24960
24419
  {
24961
24420
  "description": "Color of the help text.",
24962
- "name": "--mdc-progressbar-help-text-color"
24421
+ "name": "--mdc-progressbar-help-text-color",
24422
+ "inheritedFrom": {
24423
+ "name": "Progressbar",
24424
+ "module": "src/components/progressbar/progressbar.component.ts"
24425
+ }
24963
24426
  }
24964
24427
  ],
24965
24428
  "members": [
24966
24429
  {
24967
- "kind": "field",
24968
- "name": "variant",
24969
- "type": {
24970
- "text": "Variant"
24971
- },
24972
- "description": "Types of the progressbar\n- **Default**\n- **Inline**",
24973
- "default": "default",
24974
- "attribute": "variant",
24975
- "reflects": true
24430
+ "kind": "method",
24431
+ "name": "renderProgressSpinner",
24432
+ "privacy": "private"
24976
24433
  },
24977
24434
  {
24978
- "kind": "field",
24979
- "name": "value",
24980
- "type": {
24981
- "text": "string"
24982
- },
24983
- "default": "'0'",
24984
- "description": "The current progress as a percentage, 0 to 100.\nThe value will be clamped between 0 and 100.",
24985
- "attribute": "value",
24986
- "reflects": true
24987
- },
24988
- {
24989
- "kind": "field",
24990
- "name": "error",
24991
- "type": {
24992
- "text": "boolean"
24993
- },
24994
- "default": "false",
24995
- "description": "Define error state of the progressbar\n- **true**\n- **false**",
24996
- "attribute": "error"
24435
+ "kind": "method",
24436
+ "name": "renderErrorState",
24437
+ "privacy": "private",
24438
+ "description": "Renders the error state of the progress spinner.",
24439
+ "return": {
24440
+ "type": {
24441
+ "text": ""
24442
+ }
24443
+ }
24997
24444
  },
24998
24445
  {
24999
24446
  "kind": "method",
25000
- "name": "getValidationVariant",
24447
+ "name": "renderSuccessState",
25001
24448
  "privacy": "private",
25002
- "description": "Determines the validation state (success, error, or default) based on progress value and error state.",
24449
+ "description": "Renders the success state of the progress spinner.",
25003
24450
  "return": {
25004
24451
  "type": {
25005
24452
  "text": ""
@@ -25021,6 +24468,65 @@
25021
24468
  "module": "utils/mixins/DataAriaLabelMixin.js"
25022
24469
  }
25023
24470
  },
24471
+ {
24472
+ "kind": "field",
24473
+ "name": "variant",
24474
+ "type": {
24475
+ "text": "Variant"
24476
+ },
24477
+ "description": "Types of the progressbar\n- **Default**\n- **Inline**",
24478
+ "default": "default",
24479
+ "attribute": "variant",
24480
+ "reflects": true,
24481
+ "inheritedFrom": {
24482
+ "name": "Progressbar",
24483
+ "module": "components/progressbar/progressbar.component.js"
24484
+ }
24485
+ },
24486
+ {
24487
+ "kind": "field",
24488
+ "name": "value",
24489
+ "type": {
24490
+ "text": "string"
24491
+ },
24492
+ "default": "'0'",
24493
+ "description": "The current progress as a percentage, 0 to 100.\nThe value will be clamped between 0 and 100.",
24494
+ "attribute": "value",
24495
+ "reflects": true,
24496
+ "inheritedFrom": {
24497
+ "name": "Progressbar",
24498
+ "module": "components/progressbar/progressbar.component.js"
24499
+ }
24500
+ },
24501
+ {
24502
+ "kind": "field",
24503
+ "name": "error",
24504
+ "type": {
24505
+ "text": "boolean"
24506
+ },
24507
+ "default": "false",
24508
+ "description": "Define error state of the progressbar\n- **true**\n- **false**",
24509
+ "attribute": "error",
24510
+ "inheritedFrom": {
24511
+ "name": "Progressbar",
24512
+ "module": "components/progressbar/progressbar.component.js"
24513
+ }
24514
+ },
24515
+ {
24516
+ "kind": "method",
24517
+ "name": "getValidationVariant",
24518
+ "privacy": "private",
24519
+ "description": "Determines the validation state (success, error, or default) based on progress value and error state.",
24520
+ "return": {
24521
+ "type": {
24522
+ "text": ""
24523
+ }
24524
+ },
24525
+ "inheritedFrom": {
24526
+ "name": "Progressbar",
24527
+ "module": "components/progressbar/progressbar.component.js"
24528
+ }
24529
+ },
25024
24530
  {
25025
24531
  "kind": "field",
25026
24532
  "name": "disabled",
@@ -25226,7 +24732,27 @@
25226
24732
  }
25227
24733
  }
25228
24734
  ],
24735
+ "superclass": {
24736
+ "name": "Progressbar",
24737
+ "module": "/src/components/progressbar/progressbar.component"
24738
+ },
24739
+ "tagName": "mdc-progressspinner",
24740
+ "jsDoc": "/**\n * `mdc-progressspinner` is a customizable, circular progress indicator component.\n * It visually represents the current completion state of a process, such as loading,\n * syncing, uploading, or any ongoing task that has a measurable percentage.\n *\n * The spinner is built using SVG with two concentric `<circle>` elements:\n * - The `progress` arc represents the portion of work completed.\n * - The `track` arc represents the remaining part.\n *\n * A visual gap is maintained between the progress and track arcs to clearly\n * distinguish the two segments. The component smoothly animates arc length\n * and respects accessibility best practices with ARIA attributes.\n *\n * The component supports different states:\n * - **Default**: Circular spinner shows the progress.\n * - **Success**: Displays a checkmark icon when progress reaches 100%.\n * - **Error**: Displays an error icon when in an error state.\n *\n * @tagname mdc-progressspinner\n *\n * @cssproperty --mdc-spinner-size - The size of the spinner.\n * @cssproperty --mdc-track-color - The color of the spinner track.\n * @cssproperty --mdc-progress-color - The color of the spinner progress.\n * @cssproperty --mdc-progress-success-color - The color of the spinner when in success state.\n * @cssproperty --mdc-progress-error-color - The color of the spinner when in error state.\n *\n */",
24741
+ "customElement": true,
25229
24742
  "attributes": [
24743
+ {
24744
+ "name": "data-aria-label",
24745
+ "type": {
24746
+ "text": "string | null"
24747
+ },
24748
+ "default": "null",
24749
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
24750
+ "fieldName": "dataAriaLabel",
24751
+ "inheritedFrom": {
24752
+ "name": "DataAriaLabelMixin",
24753
+ "module": "src/utils/mixins/DataAriaLabelMixin.ts"
24754
+ }
24755
+ },
25230
24756
  {
25231
24757
  "name": "variant",
25232
24758
  "type": {
@@ -25234,7 +24760,11 @@
25234
24760
  },
25235
24761
  "description": "Types of the progressbar\n- **Default**\n- **Inline**",
25236
24762
  "default": "default",
25237
- "fieldName": "variant"
24763
+ "fieldName": "variant",
24764
+ "inheritedFrom": {
24765
+ "name": "Progressbar",
24766
+ "module": "src/components/progressbar/progressbar.component.ts"
24767
+ }
25238
24768
  },
25239
24769
  {
25240
24770
  "name": "value",
@@ -25243,7 +24773,11 @@
25243
24773
  },
25244
24774
  "default": "'0'",
25245
24775
  "description": "The current progress as a percentage, 0 to 100.\nThe value will be clamped between 0 and 100.",
25246
- "fieldName": "value"
24776
+ "fieldName": "value",
24777
+ "inheritedFrom": {
24778
+ "name": "Progressbar",
24779
+ "module": "src/components/progressbar/progressbar.component.ts"
24780
+ }
25247
24781
  },
25248
24782
  {
25249
24783
  "name": "error",
@@ -25252,19 +24786,10 @@
25252
24786
  },
25253
24787
  "default": "false",
25254
24788
  "description": "Define error state of the progressbar\n- **true**\n- **false**",
25255
- "fieldName": "error"
25256
- },
25257
- {
25258
- "name": "data-aria-label",
25259
- "type": {
25260
- "text": "string | null"
25261
- },
25262
- "default": "null",
25263
- "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
25264
- "fieldName": "dataAriaLabel",
24789
+ "fieldName": "error",
25265
24790
  "inheritedFrom": {
25266
- "name": "DataAriaLabelMixin",
25267
- "module": "src/utils/mixins/DataAriaLabelMixin.ts"
24791
+ "name": "Progressbar",
24792
+ "module": "src/components/progressbar/progressbar.component.ts"
25268
24793
  }
25269
24794
  },
25270
24795
  {
@@ -25379,20 +24904,7 @@
25379
24904
  "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
25380
24905
  }
25381
24906
  }
25382
- ],
25383
- "mixins": [
25384
- {
25385
- "name": "DataAriaLabelMixin",
25386
- "module": "/src/utils/mixins/DataAriaLabelMixin"
25387
- }
25388
- ],
25389
- "superclass": {
25390
- "name": "FormfieldWrapper",
25391
- "module": "/src/components/formfieldwrapper"
25392
- },
25393
- "tagName": "mdc-progressbar",
25394
- "jsDoc": "/**\n * mdc-progressbar component visually represents a progress indicator, typically used to show\n * the completion state of an ongoing process (e.g., loading, file upload, etc.).\n * It contains an optional label and an optional helper text.\n *\n * - It supports mainly two types: Default and Inline\n * - It supports three validation variants: Default, Success and Error.\n *\n * This component is created by extending FormfieldWrapper.\n *\n * @tagname mdc-progressbar\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @cssproperty --mdc-progressbar-default-background-color - Background color of the progressbar when inactive.\n * @cssproperty --mdc-progressbar-default-active-background-color - Background color of the progressbar when active.\n * @cssproperty --mdc-progressbar-success-background-color - Background color of the progressbar when in success state.\n * @cssproperty --mdc-progressbar-error-background-color - Background color of the progressbar when in error state.\n * @cssproperty --mdc-progressbar-height - The height of the progressbar.\n * @cssproperty --mdc-progressbar-border-radius - The border radius of the progressbar.\n * @cssproperty --mdc-progressbar-label-color - Color of the progressbar label text.\n * @cssproperty --mdc-progressbar-label-lineheight - Line height of the label text.\n * @cssproperty --mdc-progressbar-label-fontsize - Font size of the label text.\n * @cssproperty --mdc-progressbar-label-fontweight - Font weight of the label text.\n * @cssproperty --mdc-progressbar-help-text-color - Color of the help text.\n */",
25395
- "customElement": true
24907
+ ]
25396
24908
  }
25397
24909
  ],
25398
24910
  "exports": [
@@ -25400,8 +24912,8 @@
25400
24912
  "kind": "js",
25401
24913
  "name": "default",
25402
24914
  "declaration": {
25403
- "name": "Progressbar",
25404
- "module": "components/progressbar/progressbar.component.js"
24915
+ "name": "Progressspinner",
24916
+ "module": "components/progressspinner/progressspinner.component.js"
25405
24917
  }
25406
24918
  }
25407
24919
  ]
@@ -38156,637 +37668,6 @@
38156
37668
  }
38157
37669
  ]
38158
37670
  },
38159
- {
38160
- "kind": "javascript-module",
38161
- "path": "utils/mixins/MenuMixin.js",
38162
- "declarations": [
38163
- {
38164
- "kind": "class",
38165
- "description": "",
38166
- "name": "MenuMixinInterface",
38167
- "members": [
38168
- {
38169
- "kind": "field",
38170
- "name": "ariaOrientation",
38171
- "type": {
38172
- "text": "Orientation"
38173
- }
38174
- },
38175
- {
38176
- "kind": "method",
38177
- "name": "handleKeyDown",
38178
- "privacy": "protected",
38179
- "return": {
38180
- "type": {
38181
- "text": "void"
38182
- }
38183
- },
38184
- "parameters": [
38185
- {
38186
- "name": "event",
38187
- "type": {
38188
- "text": "KeyboardEvent"
38189
- }
38190
- }
38191
- ]
38192
- },
38193
- {
38194
- "kind": "method",
38195
- "name": "handleMouseClick",
38196
- "privacy": "protected",
38197
- "return": {
38198
- "type": {
38199
- "text": "void"
38200
- }
38201
- },
38202
- "parameters": [
38203
- {
38204
- "name": "event",
38205
- "type": {
38206
- "text": "MouseEvent"
38207
- }
38208
- }
38209
- ]
38210
- },
38211
- {
38212
- "kind": "method",
38213
- "name": "updatePopoverPlacementBasedOnOrientation",
38214
- "privacy": "protected",
38215
- "return": {
38216
- "type": {
38217
- "text": "void"
38218
- }
38219
- }
38220
- }
38221
- ]
38222
- },
38223
- {
38224
- "kind": "mixin",
38225
- "description": "",
38226
- "name": "MenuMixin",
38227
- "members": [
38228
- {
38229
- "kind": "field",
38230
- "name": "ariaOrientation",
38231
- "type": {
38232
- "text": "Orientation"
38233
- },
38234
- "description": "Defines the orientation of the menu. This value is reflected to\nthe `aria-orientation` attribute and can be either `'horizontal'` or `'vertical'`.",
38235
- "default": "'horizontal'",
38236
- "attribute": "aria-orientation",
38237
- "reflects": true
38238
- },
38239
- {
38240
- "kind": "method",
38241
- "name": "setMenuBarPopoverValue",
38242
- "privacy": "private",
38243
- "parameters": [
38244
- {
38245
- "name": "value",
38246
- "type": {
38247
- "text": "boolean"
38248
- },
38249
- "description": "The value to set."
38250
- }
38251
- ],
38252
- "description": "Sets the value of the data-menu-popover-open attribute on the menu element."
38253
- },
38254
- {
38255
- "kind": "method",
38256
- "name": "isMenuPopoverOpen",
38257
- "privacy": "private",
38258
- "return": {
38259
- "type": {
38260
- "text": "boolean"
38261
- }
38262
- },
38263
- "description": "Returns true if the data-menu-popover-open attribute on the menu element is set to 'true', false otherwise."
38264
- },
38265
- {
38266
- "kind": "method",
38267
- "name": "getCurrentIndex",
38268
- "privacy": "private",
38269
- "return": {
38270
- "type": {
38271
- "text": ""
38272
- }
38273
- },
38274
- "parameters": [
38275
- {
38276
- "name": "target",
38277
- "type": {
38278
- "text": "EventTarget | null"
38279
- },
38280
- "description": "The target element to find the index of."
38281
- }
38282
- ],
38283
- "description": "Returns the index of the given target in the menuItems array.\nIf the target is not a menu item, but a child element of a menu item,\nit returns the index of the parent menu item."
38284
- },
38285
- {
38286
- "kind": "method",
38287
- "name": "updatePopoverPlacementBasedOnOrientation",
38288
- "privacy": "protected",
38289
- "return": {
38290
- "type": {
38291
- "text": "void"
38292
- }
38293
- },
38294
- "description": "Updates the placement of the popover based on the aria-orientation property."
38295
- },
38296
- {
38297
- "kind": "method",
38298
- "name": "updateTabIndexAndFocusNewIndex",
38299
- "privacy": "private",
38300
- "parameters": [
38301
- {
38302
- "name": "menuItems",
38303
- "type": {
38304
- "text": "Array<HTMLElement>"
38305
- },
38306
- "description": "The list of menu items."
38307
- },
38308
- {
38309
- "name": "currentIndex",
38310
- "type": {
38311
- "text": "number"
38312
- },
38313
- "description": "The current index of the focused menu item."
38314
- },
38315
- {
38316
- "name": "newIndex",
38317
- "type": {
38318
- "text": "number"
38319
- },
38320
- "description": "The index of the new active element in the list."
38321
- }
38322
- ],
38323
- "description": "Updates the tabindex of the current index to -1 and the tabindex of the new index to 0,\neffectively setting the active element. This is used when navigating the menu via keyboard."
38324
- },
38325
- {
38326
- "kind": "method",
38327
- "name": "isValidMenu",
38328
- "privacy": "private",
38329
- "return": {
38330
- "type": {
38331
- "text": ""
38332
- }
38333
- },
38334
- "parameters": [
38335
- {
38336
- "name": "tagName",
38337
- "optional": true,
38338
- "type": {
38339
- "text": "string"
38340
- },
38341
- "description": "The tag name to check."
38342
- }
38343
- ],
38344
- "description": "Checks if the given tag name is a valid menu tag name."
38345
- },
38346
- {
38347
- "kind": "method",
38348
- "name": "isValidNavItemList",
38349
- "privacy": "private",
38350
- "return": {
38351
- "type": {
38352
- "text": ""
38353
- }
38354
- },
38355
- "parameters": [
38356
- {
38357
- "name": "tagName",
38358
- "optional": true,
38359
- "type": {
38360
- "text": "string"
38361
- },
38362
- "description": "The tag name to check."
38363
- }
38364
- ],
38365
- "description": "Checks if the given tag name is a valid navitemlist tag name."
38366
- },
38367
- {
38368
- "kind": "method",
38369
- "name": "isValidPopover",
38370
- "privacy": "private",
38371
- "return": {
38372
- "type": {
38373
- "text": ""
38374
- }
38375
- },
38376
- "parameters": [
38377
- {
38378
- "name": "tagName",
38379
- "optional": true,
38380
- "type": {
38381
- "text": "string"
38382
- },
38383
- "description": "The tag name to check."
38384
- }
38385
- ],
38386
- "description": "Checks if the given tag name is a valid menu popover tag name."
38387
- },
38388
- {
38389
- "kind": "method",
38390
- "name": "openPopover",
38391
- "privacy": "private",
38392
- "return": {
38393
- "type": {
38394
- "text": ""
38395
- }
38396
- },
38397
- "parameters": [
38398
- {
38399
- "name": "index",
38400
- "type": {
38401
- "text": "number"
38402
- },
38403
- "description": "The index of the menu item to open the popover for."
38404
- }
38405
- ],
38406
- "description": "Opens the popover at the given index if it exists."
38407
- },
38408
- {
38409
- "kind": "method",
38410
- "name": "navigateToPrevMenuItem",
38411
- "privacy": "private",
38412
- "return": {
38413
- "type": {
38414
- "text": "void"
38415
- }
38416
- },
38417
- "parameters": [
38418
- {
38419
- "name": "currentIndex",
38420
- "type": {
38421
- "text": "number"
38422
- },
38423
- "description": "The current index of the focused menu item."
38424
- },
38425
- {
38426
- "name": "firstMenuIndex",
38427
- "type": {
38428
- "text": "number"
38429
- },
38430
- "description": "The index of the first menu item."
38431
- },
38432
- {
38433
- "name": "lastMenuIndex",
38434
- "type": {
38435
- "text": "number"
38436
- },
38437
- "description": "The index of the last menu item."
38438
- },
38439
- {
38440
- "name": "ariaOrientation",
38441
- "type": {
38442
- "text": "Orientation"
38443
- },
38444
- "description": "The orientation of the menu."
38445
- }
38446
- ],
38447
- "description": "Navigates to the previous menu item and updates the tabindex of the current index\nto -1 and the tabindex of the new index to 0."
38448
- },
38449
- {
38450
- "kind": "method",
38451
- "name": "navigateToNextMenuItem",
38452
- "privacy": "private",
38453
- "return": {
38454
- "type": {
38455
- "text": "void"
38456
- }
38457
- },
38458
- "parameters": [
38459
- {
38460
- "name": "currentIndex",
38461
- "type": {
38462
- "text": "number"
38463
- },
38464
- "description": "The current index of the focused menu item."
38465
- },
38466
- {
38467
- "name": "firstMenuIndex",
38468
- "type": {
38469
- "text": "number"
38470
- },
38471
- "description": "The index of the first menu item."
38472
- },
38473
- {
38474
- "name": "lastMenuIndex",
38475
- "type": {
38476
- "text": "number"
38477
- },
38478
- "description": "The index of the last menu item."
38479
- },
38480
- {
38481
- "name": "ariaOrientation",
38482
- "type": {
38483
- "text": "Orientation"
38484
- },
38485
- "description": "The orientation of the menu."
38486
- }
38487
- ],
38488
- "description": "Navigates to the next menu item and updates the tabindex of the current index\nto -1 and the tabindex of the new index to 0."
38489
- },
38490
- {
38491
- "kind": "method",
38492
- "name": "getParentMenuItemDetails",
38493
- "privacy": "private",
38494
- "return": {
38495
- "type": {
38496
- "text": ""
38497
- }
38498
- },
38499
- "parameters": [
38500
- {
38501
- "name": "menuChildId",
38502
- "type": {
38503
- "text": "string"
38504
- },
38505
- "description": "The id of the menu child element."
38506
- },
38507
- {
38508
- "name": "menu",
38509
- "optional": true,
38510
- "type": {
38511
- "text": "HTMLElement | null"
38512
- },
38513
- "description": "The current menu element to start traversing from."
38514
- }
38515
- ],
38516
- "description": "Returns the parent menu item details for the given menu child id.\nIt recursively traverses up the DOM tree until it finds a menu or menubar element."
38517
- },
38518
- {
38519
- "kind": "method",
38520
- "name": "hideAllPopovers",
38521
- "privacy": "private",
38522
- "return": {
38523
- "type": {
38524
- "text": "void"
38525
- }
38526
- },
38527
- "parameters": [
38528
- {
38529
- "name": "menu",
38530
- "optional": true,
38531
- "type": {
38532
- "text": "HTMLElement | null"
38533
- },
38534
- "description": "The current menu element to start traversing from."
38535
- }
38536
- ],
38537
- "description": "Recursively hides all the popovers up the DOM tree until it finds a menu or menubar element."
38538
- },
38539
- {
38540
- "kind": "method",
38541
- "name": "navigateToPrevParentMenuItem",
38542
- "privacy": "private",
38543
- "return": {
38544
- "type": {
38545
- "text": "void"
38546
- }
38547
- },
38548
- "parameters": [
38549
- {
38550
- "name": "currentIndex",
38551
- "type": {
38552
- "text": "number"
38553
- },
38554
- "description": "The current index of the focused menu item."
38555
- },
38556
- {
38557
- "name": "key",
38558
- "type": {
38559
- "text": "string"
38560
- }
38561
- }
38562
- ],
38563
- "description": "Recursively navigates up the DOM tree until it finds the previous menu item\nand updates the tabindex of the current index to -1 and the tabindex of the new index to 0.\nAlso opens the popover of the previous menu item."
38564
- },
38565
- {
38566
- "kind": "method",
38567
- "name": "closePopoverAndNavigateToPrevParentMenuItem",
38568
- "privacy": "private",
38569
- "return": {
38570
- "type": {
38571
- "text": "void"
38572
- }
38573
- },
38574
- "parameters": [
38575
- {
38576
- "name": "currentIndex",
38577
- "type": {
38578
- "text": "number"
38579
- },
38580
- "description": "The current index of the focused menu item."
38581
- },
38582
- {
38583
- "name": "key",
38584
- "type": {
38585
- "text": "string"
38586
- }
38587
- }
38588
- ],
38589
- "description": "Closes the current menu popover and navigates to the previous parent menu item."
38590
- },
38591
- {
38592
- "kind": "method",
38593
- "name": "getParentMenuContents",
38594
- "privacy": "private",
38595
- "return": {
38596
- "type": {
38597
- "text": ""
38598
- }
38599
- },
38600
- "parameters": [
38601
- {
38602
- "name": "currentMenuItem",
38603
- "type": {
38604
- "text": "HTMLElement | null"
38605
- },
38606
- "description": "The current menu item to start traversing from."
38607
- }
38608
- ],
38609
- "description": "Gets the parent menu contents of the given current menu item.\nIt recursively traverses up the DOM tree until it finds the parent menu element\nand gets the parent menu item details and the children of the parent menu item."
38610
- },
38611
- {
38612
- "kind": "method",
38613
- "name": "openPopoverAndNavigateToNextChildrenMenuItem",
38614
- "privacy": "private",
38615
- "return": {
38616
- "type": {
38617
- "text": "void"
38618
- }
38619
- },
38620
- "parameters": [
38621
- {
38622
- "name": "currentIndex",
38623
- "type": {
38624
- "text": "number"
38625
- },
38626
- "description": "The current index of the focused menu item."
38627
- }
38628
- ],
38629
- "description": "Opens the popover of the next children menu item if there are children.\nIf there are no children, then it closes all popovers recursively and\nnavigates to the next menu item from the menu bar.\nIf the parent menu item does not have any children, then we will go to the next menu item."
38630
- },
38631
- {
38632
- "kind": "method",
38633
- "name": "isValidMenuItem",
38634
- "privacy": "private",
38635
- "return": {
38636
- "type": {
38637
- "text": ""
38638
- }
38639
- },
38640
- "parameters": [
38641
- {
38642
- "name": "menuItem",
38643
- "type": {
38644
- "text": "HTMLElement"
38645
- },
38646
- "description": "The menu item to check."
38647
- }
38648
- ],
38649
- "description": "Checks if the given menu item is a valid menu item."
38650
- },
38651
- {
38652
- "kind": "method",
38653
- "name": "resetTabIndexAndSetActiveTabIndex",
38654
- "privacy": "private",
38655
- "parameters": [
38656
- {
38657
- "name": "menuItems",
38658
- "type": {
38659
- "text": "Array<HTMLElement>"
38660
- }
38661
- },
38662
- {
38663
- "description": "The index of the new active element in the list.",
38664
- "name": "newIndex"
38665
- }
38666
- ],
38667
- "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."
38668
- },
38669
- {
38670
- "kind": "method",
38671
- "name": "getKeyBasedOnDirection",
38672
- "privacy": "private",
38673
- "return": {
38674
- "type": {
38675
- "text": ""
38676
- }
38677
- },
38678
- "parameters": [
38679
- {
38680
- "name": "originalKey",
38681
- "type": {
38682
- "text": "string"
38683
- },
38684
- "description": "The original key pressed."
38685
- }
38686
- ],
38687
- "description": "Returns the key based on the direction of the document.\nIf the document is in RTL mode and the key is ARROW_LEFT or ARROW_RIGHT,\nit will swap them to maintain the correct navigation direction."
38688
- },
38689
- {
38690
- "kind": "method",
38691
- "name": "handleKeyDown",
38692
- "privacy": "protected",
38693
- "return": {
38694
- "type": {
38695
- "text": "void"
38696
- }
38697
- },
38698
- "parameters": [
38699
- {
38700
- "name": "event",
38701
- "type": {
38702
- "text": "KeyboardEvent"
38703
- },
38704
- "description": "The keyboard event."
38705
- }
38706
- ],
38707
- "description": "Handles the keydown event on the menu bar.\nThe keys are as follows:\n- HOME: Sets focus to the first menu item.\n- END: Sets focus to the last menu item.\n- ARROW_LEFT:\n - If orientation is horizontal, then it navigates to the previous menu item.\n - If orientation is vertical, then it closes the popover of the current menu item and\n navigates to the previous parent menu item.\n- ARROW_RIGHT:\n - If orientation is horizontal, then it navigates to the next menu item.\n - If orientation is vertical, then it opens the popover of the current menu item and\n navigates to the next children menu item.\n- ARROW_UP:\n - If orientation is horizontal, then it opens the popover of the current menu item.\n - If orientation is vertical, then it navigates to the previous menu item.\n- ARROW_DOWN:\n - If orientation is horizontal, then it opens the popover of the current menu item.\n - If orientation is vertical, then it navigates to the next menu item.\n- SPACE:\n- ENTER:\n - If the next element sibling is a menu popover, then it opens the popover of the current\n menu item and navigates to the next children menu item.\n - If the target element is a menu item, then it closes all popovers recursively and\n navigates to the previous parent menu item.\n- ESCAPE:\n - If a popover is already open then we close it and navigate to the parent menu item.\n - If the current menuitem is a child of menubar, then we will set the value of isMenuPopoverOpen to false.,"
38708
- },
38709
- {
38710
- "kind": "method",
38711
- "name": "closeAllPopoversExceptCurrent",
38712
- "privacy": "private",
38713
- "return": {
38714
- "type": {
38715
- "text": "void"
38716
- }
38717
- },
38718
- "parameters": [
38719
- {
38720
- "name": "currentIndex",
38721
- "type": {
38722
- "text": "number"
38723
- },
38724
- "description": "The index of the current menu item."
38725
- }
38726
- ],
38727
- "description": "Closes all popovers except the current one."
38728
- },
38729
- {
38730
- "kind": "method",
38731
- "name": "handleMouseClick",
38732
- "privacy": "protected",
38733
- "return": {
38734
- "type": {
38735
- "text": "void"
38736
- }
38737
- },
38738
- "parameters": [
38739
- {
38740
- "name": "event",
38741
- "type": {
38742
- "text": "MouseEvent"
38743
- },
38744
- "description": "The mouse click event."
38745
- }
38746
- ],
38747
- "description": "Handles the mouse click event on the menu items.\n- If the menuitem has children, then it opens the popover of the next children menu item.\n- If the menuitem does not have children, then it closes all popovers recursively."
38748
- }
38749
- ],
38750
- "attributes": [
38751
- {
38752
- "name": "aria-orientation",
38753
- "type": {
38754
- "text": "Orientation"
38755
- },
38756
- "description": "Defines the orientation of the menu. This value is reflected to\nthe `aria-orientation` attribute and can be either `'horizontal'` or `'vertical'`.",
38757
- "default": "'horizontal'",
38758
- "fieldName": "ariaOrientation"
38759
- }
38760
- ],
38761
- "parameters": [
38762
- {
38763
- "name": "superClass",
38764
- "type": {
38765
- "text": "T"
38766
- }
38767
- }
38768
- ]
38769
- }
38770
- ],
38771
- "exports": [
38772
- {
38773
- "kind": "js",
38774
- "name": "MenuMixinInterface",
38775
- "declaration": {
38776
- "name": "MenuMixinInterface",
38777
- "module": "utils/mixins/MenuMixin.js"
38778
- }
38779
- },
38780
- {
38781
- "kind": "js",
38782
- "name": "MenuMixin",
38783
- "declaration": {
38784
- "name": "MenuMixin",
38785
- "module": "utils/mixins/MenuMixin.js"
38786
- }
38787
- }
38788
- ]
38789
- },
38790
37671
  {
38791
37672
  "kind": "javascript-module",
38792
37673
  "path": "utils/mixins/PreventScrollMixin.js",