@momentum-design/components 0.96.4 → 0.98.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -21353,170 +21353,174 @@
21353
21353
  },
21354
21354
  {
21355
21355
  "kind": "javascript-module",
21356
- "path": "components/optgroup/optgroup.component.js",
21356
+ "path": "components/navmenuitem/navmenuitem.component.js",
21357
21357
  "declarations": [
21358
21358
  {
21359
21359
  "kind": "class",
21360
- "description": "optgroup component, which creates a grouping of mdc-option within a listbox element.",
21361
- "name": "OptGroup",
21360
+ "description": "`mdc-navmenuitem` is a menuitem styled to work as a navigation tab.\nIt supports a leading icon, optional badge and dynamic text rendering.\n\nNote: `mdc-navmenuitem` is intended to be used inside `mdc-menubar` as part of the sideNavigation\ncomponent. Its structure, spacing, and interactions are designed to align with\nthe visual and functional requirements of side navigation layouts.",
21361
+ "name": "NavMenuItem",
21362
21362
  "cssProperties": [
21363
21363
  {
21364
- "description": "Allows customization of the disabled option color.",
21365
- "name": "--mdc-optgroup-disabled-color"
21366
- }
21367
- ],
21368
- "slots": [
21364
+ "description": "Text color of the navmenuitem in its normal state.",
21365
+ "name": "--mdc-navmenuitem-color"
21366
+ },
21369
21367
  {
21370
- "description": "This is a default slot for mdc-option elements.",
21371
- "name": "default"
21372
- }
21373
- ],
21374
- "members": [
21368
+ "description": "Border color of the navmenuitem in its normal state.",
21369
+ "name": "--mdc-navmenuitem-border-color"
21370
+ },
21375
21371
  {
21376
- "kind": "field",
21377
- "name": "label",
21378
- "type": {
21379
- "text": "string | undefined"
21380
- },
21381
- "description": "The header text to be displayed on the top of the options list.",
21382
- "attribute": "label",
21383
- "reflects": true
21372
+ "description": "Text color of the navmenuitem when disabled.",
21373
+ "name": "--mdc-navmenuitem-disabled-color"
21384
21374
  },
21385
21375
  {
21386
- "kind": "method",
21387
- "name": "setDisabledForAllOptions",
21388
- "privacy": "private",
21389
- "return": {
21390
- "type": {
21391
- "text": "void"
21392
- }
21376
+ "description": "Width of the navmenuitem when expanded.",
21377
+ "name": "--mdc-navmenuitem-expanded-width"
21378
+ },
21379
+ {
21380
+ "description": "Background color of the navmenuitem when hovered.",
21381
+ "name": "--mdc-navmenuitem-hover-background-color"
21382
+ },
21383
+ {
21384
+ "description": "Background color of the active navmenuitem when hovered.",
21385
+ "name": "--mdc-navmenuitem-hover-active-background-color"
21386
+ },
21387
+ {
21388
+ "description": "Background color of the navmenuitem when pressed.",
21389
+ "name": "--mdc-navmenuitem-pressed-background-color"
21390
+ },
21391
+ {
21392
+ "description": "Background color of the active navmenuitem when pressed.",
21393
+ "name": "--mdc-navmenuitem-pressed-active-background-color"
21394
+ },
21395
+ {
21396
+ "description": "Background color of the navmenuitem when disabled.",
21397
+ "name": "--mdc-navmenuitem-disabled-background-color"
21398
+ },
21399
+ {
21400
+ "description": "Background color of the active navmenuitem when disabled.",
21401
+ "name": "--mdc-navmenuitem-disabled-active-background-color"
21402
+ },
21403
+ {
21404
+ "description": "Background color of the active nav item in its rest state.",
21405
+ "name": "--mdc-navmenuitem-rest-active-background-color"
21406
+ },
21407
+ {
21408
+ "description": "Allows customization of the default background color.",
21409
+ "name": "--mdc-listitem-default-background-color",
21410
+ "inheritedFrom": {
21411
+ "name": "ListItem",
21412
+ "module": "src/components/listitem/listitem.component.ts"
21393
21413
  }
21394
21414
  },
21395
21415
  {
21396
- "kind": "field",
21397
- "name": "dataAriaLabel",
21398
- "type": {
21399
- "text": "string | null"
21400
- },
21401
- "default": "null",
21402
- "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
21403
- "attribute": "data-aria-label",
21404
- "reflects": true,
21416
+ "description": "Allows customization of the background color on hover.",
21417
+ "name": "--mdc-listitem-background-color-hover",
21405
21418
  "inheritedFrom": {
21406
- "name": "DataAriaLabelMixin",
21407
- "module": "utils/mixins/DataAriaLabelMixin.js"
21419
+ "name": "ListItem",
21420
+ "module": "src/components/listitem/listitem.component.ts"
21408
21421
  }
21409
21422
  },
21410
21423
  {
21411
- "kind": "field",
21412
- "name": "disabled",
21413
- "type": {
21414
- "text": "boolean | undefined"
21415
- },
21416
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
21417
- "default": "undefined",
21418
- "attribute": "disabled",
21419
- "reflects": true,
21424
+ "description": "Allows customization of the background color when pressed.",
21425
+ "name": "--mdc-listitem-background-color-active",
21420
21426
  "inheritedFrom": {
21421
- "name": "DisabledMixin",
21422
- "module": "utils/mixins/DisabledMixin.js"
21427
+ "name": "ListItem",
21428
+ "module": "src/components/listitem/listitem.component.ts"
21423
21429
  }
21424
- }
21425
- ],
21426
- "attributes": [
21430
+ },
21427
21431
  {
21428
- "name": "label",
21429
- "type": {
21430
- "text": "string | undefined"
21431
- },
21432
- "description": "The header text to be displayed on the top of the options list.",
21433
- "fieldName": "label"
21432
+ "description": "Allows customization of the primary label, side header and subline text slot color.",
21433
+ "name": "--mdc-listitem-primary-label-color",
21434
+ "inheritedFrom": {
21435
+ "name": "ListItem",
21436
+ "module": "src/components/listitem/listitem.component.ts"
21437
+ }
21434
21438
  },
21435
21439
  {
21436
- "name": "data-aria-label",
21437
- "type": {
21438
- "text": "string | null"
21439
- },
21440
- "default": "null",
21441
- "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
21442
- "fieldName": "dataAriaLabel",
21440
+ "description": "Allows customization of the secondary and tertiary label text slot color.",
21441
+ "name": "--mdc-listitem-secondary-label-color",
21443
21442
  "inheritedFrom": {
21444
- "name": "DataAriaLabelMixin",
21445
- "module": "src/utils/mixins/DataAriaLabelMixin.ts"
21443
+ "name": "ListItem",
21444
+ "module": "src/components/listitem/listitem.component.ts"
21446
21445
  }
21447
21446
  },
21448
21447
  {
21449
- "name": "disabled",
21450
- "type": {
21451
- "text": "boolean | undefined"
21452
- },
21453
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
21454
- "default": "undefined",
21455
- "fieldName": "disabled",
21448
+ "description": "Allows customization of the disabled color.",
21449
+ "name": "--mdc-listitem-disabled-color",
21456
21450
  "inheritedFrom": {
21457
- "name": "DisabledMixin",
21458
- "module": "src/utils/mixins/DisabledMixin.ts"
21451
+ "name": "ListItem",
21452
+ "module": "src/components/listitem/listitem.component.ts"
21459
21453
  }
21460
- }
21461
- ],
21462
- "mixins": [
21454
+ },
21463
21455
  {
21464
- "name": "DataAriaLabelMixin",
21465
- "module": "/src/utils/mixins/DataAriaLabelMixin"
21456
+ "description": "Allows customization of column gap.",
21457
+ "name": "--mdc-listitem-column-gap",
21458
+ "inheritedFrom": {
21459
+ "name": "ListItem",
21460
+ "module": "src/components/listitem/listitem.component.ts"
21461
+ }
21466
21462
  },
21467
21463
  {
21468
- "name": "DisabledMixin",
21469
- "module": "/src/utils/mixins/DisabledMixin"
21464
+ "description": "Allows customization of padding left and right.",
21465
+ "name": "--mdc-listitem-padding-left-and-right",
21466
+ "inheritedFrom": {
21467
+ "name": "ListItem",
21468
+ "module": "src/components/listitem/listitem.component.ts"
21469
+ }
21470
21470
  }
21471
21471
  ],
