@momentum-design/components 0.96.2 → 0.96.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -21353,403 +21353,281 @@
21353
21353
  },
21354
21354
  {
21355
21355
  "kind": "javascript-module",
21356
- "path": "components/navmenuitem/navmenuitem.component.js",
21356
+ "path": "components/optgroup/optgroup.component.js",
21357
21357
  "declarations": [
21358
21358
  {
21359
21359
  "kind": "class",
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",
21360
+ "description": "optgroup component, which creates a grouping of mdc-option within a listbox element.",
21361
+ "name": "OptGroup",
21362
21362
  "cssProperties": [
21363
21363
  {
21364
- "description": "Text color of the navmenuitem in its normal state.",
21365
- "name": "--mdc-navmenuitem-color"
21366
- },
21367
- {
21368
- "description": "Border color of the navmenuitem in its normal state.",
21369
- "name": "--mdc-navmenuitem-border-color"
21370
- },
21371
- {
21372
- "description": "Text color of the navmenuitem when disabled.",
21373
- "name": "--mdc-navmenuitem-disabled-color"
21374
- },
21375
- {
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
- },
21364
+ "description": "Allows customization of the disabled option color.",
21365
+ "name": "--mdc-optgroup-disabled-color"
21366
+ }
21367
+ ],
21368
+ "slots": [
21399
21369
  {
21400
- "description": "Background color of the active navmenuitem when disabled.",
21401
- "name": "--mdc-navmenuitem-disabled-active-background-color"
21402
- },
21370
+ "description": "This is a default slot for mdc-option elements.",
21371
+ "name": "default"
21372
+ }
21373
+ ],
21374
+ "members": [
21403
21375
  {
21404
- "description": "Background color of the active nav item in its rest state.",
21405
- "name": "--mdc-navmenuitem-rest-active-background-color"
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
21406
21384
  },
21407
21385
  {
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"
21386
+ "kind": "method",
21387
+ "name": "setDisabledForAllOptions",
21388
+ "privacy": "private",
21389
+ "return": {
21390
+ "type": {
21391
+ "text": "void"
21392
+ }
21413
21393
  }
21414
21394
  },
21415
21395
  {
21416
- "description": "Allows customization of the background color on hover.",
21417
- "name": "--mdc-listitem-background-color-hover",
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,
21418
21405
  "inheritedFrom": {
21419
- "name": "ListItem",
21420
- "module": "src/components/listitem/listitem.component.ts"
21406
+ "name": "DataAriaLabelMixin",
21407
+ "module": "utils/mixins/DataAriaLabelMixin.js"
21421
21408
  }
21422
21409
  },
21423
21410
  {
21424
- "description": "Allows customization of the background color when pressed.",
21425
- "name": "--mdc-listitem-background-color-active",
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,
21426
21420
  "inheritedFrom": {
21427
- "name": "ListItem",
21428
- "module": "src/components/listitem/listitem.component.ts"
21421
+ "name": "DisabledMixin",
21422
+ "module": "utils/mixins/DisabledMixin.js"
21429
21423
  }
21430
- },
21424
+ }
21425
+ ],
21426
+ "attributes": [
21431
21427
  {
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
- }
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"
21438
21434
  },
21439
21435
  {
21440
- "description": "Allows customization of the secondary and tertiary label text slot color.",
21441
- "name": "--mdc-listitem-secondary-label-color",
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",
21442
21443
  "inheritedFrom": {
21443
- "name": "ListItem",
21444
- "module": "src/components/listitem/listitem.component.ts"
21444
+ "name": "DataAriaLabelMixin",
21445
+ "module": "src/utils/mixins/DataAriaLabelMixin.ts"
21445
21446
  }
21446
21447
  },
21447
21448
  {
21448
- "description": "Allows customization of the disabled color.",
21449
- "name": "--mdc-listitem-disabled-color",
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",
21450
21456
  "inheritedFrom": {
21451
- "name": "ListItem",
21452
- "module": "src/components/listitem/listitem.component.ts"
21457
+ "name": "DisabledMixin",
21458
+ "module": "src/utils/mixins/DisabledMixin.ts"
21453
21459
  }
21454
- },
21460
+ }
21461
+ ],
21462
+ "mixins": [
21455
21463
  {
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
- }
21464
+ "name": "DataAriaLabelMixin",
21465
+ "module": "/src/utils/mixins/DataAriaLabelMixin"
21462
21466
  },
21463
21467
  {
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
- }
21468
+ "name": "DisabledMixin",
21469
+ "module": "/src/utils/mixins/DisabledMixin"
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",
21472
21500
  "members": [
21473
21501
  {
21474
21502
  "kind": "field",
21475
- "name": "active",
21503
+ "name": "selected",
21476
21504
  "type": {
21477
- "text": "boolean | undefined"
21505
+ "text": "boolean"
21478
21506
  },
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",
21507
+ "default": "false",
21508
+ "description": "The selected attribute is used to indicate that the option is selected.",
21509
+ "attribute": "selected",
21482
21510
  "reflects": true
21483
21511
  },
21484
21512
  {
21485
21513
  "kind": "field",
21486
- "name": "badgeType",
21514
+ "name": "prefixIcon",
21487
21515
  "type": {
21488
- "text": "BadgeType | undefined"
21516
+ "text": "IconNames | undefined"
21489
21517
  },
21490
- "description": "Type of the badge\nCan be `dot` (notification) or `counter`.",
21491
- "attribute": "badge-type",
21518
+ "description": "The prefix icon attribute is used to display the icon name on the left of the option label.",
21519
+ "attribute": "prefix-icon",
21492
21520
  "reflects": true
21493
21521
  },
21494
21522
  {
21495
21523
  "kind": "field",
21496
- "name": "counter",
21524
+ "name": "ariaLabel",
21497
21525
  "type": {
21498
- "text": "number | undefined"
21526
+ "text": "string | null"
21499
21527
  },
21500
- "description": "Counter is the number which can be provided in the badge.",
21501
- "attribute": "counter",
21528
+ "default": "null",
21529
+ "description": "Any additional description can be provided here for screen readers.",
21530
+ "attribute": "aria-label",
21502
21531
  "reflects": true
21503
21532
  },
21504
21533
  {
21505
21534
  "kind": "field",
21506
- "name": "maxCounter",
21535
+ "name": "name",
21507
21536
  "type": {
21508
- "text": "number"
21537
+ "text": "string"
21509
21538
  },
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
21539
+ "default": "''",
21540
+ "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
21541
+ "attribute": "name",
21542
+ "reflects": true,
21543
+ "inheritedFrom": {
21544
+ "name": "FormInternalsMixin",
21545
+ "module": "utils/mixins/FormInternalsMixin.js"
21546
+ }
21514
21547
  },
21515
21548
  {
21516
21549
  "kind": "field",
21517
- "name": "navId",
21550
+ "name": "value",
21518
21551
  "type": {
21519
- "text": "string | undefined"
21552
+ "text": "string"
21520
21553
  },
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",
21524
- "reflects": true
21554
+ "default": "''",
21555
+ "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
21556
+ "attribute": "value",
21557
+ "reflects": true,
21558
+ "inheritedFrom": {
21559
+ "name": "FormInternalsMixin",
21560
+ "module": "utils/mixins/FormInternalsMixin.js"
21561
+ }
21525
21562
  },
21526
21563
  {
21527
21564
  "kind": "field",
21528
- "name": "ariaLabel",
21529
- "type": {
21530
- "text": "string | null"
21531
- },
21532
- "default": "null",
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",
21544
- "reflects": true
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
- },
21606
- {
21607
- "kind": "field",
21608
- "name": "iconName",
21609
- "type": {
21610
- "text": "IconNames | undefined"
21611
- },
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",
21627
- "reflects": true,
21628
- "inheritedFrom": {
21629
- "name": "MenuItem",
21630
- "module": "components/menuitem/menuitem.component.js"
21631
- }
21632
- },
21633
- {
21634
- "kind": "field",
21635
- "name": "arrowDirection",
21565
+ "name": "validationMessage",
21636
21566
  "type": {
21637
- "text": "ArrowDirections | undefined"
21567
+ "text": "string | undefined"
21638
21568
  },
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",
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",
21641
21571
  "reflects": true,
21642
21572
  "inheritedFrom": {
21643
- "name": "MenuItem",
21644
- "module": "components/menuitem/menuitem.component.js"
21573
+ "name": "FormInternalsMixin",
21574
+ "module": "utils/mixins/FormInternalsMixin.js"
21645
21575
  }
21646
21576
  },
21647
21577
  {
21648
21578
  "kind": "field",
21649
- "name": "name",
21579
+ "name": "validity",
21650
21580
  "type": {
21651
- "text": "undefined | string | undefined"
21581
+ "text": "ValidityState"
21652
21582
  },
21653
- "default": "undefined",
21654
- "description": "The name attribute is used to identify the menu item when it is selected.",
21655
- "attribute": "name",
21656
- "reflects": true,
21583
+ "readonly": true,
21657
21584
  "inheritedFrom": {
21658
- "name": "MenuItem",
21659
- "module": "components/menuitem/menuitem.component.js"
21585
+ "name": "FormInternalsMixin",
21586
+ "module": "utils/mixins/FormInternalsMixin.js"
21660
21587
  }
21661
21588
  },
21662
21589
  {
21663
21590
  "kind": "field",
21664
- "name": "value",
21665
- "type": {
21666
- "text": "undefined | string | undefined"
21667
- },
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,
21672
- "inheritedFrom": {
21673
- "name": "MenuItem",
21674
- "module": "components/menuitem/menuitem.component.js"
21675
- }
21676
- },
21677
- {
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.",
21591
+ "name": "willValidate",
21592
+ "readonly": true,
21696
21593
  "inheritedFrom": {
21697
- "name": "ListItem",
21698
- "module": "components/listitem/listitem.component.js"
21594
+ "name": "FormInternalsMixin",
21595
+ "module": "utils/mixins/FormInternalsMixin.js"
21699
21596
  }
21700
21597
  },
21701
21598
  {
21702
21599
  "kind": "method",
21703
- "name": "handleKeyUp",
21704
- "privacy": "private",
21600
+ "name": "setValidity",
21601
+ "description": "Sets the validity of the input field based on the input field's validity.",
21705
21602
  "return": {
21706
21603
  "type": {
21707
- "text": "void"
21604
+ "text": ""
21708
21605
  }
21709
21606
  },
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.",
21720
21607
  "inheritedFrom": {
21721
- "name": "MenuItem",
21722
- "module": "components/menuitem/menuitem.component.js"
21608
+ "name": "FormInternalsMixin",
21609
+ "module": "utils/mixins/FormInternalsMixin.js"
21723
21610
  }
21724
21611
  },
21725
21612
  {
21726
21613
  "kind": "method",
21727
- "name": "renderTrailingControls",
21728
- "privacy": "protected",
21729
- "description": "Renders the trailing controls slot and optionally the trailing arrow icon,\nbased on `arrowPosition` and `arrowDirection`.",
21614
+ "name": "checkValidity",
21730
21615
  "return": {
21731
21616
  "type": {
21732
- "text": ""
21617
+ "text": "boolean"
21733
21618
  }
21734
21619
  },
21735
21620
  "inheritedFrom": {
21736
- "name": "ListItem",
21737
- "module": "components/listitem/listitem.component.js"
21621
+ "name": "FormInternalsMixin",
21622
+ "module": "utils/mixins/FormInternalsMixin.js"
21738
21623
  }
21739
21624
  },
21740
21625
  {
21741
21626
  "kind": "method",
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
- },
21627
+ "name": "reportValidity",
21750
21628
  "inheritedFrom": {
21751
- "name": "ListItem",
21752
- "module": "components/listitem/listitem.component.js"
21629
+ "name": "FormInternalsMixin",
21630
+ "module": "utils/mixins/FormInternalsMixin.js"
21753
21631
  }
21754
21632
  },