21472
- "superclass": {
21473
- "name": "Component",
21474
- "module": "/src/models"
21475
- },
21476
- "tagName": "mdc-optgroup",
21477
- "jsDoc": "/**\n * optgroup component, which creates a grouping of mdc-option within a listbox element.\n *\n * @dependency mdc-text\n *\n * @tagname mdc-optgroup\n *\n * @slot default - This is a default slot for mdc-option elements.\n *\n * @cssproperty --mdc-optgroup-disabled-color - Allows customization of the disabled option color.\n */",
21478
- "customElement": true
21479
- }
21480
- ],
21481
- "exports": [
21482
- {
21483
- "kind": "js",
21484
- "name": "default",
21485
- "declaration": {
21486
- "name": "OptGroup",
21487
- "module": "components/optgroup/optgroup.component.js"
21488
- }
21489
- }
21490
- ]
21491
- },
21492
- {
21493
- "kind": "javascript-module",
21494
- "path": "components/option/option.component.js",
21495
- "declarations": [
21496
- {
21497
- "kind": "class",
21498
- "description": "Option component, which is used within Selectlistbox within Select component.\n\nThe label and secondary label of the option can be set using the `label` and `secondaryLabel` properties respectively.\nThe `label` is the primary text displayed in the option, while the `secondaryLabel` is the secondary text displayed below the primary label.\n\nThe `selected` property is used to indicate whether the option is selected or not.\nWhen the `selected` property is set to true, a checkmark icon will be displayed\non the right side of the option to indicate that it is selected.\n\nThe `prefixIcon` property can be used to display an icon on the left side of the option label.\nWe can show a tooltip by setting `tooltip-text` attribute. This will be displayed on hover or focus of the option.\nThe tooltip will be helpful for a long label text which is truncated with ellipsis.",
21499
- "name": "Option",
21500
21472
  "members": [
21501
21473
  {
21502
21474
  "kind": "field",
21503
- "name": "selected",
21475
+ "name": "active",
21504
21476
  "type": {
21505
- "text": "boolean"
21477
+ "text": "boolean | undefined"
21506
21478
  },
21507
- "default": "false",
21508
- "description": "The selected attribute is used to indicate that the option is selected.",
21509
- "attribute": "selected",
21479
+ "description": "The navmenuitem's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the navmenuitem is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the navmenuitem is in an inactive state, indicating it is toggled off.",
21480
+ "default": "undefined",
21481
+ "attribute": "active",
21510
21482
  "reflects": true
21511
21483
  },
21512
21484
  {
21513
21485
  "kind": "field",
21514
- "name": "prefixIcon",
21486
+ "name": "badgeType",
21515
21487
  "type": {
21516
- "text": "IconNames | undefined"
21488
+ "text": "BadgeType | undefined"
21517
21489
  },
21518
- "description": "The prefix icon attribute is used to display the icon name on the left of the option label.",
21519
- "attribute": "prefix-icon",
21490
+ "description": "Type of the badge\nCan be `dot` (notification) or `counter`.",
21491
+ "attribute": "badge-type",
21492
+ "reflects": true
21493
+ },
21494
+ {
21495
+ "kind": "field",
21496
+ "name": "counter",
21497
+ "type": {
21498
+ "text": "number | undefined"
21499
+ },
21500
+ "description": "Counter is the number which can be provided in the badge.",
21501
+ "attribute": "counter",
21502
+ "reflects": true
21503
+ },
21504
+ {
21505
+ "kind": "field",
21506
+ "name": "maxCounter",
21507
+ "type": {
21508
+ "text": "number"
21509
+ },
21510
+ "description": "The maximum number can be set up to 999, anything above that will be rendered as _999+_.\nThe max counter can be `9`, `99` or `999`.",
21511
+ "default": "99",
21512
+ "attribute": "max-counter",
21513
+ "reflects": true
21514
+ },
21515
+ {
21516
+ "kind": "field",
21517
+ "name": "navId",
21518
+ "type": {
21519
+ "text": "string | undefined"
21520
+ },
21521
+ "description": "Id of the navMenuItem (used as a identificator when used in the menubar)\nNote: It has to be unique.",
21522
+ "default": "undefined",
21523
+ "attribute": "nav-id",
21520
21524
  "reflects": true
21521
21525
  },
21522
21526
  {
@@ -21526,108 +21530,226 @@
21526
21530
  "text": "string | null"
21527
21531
  },
21528
21532
  "default": "null",
21529
- "description": "Any additional description can be provided here for screen readers.",
21530
- "attribute": "aria-label",
21533
+ "description": "Aria-label attribute to be set for accessibility",
21534
+ "attribute": "aria-label"
21535
+ },
21536
+ {
21537
+ "kind": "field",
21538
+ "name": "disableAriaCurrent",
21539
+ "type": {
21540
+ "text": "boolean | undefined"
21541
+ },
21542
+ "description": "When set to true, prevents the automatic setting of the `aria-current` attribute on the navmenuitem\nwhen it becomes active. This is useful for cases where you want to maintain the visual active styling\nbut need to handle aria-current attribute differently or not at all.\nThe active button styling will still be applied regardless of this setting.",
21543
+ "attribute": "disable-aria-current",
21531
21544
  "reflects": true
21532
21545
  },
21546
+ {
21547
+ "kind": "method",
21548
+ "name": "isNested",
21549
+ "privacy": "private",
21550
+ "return": {
21551
+ "type": {
21552
+ "text": "boolean"
21553
+ }
21554
+ },
21555
+ "description": "Check whether the navmenuitem is inside a nested nav structure.\nReturns `true` if there is a parent `mdc-menupopover`\nThis method assumes nesting implies deeper levels of nav hierarchy."
21556
+ },
21557
+ {
21558
+ "kind": "method",
21559
+ "name": "handleClickEvent",
21560
+ "privacy": "private",
21561
+ "return": {
21562
+ "type": {
21563
+ "text": "void"
21564
+ }
21565
+ }
21566
+ },
21567
+ {
21568
+ "kind": "method",
21569
+ "name": "renderTextLabel",
21570
+ "privacy": "private",
21571
+ "parameters": [
21572
+ {
21573
+ "name": "label",
21574
+ "type": {
21575
+ "text": "string | undefined"
21576
+ }
21577
+ }
21578
+ ]
21579
+ },
21580
+ {
21581
+ "kind": "method",
21582
+ "name": "renderArrowIcon",
21583
+ "privacy": "private",
21584
+ "parameters": [
21585
+ {
21586
+ "name": "showLabel",
21587
+ "type": {
21588
+ "text": "boolean | undefined"
21589
+ }
21590
+ }
21591
+ ]
21592
+ },
21593
+ {
21594
+ "kind": "method",
21595
+ "name": "renderBadge",
21596
+ "privacy": "private",
21597
+ "parameters": [
21598
+ {
21599
+ "name": "showLabel",
21600
+ "type": {
21601
+ "text": "boolean | undefined"
21602
+ }
21603
+ }
21604
+ ]
21605
+ },
21533
21606
  {
21534
21607
  "kind": "field",
21535
- "name": "name",
21608
+ "name": "iconName",
21536
21609
  "type": {
21537
- "text": "string"
21610
+ "text": "IconNames | undefined"
21538
21611
  },
21539
- "default": "''",
21540
- "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
21541
- "attribute": "name",
21612
+ "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
21613
+ "attribute": "icon-name",
21614
+ "inheritedFrom": {
21615
+ "name": "IconNameMixin",
21616
+ "module": "utils/mixins/IconNameMixin.js"
21617
+ }
21618
+ },
21619
+ {
21620
+ "kind": "field",
21621
+ "name": "arrowPosition",
21622
+ "type": {
21623
+ "text": "ArrowPositions | undefined"
21624
+ },
21625
+ "description": "Defines where the arrow icon will appear.\n- `'leading'`: Icon appears on the leading edge (start).\n- `'trailing'`: Icon appears on the trailing edge (end).\n\nIf not set, no arrow is displayed.",
21626
+ "attribute": "arrow-position",
21542
21627
  "reflects": true,
21543
21628
  "inheritedFrom": {
21544
- "name": "FormInternalsMixin",
21545
- "module": "utils/mixins/FormInternalsMixin.js"
21629
+ "name": "MenuItem",
21630
+ "module": "components/menuitem/menuitem.component.js"
21546
21631
  }
21547
21632
  },
21548
21633
  {
21549
21634
  "kind": "field",
21550
- "name": "value",
21635
+ "name": "arrowDirection",
21551
21636
  "type": {
21552
- "text": "string"
21637
+ "text": "ArrowDirections | undefined"
21553
21638
  },
21554
- "default": "''",
21555
- "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
21556
- "attribute": "value",
21639
+ "description": "Defines the direction the arrow icon points.\n- `'positive'`: Arrow points toward the trailing side.\n- `'negative'`: Arrow points toward the leading side.",
21640
+ "attribute": "arrow-direction",
21557
21641
  "reflects": true,
21558
21642
  "inheritedFrom": {
21559
- "name": "FormInternalsMixin",
21560
- "module": "utils/mixins/FormInternalsMixin.js"
21643
+ "name": "MenuItem",
21644
+ "module": "components/menuitem/menuitem.component.js"
21561
21645
  }
21562
21646
  },
21563
21647
  {
21564
21648
  "kind": "field",
21565
- "name": "validationMessage",
21649
+ "name": "name",
21566
21650
  "type": {
21567
- "text": "string | undefined"
21651
+ "text": "undefined | string | undefined"
21568
21652
  },
21569
- "description": "Custom validation message that will override the default message and displayed when the input is invalid.\n\nTo display custom validation messages, you must listen for input events (or other relevant events)\non your component and update the `validationMessage` property with the desired message string.\nUpdating this property will ensure that new validation messages are shown to the user.\n- The `validationMessage` property overrides the default browser validation message when set.\n- Consumers are responsible for updating `validationMessage` in response to input or validation state changes.",
21570
- "attribute": "validation-message",
21653
+ "default": "undefined",
21654
+ "description": "The name attribute is used to identify the menu item when it is selected.",
21655
+ "attribute": "name",
21571
21656
  "reflects": true,
21572
21657
  "inheritedFrom": {
21573
- "name": "FormInternalsMixin",
21574
- "module": "utils/mixins/FormInternalsMixin.js"
21658
+ "name": "MenuItem",
21659
+ "module": "components/menuitem/menuitem.component.js"
21575
21660
  }
21576
21661
  },
21577
21662
  {
21578
21663
  "kind": "field",
21579
- "name": "validity",
21664
+ "name": "value",
21580
21665
  "type": {
21581
- "text": "ValidityState"
21666
+ "text": "undefined | string | undefined"
21582
21667
  },
21583
- "readonly": true,
21668
+ "default": "undefined",
21669
+ "description": "The value attribute is used to represent a value when the menu item is selected.\nIt is typically used with checkbox and radio menu items, but can be handy for any menu item.",
21670
+ "attribute": "value",
21671
+ "reflects": true,
21584
21672
  "inheritedFrom": {
21585
- "name": "FormInternalsMixin",
21586
- "module": "utils/mixins/FormInternalsMixin.js"
21673
+ "name": "MenuItem",
21674
+ "module": "components/menuitem/menuitem.component.js"
21587
21675
  }
21588
21676
  },
21589
21677
  {
21590
- "kind": "field",
21591
- "name": "willValidate",
21592
- "readonly": true,
21678
+ "kind": "method",
21679
+ "name": "handleKeyDown",
21680
+ "privacy": "protected",
21681
+ "return": {
21682
+ "type": {
21683
+ "text": "void"
21684
+ }
21685
+ },
21686
+ "parameters": [
21687
+ {
21688
+ "name": "event",
21689
+ "type": {
21690
+ "text": "KeyboardEvent"
21691
+ },
21692
+ "description": "The keyboard event that triggered the action."
21693
+ }
21694
+ ],
21695
+ "description": "Handles the keydown event for the menu item.\nIf the Enter key is pressed, it triggers a click event on the menu item.\nThis allows keyboard users to activate the menu item using the Enter key.\n\nThis follows the native behaviour, actionable element can be triggered by Enter\nkey on the keydown event.\n\nNote: Action triggered by Space on the keyup event.",
21593
21696
  "inheritedFrom": {
21594
- "name": "FormInternalsMixin",
21595
- "module": "utils/mixins/FormInternalsMixin.js"
21697
+ "name": "ListItem",
21698
+ "module": "components/listitem/listitem.component.js"
21596
21699
  }
21597
21700
  },
21598
21701
  {
21599
21702
  "kind": "method",
21600
- "name": "setValidity",
21601
- "description": "Sets the validity of the input field based on the input field's validity.",
21703
+ "name": "handleKeyUp",
21704
+ "privacy": "private",
21602
21705
  "return": {
21603
21706
  "type": {
21604
- "text": ""
21707
+ "text": "void"
21605
21708
  }
21606
21709
  },
21710
+ "parameters": [
21711
+ {
21712
+ "name": "event",
21713
+ "type": {
21714
+ "text": "KeyboardEvent"
21715
+ },
21716
+ "description": "The keyboard event that triggered the action."
21717
+ }
21718
+ ],
21719
+ "description": "Handles the keyup event for the menu item.\nIf the Space key is released, it triggers a click event on the menu item.\nThis allows keyboard users to activate the menu item using the Space key.\nIt also prevents the default action of the Space key to avoid scrolling the page.\n\nThis follows the native behaviour, actionable element can be triggered by Space\nkey on the keyup event.\n\nNote: Action triggered by Enter on the keydown event.",
21607
21720
  "inheritedFrom": {
21608
- "name": "FormInternalsMixin",
21609
- "module": "utils/mixins/FormInternalsMixin.js"
21721
+ "name": "MenuItem",
21722
+ "module": "components/menuitem/menuitem.component.js"
21610
21723
  }
21611
21724
  },
21612
21725
  {
21613
21726
  "kind": "method",
21614
- "name": "checkValidity",
21727
+ "name": "renderTrailingControls",
21728
+ "privacy": "protected",
21729
+ "description": "Renders the trailing controls slot and optionally the trailing arrow icon,\nbased on `arrowPosition` and `arrowDirection`.",
21615
21730
  "return": {
21616
21731
  "type": {
21617
- "text": "boolean"
21732
+ "text": ""
21618
21733
  }
21619
21734
  },
21620
21735
  "inheritedFrom": {
21621
- "name": "FormInternalsMixin",
21622
- "module": "utils/mixins/FormInternalsMixin.js"
21736
+ "name": "ListItem",
21737
+ "module": "components/listitem/listitem.component.js"
21623
21738
  }
21624
21739
  },
21625
21740
  {
21626
21741
  "kind": "method",
21627
- "name": "reportValidity",
21742
+ "name": "renderLeadingControls",
21743
+ "privacy": "protected",
21744
+ "description": "Renders the leading controls slot and optionally the leading arrow icon,\nbased on `arrowPosition` and `arrowDirection`.",
21745
+ "return": {
21746
+ "type": {
21747
+ "text": ""
21748
+ }
21749
+ },
21628
21750
  "inheritedFrom": {
21629
- "name": "FormInternalsMixin",
21630
- "module": "utils/mixins/FormInternalsMixin.js"
21751
+ "name": "ListItem",
21752
+ "module": "components/listitem/listitem.component.js"
21631
21753
  }
21632
21754
  },
21633
21755
  {
@@ -21789,30 +21911,6 @@
21789
21911
  "module": "components/listitem/listitem.component.js"
21790
21912
  }
21791
21913
  },
21792
- {
21793
- "kind": "method",
21794
- "name": "handleKeyDown",
21795
- "privacy": "protected",
21796
- "return": {
21797
- "type": {
21798
- "text": "void"
21799
- }
21800
- },
21801
- "parameters": [
21802
- {
21803
- "name": "event",
21804
- "type": {
21805
- "text": "KeyboardEvent"
21806
- },
21807
- "description": "The keyboard event triggered when a key is pressed down."
21808
- }
21809
- ],
21810
- "description": "Fires the click event when the enter or space key is pressed down.\nThis behavior is similar to a button click and key interaction.",
21811
- "inheritedFrom": {
21812
- "name": "ListItem",
21813
- "module": "components/listitem/listitem.component.js"
21814
- }
21815
- },
21816
21914
  {
21817
21915
  "kind": "method",
21818
21916
  "name": "triggerClickEvent",
@@ -21932,36 +22030,6 @@
21932
22030
  "module": "components/listitem/listitem.component.js"
21933
22031
  }
21934
22032
  },
21935
- {
21936
- "kind": "method",
21937
- "name": "renderTrailingControls",
21938
- "privacy": "protected",
21939
- "description": "Renders the trailing controls slot.",
21940
- "return": {
21941
- "type": {
21942
- "text": ""
21943
- }
21944
- },
21945
- "inheritedFrom": {
21946
- "name": "ListItem",
21947
- "module": "components/listitem/listitem.component.js"
21948
- }
21949
- },
21950
- {
21951
- "kind": "method",
21952
- "name": "renderLeadingControls",
21953
- "privacy": "protected",
21954
- "description": "Renders the leading controls slot.",
21955
- "return": {
21956
- "type": {
21957
- "text": ""
21958
- }
21959
- },
21960
- "inheritedFrom": {
21961
- "name": "ListItem",
21962
- "module": "components/listitem/listitem.component.js"
21963
- }
21964
- },
21965
22033
  {
21966
22034
  "kind": "method",
21967
22035
  "name": "stopEventPropagation",
@@ -21989,7 +22057,7 @@
21989
22057
  ],
21990
22058
  "events": [
21991
22059
  {
21992
- "description": "(React: onClick) This event is dispatched when the option is clicked.",
22060
+ "description": "(React: onClick) This event is dispatched when the navmenuitem is clicked.",
21993
22061
  "name": "click",
21994
22062
  "reactName": "onClick",
21995
22063
  "inheritedFrom": {
@@ -21998,7 +22066,7 @@
21998
22066
  }
21999
22067
  },
22000
22068
  {
22001
- "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the option.",
22069
+ "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the navmenuitem.",
22002
22070
  "name": "keydown",
22003
22071
  "reactName": "onKeyDown",
22004
22072
  "inheritedFrom": {
@@ -22007,7 +22075,7 @@
22007
22075
  }
22008
22076
  },
22009
22077
  {
22010
- "description": "(React: onKeyUp) This event is dispatched when a key is released on the option.",
22078
+ "description": "(React: onKeyUp) This event is dispatched when a key is released on the navmenuitem.",
22011
22079
  "name": "keyup",
22012
22080
  "reactName": "onKeyUp",
22013
22081
  "inheritedFrom": {
@@ -22016,7 +22084,7 @@
22016
22084
  }
22017
22085
  },
22018
22086
  {
22019
- "description": "(React: onFocus) This event is dispatched when the option receives focus.",
22087
+ "description": "(React: onFocus) This event is dispatched when the navmenuitem receives focus.",
22020
22088
  "name": "focus",
22021
22089
  "reactName": "onFocus",
22022
22090
  "inheritedFrom": {
@@ -22024,6 +22092,11 @@
22024
22092
  "module": "src/components/listitem/listitem.component.ts"
22025
22093
  }
22026
22094
  },
22095
+ {
22096
+ "description": "(React: onActiveChange) Dispatched when the active state of the navmenuitem changes.",
22097
+ "name": "activechange",
22098
+ "reactName": "onActiveChange"
22099
+ },
22027
22100
  {
22028
22101
  "description": "(React: onEnabled) This event is dispatched after the listitem is enabled",
22029
22102
  "name": "enabled",
@@ -22063,21 +22136,47 @@
22063
22136
  ],
22064
22137
  "attributes": [
22065
22138
  {
22066
- "name": "selected",
22139
+ "name": "active",
22067
22140
  "type": {
22068
- "text": "boolean"
22141
+ "text": "boolean | undefined"
22069
22142
  },
22070
- "default": "false",
22071
- "description": "The selected attribute is used to indicate that the option is selected.",
22072
- "fieldName": "selected"
22143
+ "description": "The navmenuitem's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the navmenuitem is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the navmenuitem is in an inactive state, indicating it is toggled off.",
22144
+ "default": "undefined",
22145
+ "fieldName": "active"
22073
22146
  },
22074
22147
  {
22075
- "name": "prefix-icon",
22148
+ "name": "badge-type",
22076
22149
  "type": {
22077
- "text": "IconNames | undefined"
22150
+ "text": "BadgeType | undefined"
22078
22151
  },
22079
- "description": "The prefix icon attribute is used to display the icon name on the left of the option label.",
22080
- "fieldName": "prefixIcon"
22152
+ "description": "Type of the badge\nCan be `dot` (notification) or `counter`.",
22153
+ "fieldName": "badgeType"
22154
+ },
22155
+ {
22156
+ "name": "counter",
22157
+ "type": {
22158
+ "text": "number | undefined"
22159
+ },
22160
+ "description": "Counter is the number which can be provided in the badge.",
22161
+ "fieldName": "counter"
22162
+ },
22163
+ {
22164
+ "name": "max-counter",
22165
+ "type": {
22166
+ "text": "number"
22167
+ },
22168
+ "description": "The maximum number can be set up to 999, anything above that will be rendered as _999+_.\nThe max counter can be `9`, `99` or `999`.",
22169
+ "default": "99",
22170
+ "fieldName": "maxCounter"
22171
+ },
22172
+ {
22173
+ "name": "nav-id",
22174
+ "type": {
22175
+ "text": "string | undefined"
22176
+ },
22177
+ "description": "Id of the navMenuItem (used as a identificator when used in the menubar)\nNote: It has to be unique.",
22178
+ "default": "undefined",
22179
+ "fieldName": "navId"
22081
22180
  },
22082
22181
  {
22083
22182
  "name": "aria-label",
@@ -22085,45 +22184,77 @@
22085
22184
  "text": "string | null"
22086
22185
  },
22087
22186
  "default": "null",
22088
- "description": "Any additional description can be provided here for screen readers.",
22187
+ "description": "Aria-label attribute to be set for accessibility",
22089
22188
  "fieldName": "ariaLabel"
22090
22189
  },
22091
22190
  {
22092
- "name": "name",
22191
+ "name": "disable-aria-current",
22093
22192
  "type": {
22094
- "text": "string"
22193
+ "text": "boolean | undefined"
22095
22194
  },
22096
- "default": "''",
22097
- "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
22098
- "fieldName": "name",
22195
+ "description": "When set to true, prevents the automatic setting of the `aria-current` attribute on the navmenuitem\nwhen it becomes active. This is useful for cases where you want to maintain the visual active styling\nbut need to handle aria-current attribute differently or not at all.\nThe active button styling will still be applied regardless of this setting.",
22196
+ "fieldName": "disableAriaCurrent"
22197
+ },
22198
+ {
22199
+ "name": "icon-name",
22200
+ "type": {
22201
+ "text": "IconNames | undefined"
22202
+ },
22203
+ "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
22204
+ "fieldName": "iconName",
22099
22205
  "inheritedFrom": {
22100
- "name": "FormInternalsMixin",
22101
- "module": "src/utils/mixins/FormInternalsMixin.ts"
22206
+ "name": "IconNameMixin",
22207
+ "module": "src/utils/mixins/IconNameMixin.ts"
22102
22208
  }
22103
22209
  },
22104
22210
  {
22105
- "name": "value",
22211
+ "name": "arrow-position",
22106
22212
  "type": {
22107
- "text": "string"
22213
+ "text": "ArrowPositions | undefined"
22108
22214
  },
22109
- "default": "''",
22110
- "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
22111
- "fieldName": "value",
22215
+ "description": "Defines where the arrow icon will appear.\n- `'leading'`: Icon appears on the leading edge (start).\n- `'trailing'`: Icon appears on the trailing edge (end).\n\nIf not set, no arrow is displayed.",
22216
+ "fieldName": "arrowPosition",
22217
+ "inheritedFrom": {
22218
+ "name": "MenuItem",
22219
+ "module": "src/components/menuitem/menuitem.component.ts"
22220
+ }
22221
+ },
22222
+ {
22223
+ "name": "arrow-direction",
22224
+ "type": {
22225
+ "text": "ArrowDirections | undefined"
22226
+ },
22227
+ "description": "Defines the direction the arrow icon points.\n- `'positive'`: Arrow points toward the trailing side.\n- `'negative'`: Arrow points toward the leading side.",
22228
+ "fieldName": "arrowDirection",
22229
+ "inheritedFrom": {
22230
+ "name": "MenuItem",
22231
+ "module": "src/components/menuitem/menuitem.component.ts"
22232
+ }
22233
+ },
22234
+ {
22235
+ "name": "name",
22236
+ "type": {
22237
+ "text": "undefined | string | undefined"
22238
+ },
22239
+ "default": "undefined",
22240
+ "description": "The name attribute is used to identify the menu item when it is selected.",
22241
+ "fieldName": "name",
22112
22242
  "inheritedFrom": {
22113
- "name": "FormInternalsMixin",
22114
- "module": "src/utils/mixins/FormInternalsMixin.ts"
22243
+ "name": "MenuItem",
22244
+ "module": "src/components/menuitem/menuitem.component.ts"
22115
22245
  }
22116
22246
  },
22117
22247
  {
22118
- "name": "validation-message",
22248
+ "name": "value",
22119
22249
  "type": {
22120
- "text": "string | undefined"
22250
+ "text": "undefined | string | undefined"
22121
22251
  },
22122
- "description": "Custom validation message that will override the default message and displayed when the input is invalid.\n\nTo display custom validation messages, you must listen for input events (or other relevant events)\non your component and update the `validationMessage` property with the desired message string.\nUpdating this property will ensure that new validation messages are shown to the user.\n- The `validationMessage` property overrides the default browser validation message when set.\n- Consumers are responsible for updating `validationMessage` in response to input or validation state changes.",
22123
- "fieldName": "validationMessage",
22252
+ "default": "undefined",
22253
+ "description": "The value attribute is used to represent a value when the menu item is selected.\nIt is typically used with checkbox and radio menu items, but can be handy for any menu item.",
22254
+ "fieldName": "value",
22124
22255
  "inheritedFrom": {
22125
- "name": "FormInternalsMixin",
22126
- "module": "src/utils/mixins/FormInternalsMixin.ts"
22256
+ "name": "MenuItem",
22257
+ "module": "src/components/menuitem/menuitem.component.ts"
22127
22258
  }
22128
22259
  },
22129
22260
  {
@@ -22221,598 +22352,410 @@
22221
22352
  "description": "The subline text of the list item.\nThis appears on the trailing side of the list item.",
22222
22353
  "fieldName": "sublineText",
22223
22354
  "inheritedFrom": {
22224
- "name": "ListItem",
22225
- "module": "src/components/listitem/listitem.component.ts"
22226
- }
22227
- },
22228
- {
22229
- "name": "soft-disabled",
22230
- "type": {
22231
- "text": "boolean | undefined"
22232
- },
22233
- "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.",
22234
- "default": "undefined",
22235
- "fieldName": "softDisabled",
22236
- "inheritedFrom": {
22237
- "name": "ListItem",
22238
- "module": "src/components/listitem/listitem.component.ts"
22239
- }
22240
- },
22241
- {
22242
- "name": "tooltip-text",
22243
- "type": {
22244
- "text": "string | undefined"
22245
- },
22246
- "description": "The tooltip text is displayed on hover of the list item.",
22247
- "fieldName": "tooltipText",
22248
- "inheritedFrom": {
22249
- "name": "ListItem",
22250
- "module": "src/components/listitem/listitem.component.ts"
22251
- }
22252
- },
22253
- {
22254
- "name": "tooltip-placement",
22255
- "type": {
22256
- "text": "PopoverPlacement"
22257
- },
22258
- "description": "The tooltip placement of the list item. If the tooltip text is present,\nthen this tooltip placement will be applied.",
22259
- "default": "'top'",
22260
- "fieldName": "tooltipPlacement",
22261
- "inheritedFrom": {
22262
- "name": "ListItem",
22263
- "module": "src/components/listitem/listitem.component.ts"
22264
- }
22265
- }
22266
- ],
22267
- "mixins": [
22268
- {
22269
- "name": "FormInternalsMixin",
22270
- "module": "/src/utils/mixins/FormInternalsMixin"
22271
- }
22272
- ],
22273
- "superclass": {
22274
- "name": "ListItem",
22275
- "module": "/src/components/listitem/listitem.component"
22276
- },
22277
- "tagName": "mdc-option",
22278
- "jsDoc": "/**\n * Option component, which is used within Selectlistbox within Select component.\n *\n * The label and secondary label of the option can be set using the `label` and `secondaryLabel` properties respectively.\n * The `label` is the primary text displayed in the option, while the `secondaryLabel` is the secondary text displayed below the primary label.\n *\n * The `selected` property is used to indicate whether the option is selected or not.\n * When the `selected` property is set to true, a checkmark icon will be displayed\n * on the right side of the option to indicate that it is selected.\n *\n * The `prefixIcon` property can be used to display an icon on the left side of the option label.\n * We can show a tooltip by setting `tooltip-text` attribute. This will be displayed on hover or focus of the option.\n * The tooltip will be helpful for a long label text which is truncated with ellipsis.\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n * @dependency mdc-tooltip\n *\n * @tagname mdc-option\n *\n * @event click - (React: onClick) This event is dispatched when the option is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the option.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the option.\n * @event focus - (React: onFocus) This event is dispatched when the option receives focus.\n */",
22279
- "customElement": true,
22280
- "slots": [
22281
- {
22282
- "description": "slot for list item controls to appear of leading end.",
22283
- "name": "leading-controls",
22284
- "inheritedFrom": {
22285
- "name": "ListItem",
22286
- "module": "src/components/listitem/listitem.component.ts"
22287
- }
22288
- },
22289
- {
22290
- "description": "slot for list item primary label.",
22291
- "name": "leading-text-primary-label",
22292
- "inheritedFrom": {
22293
- "name": "ListItem",
22294
- "module": "src/components/listitem/listitem.component.ts"
22295
- }
22296
- },
22297
- {
22298
- "description": "slot for list item secondary label.",
22299
- "name": "leading-text-secondary-label",
22300
- "inheritedFrom": {
22301
- "name": "ListItem",
22302
- "module": "src/components/listitem/listitem.component.ts"
22303
- }
22304
- },
22305
- {
22306
- "description": "slot for list item tertiary label.",
22307
- "name": "leading-text-tertiary-label",
22308
- "inheritedFrom": {
22309
- "name": "ListItem",
22310
- "module": "src/components/listitem/listitem.component.ts"
22311
- }
22312
- },
22313
- {
22314
- "description": "slot for list item side header text.",
22315
- "name": "trailing-text-side-header",
22316
- "inheritedFrom": {
22317
- "name": "ListItem",
22318
- "module": "src/components/listitem/listitem.component.ts"
22319
- }
22320
- },
22321
- {
22322
- "description": "slot for list item subline text.",
22323
- "name": "trailing-text-subline",
22324
- "inheritedFrom": {
22325
- "name": "ListItem",
22326
- "module": "src/components/listitem/listitem.component.ts"
22327
- }
22328
- },
22329
- {
22330
- "description": "slot for list item controls to appear of trailing end.",
22331
- "name": "trailing-controls",
22332
- "inheritedFrom": {
22333
- "name": "ListItem",
22334
- "module": "src/components/listitem/listitem.component.ts"
22335
- }
22336
- }
22337
- ],
22338
- "cssProperties": [
22339
- {
22340
- "description": "Allows customization of the default background color.",
22341
- "name": "--mdc-listitem-default-background-color",
22342
- "inheritedFrom": {
22343
- "name": "ListItem",
22344
- "module": "src/components/listitem/listitem.component.ts"
22345
- }
22346
- },
22347
- {
22348
- "description": "Allows customization of the background color on hover.",
22349
- "name": "--mdc-listitem-background-color-hover",
22350
- "inheritedFrom": {
22351
- "name": "ListItem",
22352
- "module": "src/components/listitem/listitem.component.ts"
22353
- }
22354
- },
22355
- {
22356
- "description": "Allows customization of the background color when pressed.",
22357
- "name": "--mdc-listitem-background-color-active",
22358
- "inheritedFrom": {
22359
- "name": "ListItem",
22360
- "module": "src/components/listitem/listitem.component.ts"
22361
- }
22362
- },
22363
- {
22364
- "description": "Allows customization of the primary label, side header and subline text slot color.",
22365
- "name": "--mdc-listitem-primary-label-color",
22366
- "inheritedFrom": {
22367
- "name": "ListItem",
22368
- "module": "src/components/listitem/listitem.component.ts"
22369
- }
22370
- },
22371
- {
22372
- "description": "Allows customization of the secondary and tertiary label text slot color.",
22373
- "name": "--mdc-listitem-secondary-label-color",
22374
- "inheritedFrom": {
22375
- "name": "ListItem",
22376
- "module": "src/components/listitem/listitem.component.ts"
22377
- }
22378
- },
22379
- {
22380
- "description": "Allows customization of the disabled color.",
22381
- "name": "--mdc-listitem-disabled-color",
22382
- "inheritedFrom": {
22383
- "name": "ListItem",
22384
- "module": "src/components/listitem/listitem.component.ts"
22385
- }
22386
- },
22387
- {
22388
- "description": "Allows customization of column gap.",
22389
- "name": "--mdc-listitem-column-gap",
22390
- "inheritedFrom": {
22391
- "name": "ListItem",
22392
- "module": "src/components/listitem/listitem.component.ts"
22393
- }
22394
- },
22395
- {
22396
- "description": "Allows customization of padding left and right.",
22397
- "name": "--mdc-listitem-padding-left-and-right",
22398
- "inheritedFrom": {
22399
- "name": "ListItem",
22400
- "module": "src/components/listitem/listitem.component.ts"
22401
- }
22402
- }
22403
- ]
22404
- }
22405
- ],
22406
- "exports": [
22407
- {
22408
- "kind": "js",
22409
- "name": "default",
22410
- "declaration": {
22411
- "name": "Option",
22412
- "module": "components/option/option.component.js"
22413
- }
22414
- }
22415
- ]
22416
- },
22417
- {
22418
- "kind": "javascript-module",
22419
- "path": "components/navmenuitem/navmenuitem.component.js",
22420
- "declarations": [
22421
- {
22422
- "kind": "class",
22423
- "description": "`mdc-navmenuitem` is a menuitem styled to work as a navigation tab.\nIt supports a leading icon, optional badge and dynamic text rendering.\n\nNote: `mdc-navmenuitem` is intended to be used inside `mdc-menubar` as part of the sideNavigation\ncomponent. Its structure, spacing, and interactions are designed to align with\nthe visual and functional requirements of side navigation layouts.",
22424
- "name": "NavMenuItem",
22425
- "cssProperties": [
22426
- {
22427
- "description": "Text color of the navmenuitem in its normal state.",
22428
- "name": "--mdc-navmenuitem-color"
22429
- },
22430
- {
22431
- "description": "Border color of the navmenuitem in its normal state.",
22432
- "name": "--mdc-navmenuitem-border-color"
22433
- },
22434
- {
22435
- "description": "Text color of the navmenuitem when disabled.",
22436
- "name": "--mdc-navmenuitem-disabled-color"
22437
- },
22438
- {
22439
- "description": "Width of the navmenuitem when expanded.",
22440
- "name": "--mdc-navmenuitem-expanded-width"
22441
- },
22442
- {
22443
- "description": "Background color of the navmenuitem when hovered.",
22444
- "name": "--mdc-navmenuitem-hover-background-color"
22445
- },
22446
- {
22447
- "description": "Background color of the active navmenuitem when hovered.",
22448
- "name": "--mdc-navmenuitem-hover-active-background-color"
22449
- },
22450
- {
22451
- "description": "Background color of the navmenuitem when pressed.",
22452
- "name": "--mdc-navmenuitem-pressed-background-color"
22453
- },
22454
- {
22455
- "description": "Background color of the active navmenuitem when pressed.",
22456
- "name": "--mdc-navmenuitem-pressed-active-background-color"
22457
- },
22458
- {
22459
- "description": "Background color of the navmenuitem when disabled.",
22460
- "name": "--mdc-navmenuitem-disabled-background-color"
22355
+ "name": "ListItem",
22356
+ "module": "src/components/listitem/listitem.component.ts"
22357
+ }
22461
22358
  },
22462
22359
  {
22463
- "description": "Background color of the active navmenuitem when disabled.",
22464
- "name": "--mdc-navmenuitem-disabled-active-background-color"
22360
+ "name": "soft-disabled",
22361
+ "type": {
22362
+ "text": "boolean | undefined"
22363
+ },
22364
+ "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.",
22365
+ "default": "undefined",
22366
+ "fieldName": "softDisabled",
22367
+ "inheritedFrom": {
22368
+ "name": "ListItem",
22369
+ "module": "src/components/listitem/listitem.component.ts"
22370
+ }
22465
22371
  },
22466
22372
  {
22467
- "description": "Background color of the active nav item in its rest state.",
22468
- "name": "--mdc-navmenuitem-rest-active-background-color"
22373
+ "name": "tooltip-text",
22374
+ "type": {
22375
+ "text": "string | undefined"
22376
+ },
22377
+ "description": "The tooltip text is displayed on hover of the list item.",
22378
+ "fieldName": "tooltipText",
22379
+ "inheritedFrom": {
22380
+ "name": "ListItem",
22381
+ "module": "src/components/listitem/listitem.component.ts"
22382
+ }
22469
22383
  },
22470
22384
  {
22471
- "description": "Allows customization of the default background color.",
22472
- "name": "--mdc-listitem-default-background-color",
22385
+ "name": "tooltip-placement",
22386
+ "type": {
22387
+ "text": "PopoverPlacement"
22388
+ },
22389
+ "description": "The tooltip placement of the list item. If the tooltip text is present,\nthen this tooltip placement will be applied.",
22390
+ "default": "'top'",
22391
+ "fieldName": "tooltipPlacement",
22473
22392
  "inheritedFrom": {
22474
22393
  "name": "ListItem",
22475
22394
  "module": "src/components/listitem/listitem.component.ts"
22476
22395
  }
22477
- },
22396
+ }
22397
+ ],
22398
+ "mixins": [
22478
22399
  {
22479
- "description": "Allows customization of the background color on hover.",
22480
- "name": "--mdc-listitem-background-color-hover",
22400
+ "name": "IconNameMixin",
22401
+ "module": "/src/utils/mixins/IconNameMixin"
22402
+ }
22403
+ ],
22404
+ "superclass": {
22405
+ "name": "MenuItem",
22406
+ "module": "/src/components/menuitem/menuitem.component"
22407
+ },
22408
+ "tagName": "mdc-navmenuitem",
22409
+ "jsDoc": "/**\n * `mdc-navmenuitem` is a menuitem styled to work as a navigation tab.\n * It supports a leading icon, optional badge and dynamic text rendering.\n *\n * Note: `mdc-navmenuitem` is intended to be used inside `mdc-menubar` as part of the sideNavigation\n * component. Its structure, spacing, and interactions are designed to align with\n * the visual and functional requirements of side navigation layouts.\n *\n * @tagname mdc-navmenuitem\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n * @dependency mdc-badge\n * @dependency mdc-tooltip\n *\n * @event click - (React: onClick) This event is dispatched when the navmenuitem is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the navmenuitem.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the navmenuitem.\n * @event focus - (React: onFocus) This event is dispatched when the navmenuitem receives focus.\n * @event activechange - (React: onActiveChange) Dispatched when the active state of the navmenuitem changes.\n *\n * @cssproperty --mdc-navmenuitem-color - Text color of the navmenuitem in its normal state.\n * @cssproperty --mdc-navmenuitem-border-color - Border color of the navmenuitem in its normal state.\n * @cssproperty --mdc-navmenuitem-disabled-color - Text color of the navmenuitem when disabled.\n * @cssproperty --mdc-navmenuitem-expanded-width - Width of the navmenuitem when expanded.\n * @cssproperty --mdc-navmenuitem-hover-background-color - Background color of the navmenuitem when hovered.\n * @cssproperty --mdc-navmenuitem-hover-active-background-color - Background color of the active navmenuitem when hovered.\n * @cssproperty --mdc-navmenuitem-pressed-background-color - Background color of the navmenuitem when pressed.\n * @cssproperty --mdc-navmenuitem-pressed-active-background-color - Background color of the active navmenuitem when pressed.\n * @cssproperty --mdc-navmenuitem-disabled-background-color - Background color of the navmenuitem when disabled.\n * @cssproperty --mdc-navmenuitem-disabled-active-background-color - Background color of the active navmenuitem when disabled.\n * @cssproperty --mdc-navmenuitem-rest-active-background-color - Background color of the active nav item in its rest state.\n */",
22410
+ "customElement": true,
22411
+ "slots": [
22412
+ {
22413
+ "description": "slot for menu item controls to appear of leading end.",
22414
+ "name": "leading-controls",
22481
22415
  "inheritedFrom": {
22482
22416
  "name": "ListItem",
22483
22417
  "module": "src/components/listitem/listitem.component.ts"
22484
22418
  }
22485
22419
  },
22486
22420
  {
22487
- "description": "Allows customization of the background color when pressed.",
22488
- "name": "--mdc-listitem-background-color-active",
22421
+ "description": "slot for menu item primary label.",
22422
+ "name": "leading-text-primary-label",
22489
22423
  "inheritedFrom": {
22490
22424
  "name": "ListItem",
22491
22425
  "module": "src/components/listitem/listitem.component.ts"
22492
22426
  }
22493
22427
  },
22494
22428
  {
22495
- "description": "Allows customization of the primary label, side header and subline text slot color.",
22496
- "name": "--mdc-listitem-primary-label-color",
22429
+ "description": "slot for menu item secondary label.",
22430
+ "name": "leading-text-secondary-label",
22497
22431
  "inheritedFrom": {
22498
22432
  "name": "ListItem",
22499
22433
  "module": "src/components/listitem/listitem.component.ts"
22500
22434
  }
22501
22435
  },
22502
22436
  {
22503
- "description": "Allows customization of the secondary and tertiary label text slot color.",
22504
- "name": "--mdc-listitem-secondary-label-color",
22437
+ "description": "slot for menu item tertiary label.",
22438
+ "name": "leading-text-tertiary-label",
22505
22439
  "inheritedFrom": {
22506
22440
  "name": "ListItem",
22507
22441
  "module": "src/components/listitem/listitem.component.ts"
22508
22442
  }
22509
22443
  },
22510
22444
  {
22511
- "description": "Allows customization of the disabled color.",
22512
- "name": "--mdc-listitem-disabled-color",
22445
+ "description": "slot for menu item side header text.",
22446
+ "name": "trailing-text-side-header",
22513
22447
  "inheritedFrom": {
22514
22448
  "name": "ListItem",
22515
22449
  "module": "src/components/listitem/listitem.component.ts"
22516
22450
  }
22517
22451
  },
22518
22452
  {
22519
- "description": "Allows customization of column gap.",
22520
- "name": "--mdc-listitem-column-gap",
22453
+ "description": "slot for menu item subline text.",
22454
+ "name": "trailing-text-subline",
22521
22455
  "inheritedFrom": {
22522
22456
  "name": "ListItem",
22523
22457
  "module": "src/components/listitem/listitem.component.ts"
22524
22458
  }
22525
22459
  },
22526
22460
  {
22527
- "description": "Allows customization of padding left and right.",
22528
- "name": "--mdc-listitem-padding-left-and-right",
22461
+ "description": "slot for menu item controls to appear of trailing end.",
22462
+ "name": "trailing-controls",
22529
22463
  "inheritedFrom": {
22530
22464
  "name": "ListItem",
22531
22465
  "module": "src/components/listitem/listitem.component.ts"
22532
22466
  }
22533
22467
  }
22468
+ ]
22469
+ }
22470
+ ],
22471
+ "exports": [
22472
+ {
22473
+ "kind": "js",
22474
+ "name": "default",
22475
+ "declaration": {
22476
+ "name": "NavMenuItem",
22477
+ "module": "components/navmenuitem/navmenuitem.component.js"
22478
+ }
22479
+ }
22480
+ ]
22481
+ },
22482
+ {
22483
+ "kind": "javascript-module",
22484
+ "path": "components/optgroup/optgroup.component.js",
22485
+ "declarations": [
22486
+ {
22487
+ "kind": "class",
22488
+ "description": "optgroup component, which creates a grouping of mdc-option within a listbox element.",
22489
+ "name": "OptGroup",
22490
+ "cssProperties": [
22491
+ {
22492
+ "description": "Allows customization of the disabled option color.",
22493
+ "name": "--mdc-optgroup-disabled-color"
22494
+ }
22495
+ ],
22496
+ "slots": [
22497
+ {
22498
+ "description": "This is a default slot for mdc-option elements.",
22499
+ "name": "default"
22500
+ }
22534
22501
  ],
22535
22502
  "members": [
22536
22503
  {
22537
22504
  "kind": "field",
22538
- "name": "active",
22505
+ "name": "label",
22539
22506
  "type": {
22540
- "text": "boolean | undefined"
22507
+ "text": "string | undefined"
22541
22508
  },
22542
- "description": "The navmenuitem's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the navmenuitem is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the navmenuitem is in an inactive state, indicating it is toggled off.",
22543
- "default": "undefined",
22544
- "attribute": "active",
22509
+ "description": "The header text to be displayed on the top of the options list.",
22510
+ "attribute": "label",
22545
22511
  "reflects": true
22546
22512
  },
22547
22513
  {
22548
- "kind": "field",
22549
- "name": "badgeType",
22550
- "type": {
22551
- "text": "BadgeType | undefined"
22552
- },
22553
- "description": "Type of the badge\nCan be `dot` (notification) or `counter`.",
22554
- "attribute": "badge-type",
22555
- "reflects": true
22514
+ "kind": "method",
22515
+ "name": "setDisabledForAllOptions",
22516
+ "privacy": "private",
22517
+ "return": {
22518
+ "type": {
22519
+ "text": "void"
22520
+ }
22521
+ }
22556
22522
  },
22557
22523
  {
22558
22524
  "kind": "field",
22559
- "name": "counter",
22525
+ "name": "dataAriaLabel",
22560
22526
  "type": {
22561
- "text": "number | undefined"
22527
+ "text": "string | null"
22562
22528
  },
22563
- "description": "Counter is the number which can be provided in the badge.",
22564
- "attribute": "counter",
22565
- "reflects": true
22529
+ "default": "null",
22530
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
22531
+ "attribute": "data-aria-label",
22532
+ "reflects": true,
22533
+ "inheritedFrom": {
22534
+ "name": "DataAriaLabelMixin",
22535
+ "module": "utils/mixins/DataAriaLabelMixin.js"
22536
+ }
22566
22537
  },
22567
22538
  {
22568
22539
  "kind": "field",
22569
- "name": "maxCounter",
22540
+ "name": "disabled",
22570
22541
  "type": {
22571
- "text": "number"
22542
+ "text": "boolean | undefined"
22572
22543
  },
22573
- "description": "The maximum number can be set up to 999, anything above that will be rendered as _999+_.\nThe max counter can be `9`, `99` or `999`.",
22574
- "default": "99",
22575
- "attribute": "max-counter",
22576
- "reflects": true
22577
- },
22544
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
22545
+ "default": "undefined",
22546
+ "attribute": "disabled",
22547
+ "reflects": true,
22548
+ "inheritedFrom": {
22549
+ "name": "DisabledMixin",
22550
+ "module": "utils/mixins/DisabledMixin.js"
22551
+ }
22552
+ }
22553
+ ],
22554
+ "attributes": [
22578
22555
  {
22579
- "kind": "field",
22580
- "name": "navId",
22556
+ "name": "label",
22581
22557
  "type": {
22582
22558
  "text": "string | undefined"
22583
22559
  },
22584
- "description": "Id of the navMenuItem (used as a identificator when used in the menubar)\nNote: It has to be unique.",
22585
- "default": "undefined",
22586
- "attribute": "nav-id",
22587
- "reflects": true
22560
+ "description": "The header text to be displayed on the top of the options list.",
22561
+ "fieldName": "label"
22588
22562
  },
22589
22563
  {
22590
- "kind": "field",
22591
- "name": "ariaLabel",
22564
+ "name": "data-aria-label",
22592
22565
  "type": {
22593
22566
  "text": "string | null"
22594
22567
  },
22595
22568
  "default": "null",
22596
- "description": "Aria-label attribute to be set for accessibility",
22597
- "attribute": "aria-label"
22569
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
22570
+ "fieldName": "dataAriaLabel",
22571
+ "inheritedFrom": {
22572
+ "name": "DataAriaLabelMixin",
22573
+ "module": "src/utils/mixins/DataAriaLabelMixin.ts"
22574
+ }
22598
22575
  },
22599
22576
  {
22600
- "kind": "field",
22601
- "name": "disableAriaCurrent",
22577
+ "name": "disabled",
22602
22578
  "type": {
22603
22579
  "text": "boolean | undefined"
22604
22580
  },
22605
- "description": "When set to true, prevents the automatic setting of the `aria-current` attribute on the navmenuitem\nwhen it becomes active. This is useful for cases where you want to maintain the visual active styling\nbut need to handle aria-current attribute differently or not at all.\nThe active button styling will still be applied regardless of this setting.",
22606
- "attribute": "disable-aria-current",
22581
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
22582
+ "default": "undefined",
22583
+ "fieldName": "disabled",
22584
+ "inheritedFrom": {
22585
+ "name": "DisabledMixin",
22586
+ "module": "src/utils/mixins/DisabledMixin.ts"
22587
+ }
22588
+ }
22589
+ ],
22590
+ "mixins": [
22591
+ {
22592
+ "name": "DataAriaLabelMixin",
22593
+ "module": "/src/utils/mixins/DataAriaLabelMixin"
22594
+ },
22595
+ {
22596
+ "name": "DisabledMixin",
22597
+ "module": "/src/utils/mixins/DisabledMixin"
22598
+ }
22599
+ ],
22600
+ "superclass": {
22601
+ "name": "Component",
22602
+ "module": "/src/models"
22603
+ },
22604
+ "tagName": "mdc-optgroup",
22605
+ "jsDoc": "/**\n * optgroup component, which creates a grouping of mdc-option within a listbox element.\n *\n * @dependency mdc-text\n *\n * @tagname mdc-optgroup\n *\n * @slot default - This is a default slot for mdc-option elements.\n *\n * @cssproperty --mdc-optgroup-disabled-color - Allows customization of the disabled option color.\n */",
22606
+ "customElement": true
22607
+ }
22608
+ ],
22609
+ "exports": [
22610
+ {
22611
+ "kind": "js",
22612
+ "name": "default",
22613
+ "declaration": {
22614
+ "name": "OptGroup",
22615
+ "module": "components/optgroup/optgroup.component.js"
22616
+ }
22617
+ }
22618
+ ]
22619
+ },
22620
+ {
22621
+ "kind": "javascript-module",
22622
+ "path": "components/option/option.component.js",
22623
+ "declarations": [
22624
+ {
22625
+ "kind": "class",
22626
+ "description": "Option component, which is used within Selectlistbox within Select component.\n\nThe label and secondary label of the option can be set using the `label` and `secondaryLabel` properties respectively.\nThe `label` is the primary text displayed in the option, while the `secondaryLabel` is the secondary text displayed below the primary label.\n\nThe `selected` property is used to indicate whether the option is selected or not.\nWhen the `selected` property is set to true, a checkmark icon will be displayed\non the right side of the option to indicate that it is selected.\n\nThe `prefixIcon` property can be used to display an icon on the left side of the option label.\nWe can show a tooltip by setting `tooltip-text` attribute. This will be displayed on hover or focus of the option.\nThe tooltip will be helpful for a long label text which is truncated with ellipsis.",
22627
+ "name": "Option",
22628
+ "members": [
22629
+ {
22630
+ "kind": "field",
22631
+ "name": "selected",
22632
+ "type": {
22633
+ "text": "boolean"
22634
+ },
22635
+ "default": "false",
22636
+ "description": "The selected attribute is used to indicate that the option is selected.",
22637
+ "attribute": "selected",
22607
22638
  "reflects": true
22608
22639
  },
22609
22640
  {
22610
- "kind": "method",
22611
- "name": "isNested",
22612
- "privacy": "private",
22613
- "return": {
22614
- "type": {
22615
- "text": "boolean"
22616
- }
22641
+ "kind": "field",
22642
+ "name": "prefixIcon",
22643
+ "type": {
22644
+ "text": "IconNames | undefined"
22617
22645
  },
22618
- "description": "Check whether the navmenuitem is inside a nested nav structure.\nReturns `true` if there is a parent `mdc-menupopover`\nThis method assumes nesting implies deeper levels of nav hierarchy."
22619
- },
22620
- {
22621
- "kind": "method",
22622
- "name": "handleClickEvent",
22623
- "privacy": "private",
22624
- "return": {
22625
- "type": {
22626
- "text": "void"
22627
- }
22628
- }
22629
- },
22630
- {
22631
- "kind": "method",
22632
- "name": "renderTextLabel",
22633
- "privacy": "private",
22634
- "parameters": [
22635
- {
22636
- "name": "label",
22637
- "type": {
22638
- "text": "string | undefined"
22639
- }
22640
- }
22641
- ]
22642
- },
22643
- {
22644
- "kind": "method",
22645
- "name": "renderArrowIcon",
22646
- "privacy": "private",
22647
- "parameters": [
22648
- {
22649
- "name": "showLabel",
22650
- "type": {
22651
- "text": "boolean | undefined"
22652
- }
22653
- }
22654
- ]
22655
- },
22656
- {
22657
- "kind": "method",
22658
- "name": "renderBadge",
22659
- "privacy": "private",
22660
- "parameters": [
22661
- {
22662
- "name": "showLabel",
22663
- "type": {
22664
- "text": "boolean | undefined"
22665
- }
22666
- }
22667
- ]
22646
+ "description": "The prefix icon attribute is used to display the icon name on the left of the option label.",
22647
+ "attribute": "prefix-icon",
22648
+ "reflects": true
22668
22649
  },
22669
22650
  {
22670
22651
  "kind": "field",
22671
- "name": "iconName",
22652
+ "name": "ariaLabel",
22672
22653
  "type": {
22673
- "text": "IconNames | undefined"
22654
+ "text": "string | null"
22674
22655
  },
22675
- "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
22676
- "attribute": "icon-name",
22677
- "inheritedFrom": {
22678
- "name": "IconNameMixin",
22679
- "module": "utils/mixins/IconNameMixin.js"
22680
- }
22656
+ "default": "null",
22657
+ "description": "Any additional description can be provided here for screen readers.",
22658
+ "attribute": "aria-label",
22659
+ "reflects": true
22681
22660
  },
22682
22661
  {
22683
22662
  "kind": "field",
22684
- "name": "arrowPosition",
22663
+ "name": "name",
22685
22664
  "type": {
22686
- "text": "ArrowPositions | undefined"
22665
+ "text": "string"
22687
22666
  },
22688
- "description": "Defines where the arrow icon will appear.\n- `'leading'`: Icon appears on the leading edge (start).\n- `'trailing'`: Icon appears on the trailing edge (end).\n\nIf not set, no arrow is displayed.",
22689
- "attribute": "arrow-position",
22667
+ "default": "''",
22668
+ "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
22669
+ "attribute": "name",
22690
22670
  "reflects": true,
22691
22671
  "inheritedFrom": {
22692
- "name": "MenuItem",
22693
- "module": "components/menuitem/menuitem.component.js"
22672
+ "name": "FormInternalsMixin",
22673
+ "module": "utils/mixins/FormInternalsMixin.js"
22694
22674
  }
22695
22675
  },
22696
22676
  {
22697
22677
  "kind": "field",
22698
- "name": "arrowDirection",
22678
+ "name": "value",
22699
22679
  "type": {
22700
- "text": "ArrowDirections | undefined"
22680
+ "text": "string"
22701
22681
  },
22702
- "description": "Defines the direction the arrow icon points.\n- `'positive'`: Arrow points toward the trailing side.\n- `'negative'`: Arrow points toward the leading side.",
22703
- "attribute": "arrow-direction",
22682
+ "default": "''",
22683
+ "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
22684
+ "attribute": "value",
22704
22685
  "reflects": true,
22705
22686
  "inheritedFrom": {
22706
- "name": "MenuItem",
22707
- "module": "components/menuitem/menuitem.component.js"
22687
+ "name": "FormInternalsMixin",
22688
+ "module": "utils/mixins/FormInternalsMixin.js"
22708
22689
  }
22709
22690
  },
22710
22691
  {
22711
22692
  "kind": "field",
22712
- "name": "name",
22693
+ "name": "validationMessage",
22713
22694
  "type": {
22714
- "text": "undefined | string | undefined"
22695
+ "text": "string | undefined"
22715
22696
  },
22716
- "default": "undefined",
22717
- "description": "The name attribute is used to identify the menu item when it is selected.",
22718
- "attribute": "name",
22697
+ "description": "Custom validation message that will override the default message and displayed when the input is invalid.\n\nTo display custom validation messages, you must listen for input events (or other relevant events)\non your component and update the `validationMessage` property with the desired message string.\nUpdating this property will ensure that new validation messages are shown to the user.\n- The `validationMessage` property overrides the default browser validation message when set.\n- Consumers are responsible for updating `validationMessage` in response to input or validation state changes.",
22698
+ "attribute": "validation-message",
22719
22699
  "reflects": true,
22720
22700
  "inheritedFrom": {
22721
- "name": "MenuItem",
22722
- "module": "components/menuitem/menuitem.component.js"
22701
+ "name": "FormInternalsMixin",
22702
+ "module": "utils/mixins/FormInternalsMixin.js"
22723
22703
  }
22724
22704
  },
22725
22705
  {
22726
22706
  "kind": "field",
22727
- "name": "value",
22707
+ "name": "validity",
22728
22708
  "type": {
22729
- "text": "undefined | string | undefined"
22709
+ "text": "ValidityState"
22730
22710
  },
22731
- "default": "undefined",
22732
- "description": "The value attribute is used to represent a value when the menu item is selected.\nIt is typically used with checkbox and radio menu items, but can be handy for any menu item.",
22733
- "attribute": "value",
22734
- "reflects": true,
22711
+ "readonly": true,
22735
22712
  "inheritedFrom": {
22736
- "name": "MenuItem",
22737
- "module": "components/menuitem/menuitem.component.js"
22713
+ "name": "FormInternalsMixin",
22714
+ "module": "utils/mixins/FormInternalsMixin.js"
22738
22715
  }
22739
22716
  },
22740
22717
  {
22741
- "kind": "method",
22742
- "name": "handleKeyDown",
22743
- "privacy": "protected",
22744
- "return": {
22745
- "type": {
22746
- "text": "void"
22747
- }
22748
- },
22749
- "parameters": [
22750
- {
22751
- "name": "event",
22752
- "type": {
22753
- "text": "KeyboardEvent"
22754
- },
22755
- "description": "The keyboard event that triggered the action."
22756
- }
22757
- ],
22758
- "description": "Handles the keydown event for the menu item.\nIf the Enter key is pressed, it triggers a click event on the menu item.\nThis allows keyboard users to activate the menu item using the Enter key.\n\nThis follows the native behaviour, actionable element can be triggered by Enter\nkey on the keydown event.\n\nNote: Action triggered by Space on the keyup event.",
22718
+ "kind": "field",
22719
+ "name": "willValidate",
22720
+ "readonly": true,
22759
22721
  "inheritedFrom": {
22760
- "name": "ListItem",
22761
- "module": "components/listitem/listitem.component.js"
22722
+ "name": "FormInternalsMixin",
22723
+ "module": "utils/mixins/FormInternalsMixin.js"
22762
22724
  }
22763
22725
  },
22764
22726
  {
22765
22727
  "kind": "method",
22766
- "name": "handleKeyUp",
22767
- "privacy": "private",
22728
+ "name": "setValidity",
22729
+ "description": "Sets the validity of the input field based on the input field's validity.",
22768
22730
  "return": {
22769
22731
  "type": {
22770
- "text": "void"
22732
+ "text": ""
22771
22733
  }
22772
22734
  },
22773
- "parameters": [
22774
- {
22775
- "name": "event",
22776
- "type": {
22777
- "text": "KeyboardEvent"
22778
- },
22779
- "description": "The keyboard event that triggered the action."
22780
- }
22781
- ],
22782
- "description": "Handles the keyup event for the menu item.\nIf the Space key is released, it triggers a click event on the menu item.\nThis allows keyboard users to activate the menu item using the Space key.\nIt also prevents the default action of the Space key to avoid scrolling the page.\n\nThis follows the native behaviour, actionable element can be triggered by Space\nkey on the keyup event.\n\nNote: Action triggered by Enter on the keydown event.",
22783
22735
  "inheritedFrom": {
22784
- "name": "MenuItem",
22785
- "module": "components/menuitem/menuitem.component.js"
22736
+ "name": "FormInternalsMixin",
22737
+ "module": "utils/mixins/FormInternalsMixin.js"
22786
22738
  }
22787
22739
  },
22788
22740
  {
22789
22741
  "kind": "method",
22790
- "name": "renderTrailingControls",
22791
- "privacy": "protected",
22792
- "description": "Renders the trailing controls slot and optionally the trailing arrow icon,\nbased on `arrowPosition` and `arrowDirection`.",
22742
+ "name": "checkValidity",
22793
22743
  "return": {
22794
22744
  "type": {
22795
- "text": ""
22745
+ "text": "boolean"
22796
22746
  }
22797
22747
  },
22798
22748
  "inheritedFrom": {
22799
- "name": "ListItem",
22800
- "module": "components/listitem/listitem.component.js"
22749
+ "name": "FormInternalsMixin",
22750
+ "module": "utils/mixins/FormInternalsMixin.js"
22801
22751
  }
22802
22752
  },
22803
22753
  {
22804
22754
  "kind": "method",
22805
- "name": "renderLeadingControls",
22806
- "privacy": "protected",
22807
- "description": "Renders the leading controls slot and optionally the leading arrow icon,\nbased on `arrowPosition` and `arrowDirection`.",
22808
- "return": {
22809
- "type": {
22810
- "text": ""
22811
- }
22812
- },
22755
+ "name": "reportValidity",
22813
22756
  "inheritedFrom": {
22814
- "name": "ListItem",
22815
- "module": "components/listitem/listitem.component.js"
22757
+ "name": "FormInternalsMixin",
22758
+ "module": "utils/mixins/FormInternalsMixin.js"
22816
22759
  }
22817
22760
  },
22818
22761
  {
@@ -22974,6 +22917,30 @@
22974
22917
  "module": "components/listitem/listitem.component.js"
22975
22918
  }
22976
22919
  },
22920
+ {
22921
+ "kind": "method",
22922
+ "name": "handleKeyDown",
22923
+ "privacy": "protected",
22924
+ "return": {
22925
+ "type": {
22926
+ "text": "void"
22927
+ }
22928
+ },
22929
+ "parameters": [
22930
+ {
22931
+ "name": "event",
22932
+ "type": {
22933
+ "text": "KeyboardEvent"
22934
+ },
22935
+ "description": "The keyboard event triggered when a key is pressed down."
22936
+ }
22937
+ ],
22938
+ "description": "Fires the click event when the enter or space key is pressed down.\nThis behavior is similar to a button click and key interaction.",
22939
+ "inheritedFrom": {
22940
+ "name": "ListItem",
22941
+ "module": "components/listitem/listitem.component.js"
22942
+ }
22943
+ },
22977
22944
  {
22978
22945
  "kind": "method",
22979
22946
  "name": "triggerClickEvent",
@@ -23061,8 +23028,48 @@
23061
23028
  },
23062
23029
  "description": "The text content to be displayed within the slot."
23063
23030
  }
23064
- ],
23065
- "description": "Generates a template for a text slot with the specified content.",
23031
+ ],
23032
+ "description": "Generates a template for a text slot with the specified content.",
23033
+ "inheritedFrom": {
23034
+ "name": "ListItem",
23035
+ "module": "components/listitem/listitem.component.js"
23036
+ }
23037
+ },
23038
+ {
23039
+ "kind": "method",
23040
+ "name": "disableSlottedChildren",
23041
+ "privacy": "private",
23042
+ "return": {
23043
+ "type": {
23044
+ "text": "void"
23045
+ }
23046
+ },
23047
+ "parameters": [
23048
+ {
23049
+ "name": "disabled",
23050
+ "default": "false",
23051
+ "type": {
23052
+ "text": "boolean"
23053
+ },
23054
+ "description": "Whether to disable or enable the controls."
23055
+ }
23056
+ ],
23057
+ "description": "Disable or enable all slotted elements in the leading and trailing slots.\nThis is useful when the list item is disabled, to prevent the user from interacting with the controls.",
23058
+ "inheritedFrom": {
23059
+ "name": "ListItem",
23060
+ "module": "components/listitem/listitem.component.js"
23061
+ }
23062
+ },
23063
+ {
23064
+ "kind": "method",
23065
+ "name": "renderTrailingControls",
23066
+ "privacy": "protected",
23067
+ "description": "Renders the trailing controls slot.",
23068
+ "return": {
23069
+ "type": {
23070
+ "text": ""
23071
+ }
23072
+ },
23066
23073
  "inheritedFrom": {
23067
23074
  "name": "ListItem",
23068
23075
  "module": "components/listitem/listitem.component.js"
@@ -23070,24 +23077,14 @@
23070
23077
  },
23071
23078
  {
23072
23079
  "kind": "method",
23073
- "name": "disableSlottedChildren",
23074
- "privacy": "private",
23080
+ "name": "renderLeadingControls",
23081
+ "privacy": "protected",
23082
+ "description": "Renders the leading controls slot.",
23075
23083
  "return": {
23076
23084
  "type": {
23077
- "text": "void"
23085
+ "text": ""
23078
23086
  }
23079
23087
  },
23080
- "parameters": [
23081
- {
23082
- "name": "disabled",
23083
- "default": "false",
23084
- "type": {
23085
- "text": "boolean"
23086
- },
23087
- "description": "Whether to disable or enable the controls."
23088
- }
23089
- ],
23090
- "description": "Disable or enable all slotted elements in the leading and trailing slots.\nThis is useful when the list item is disabled, to prevent the user from interacting with the controls.",
23091
23088
  "inheritedFrom": {
23092
23089
  "name": "ListItem",
23093
23090
  "module": "components/listitem/listitem.component.js"
@@ -23120,7 +23117,7 @@
23120
23117
  ],
23121
23118
  "events": [
23122
23119
  {
23123
- "description": "(React: onClick) This event is dispatched when the navmenuitem is clicked.",
23120
+ "description": "(React: onClick) This event is dispatched when the option is clicked.",
23124
23121
  "name": "click",
23125
23122
  "reactName": "onClick",
23126
23123
  "inheritedFrom": {
@@ -23129,7 +23126,7 @@
23129
23126
  }
23130
23127
  },
23131
23128
  {
23132
- "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the navmenuitem.",
23129
+ "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the option.",
23133
23130
  "name": "keydown",
23134
23131
  "reactName": "onKeyDown",
23135
23132
  "inheritedFrom": {
@@ -23138,7 +23135,7 @@
23138
23135
  }
23139
23136
  },
23140
23137
  {
23141
- "description": "(React: onKeyUp) This event is dispatched when a key is released on the navmenuitem.",
23138
+ "description": "(React: onKeyUp) This event is dispatched when a key is released on the option.",
23142
23139
  "name": "keyup",
23143
23140
  "reactName": "onKeyUp",
23144
23141
  "inheritedFrom": {
@@ -23147,7 +23144,7 @@
23147
23144
  }
23148
23145
  },
23149
23146
  {
23150
- "description": "(React: onFocus) This event is dispatched when the navmenuitem receives focus.",
23147
+ "description": "(React: onFocus) This event is dispatched when the option receives focus.",
23151
23148
  "name": "focus",
23152
23149
  "reactName": "onFocus",
23153
23150
  "inheritedFrom": {
@@ -23155,11 +23152,6 @@
23155
23152
  "module": "src/components/listitem/listitem.component.ts"
23156
23153
  }
23157
23154
  },
23158
- {
23159
- "description": "(React: onActiveChange) Dispatched when the active state of the navmenuitem changes.",
23160
- "name": "activechange",
23161
- "reactName": "onActiveChange"
23162
- },
23163
23155
  {
23164
23156
  "description": "(React: onEnabled) This event is dispatched after the listitem is enabled",
23165
23157
  "name": "enabled",
@@ -23199,47 +23191,21 @@
23199
23191
  ],
23200
23192
  "attributes": [
23201
23193
  {
23202
- "name": "active",
23203
- "type": {
23204
- "text": "boolean | undefined"
23205
- },
23206
- "description": "The navmenuitem's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the navmenuitem is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the navmenuitem is in an inactive state, indicating it is toggled off.",
23207
- "default": "undefined",
23208
- "fieldName": "active"
23209
- },
23210
- {
23211
- "name": "badge-type",
23212
- "type": {
23213
- "text": "BadgeType | undefined"
23214
- },
23215
- "description": "Type of the badge\nCan be `dot` (notification) or `counter`.",
23216
- "fieldName": "badgeType"
23217
- },
23218
- {
23219
- "name": "counter",
23220
- "type": {
23221
- "text": "number | undefined"
23222
- },
23223
- "description": "Counter is the number which can be provided in the badge.",
23224
- "fieldName": "counter"
23225
- },
23226
- {
23227
- "name": "max-counter",
23194
+ "name": "selected",
23228
23195
  "type": {
23229
- "text": "number"
23196
+ "text": "boolean"
23230
23197
  },
23231
- "description": "The maximum number can be set up to 999, anything above that will be rendered as _999+_.\nThe max counter can be `9`, `99` or `999`.",
23232
- "default": "99",
23233
- "fieldName": "maxCounter"
23198
+ "default": "false",
23199
+ "description": "The selected attribute is used to indicate that the option is selected.",
23200
+ "fieldName": "selected"
23234
23201
  },
23235
23202
  {
23236
- "name": "nav-id",
23203
+ "name": "prefix-icon",
23237
23204
  "type": {
23238
- "text": "string | undefined"
23205
+ "text": "IconNames | undefined"
23239
23206
  },
23240
- "description": "Id of the navMenuItem (used as a identificator when used in the menubar)\nNote: It has to be unique.",
23241
- "default": "undefined",
23242
- "fieldName": "navId"
23207
+ "description": "The prefix icon attribute is used to display the icon name on the left of the option label.",
23208
+ "fieldName": "prefixIcon"
23243
23209
  },
23244
23210
  {
23245
23211
  "name": "aria-label",
@@ -23247,77 +23213,45 @@
23247
23213
  "text": "string | null"
23248
23214
  },
23249
23215
  "default": "null",
23250
- "description": "Aria-label attribute to be set for accessibility",
23216
+ "description": "Any additional description can be provided here for screen readers.",
23251
23217
  "fieldName": "ariaLabel"
23252
23218
  },
23253
23219
  {
23254
- "name": "disable-aria-current",
23255
- "type": {
23256
- "text": "boolean | undefined"
23257
- },
23258
- "description": "When set to true, prevents the automatic setting of the `aria-current` attribute on the navmenuitem\nwhen it becomes active. This is useful for cases where you want to maintain the visual active styling\nbut need to handle aria-current attribute differently or not at all.\nThe active button styling will still be applied regardless of this setting.",
23259
- "fieldName": "disableAriaCurrent"
23260
- },
23261
- {
23262
- "name": "icon-name",
23263
- "type": {
23264
- "text": "IconNames | undefined"
23265
- },
23266
- "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
23267
- "fieldName": "iconName",
23268
- "inheritedFrom": {
23269
- "name": "IconNameMixin",
23270
- "module": "src/utils/mixins/IconNameMixin.ts"
23271
- }
23272
- },
23273
- {
23274
- "name": "arrow-position",
23275
- "type": {
23276
- "text": "ArrowPositions | undefined"
23277
- },
23278
- "description": "Defines where the arrow icon will appear.\n- `'leading'`: Icon appears on the leading edge (start).\n- `'trailing'`: Icon appears on the trailing edge (end).\n\nIf not set, no arrow is displayed.",
23279
- "fieldName": "arrowPosition",
23280
- "inheritedFrom": {
23281
- "name": "MenuItem",
23282
- "module": "src/components/menuitem/menuitem.component.ts"
23283
- }
23284
- },
23285
- {
23286
- "name": "arrow-direction",
23220
+ "name": "name",
23287
23221
  "type": {
23288
- "text": "ArrowDirections | undefined"
23222
+ "text": "string"
23289
23223
  },
23290
- "description": "Defines the direction the arrow icon points.\n- `'positive'`: Arrow points toward the trailing side.\n- `'negative'`: Arrow points toward the leading side.",
23291
- "fieldName": "arrowDirection",
23224
+ "default": "''",
23225
+ "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
23226
+ "fieldName": "name",
23292
23227
  "inheritedFrom": {
23293
- "name": "MenuItem",
23294
- "module": "src/components/menuitem/menuitem.component.ts"
23228
+ "name": "FormInternalsMixin",
23229
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
23295
23230
  }
23296
23231
  },
23297
23232
  {
23298
- "name": "name",
23233
+ "name": "value",
23299
23234
  "type": {
23300
- "text": "undefined | string | undefined"
23235
+ "text": "string"
23301
23236
  },
23302
- "default": "undefined",
23303
- "description": "The name attribute is used to identify the menu item when it is selected.",
23304
- "fieldName": "name",
23237
+ "default": "''",
23238
+ "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
23239
+ "fieldName": "value",
23305
23240
  "inheritedFrom": {
23306
- "name": "MenuItem",
23307
- "module": "src/components/menuitem/menuitem.component.ts"
23241
+ "name": "FormInternalsMixin",
23242
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
23308
23243
  }
23309
23244
  },
23310
23245
  {
23311
- "name": "value",
23246
+ "name": "validation-message",
23312
23247
  "type": {
23313
- "text": "undefined | string | undefined"
23248
+ "text": "string | undefined"
23314
23249
  },
23315
- "default": "undefined",
23316
- "description": "The value attribute is used to represent a value when the menu item is selected.\nIt is typically used with checkbox and radio menu items, but can be handy for any menu item.",
23317
- "fieldName": "value",
23250
+ "description": "Custom validation message that will override the default message and displayed when the input is invalid.\n\nTo display custom validation messages, you must listen for input events (or other relevant events)\non your component and update the `validationMessage` property with the desired message string.\nUpdating this property will ensure that new validation messages are shown to the user.\n- The `validationMessage` property overrides the default browser validation message when set.\n- Consumers are responsible for updating `validationMessage` in response to input or validation state changes.",
23251
+ "fieldName": "validationMessage",
23318
23252
  "inheritedFrom": {
23319
- "name": "MenuItem",
23320
- "module": "src/components/menuitem/menuitem.component.ts"
23253
+ "name": "FormInternalsMixin",
23254
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
23321
23255
  }
23322
23256
  },
23323
23257
  {
@@ -23460,20 +23394,20 @@
23460
23394
  ],
23461
23395
  "mixins": [
23462
23396
  {
23463
- "name": "IconNameMixin",
23464
- "module": "/src/utils/mixins/IconNameMixin"
23397
+ "name": "FormInternalsMixin",
23398
+ "module": "/src/utils/mixins/FormInternalsMixin"
23465
23399
  }
23466
23400
  ],
23467
23401
  "superclass": {
23468
- "name": "MenuItem",
23469
- "module": "/src/components/menuitem/menuitem.component"
23402
+ "name": "ListItem",
23403
+ "module": "/src/components/listitem/listitem.component"
23470
23404
  },
23471
- "tagName": "mdc-navmenuitem",
23472
- "jsDoc": "/**\n * `mdc-navmenuitem` is a menuitem styled to work as a navigation tab.\n * It supports a leading icon, optional badge and dynamic text rendering.\n *\n * Note: `mdc-navmenuitem` is intended to be used inside `mdc-menubar` as part of the sideNavigation\n * component. Its structure, spacing, and interactions are designed to align with\n * the visual and functional requirements of side navigation layouts.\n *\n * @tagname mdc-navmenuitem\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n * @dependency mdc-badge\n * @dependency mdc-tooltip\n *\n * @event click - (React: onClick) This event is dispatched when the navmenuitem is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the navmenuitem.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the navmenuitem.\n * @event focus - (React: onFocus) This event is dispatched when the navmenuitem receives focus.\n * @event activechange - (React: onActiveChange) Dispatched when the active state of the navmenuitem changes.\n *\n * @cssproperty --mdc-navmenuitem-color - Text color of the navmenuitem in its normal state.\n * @cssproperty --mdc-navmenuitem-border-color - Border color of the navmenuitem in its normal state.\n * @cssproperty --mdc-navmenuitem-disabled-color - Text color of the navmenuitem when disabled.\n * @cssproperty --mdc-navmenuitem-expanded-width - Width of the navmenuitem when expanded.\n * @cssproperty --mdc-navmenuitem-hover-background-color - Background color of the navmenuitem when hovered.\n * @cssproperty --mdc-navmenuitem-hover-active-background-color - Background color of the active navmenuitem when hovered.\n * @cssproperty --mdc-navmenuitem-pressed-background-color - Background color of the navmenuitem when pressed.\n * @cssproperty --mdc-navmenuitem-pressed-active-background-color - Background color of the active navmenuitem when pressed.\n * @cssproperty --mdc-navmenuitem-disabled-background-color - Background color of the navmenuitem when disabled.\n * @cssproperty --mdc-navmenuitem-disabled-active-background-color - Background color of the active navmenuitem when disabled.\n * @cssproperty --mdc-navmenuitem-rest-active-background-color - Background color of the active nav item in its rest state.\n */",
23405
+ "tagName": "mdc-option",
23406
+ "jsDoc": "/**\n * Option component, which is used within Selectlistbox within Select component.\n *\n * The label and secondary label of the option can be set using the `label` and `secondaryLabel` properties respectively.\n * The `label` is the primary text displayed in the option, while the `secondaryLabel` is the secondary text displayed below the primary label.\n *\n * The `selected` property is used to indicate whether the option is selected or not.\n * When the `selected` property is set to true, a checkmark icon will be displayed\n * on the right side of the option to indicate that it is selected.\n *\n * The `prefixIcon` property can be used to display an icon on the left side of the option label.\n * We can show a tooltip by setting `tooltip-text` attribute. This will be displayed on hover or focus of the option.\n * The tooltip will be helpful for a long label text which is truncated with ellipsis.\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n * @dependency mdc-tooltip\n *\n * @tagname mdc-option\n *\n * @event click - (React: onClick) This event is dispatched when the option is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the option.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the option.\n * @event focus - (React: onFocus) This event is dispatched when the option receives focus.\n */",
23473
23407
  "customElement": true,
23474
23408
  "slots": [
23475
23409
  {
23476
- "description": "slot for menu item controls to appear of leading end.",
23410
+ "description": "slot for list item controls to appear of leading end.",
23477
23411
  "name": "leading-controls",
23478
23412
  "inheritedFrom": {
23479
23413
  "name": "ListItem",
@@ -23481,7 +23415,7 @@
23481
23415
  }
23482
23416
  },
23483
23417
  {
23484
- "description": "slot for menu item primary label.",
23418
+ "description": "slot for list item primary label.",
23485
23419
  "name": "leading-text-primary-label",
23486
23420
  "inheritedFrom": {
23487
23421
  "name": "ListItem",
@@ -23489,7 +23423,7 @@
23489
23423
  }
23490
23424
  },
23491
23425
  {
23492
- "description": "slot for menu item secondary label.",
23426
+ "description": "slot for list item secondary label.",
23493
23427
  "name": "leading-text-secondary-label",
23494
23428
  "inheritedFrom": {
23495
23429
  "name": "ListItem",
@@ -23497,7 +23431,7 @@
23497
23431
  }
23498
23432
  },
23499
23433
  {
23500
- "description": "slot for menu item tertiary label.",
23434
+ "description": "slot for list item tertiary label.",
23501
23435
  "name": "leading-text-tertiary-label",
23502
23436
  "inheritedFrom": {
23503
23437
  "name": "ListItem",
@@ -23505,7 +23439,7 @@
23505
23439
  }
23506
23440
  },
23507
23441
  {
23508
- "description": "slot for menu item side header text.",
23442
+ "description": "slot for list item side header text.",
23509
23443
  "name": "trailing-text-side-header",
23510
23444
  "inheritedFrom": {
23511
23445
  "name": "ListItem",
@@ -23513,7 +23447,7 @@
23513
23447
  }
23514
23448
  },
23515
23449
  {
23516
- "description": "slot for menu item subline text.",
23450
+ "description": "slot for list item subline text.",
23517
23451
  "name": "trailing-text-subline",
23518
23452
  "inheritedFrom": {
23519
23453
  "name": "ListItem",
@@ -23521,13 +23455,79 @@
23521
23455
  }
23522
23456
  },
23523
23457
  {
23524
- "description": "slot for menu item controls to appear of trailing end.",
23458
+ "description": "slot for list item controls to appear of trailing end.",
23525
23459
  "name": "trailing-controls",
23526
23460
  "inheritedFrom": {
23527
23461
  "name": "ListItem",
23528
23462
  "module": "src/components/listitem/listitem.component.ts"
23529
23463
  }
23530
23464
  }
23465
+ ],
23466
+ "cssProperties": [
23467
+ {
23468
+ "description": "Allows customization of the default background color.",
23469
+ "name": "--mdc-listitem-default-background-color",
23470
+ "inheritedFrom": {
23471
+ "name": "ListItem",
23472
+ "module": "src/components/listitem/listitem.component.ts"
23473
+ }
23474
+ },
23475
+ {
23476
+ "description": "Allows customization of the background color on hover.",
23477
+ "name": "--mdc-listitem-background-color-hover",
23478
+ "inheritedFrom": {
23479
+ "name": "ListItem",
23480
+ "module": "src/components/listitem/listitem.component.ts"
23481
+ }
23482
+ },
23483
+ {
23484
+ "description": "Allows customization of the background color when pressed.",
23485
+ "name": "--mdc-listitem-background-color-active",
23486
+ "inheritedFrom": {
23487
+ "name": "ListItem",
23488
+ "module": "src/components/listitem/listitem.component.ts"
23489
+ }
23490
+ },
23491
+ {
23492
+ "description": "Allows customization of the primary label, side header and subline text slot color.",
23493
+ "name": "--mdc-listitem-primary-label-color",
23494
+ "inheritedFrom": {
23495
+ "name": "ListItem",
23496
+ "module": "src/components/listitem/listitem.component.ts"
23497
+ }
23498
+ },
23499
+ {
23500
+ "description": "Allows customization of the secondary and tertiary label text slot color.",
23501
+ "name": "--mdc-listitem-secondary-label-color",
23502
+ "inheritedFrom": {
23503
+ "name": "ListItem",
23504
+ "module": "src/components/listitem/listitem.component.ts"
23505
+ }
23506
+ },
23507
+ {
23508
+ "description": "Allows customization of the disabled color.",
23509
+ "name": "--mdc-listitem-disabled-color",
23510
+ "inheritedFrom": {
23511
+ "name": "ListItem",
23512
+ "module": "src/components/listitem/listitem.component.ts"
23513
+ }
23514
+ },
23515
+ {
23516
+ "description": "Allows customization of column gap.",
23517
+ "name": "--mdc-listitem-column-gap",
23518
+ "inheritedFrom": {
23519
+ "name": "ListItem",
23520
+ "module": "src/components/listitem/listitem.component.ts"
23521
+ }
23522
+ },
23523
+ {
23524
+ "description": "Allows customization of padding left and right.",
23525
+ "name": "--mdc-listitem-padding-left-and-right",
23526
+ "inheritedFrom": {
23527
+ "name": "ListItem",
23528
+ "module": "src/components/listitem/listitem.component.ts"
23529
+ }
23530
+ }
23531
23531
  ]
23532
23532
  }
23533
23533
  ],
@@ -23536,8 +23536,8 @@
23536
23536
  "kind": "js",
23537
23537
  "name": "default",
23538
23538
  "declaration": {
23539
- "name": "NavMenuItem",
23540
- "module": "components/navmenuitem/navmenuitem.component.js"
23539
+ "name": "Option",
23540
+ "module": "components/option/option.component.js"
23541
23541
  }
23542
23542
  }
23543
23543
  ]