21755
21633
  {
@@ -21911,6 +21789,30 @@
21911
21789
  "module": "components/listitem/listitem.component.js"
21912
21790
  }
21913
21791
  },
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
+ },
21914
21816
  {
21915
21817
  "kind": "method",
21916
21818
  "name": "triggerClickEvent",
@@ -22032,32 +21934,62 @@
22032
21934
  },
22033
21935
  {
22034
21936
  "kind": "method",
22035
- "name": "stopEventPropagation",
21937
+ "name": "renderTrailingControls",
22036
21938
  "privacy": "protected",
21939
+ "description": "Renders the trailing controls slot.",
22037
21940
  "return": {
22038
21941
  "type": {
22039
- "text": "void"
21942
+ "text": ""
22040
21943
  }
22041
21944
  },
22042
- "parameters": [
22043
- {
22044
- "name": "event",
22045
- "type": {
22046
- "text": "Event"
22047
- },
22048
- "description": "The mouse event triggered when a click occurs."
22049
- }
22050
- ],
22051
- "description": "Stops the click event from propagating to parent elements. In case of keyboard events,\nit stops the propagation for Enter and Space keys.\nThis is useful when the list item contains controls that\nshould not trigger the click event on the list item itself.",
22052
21945
  "inheritedFrom": {
22053
21946
  "name": "ListItem",
22054
21947
  "module": "components/listitem/listitem.component.js"
22055
21948
  }
22056
- }
22057
- ],
22058
- "events": [
21949
+ },
22059
21950
  {
22060
- "description": "(React: onClick) This event is dispatched when the navmenuitem is clicked.",
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
+ {
21966
+ "kind": "method",
21967
+ "name": "stopEventPropagation",
21968
+ "privacy": "protected",
21969
+ "return": {
21970
+ "type": {
21971
+ "text": "void"
21972
+ }
21973
+ },
21974
+ "parameters": [
21975
+ {
21976
+ "name": "event",
21977
+ "type": {
21978
+ "text": "Event"
21979
+ },
21980
+ "description": "The mouse event triggered when a click occurs."
21981
+ }
21982
+ ],
21983
+ "description": "Stops the click event from propagating to parent elements. In case of keyboard events,\nit stops the propagation for Enter and Space keys.\nThis is useful when the list item contains controls that\nshould not trigger the click event on the list item itself.",
21984
+ "inheritedFrom": {
21985
+ "name": "ListItem",
21986
+ "module": "components/listitem/listitem.component.js"
21987
+ }
21988
+ }
21989
+ ],
21990
+ "events": [
21991
+ {
21992
+ "description": "(React: onClick) This event is dispatched when the option is clicked.",
22061
21993
  "name": "click",
22062
21994
  "reactName": "onClick",
22063
21995
  "inheritedFrom": {
@@ -22066,7 +21998,7 @@
22066
21998
  }
22067
21999
  },
22068
22000
  {
22069
- "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the navmenuitem.",
22001
+ "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the option.",
22070
22002
  "name": "keydown",
22071
22003
  "reactName": "onKeyDown",
22072
22004
  "inheritedFrom": {
@@ -22075,7 +22007,7 @@
22075
22007
  }
22076
22008
  },
22077
22009
  {
22078
- "description": "(React: onKeyUp) This event is dispatched when a key is released on the navmenuitem.",
22010
+ "description": "(React: onKeyUp) This event is dispatched when a key is released on the option.",
22079
22011
  "name": "keyup",
22080
22012
  "reactName": "onKeyUp",
22081
22013
  "inheritedFrom": {
@@ -22084,7 +22016,7 @@
22084
22016
  }
22085
22017
  },
22086
22018
  {
22087
- "description": "(React: onFocus) This event is dispatched when the navmenuitem receives focus.",
22019
+ "description": "(React: onFocus) This event is dispatched when the option receives focus.",
22088
22020
  "name": "focus",
22089
22021
  "reactName": "onFocus",
22090
22022
  "inheritedFrom": {
@@ -22092,11 +22024,6 @@
22092
22024
  "module": "src/components/listitem/listitem.component.ts"
22093
22025
  }
22094
22026
  },
22095
- {
22096
- "description": "(React: onActiveChange) Dispatched when the active state of the navmenuitem changes.",
22097
- "name": "activechange",
22098
- "reactName": "onActiveChange"
22099
- },
22100
22027
  {
22101
22028
  "description": "(React: onEnabled) This event is dispatched after the listitem is enabled",
22102
22029
  "name": "enabled",
@@ -22136,47 +22063,21 @@
22136
22063
  ],
22137
22064
  "attributes": [
22138
22065
  {
22139
- "name": "active",
22140
- "type": {
22141
- "text": "boolean | undefined"
22142
- },
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"
22146
- },
22147
- {
22148
- "name": "badge-type",
22149
- "type": {
22150
- "text": "BadgeType | undefined"
22151
- },
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",
22066
+ "name": "selected",
22165
22067
  "type": {
22166
- "text": "number"
22068
+ "text": "boolean"
22167
22069
  },
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"
22070
+ "default": "false",
22071
+ "description": "The selected attribute is used to indicate that the option is selected.",
22072
+ "fieldName": "selected"
22171
22073
  },
22172
22074
  {
22173
- "name": "nav-id",
22075
+ "name": "prefix-icon",
22174
22076
  "type": {
22175
- "text": "string | undefined"
22077
+ "text": "IconNames | undefined"
22176
22078
  },
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"
22079
+ "description": "The prefix icon attribute is used to display the icon name on the left of the option label.",
22080
+ "fieldName": "prefixIcon"
22180
22081
  },
22181
22082
  {
22182
22083
  "name": "aria-label",
@@ -22184,77 +22085,45 @@
22184
22085
  "text": "string | null"
22185
22086
  },
22186
22087
  "default": "null",
22187
- "description": "Aria-label attribute to be set for accessibility",
22088
+ "description": "Any additional description can be provided here for screen readers.",
22188
22089
  "fieldName": "ariaLabel"
22189
22090
  },
22190
22091
  {
22191
- "name": "disable-aria-current",
22192
- "type": {
22193
- "text": "boolean | undefined"
22194
- },
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",
22205
- "inheritedFrom": {
22206
- "name": "IconNameMixin",
22207
- "module": "src/utils/mixins/IconNameMixin.ts"
22208
- }
22209
- },
22210
- {
22211
- "name": "arrow-position",
22212
- "type": {
22213
- "text": "ArrowPositions | undefined"
22214
- },
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",
22092
+ "name": "name",
22224
22093
  "type": {
22225
- "text": "ArrowDirections | undefined"
22094
+ "text": "string"
22226
22095
  },
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",
22096
+ "default": "''",
22097
+ "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
22098
+ "fieldName": "name",
22229
22099
  "inheritedFrom": {
22230
- "name": "MenuItem",
22231
- "module": "src/components/menuitem/menuitem.component.ts"
22100
+ "name": "FormInternalsMixin",
22101
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
22232
22102
  }
22233
22103
  },
22234
22104
  {
22235
- "name": "name",
22105
+ "name": "value",
22236
22106
  "type": {
22237
- "text": "undefined | string | undefined"
22107
+ "text": "string"
22238
22108
  },
22239
- "default": "undefined",
22240
- "description": "The name attribute is used to identify the menu item when it is selected.",
22241
- "fieldName": "name",
22109
+ "default": "''",
22110
+ "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
22111
+ "fieldName": "value",
22242
22112
  "inheritedFrom": {
22243
- "name": "MenuItem",
22244
- "module": "src/components/menuitem/menuitem.component.ts"
22113
+ "name": "FormInternalsMixin",
22114
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
22245
22115
  }
22246
22116
  },
22247
22117
  {
22248
- "name": "value",
22118
+ "name": "validation-message",
22249
22119
  "type": {
22250
- "text": "undefined | string | undefined"
22120
+ "text": "string | undefined"
22251
22121
  },
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",
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",
22255
22124
  "inheritedFrom": {
22256
- "name": "MenuItem",
22257
- "module": "src/components/menuitem/menuitem.component.ts"
22125
+ "name": "FormInternalsMixin",
22126
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
22258
22127
  }
22259
22128
  },
22260
22129
  {
@@ -22397,20 +22266,20 @@
22397
22266
  ],
22398
22267
  "mixins": [
22399
22268
  {
22400
- "name": "IconNameMixin",
22401
- "module": "/src/utils/mixins/IconNameMixin"
22269
+ "name": "FormInternalsMixin",
22270
+ "module": "/src/utils/mixins/FormInternalsMixin"
22402
22271
  }
22403
22272
  ],
22404
22273
  "superclass": {
22405
- "name": "MenuItem",
22406
- "module": "/src/components/menuitem/menuitem.component"
22274
+ "name": "ListItem",
22275
+ "module": "/src/components/listitem/listitem.component"
22407
22276
  },
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 */",
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 */",
22410
22279
  "customElement": true,
22411
22280
  "slots": [
22412
22281
  {
22413
- "description": "slot for menu item controls to appear of leading end.",
22282
+ "description": "slot for list item controls to appear of leading end.",
22414
22283
  "name": "leading-controls",
22415
22284
  "inheritedFrom": {
22416
22285
  "name": "ListItem",
@@ -22418,7 +22287,7 @@
22418
22287
  }
22419
22288
  },
22420
22289
  {
22421
- "description": "slot for menu item primary label.",
22290
+ "description": "slot for list item primary label.",
22422
22291
  "name": "leading-text-primary-label",
22423
22292
  "inheritedFrom": {
22424
22293
  "name": "ListItem",
@@ -22426,7 +22295,7 @@
22426
22295
  }
22427
22296
  },
22428
22297
  {
22429
- "description": "slot for menu item secondary label.",
22298
+ "description": "slot for list item secondary label.",
22430
22299
  "name": "leading-text-secondary-label",
22431
22300
  "inheritedFrom": {
22432
22301
  "name": "ListItem",
@@ -22434,7 +22303,7 @@
22434
22303
  }
22435
22304
  },
22436
22305
  {
22437
- "description": "slot for menu item tertiary label.",
22306
+ "description": "slot for list item tertiary label.",
22438
22307
  "name": "leading-text-tertiary-label",
22439
22308
  "inheritedFrom": {
22440
22309
  "name": "ListItem",
@@ -22442,7 +22311,7 @@
22442
22311
  }
22443
22312
  },
22444
22313
  {
22445
- "description": "slot for menu item side header text.",
22314
+ "description": "slot for list item side header text.",
22446
22315
  "name": "trailing-text-side-header",
22447
22316
  "inheritedFrom": {
22448
22317
  "name": "ListItem",
@@ -22450,7 +22319,7 @@
22450
22319
  }
22451
22320
  },
22452
22321
  {
22453
- "description": "slot for menu item subline text.",
22322
+ "description": "slot for list item subline text.",
22454
22323
  "name": "trailing-text-subline",
22455
22324
  "inheritedFrom": {
22456
22325
  "name": "ListItem",
@@ -22458,152 +22327,80 @@
22458
22327
  }
22459
22328
  },
22460
22329
  {
22461
- "description": "slot for menu item controls to appear of trailing end.",
22330
+ "description": "slot for list item controls to appear of trailing end.",
22462
22331
  "name": "trailing-controls",
22463
22332
  "inheritedFrom": {
22464
22333
  "name": "ListItem",
22465
22334
  "module": "src/components/listitem/listitem.component.ts"
22466
22335
  }
22467
22336
  }
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
22337
  ],
22496
- "slots": [
22497
- {
22498
- "description": "This is a default slot for mdc-option elements.",
22499
- "name": "default"
22500
- }
22501
- ],
22502
- "members": [
22503
- {
22504
- "kind": "field",
22505
- "name": "label",
22506
- "type": {
22507
- "text": "string | undefined"
22508
- },
22509
- "description": "The header text to be displayed on the top of the options list.",
22510
- "attribute": "label",
22511
- "reflects": true
22512
- },
22338
+ "cssProperties": [
22513
22339
  {
22514
- "kind": "method",
22515
- "name": "setDisabledForAllOptions",
22516
- "privacy": "private",
22517
- "return": {
22518
- "type": {
22519
- "text": "void"
22520
- }
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"
22521
22345
  }
22522
22346
  },
22523
22347
  {
22524
- "kind": "field",
22525
- "name": "dataAriaLabel",
22526
- "type": {
22527
- "text": "string | null"
22528
- },
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,
22348
+ "description": "Allows customization of the background color on hover.",
22349
+ "name": "--mdc-listitem-background-color-hover",
22533
22350
  "inheritedFrom": {
22534
- "name": "DataAriaLabelMixin",
22535
- "module": "utils/mixins/DataAriaLabelMixin.js"
22351
+ "name": "ListItem",
22352
+ "module": "src/components/listitem/listitem.component.ts"
22536
22353
  }
22537
22354
  },
22538
22355
  {
22539
- "kind": "field",
22540
- "name": "disabled",
22541
- "type": {
22542
- "text": "boolean | undefined"
22543
- },
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,
22356
+ "description": "Allows customization of the background color when pressed.",
22357
+ "name": "--mdc-listitem-background-color-active",
22548
22358
  "inheritedFrom": {
22549
- "name": "DisabledMixin",
22550
- "module": "utils/mixins/DisabledMixin.js"
22359
+ "name": "ListItem",
22360
+ "module": "src/components/listitem/listitem.component.ts"
22551
22361
  }
22552
- }
22553
- ],
22554
- "attributes": [
22362
+ },
22555
22363
  {
22556
- "name": "label",
22557
- "type": {
22558
- "text": "string | undefined"
22559
- },
22560
- "description": "The header text to be displayed on the top of the options list.",
22561
- "fieldName": "label"
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
+ }
22562
22370
  },
22563
22371
  {
22564
- "name": "data-aria-label",
22565
- "type": {
22566
- "text": "string | null"
22567
- },
22568
- "default": "null",
22569
- "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
22570
- "fieldName": "dataAriaLabel",
22372
+ "description": "Allows customization of the secondary and tertiary label text slot color.",
22373
+ "name": "--mdc-listitem-secondary-label-color",
22571
22374
  "inheritedFrom": {
22572
- "name": "DataAriaLabelMixin",
22573
- "module": "src/utils/mixins/DataAriaLabelMixin.ts"
22375
+ "name": "ListItem",
22376
+ "module": "src/components/listitem/listitem.component.ts"
22574
22377
  }
22575
22378
  },
22576
22379
  {
22577
- "name": "disabled",
22578
- "type": {
22579
- "text": "boolean | undefined"
22580
- },
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",
22380
+ "description": "Allows customization of the disabled color.",
22381
+ "name": "--mdc-listitem-disabled-color",
22584
22382
  "inheritedFrom": {
22585
- "name": "DisabledMixin",
22586
- "module": "src/utils/mixins/DisabledMixin.ts"
22383
+ "name": "ListItem",
22384
+ "module": "src/components/listitem/listitem.component.ts"
22587
22385
  }
22588
- }
22589
- ],
22590
- "mixins": [
22386
+ },
22591
22387
  {
22592
- "name": "DataAriaLabelMixin",
22593
- "module": "/src/utils/mixins/DataAriaLabelMixin"
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
+ }
22594
22394
  },
22595
22395
  {
22596
- "name": "DisabledMixin",
22597
- "module": "/src/utils/mixins/DisabledMixin"
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
+ }
22598
22402
  }
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
22403
+ ]
22607
22404
  }
22608
22405
  ],
22609
22406
  "exports": [
@@ -22611,40 +22408,182 @@
22611
22408
  "kind": "js",
22612
22409
  "name": "default",
22613
22410
  "declaration": {
22614
- "name": "OptGroup",
22615
- "module": "components/optgroup/optgroup.component.js"
22411
+ "name": "Option",
22412
+ "module": "components/option/option.component.js"
22616
22413
  }
22617
22414
  }
22618
22415
  ]
22619
22416
  },
22620
22417
  {
22621
22418
  "kind": "javascript-module",
22622
- "path": "components/option/option.component.js",
22419
+ "path": "components/navmenuitem/navmenuitem.component.js",
22623
22420
  "declarations": [
22624
22421
  {
22625
22422
  "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",
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"
22461
+ },
22462
+ {
22463
+ "description": "Background color of the active navmenuitem when disabled.",
22464
+ "name": "--mdc-navmenuitem-disabled-active-background-color"
22465
+ },
22466
+ {
22467
+ "description": "Background color of the active nav item in its rest state.",
22468
+ "name": "--mdc-navmenuitem-rest-active-background-color"
22469
+ },
22470
+ {
22471
+ "description": "Allows customization of the default background color.",
22472
+ "name": "--mdc-listitem-default-background-color",
22473
+ "inheritedFrom": {
22474
+ "name": "ListItem",
22475
+ "module": "src/components/listitem/listitem.component.ts"
22476
+ }
22477
+ },
22478
+ {
22479
+ "description": "Allows customization of the background color on hover.",
22480
+ "name": "--mdc-listitem-background-color-hover",
22481
+ "inheritedFrom": {
22482
+ "name": "ListItem",
22483
+ "module": "src/components/listitem/listitem.component.ts"
22484
+ }
22485
+ },
22486
+ {
22487
+ "description": "Allows customization of the background color when pressed.",
22488
+ "name": "--mdc-listitem-background-color-active",
22489
+ "inheritedFrom": {
22490
+ "name": "ListItem",
22491
+ "module": "src/components/listitem/listitem.component.ts"
22492
+ }
22493
+ },
22494
+ {
22495
+ "description": "Allows customization of the primary label, side header and subline text slot color.",
22496
+ "name": "--mdc-listitem-primary-label-color",
22497
+ "inheritedFrom": {
22498
+ "name": "ListItem",
22499
+ "module": "src/components/listitem/listitem.component.ts"
22500
+ }
22501
+ },
22502
+ {
22503
+ "description": "Allows customization of the secondary and tertiary label text slot color.",
22504
+ "name": "--mdc-listitem-secondary-label-color",
22505
+ "inheritedFrom": {
22506
+ "name": "ListItem",
22507
+ "module": "src/components/listitem/listitem.component.ts"
22508
+ }
22509
+ },
22510
+ {
22511
+ "description": "Allows customization of the disabled color.",
22512
+ "name": "--mdc-listitem-disabled-color",
22513
+ "inheritedFrom": {
22514
+ "name": "ListItem",
22515
+ "module": "src/components/listitem/listitem.component.ts"
22516
+ }
22517
+ },
22518
+ {
22519
+ "description": "Allows customization of column gap.",
22520
+ "name": "--mdc-listitem-column-gap",
22521
+ "inheritedFrom": {
22522
+ "name": "ListItem",
22523
+ "module": "src/components/listitem/listitem.component.ts"
22524
+ }
22525
+ },
22526
+ {
22527
+ "description": "Allows customization of padding left and right.",
22528
+ "name": "--mdc-listitem-padding-left-and-right",
22529
+ "inheritedFrom": {
22530
+ "name": "ListItem",
22531
+ "module": "src/components/listitem/listitem.component.ts"
22532
+ }
22533
+ }
22534
+ ],
22628
22535
  "members": [
22629
22536
  {
22630
22537
  "kind": "field",
22631
- "name": "selected",
22538
+ "name": "active",
22632
22539
  "type": {
22633
- "text": "boolean"
22540
+ "text": "boolean | undefined"
22634
22541
  },
22635
- "default": "false",
22636
- "description": "The selected attribute is used to indicate that the option is selected.",
22637
- "attribute": "selected",
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",
22638
22545
  "reflects": true
22639
22546
  },
22640
22547
  {
22641
22548
  "kind": "field",
22642
- "name": "prefixIcon",
22549
+ "name": "badgeType",
22643
22550
  "type": {
22644
- "text": "IconNames | undefined"
22551
+ "text": "BadgeType | undefined"
22645
22552
  },
22646
- "description": "The prefix icon attribute is used to display the icon name on the left of the option label.",
22647
- "attribute": "prefix-icon",
22553
+ "description": "Type of the badge\nCan be `dot` (notification) or `counter`.",
22554
+ "attribute": "badge-type",
22555
+ "reflects": true
22556
+ },
22557
+ {
22558
+ "kind": "field",
22559
+ "name": "counter",
22560
+ "type": {
22561
+ "text": "number | undefined"
22562
+ },
22563
+ "description": "Counter is the number which can be provided in the badge.",
22564
+ "attribute": "counter",
22565
+ "reflects": true
22566
+ },
22567
+ {
22568
+ "kind": "field",
22569
+ "name": "maxCounter",
22570
+ "type": {
22571
+ "text": "number"
22572
+ },
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
+ },
22578
+ {
22579
+ "kind": "field",
22580
+ "name": "navId",
22581
+ "type": {
22582
+ "text": "string | undefined"
22583
+ },
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",
22648
22587
  "reflects": true
22649
22588
  },
22650
22589
  {
@@ -22654,108 +22593,226 @@
22654
22593
  "text": "string | null"
22655
22594
  },
22656
22595
  "default": "null",
22657
- "description": "Any additional description can be provided here for screen readers.",
22658
- "attribute": "aria-label",
22596
+ "description": "Aria-label attribute to be set for accessibility",
22597
+ "attribute": "aria-label"
22598
+ },
22599
+ {
22600
+ "kind": "field",
22601
+ "name": "disableAriaCurrent",
22602
+ "type": {
22603
+ "text": "boolean | undefined"
22604
+ },
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",
22659
22607
  "reflects": true
22660
22608
  },
22609
+ {
22610
+ "kind": "method",
22611
+ "name": "isNested",
22612
+ "privacy": "private",
22613
+ "return": {
22614
+ "type": {
22615
+ "text": "boolean"
22616
+ }
22617
+ },
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
+ ]
22668
+ },
22661
22669
  {
22662
22670
  "kind": "field",
22663
- "name": "name",
22671
+ "name": "iconName",
22672
+ "type": {
22673
+ "text": "IconNames | undefined"
22674
+ },
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
+ }
22681
+ },
22682
+ {
22683
+ "kind": "field",
22684
+ "name": "arrowPosition",
22664
22685
  "type": {
22665
- "text": "string"
22686
+ "text": "ArrowPositions | undefined"
22666
22687
  },
22667
- "default": "''",
22668
- "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
22669
- "attribute": "name",
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",
22670
22690
  "reflects": true,
22671
22691
  "inheritedFrom": {
22672
- "name": "FormInternalsMixin",
22673
- "module": "utils/mixins/FormInternalsMixin.js"
22692
+ "name": "MenuItem",
22693
+ "module": "components/menuitem/menuitem.component.js"
22674
22694
  }
22675
22695
  },
22676
22696
  {
22677
22697
  "kind": "field",
22678
- "name": "value",
22698
+ "name": "arrowDirection",
22679
22699
  "type": {
22680
- "text": "string"
22700
+ "text": "ArrowDirections | undefined"
22681
22701
  },
22682
- "default": "''",
22683
- "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
22684
- "attribute": "value",
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",
22685
22704
  "reflects": true,
22686
22705
  "inheritedFrom": {
22687
- "name": "FormInternalsMixin",
22688
- "module": "utils/mixins/FormInternalsMixin.js"
22706
+ "name": "MenuItem",
22707
+ "module": "components/menuitem/menuitem.component.js"
22689
22708
  }
22690
22709
  },
22691
22710
  {
22692
22711
  "kind": "field",
22693
- "name": "validationMessage",
22712
+ "name": "name",
22694
22713
  "type": {
22695
- "text": "string | undefined"
22714
+ "text": "undefined | string | undefined"
22696
22715
  },
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",
22716
+ "default": "undefined",
22717
+ "description": "The name attribute is used to identify the menu item when it is selected.",
22718
+ "attribute": "name",
22699
22719
  "reflects": true,
22700
22720
  "inheritedFrom": {
22701
- "name": "FormInternalsMixin",
22702
- "module": "utils/mixins/FormInternalsMixin.js"
22721
+ "name": "MenuItem",
22722
+ "module": "components/menuitem/menuitem.component.js"
22703
22723
  }
22704
22724
  },
22705
22725
  {
22706
22726
  "kind": "field",
22707
- "name": "validity",
22727
+ "name": "value",
22708
22728
  "type": {
22709
- "text": "ValidityState"
22729
+ "text": "undefined | string | undefined"
22710
22730
  },
22711
- "readonly": true,
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,
22712
22735
  "inheritedFrom": {
22713
- "name": "FormInternalsMixin",
22714
- "module": "utils/mixins/FormInternalsMixin.js"
22736
+ "name": "MenuItem",
22737
+ "module": "components/menuitem/menuitem.component.js"
22715
22738
  }
22716
22739
  },
22717
22740
  {
22718
- "kind": "field",
22719
- "name": "willValidate",
22720
- "readonly": true,
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.",
22721
22759
  "inheritedFrom": {
22722
- "name": "FormInternalsMixin",
22723
- "module": "utils/mixins/FormInternalsMixin.js"
22760
+ "name": "ListItem",
22761
+ "module": "components/listitem/listitem.component.js"
22724
22762
  }
22725
22763
  },
22726
22764
  {
22727
22765
  "kind": "method",
22728
- "name": "setValidity",
22729
- "description": "Sets the validity of the input field based on the input field's validity.",
22766
+ "name": "handleKeyUp",
22767
+ "privacy": "private",
22730
22768
  "return": {
22731
22769
  "type": {
22732
- "text": ""
22770
+ "text": "void"
22733
22771
  }
22734
22772
  },
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.",
22735
22783
  "inheritedFrom": {
22736
- "name": "FormInternalsMixin",
22737
- "module": "utils/mixins/FormInternalsMixin.js"
22784
+ "name": "MenuItem",
22785
+ "module": "components/menuitem/menuitem.component.js"
22738
22786
  }
22739
22787
  },
22740
22788
  {
22741
22789
  "kind": "method",
22742
- "name": "checkValidity",
22790
+ "name": "renderTrailingControls",
22791
+ "privacy": "protected",
22792
+ "description": "Renders the trailing controls slot and optionally the trailing arrow icon,\nbased on `arrowPosition` and `arrowDirection`.",
22743
22793
  "return": {
22744
22794
  "type": {
22745
- "text": "boolean"
22795
+ "text": ""
22746
22796
  }
22747
22797
  },
22748
22798
  "inheritedFrom": {
22749
- "name": "FormInternalsMixin",
22750
- "module": "utils/mixins/FormInternalsMixin.js"
22799
+ "name": "ListItem",
22800
+ "module": "components/listitem/listitem.component.js"
22751
22801
  }
22752
22802
  },
22753
22803
  {
22754
22804
  "kind": "method",
22755
- "name": "reportValidity",
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
+ },
22756
22813
  "inheritedFrom": {
22757
- "name": "FormInternalsMixin",
22758
- "module": "utils/mixins/FormInternalsMixin.js"
22814
+ "name": "ListItem",
22815
+ "module": "components/listitem/listitem.component.js"
22759
22816
  }
22760
22817
  },
22761
22818
  {
@@ -22917,30 +22974,6 @@
22917
22974
  "module": "components/listitem/listitem.component.js"
22918
22975
  }
22919
22976
  },
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
- },
22944
22977
  {
22945
22978
  "kind": "method",
22946
22979
  "name": "triggerClickEvent",
@@ -23060,36 +23093,6 @@
23060
23093
  "module": "components/listitem/listitem.component.js"
23061
23094
  }
23062
23095
  },
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
- },
23073
- "inheritedFrom": {
23074
- "name": "ListItem",
23075
- "module": "components/listitem/listitem.component.js"
23076
- }
23077
- },
23078
- {
23079
- "kind": "method",
23080
- "name": "renderLeadingControls",
23081
- "privacy": "protected",
23082
- "description": "Renders the leading controls slot.",
23083
- "return": {
23084
- "type": {
23085
- "text": ""
23086
- }
23087
- },
23088
- "inheritedFrom": {
23089
- "name": "ListItem",
23090
- "module": "components/listitem/listitem.component.js"
23091
- }
23092
- },
23093
23096
  {
23094
23097
  "kind": "method",
23095
23098
  "name": "stopEventPropagation",
@@ -23117,7 +23120,7 @@
23117
23120
  ],
23118
23121
  "events": [
23119
23122
  {
23120
- "description": "(React: onClick) This event is dispatched when the option is clicked.",
23123
+ "description": "(React: onClick) This event is dispatched when the navmenuitem is clicked.",
23121
23124
  "name": "click",
23122
23125
  "reactName": "onClick",
23123
23126
  "inheritedFrom": {
@@ -23126,7 +23129,7 @@
23126
23129
  }
23127
23130
  },
23128
23131
  {
23129
- "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the option.",
23132
+ "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the navmenuitem.",
23130
23133
  "name": "keydown",
23131
23134
  "reactName": "onKeyDown",
23132
23135
  "inheritedFrom": {
@@ -23135,7 +23138,7 @@
23135
23138
  }
23136
23139
  },
23137
23140
  {
23138
- "description": "(React: onKeyUp) This event is dispatched when a key is released on the option.",
23141
+ "description": "(React: onKeyUp) This event is dispatched when a key is released on the navmenuitem.",
23139
23142
  "name": "keyup",
23140
23143
  "reactName": "onKeyUp",
23141
23144
  "inheritedFrom": {
@@ -23144,7 +23147,7 @@
23144
23147
  }
23145
23148
  },
23146
23149
  {
23147
- "description": "(React: onFocus) This event is dispatched when the option receives focus.",
23150
+ "description": "(React: onFocus) This event is dispatched when the navmenuitem receives focus.",
23148
23151
  "name": "focus",
23149
23152
  "reactName": "onFocus",
23150
23153
  "inheritedFrom": {
@@ -23152,6 +23155,11 @@
23152
23155
  "module": "src/components/listitem/listitem.component.ts"
23153
23156
  }
23154
23157
  },
23158
+ {
23159
+ "description": "(React: onActiveChange) Dispatched when the active state of the navmenuitem changes.",
23160
+ "name": "activechange",
23161
+ "reactName": "onActiveChange"
23162
+ },
23155
23163
  {
23156
23164
  "description": "(React: onEnabled) This event is dispatched after the listitem is enabled",
23157
23165
  "name": "enabled",
@@ -23191,67 +23199,125 @@
23191
23199
  ],
23192
23200
  "attributes": [
23193
23201
  {
23194
- "name": "selected",
23202
+ "name": "active",
23195
23203
  "type": {
23196
- "text": "boolean"
23204
+ "text": "boolean | undefined"
23197
23205
  },
23198
- "default": "false",
23199
- "description": "The selected attribute is used to indicate that the option is selected.",
23200
- "fieldName": "selected"
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",
23228
+ "type": {
23229
+ "text": "number"
23230
+ },
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"
23234
+ },
23235
+ {
23236
+ "name": "nav-id",
23237
+ "type": {
23238
+ "text": "string | undefined"
23239
+ },
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"
23243
+ },
23244
+ {
23245
+ "name": "aria-label",
23246
+ "type": {
23247
+ "text": "string | null"
23248
+ },
23249
+ "default": "null",
23250
+ "description": "Aria-label attribute to be set for accessibility",
23251
+ "fieldName": "ariaLabel"
23252
+ },
23253
+ {
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
+ }
23201
23272
  },
23202
23273
  {
23203
- "name": "prefix-icon",
23274
+ "name": "arrow-position",
23204
23275
  "type": {
23205
- "text": "IconNames | undefined"
23276
+ "text": "ArrowPositions | undefined"
23206
23277
  },
23207
- "description": "The prefix icon attribute is used to display the icon name on the left of the option label.",
23208
- "fieldName": "prefixIcon"
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
+ }
23209
23284
  },
23210
23285
  {
23211
- "name": "aria-label",
23286
+ "name": "arrow-direction",
23212
23287
  "type": {
23213
- "text": "string | null"
23288
+ "text": "ArrowDirections | undefined"
23214
23289
  },
23215
- "default": "null",
23216
- "description": "Any additional description can be provided here for screen readers.",
23217
- "fieldName": "ariaLabel"
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",
23292
+ "inheritedFrom": {
23293
+ "name": "MenuItem",
23294
+ "module": "src/components/menuitem/menuitem.component.ts"
23295
+ }
23218
23296
  },
23219
23297
  {
23220
23298
  "name": "name",
23221
23299
  "type": {
23222
- "text": "string"
23300
+ "text": "undefined | string | undefined"
23223
23301
  },
23224
- "default": "''",
23225
- "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
23302
+ "default": "undefined",
23303
+ "description": "The name attribute is used to identify the menu item when it is selected.",
23226
23304
  "fieldName": "name",
23227
23305
  "inheritedFrom": {
23228
- "name": "FormInternalsMixin",
23229
- "module": "src/utils/mixins/FormInternalsMixin.ts"
23306
+ "name": "MenuItem",
23307
+ "module": "src/components/menuitem/menuitem.component.ts"
23230
23308
  }
23231
23309
  },
23232
23310
  {
23233
23311
  "name": "value",
23234
23312
  "type": {
23235
- "text": "string"
23313
+ "text": "undefined | string | undefined"
23236
23314
  },
23237
- "default": "''",
23238
- "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
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.",
23239
23317
  "fieldName": "value",
23240
23318
  "inheritedFrom": {
23241
- "name": "FormInternalsMixin",
23242
- "module": "src/utils/mixins/FormInternalsMixin.ts"
23243
- }
23244
- },
23245
- {
23246
- "name": "validation-message",
23247
- "type": {
23248
- "text": "string | undefined"
23249
- },
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",
23252
- "inheritedFrom": {
23253
- "name": "FormInternalsMixin",
23254
- "module": "src/utils/mixins/FormInternalsMixin.ts"
23319
+ "name": "MenuItem",
23320
+ "module": "src/components/menuitem/menuitem.component.ts"
23255
23321
  }
23256
23322
  },
23257
23323
  {
@@ -23394,20 +23460,20 @@
23394
23460
  ],
23395
23461
  "mixins": [
23396
23462
  {
23397
- "name": "FormInternalsMixin",
23398
- "module": "/src/utils/mixins/FormInternalsMixin"
23463
+ "name": "IconNameMixin",
23464
+ "module": "/src/utils/mixins/IconNameMixin"
23399
23465
  }
23400
23466
  ],
23401
23467
  "superclass": {
23402
- "name": "ListItem",
23403
- "module": "/src/components/listitem/listitem.component"
23468
+ "name": "MenuItem",
23469
+ "module": "/src/components/menuitem/menuitem.component"
23404
23470
  },
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 */",
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 */",
23407
23473
  "customElement": true,
23408
23474
  "slots": [
23409
23475
  {
23410
- "description": "slot for list item controls to appear of leading end.",
23476
+ "description": "slot for menu item controls to appear of leading end.",
23411
23477
  "name": "leading-controls",
23412
23478
  "inheritedFrom": {
23413
23479
  "name": "ListItem",
@@ -23415,7 +23481,7 @@
23415
23481
  }
23416
23482
  },
23417
23483
  {
23418
- "description": "slot for list item primary label.",
23484
+ "description": "slot for menu item primary label.",
23419
23485
  "name": "leading-text-primary-label",
23420
23486
  "inheritedFrom": {
23421
23487
  "name": "ListItem",
@@ -23423,7 +23489,7 @@
23423
23489
  }
23424
23490
  },
23425
23491
  {
23426
- "description": "slot for list item secondary label.",
23492
+ "description": "slot for menu item secondary label.",
23427
23493
  "name": "leading-text-secondary-label",
23428
23494
  "inheritedFrom": {
23429
23495
  "name": "ListItem",
@@ -23431,7 +23497,7 @@
23431
23497
  }
23432
23498
  },
23433
23499
  {
23434
- "description": "slot for list item tertiary label.",
23500
+ "description": "slot for menu item tertiary label.",
23435
23501
  "name": "leading-text-tertiary-label",
23436
23502
  "inheritedFrom": {
23437
23503
  "name": "ListItem",
@@ -23439,7 +23505,7 @@
23439
23505
  }
23440
23506
  },
23441
23507
  {
23442
- "description": "slot for list item side header text.",
23508
+ "description": "slot for menu item side header text.",
23443
23509
  "name": "trailing-text-side-header",
23444
23510
  "inheritedFrom": {
23445
23511
  "name": "ListItem",
@@ -23447,7 +23513,7 @@
23447
23513
  }
23448
23514
  },
23449
23515
  {
23450
- "description": "slot for list item subline text.",
23516
+ "description": "slot for menu item subline text.",
23451
23517
  "name": "trailing-text-subline",
23452
23518
  "inheritedFrom": {
23453
23519
  "name": "ListItem",
@@ -23455,79 +23521,13 @@
23455
23521
  }
23456
23522
  },
23457
23523
  {
23458
- "description": "slot for list item controls to appear of trailing end.",
23524
+ "description": "slot for menu item controls to appear of trailing end.",
23459
23525
  "name": "trailing-controls",
23460
23526
  "inheritedFrom": {
23461
23527
  "name": "ListItem",
23462
23528
  "module": "src/components/listitem/listitem.component.ts"
23463
23529
  }
23464
23530
  }
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": "Option",
23540
- "module": "components/option/option.component.js"
23539
+ "name": "NavMenuItem",
23540
+ "module": "components/navmenuitem/navmenuitem.component.js"
23541
23541
  }
23542
23542
  }
23543
23543
  ]
@@ -31933,40 +31933,137 @@
31933
31933
  "fieldName": "checked"
31934
31934
  },
31935
31935
  {
31936
- "name": "size",
31936
+ "name": "size",
31937
+ "type": {
31938
+ "text": "ToggleSize"
31939
+ },
31940
+ "description": "Determines toggle size in rem (height is specified here).\n- **Default**: 1.5\n- **Compact**: 1",
31941
+ "default": "default",
31942
+ "fieldName": "size"
31943
+ },
31944
+ {
31945
+ "name": "disabled",
31946
+ "type": {
31947
+ "text": "boolean | undefined"
31948
+ },
31949
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
31950
+ "default": "undefined",
31951
+ "fieldName": "disabled",
31952
+ "inheritedFrom": {
31953
+ "name": "DisabledMixin",
31954
+ "module": "src/utils/mixins/DisabledMixin.ts"
31955
+ }
31956
+ }
31957
+ ],
31958
+ "mixins": [
31959
+ {
31960
+ "name": "DisabledMixin",
31961
+ "module": "/src/utils/mixins/DisabledMixin"
31962
+ }
31963
+ ],
31964
+ "superclass": {
31965
+ "name": "Component",
31966
+ "module": "/src/models"
31967
+ },
31968
+ "tagName": "mdc-statictoggle",
31969
+ "jsDoc": "/**\n * This is a decorative component that is styled to look as a toggle. <br/>\n * It has 3 properties - checked, size and disabled. <br/>\n * We are using the same styling that has been created for the `mdc-toggle` component.\n *\n * @dependency mdc-icon\n *\n * @tagname mdc-statictoggle\n *\n * @slot default - This is a default/unnamed slot\n *\n * @cssproperty --mdc-statictoggle-width - Width of the toggle\n * @cssproperty --mdc-statictoggle-height - Height of the toggle\n * @cssproperty --mdc-statictoggle-width-compact - Width of the toggle when it's size is compact\n * @cssproperty --mdc-statictoggle-height-compact - Height of the toggle when it's size is compact\n * @cssproperty --mdc-statictoggle-border-radius - Border radius of the toggle\n * @cssproperty --mdc-statictoggle-border-radius-compact - Border radius of the toggle when it's size is compact\n * @cssproperty --mdc-statictoggle-border - Border of the toggle\n * @cssproperty --mdc-statictoggle-inactive-rest-color - Background color of the inactive toggle in rest state\n * @cssproperty --mdc-statictoggle-inactive-disabled-color - Background color of the inactive toggle in disabled state\n * @cssproperty --mdc-statictoggle-active-rest-color - Background color of the active toggle in rest state\n * @cssproperty --mdc-statictoggle-active-disabled-color - Background color of the active toggle in disabled state\n * @cssproperty --mdc-statictoggle-icon-color-normal - Color of the icon in normal state\n * @cssproperty --mdc-statictoggle-icon-color-disabled - Color of the icon in disabled state\n * @cssproperty --mdc-statictoggle-icon-background-color-normal - Background color of the icon in normal state\n * @cssproperty --mdc-statictoggle-icon-background-color-disabled - Background color of the icon in disabled state\n */",
31970
+ "customElement": true
31971
+ }
31972
+ ],
31973
+ "exports": [
31974
+ {
31975
+ "kind": "js",
31976
+ "name": "default",
31977
+ "declaration": {
31978
+ "name": "StaticToggle",
31979
+ "module": "components/statictoggle/statictoggle.component.js"
31980
+ }
31981
+ }
31982
+ ]
31983
+ },
31984
+ {
31985
+ "kind": "javascript-module",
31986
+ "path": "components/stepper/stepper.component.js",
31987
+ "declarations": [
31988
+ {
31989
+ "kind": "class",
31990
+ "description": "Stepper component, which orchestrates stepperitem and stepperconnector components, is a wrapper for the stepper functionality.\nIt provides the context for the stepper items and connectors, allowing them to adapt to the stepper's orientation and variant.",
31991
+ "name": "Stepper",
31992
+ "slots": [
31993
+ {
31994
+ "description": "Pass the list of `mdc-stepperitem` and `mdc-stepperconnector` elements to be rendered inside the stepper.",
31995
+ "name": "default"
31996
+ }
31997
+ ],
31998
+ "members": [
31999
+ {
32000
+ "kind": "field",
32001
+ "name": "orientation",
32002
+ "type": {
32003
+ "text": "OrientationType"
32004
+ },
32005
+ "description": "The orientation of the stepperconnector (vertical or horizontal)",
32006
+ "default": "\"horizontal\"",
32007
+ "attribute": "orientation",
32008
+ "reflects": true
32009
+ },
32010
+ {
32011
+ "kind": "field",
32012
+ "name": "variant",
32013
+ "type": {
32014
+ "text": "VariantType"
32015
+ },
32016
+ "description": "The variant of the stepper item, which can be `inline` or `stacked`.",
32017
+ "default": "'inline'",
32018
+ "attribute": "variant",
32019
+ "reflects": true
32020
+ },
32021
+ {
32022
+ "kind": "field",
32023
+ "name": "Context",
32024
+ "privacy": "public",
32025
+ "static": true,
32026
+ "description": "Get the context for the stepper component.\nThis context provides the orientation and variant for the stepper items and connectors.",
32027
+ "readonly": true
32028
+ },
32029
+ {
32030
+ "kind": "method",
32031
+ "name": "updateContext",
32032
+ "privacy": "protected",
32033
+ "return": {
32034
+ "type": {
32035
+ "text": "void"
32036
+ }
32037
+ },
32038
+ "description": "Update all observing components of this\nprovider to update the values\n\nIs called on every re-render, see Provider class"
32039
+ }
32040
+ ],
32041
+ "attributes": [
32042
+ {
32043
+ "name": "orientation",
31937
32044
  "type": {
31938
- "text": "ToggleSize"
32045
+ "text": "OrientationType"
31939
32046
  },
31940
- "description": "Determines toggle size in rem (height is specified here).\n- **Default**: 1.5\n- **Compact**: 1",
31941
- "default": "default",
31942
- "fieldName": "size"
32047
+ "description": "The orientation of the stepperconnector (vertical or horizontal)",
32048
+ "default": "\"horizontal\"",
32049
+ "fieldName": "orientation"
31943
32050
  },
31944
32051
  {
31945
- "name": "disabled",
32052
+ "name": "variant",
31946
32053
  "type": {
31947
- "text": "boolean | undefined"
32054
+ "text": "VariantType"
31948
32055
  },
31949
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
31950
- "default": "undefined",
31951
- "fieldName": "disabled",
31952
- "inheritedFrom": {
31953
- "name": "DisabledMixin",
31954
- "module": "src/utils/mixins/DisabledMixin.ts"
31955
- }
31956
- }
31957
- ],
31958
- "mixins": [
31959
- {
31960
- "name": "DisabledMixin",
31961
- "module": "/src/utils/mixins/DisabledMixin"
32056
+ "description": "The variant of the stepper item, which can be `inline` or `stacked`.",
32057
+ "default": "'inline'",
32058
+ "fieldName": "variant"
31962
32059
  }
31963
32060
  ],
31964
32061
  "superclass": {
31965
- "name": "Component",
32062
+ "name": "Provider",
31966
32063
  "module": "/src/models"
31967
32064
  },
31968
- "tagName": "mdc-statictoggle",
31969
- "jsDoc": "/**\n * This is a decorative component that is styled to look as a toggle. <br/>\n * It has 3 properties - checked, size and disabled. <br/>\n * We are using the same styling that has been created for the `mdc-toggle` component.\n *\n * @dependency mdc-icon\n *\n * @tagname mdc-statictoggle\n *\n * @slot default - This is a default/unnamed slot\n *\n * @cssproperty --mdc-statictoggle-width - Width of the toggle\n * @cssproperty --mdc-statictoggle-height - Height of the toggle\n * @cssproperty --mdc-statictoggle-width-compact - Width of the toggle when it's size is compact\n * @cssproperty --mdc-statictoggle-height-compact - Height of the toggle when it's size is compact\n * @cssproperty --mdc-statictoggle-border-radius - Border radius of the toggle\n * @cssproperty --mdc-statictoggle-border-radius-compact - Border radius of the toggle when it's size is compact\n * @cssproperty --mdc-statictoggle-border - Border of the toggle\n * @cssproperty --mdc-statictoggle-inactive-rest-color - Background color of the inactive toggle in rest state\n * @cssproperty --mdc-statictoggle-inactive-disabled-color - Background color of the inactive toggle in disabled state\n * @cssproperty --mdc-statictoggle-active-rest-color - Background color of the active toggle in rest state\n * @cssproperty --mdc-statictoggle-active-disabled-color - Background color of the active toggle in disabled state\n * @cssproperty --mdc-statictoggle-icon-color-normal - Color of the icon in normal state\n * @cssproperty --mdc-statictoggle-icon-color-disabled - Color of the icon in disabled state\n * @cssproperty --mdc-statictoggle-icon-background-color-normal - Background color of the icon in normal state\n * @cssproperty --mdc-statictoggle-icon-background-color-disabled - Background color of the icon in disabled state\n */",
32065
+ "tagName": "mdc-stepper",
32066
+ "jsDoc": "/**\n * Stepper component, which orchestrates stepperitem and stepperconnector components, is a wrapper for the stepper functionality.\n * It provides the context for the stepper items and connectors, allowing them to adapt to the stepper's orientation and variant.\n *\n * @tagname mdc-stepper\n *\n * @slot default - Pass the list of `mdc-stepperitem` and `mdc-stepperconnector` elements to be rendered inside the stepper.\n *\n */",
31970
32067
  "customElement": true
31971
32068
  }
31972
32069
  ],
@@ -31975,8 +32072,8 @@
31975
32072
  "kind": "js",
31976
32073
  "name": "default",
31977
32074
  "declaration": {
31978
- "name": "StaticToggle",
31979
- "module": "components/statictoggle/statictoggle.component.js"
32075
+ "name": "Stepper",
32076
+ "module": "components/stepper/stepper.component.js"
31980
32077
  }
31981
32078
  }
31982
32079
  ]
@@ -33359,116 +33456,6 @@
33359
33456
  }
33360
33457
  ]
33361
33458
  },
33362
- {
33363
- "kind": "javascript-module",
33364
- "path": "components/themeprovider/themeprovider.component.js",
33365
- "declarations": [
33366
- {
33367
- "kind": "class",
33368
- "description": "ThemeProvider component, which sets the passed in themeclass as class.\nIf the themeclass switches, the existing themeclass will be removed as a class\nand the new themeclass will be added.\n\nCSS variables defined in the themeclass will be used for the styling of child dom nodes.\n\nAvailable Momentum theme classes:\n\n`mds-theme-stable-darkWebex`, `mds-theme-stable-lightWebex`\n\n`mds-theme-stable-darkBronzeWebex`, `mds-theme-stable-lightBronzeWebex`\n\n`mds-theme-stable-darkIndigoWebex`, `mds-theme-stable-lightIndigoWebex`\n\n`mds-theme-stable-darkJadeWebex`, `mds-theme-stable-lightJadeWebex`\n\n`mds-theme-stable-darkLavenderWebex`, `mds-theme-stable-lightLavenderWebex`\n\n`mds-theme-stable-darkRoseWebex`, `mds-theme-stable-lightRoseWebex`\n\nThemeclass context can be be consumed from Lit child components\n(see providerUtils.consume for how to consume)\n\nThemeProvider also includes basic font defaults for text.",
33369
- "name": "ThemeProvider",
33370
- "cssProperties": [
33371
- {
33372
- "description": "Option to override the default color, default: color-theme-text-primary-normal",
33373
- "name": "--mdc-themeprovider-color-default"
33374
- },
33375
- {
33376
- "description": "Option to override the font family, default: `Momentum` (from momentum-design/fonts)",
33377
- "name": "--mdc-themeprovider-font-family"
33378
- },
33379
- {
33380
- "description": "Option to override the font weight, default: `400`",
33381
- "name": "--mdc-themeprovider-font-weight"
33382
- },
33383
- {
33384
- "description": "Option to override the default letter-spacing, default: `-0.25px` (this is to match the old CiscoSans)",
33385
- "name": "--mdc-themeprovider-letter-spacing-adjustment"
33386
- },
33387
- {
33388
- "description": "Option to override the font feature settings, default: `\"ss02\" on`",
33389
- "name": "--mdc-themeprovider-font-feature-settings"
33390
- },
33391
- {
33392
- "description": "Option to override the color of the scrollbar track.",
33393
- "name": "--mdc-themeprovider-scrollbar-track-color"
33394
- },
33395
- {
33396
- "description": "Option to override the color of the scrollbar thumb.",
33397
- "name": "--mdc-themeprovider-scrollbar-thumb-color"
33398
- }
33399
- ],
33400
- "slots": [
33401
- {
33402
- "description": "children",
33403
- "name": ""
33404
- }
33405
- ],
33406
- "members": [
33407
- {
33408
- "kind": "field",
33409
- "name": "Context",
33410
- "privacy": "public",
33411
- "static": true,
33412
- "description": "Context object of the ThemeProvider, to be consumed by child components",
33413
- "readonly": true
33414
- },
33415
- {
33416
- "kind": "field",
33417
- "name": "themeclass",
33418
- "type": {
33419
- "text": "string"
33420
- },
33421
- "description": "Current theme class\n\nHas to be fully qualified, such that\nthe theme class matches the class of the respective\ntheme stylesheet\n\nDefault: 'mds-theme-stable-darkWebex'",
33422
- "attribute": "themeclass"
33423
- },
33424
- {
33425
- "kind": "method",
33426
- "name": "updateContext",
33427
- "privacy": "protected",
33428
- "return": {
33429
- "type": {
33430
- "text": "void"
33431
- }
33432
- },
33433
- "description": "Update all observing components of this\nprovider to update the themeclass\n\nIs called on every re-render, see Provider class"
33434
- },
33435
- {
33436
- "kind": "method",
33437
- "name": "setThemeInClassList",
33438
- "privacy": "private",
33439
- "description": "Function to update the active theme classnames to update the theme tokens\nas CSS variables on the web component."
33440
- }
33441
- ],
33442
- "attributes": [
33443
- {
33444
- "name": "themeclass",
33445
- "type": {
33446
- "text": "string"
33447
- },
33448
- "description": "Current theme class\n\nHas to be fully qualified, such that\nthe theme class matches the class of the respective\ntheme stylesheet\n\nDefault: 'mds-theme-stable-darkWebex'",
33449
- "fieldName": "themeclass"
33450
- }
33451
- ],
33452
- "superclass": {
33453
- "name": "Provider",
33454
- "module": "/src/models"
33455
- },
33456
- "tagName": "mdc-themeprovider",
33457
- "jsDoc": "/**\n * ThemeProvider component, which sets the passed in themeclass as class.\n * If the themeclass switches, the existing themeclass will be removed as a class\n * and the new themeclass will be added.\n *\n * CSS variables defined in the themeclass will be used for the styling of child dom nodes.\n *\n * Available Momentum theme classes:\n *\n * `mds-theme-stable-darkWebex`, `mds-theme-stable-lightWebex`\n *\n * `mds-theme-stable-darkBronzeWebex`, `mds-theme-stable-lightBronzeWebex`\n *\n * `mds-theme-stable-darkIndigoWebex`, `mds-theme-stable-lightIndigoWebex`\n *\n * `mds-theme-stable-darkJadeWebex`, `mds-theme-stable-lightJadeWebex`\n *\n * `mds-theme-stable-darkLavenderWebex`, `mds-theme-stable-lightLavenderWebex`\n *\n * `mds-theme-stable-darkRoseWebex`, `mds-theme-stable-lightRoseWebex`\n *\n * Themeclass context can be be consumed from Lit child components\n * (see providerUtils.consume for how to consume)\n *\n * ThemeProvider also includes basic font defaults for text.\n *\n * @tagname mdc-themeprovider\n *\n * @slot - children\n *\n * @cssproperty --mdc-themeprovider-color-default - Option to override the default color,\n * default: color-theme-text-primary-normal\n * @cssproperty --mdc-themeprovider-font-family - Option to override the font family,\n * default: `Momentum` (from momentum-design/fonts)\n * @cssproperty --mdc-themeprovider-font-weight - Option to override the font weight, default: `400`\n * @cssproperty --mdc-themeprovider-letter-spacing-adjustment - Option to override the default letter-spacing,\n * default: `-0.25px` (this is to match the old CiscoSans)\n * @cssproperty --mdc-themeprovider-font-feature-settings - Option to override the font feature settings,\n * default: `\"ss02\" on`\n * @cssproperty --mdc-themeprovider-scrollbar-track-color - Option to override the color of the scrollbar track.\n * @cssproperty --mdc-themeprovider-scrollbar-thumb-color - Option to override the color of the scrollbar thumb.\n */",
33458
- "customElement": true
33459
- }
33460
- ],
33461
- "exports": [
33462
- {
33463
- "kind": "js",
33464
- "name": "default",
33465
- "declaration": {
33466
- "name": "ThemeProvider",
33467
- "module": "components/themeprovider/themeprovider.component.js"
33468
- }
33469
- }
33470
- ]
33471
- },
33472
33459
  {
33473
33460
  "kind": "javascript-module",
33474
33461
  "path": "components/textarea/textarea.component.js",
@@ -34383,6 +34370,116 @@
34383
34370
  }
34384
34371
  ]
34385
34372
  },
34373
+ {
34374
+ "kind": "javascript-module",
34375
+ "path": "components/themeprovider/themeprovider.component.js",
34376
+ "declarations": [
34377
+ {
34378
+ "kind": "class",
34379
+ "description": "ThemeProvider component, which sets the passed in themeclass as class.\nIf the themeclass switches, the existing themeclass will be removed as a class\nand the new themeclass will be added.\n\nCSS variables defined in the themeclass will be used for the styling of child dom nodes.\n\nAvailable Momentum theme classes:\n\n`mds-theme-stable-darkWebex`, `mds-theme-stable-lightWebex`\n\n`mds-theme-stable-darkBronzeWebex`, `mds-theme-stable-lightBronzeWebex`\n\n`mds-theme-stable-darkIndigoWebex`, `mds-theme-stable-lightIndigoWebex`\n\n`mds-theme-stable-darkJadeWebex`, `mds-theme-stable-lightJadeWebex`\n\n`mds-theme-stable-darkLavenderWebex`, `mds-theme-stable-lightLavenderWebex`\n\n`mds-theme-stable-darkRoseWebex`, `mds-theme-stable-lightRoseWebex`\n\nThemeclass context can be be consumed from Lit child components\n(see providerUtils.consume for how to consume)\n\nThemeProvider also includes basic font defaults for text.",
34380
+ "name": "ThemeProvider",
34381
+ "cssProperties": [
34382
+ {
34383
+ "description": "Option to override the default color, default: color-theme-text-primary-normal",
34384
+ "name": "--mdc-themeprovider-color-default"
34385
+ },
34386
+ {
34387
+ "description": "Option to override the font family, default: `Momentum` (from momentum-design/fonts)",
34388
+ "name": "--mdc-themeprovider-font-family"
34389
+ },
34390
+ {
34391
+ "description": "Option to override the font weight, default: `400`",
34392
+ "name": "--mdc-themeprovider-font-weight"
34393
+ },
34394
+ {
34395
+ "description": "Option to override the default letter-spacing, default: `-0.25px` (this is to match the old CiscoSans)",
34396
+ "name": "--mdc-themeprovider-letter-spacing-adjustment"
34397
+ },
34398
+ {
34399
+ "description": "Option to override the font feature settings, default: `\"ss02\" on`",
34400
+ "name": "--mdc-themeprovider-font-feature-settings"
34401
+ },
34402
+ {
34403
+ "description": "Option to override the color of the scrollbar track.",
34404
+ "name": "--mdc-themeprovider-scrollbar-track-color"
34405
+ },
34406
+ {
34407
+ "description": "Option to override the color of the scrollbar thumb.",
34408
+ "name": "--mdc-themeprovider-scrollbar-thumb-color"
34409
+ }
34410
+ ],
34411
+ "slots": [
34412
+ {
34413
+ "description": "children",
34414
+ "name": ""
34415
+ }
34416
+ ],
34417
+ "members": [
34418
+ {
34419
+ "kind": "field",
34420
+ "name": "Context",
34421
+ "privacy": "public",
34422
+ "static": true,
34423
+ "description": "Context object of the ThemeProvider, to be consumed by child components",
34424
+ "readonly": true
34425
+ },
34426
+ {
34427
+ "kind": "field",
34428
+ "name": "themeclass",
34429
+ "type": {
34430
+ "text": "string"
34431
+ },
34432
+ "description": "Current theme class\n\nHas to be fully qualified, such that\nthe theme class matches the class of the respective\ntheme stylesheet\n\nDefault: 'mds-theme-stable-darkWebex'",
34433
+ "attribute": "themeclass"
34434
+ },
34435
+ {
34436
+ "kind": "method",
34437
+ "name": "updateContext",
34438
+ "privacy": "protected",
34439
+ "return": {
34440
+ "type": {
34441
+ "text": "void"
34442
+ }
34443
+ },
34444
+ "description": "Update all observing components of this\nprovider to update the themeclass\n\nIs called on every re-render, see Provider class"
34445
+ },
34446
+ {
34447
+ "kind": "method",
34448
+ "name": "setThemeInClassList",
34449
+ "privacy": "private",
34450
+ "description": "Function to update the active theme classnames to update the theme tokens\nas CSS variables on the web component."
34451
+ }
34452
+ ],
34453
+ "attributes": [
34454
+ {
34455
+ "name": "themeclass",
34456
+ "type": {
34457
+ "text": "string"
34458
+ },
34459
+ "description": "Current theme class\n\nHas to be fully qualified, such that\nthe theme class matches the class of the respective\ntheme stylesheet\n\nDefault: 'mds-theme-stable-darkWebex'",
34460
+ "fieldName": "themeclass"
34461
+ }
34462
+ ],
34463
+ "superclass": {
34464
+ "name": "Provider",
34465
+ "module": "/src/models"
34466
+ },
34467
+ "tagName": "mdc-themeprovider",
34468
+ "jsDoc": "/**\n * ThemeProvider component, which sets the passed in themeclass as class.\n * If the themeclass switches, the existing themeclass will be removed as a class\n * and the new themeclass will be added.\n *\n * CSS variables defined in the themeclass will be used for the styling of child dom nodes.\n *\n * Available Momentum theme classes:\n *\n * `mds-theme-stable-darkWebex`, `mds-theme-stable-lightWebex`\n *\n * `mds-theme-stable-darkBronzeWebex`, `mds-theme-stable-lightBronzeWebex`\n *\n * `mds-theme-stable-darkIndigoWebex`, `mds-theme-stable-lightIndigoWebex`\n *\n * `mds-theme-stable-darkJadeWebex`, `mds-theme-stable-lightJadeWebex`\n *\n * `mds-theme-stable-darkLavenderWebex`, `mds-theme-stable-lightLavenderWebex`\n *\n * `mds-theme-stable-darkRoseWebex`, `mds-theme-stable-lightRoseWebex`\n *\n * Themeclass context can be be consumed from Lit child components\n * (see providerUtils.consume for how to consume)\n *\n * ThemeProvider also includes basic font defaults for text.\n *\n * @tagname mdc-themeprovider\n *\n * @slot - children\n *\n * @cssproperty --mdc-themeprovider-color-default - Option to override the default color,\n * default: color-theme-text-primary-normal\n * @cssproperty --mdc-themeprovider-font-family - Option to override the font family,\n * default: `Momentum` (from momentum-design/fonts)\n * @cssproperty --mdc-themeprovider-font-weight - Option to override the font weight, default: `400`\n * @cssproperty --mdc-themeprovider-letter-spacing-adjustment - Option to override the default letter-spacing,\n * default: `-0.25px` (this is to match the old CiscoSans)\n * @cssproperty --mdc-themeprovider-font-feature-settings - Option to override the font feature settings,\n * default: `\"ss02\" on`\n * @cssproperty --mdc-themeprovider-scrollbar-track-color - Option to override the color of the scrollbar track.\n * @cssproperty --mdc-themeprovider-scrollbar-thumb-color - Option to override the color of the scrollbar thumb.\n */",
34469
+ "customElement": true
34470
+ }
34471
+ ],
34472
+ "exports": [
34473
+ {
34474
+ "kind": "js",
34475
+ "name": "default",
34476
+ "declaration": {
34477
+ "name": "ThemeProvider",
34478
+ "module": "components/themeprovider/themeprovider.component.js"
34479
+ }
34480
+ }
34481
+ ]
34482
+ },
34386
34483
  {
34387
34484
  "kind": "javascript-module",
34388
34485
  "path": "components/toggle/toggle.component.js",