@momentum-design/components 0.86.0 → 0.87.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -6677,7 +6677,7 @@
6677
6677
  "type": {
6678
6678
  "text": "string | undefined"
6679
6679
  },
6680
- "description": "Custom validation message that will override the default message and displayed when the input is invalid.",
6680
+ "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.",
6681
6681
  "attribute": "validation-message",
6682
6682
  "reflects": true,
6683
6683
  "inheritedFrom": {
@@ -7037,7 +7037,7 @@
7037
7037
  "type": {
7038
7038
  "text": "string | undefined"
7039
7039
  },
7040
- "description": "Custom validation message that will override the default message and displayed when the input is invalid.",
7040
+ "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.",
7041
7041
  "fieldName": "validationMessage",
7042
7042
  "inheritedFrom": {
7043
7043
  "name": "FormInternalsMixin",
@@ -9479,6 +9479,252 @@
9479
9479
  }
9480
9480
  ]
9481
9481
  },
9482
+ {
9483
+ "kind": "javascript-module",
9484
+ "path": "components/divider/divider.component.js",
9485
+ "declarations": [
9486
+ {
9487
+ "kind": "class",
9488
+ "description": "`mdc-divider` is a component that provides a line to separate and organize content.\nIt can also include a button or text positioned centrally, allowing users to interact with the layout.\n\n**Divider Orientation:**\n- **Horizontal**: A thin, horizontal line.\n- **Vertical**: A thin, vertical line.\n\n**Divider Variants:**\n- **solid**: Solid line.\n- **gradient**: Gradient Line.\n\n**Divider Types:**\n- The type of divider is inferred based on the kind of slot present.\n - **Primary**: A simple horizontal or vertical divider.\n - **Text**: A horizontal divider with a text label in the center.\n - **Grabber Button**: A horizontal or vertical divider with a styled button in the center.\n\n**Accessibility:**\n- When the slot is replaced by an `mdc-button`:\n - `aria-label` should be passed to the `mdc-button`.\n - `aria-expanded` should be passed to the `mdc-button`.\n\n**Notes:**\n- If the slot is replaced by an invalid tag name or contains multiple elements,\n the divider defaults to the **Primary** type.\n- To override the styles of the divider, use the provided CSS custom properties.",
9489
+ "name": "Divider",
9490
+ "cssProperties": [
9491
+ {
9492
+ "description": "background color of the divider",
9493
+ "name": "--mdc-divider-background-color"
9494
+ },
9495
+ {
9496
+ "description": "width of the divider",
9497
+ "name": "--mdc-divider-width"
9498
+ },
9499
+ {
9500
+ "description": "gradient of the horizontal divider",
9501
+ "name": "--mdc-divider-horizontal-gradient"
9502
+ },
9503
+ {
9504
+ "description": "gradient of the vertical divider",
9505
+ "name": "--mdc-divider-vertical-gradient"
9506
+ },
9507
+ {
9508
+ "description": "font size of label in the text divider",
9509
+ "name": "--mdc-divider-text-size"
9510
+ },
9511
+ {
9512
+ "description": "font color of label in the text divider",
9513
+ "name": "--mdc-divider-text-color"
9514
+ },
9515
+ {
9516
+ "description": "left and right margin of label in the text divider",
9517
+ "name": "--mdc-divider-text-margin"
9518
+ },
9519
+ {
9520
+ "description": "line height of label in the text divider",
9521
+ "name": "--mdc-divider-text-line-height"
9522
+ },
9523
+ {
9524
+ "description": "background color of the grabber button in rest state",
9525
+ "name": "--mdc-divider-grabber-button-background-color-normal"
9526
+ },
9527
+ {
9528
+ "description": "background color of the grabber button in hover state",
9529
+ "name": "--mdc-divider-grabber-button-background-color-hover"
9530
+ },
9531
+ {
9532
+ "description": "background color of the grabber button in pressed state",
9533
+ "name": "--mdc-divider-grabber-button-background-color-pressed"
9534
+ },
9535
+ {
9536
+ "description": "border color of the grabber button",
9537
+ "name": "--mdc-divider-grabber-button-border-color"
9538
+ },
9539
+ {
9540
+ "description": "border radius of the grabber button",
9541
+ "name": "--mdc-divider-grabber-button-border-radius"
9542
+ }
9543
+ ],
9544
+ "members": [
9545
+ {
9546
+ "kind": "field",
9547
+ "name": "orientation",
9548
+ "type": {
9549
+ "text": "DividerOrientation"
9550
+ },
9551
+ "description": "Two orientations of divider\n- **horizontal**: A thin, horizontal line with 0.0625rem width.\n- **vertical**: A thin, vertical line with 0.0625rem width.\n\nNote: We do not support \"Vertical Text Divider\" as of now.",
9552
+ "default": "horizontal",
9553
+ "attribute": "orientation",
9554
+ "reflects": true
9555
+ },
9556
+ {
9557
+ "kind": "field",
9558
+ "name": "variant",
9559
+ "type": {
9560
+ "text": "DividerVariant"
9561
+ },
9562
+ "description": "Two variants of divider\n- **solid**: Solid line.\n- **gradient**: Gradient Line that fades on either sides of the divider.",
9563
+ "default": "solid",
9564
+ "attribute": "variant",
9565
+ "reflects": true
9566
+ },
9567
+ {
9568
+ "kind": "field",
9569
+ "name": "arrowDirection",
9570
+ "type": {
9571
+ "text": "Directions"
9572
+ },
9573
+ "description": "Direction of the arrow icon, if applicable.\n- **positive**\n- **negative**\n\nNote: Positive and Negative directions are defined based on Cartesian plane.",
9574
+ "default": "'negative'",
9575
+ "attribute": "arrow-direction",
9576
+ "reflects": true
9577
+ },
9578
+ {
9579
+ "kind": "field",
9580
+ "name": "buttonPosition",
9581
+ "type": {
9582
+ "text": "Directions"
9583
+ },
9584
+ "description": "Position of the button, if applicable.\n- **positive**\n- **negative**\n\nNote: Positive and Negative directions are defined based on Cartesian plane.",
9585
+ "default": "'negative'",
9586
+ "attribute": "button-position",
9587
+ "reflects": true
9588
+ },
9589
+ {
9590
+ "kind": "method",
9591
+ "name": "setVariant",
9592
+ "privacy": "private",
9593
+ "parameters": [
9594
+ {
9595
+ "name": "variant",
9596
+ "type": {
9597
+ "text": "DividerVariant"
9598
+ },
9599
+ "description": "The variant to set."
9600
+ }
9601
+ ],
9602
+ "description": "Sets the variant attribute for the divider component.\nIf the provided variant is not included in the DIVIDER_VARIANT,\nit defaults to the value specified in DEFAULTS.VARIANT."
9603
+ },
9604
+ {
9605
+ "kind": "method",
9606
+ "name": "setOrientation",
9607
+ "privacy": "private",
9608
+ "parameters": [
9609
+ {
9610
+ "name": "orientation",
9611
+ "type": {
9612
+ "text": "DividerOrientation"
9613
+ },
9614
+ "description": "The orientation to set."
9615
+ }
9616
+ ],
9617
+ "description": "Sets the orientation attribute for the divider component.\nIf the provided orientation is not included in the DIVIDER_ORIENTATION,\nit defaults to the value specified in DEFAULTS.ORIENTATION."
9618
+ },
9619
+ {
9620
+ "kind": "method",
9621
+ "name": "ensureValidDirections",
9622
+ "privacy": "private",
9623
+ "description": "Sets the buttonPosition and arrowDirection attribute for the divider component.\nIf the provided buttonPosition and arrowDirection are not included in the DIRECTIONS,\nit defaults to the value specified in DIRECTIONS based on the ORIENTATION.",
9624
+ "parameters": [
9625
+ {
9626
+ "description": "The buttonPosition to set.",
9627
+ "name": "buttonPosition"
9628
+ },
9629
+ {
9630
+ "description": "The arrowDirection to set.",
9631
+ "name": "arrowDirection"
9632
+ }
9633
+ ]
9634
+ },
9635
+ {
9636
+ "kind": "method",
9637
+ "name": "setGrabberButton",
9638
+ "privacy": "private",
9639
+ "return": {
9640
+ "type": {
9641
+ "text": "void"
9642
+ }
9643
+ },
9644
+ "description": "Configures the grabber button within the divider.\n\n- Sets the `prefix-icon` attribute for the grabber button based\non the `arrow-direction` and `orientation` properties.\n\nThis method updates the DOM element dynamically if a grabber button is present."
9645
+ },
9646
+ {
9647
+ "kind": "method",
9648
+ "name": "getArrowIcon",
9649
+ "privacy": "private",
9650
+ "return": {
9651
+ "type": {
9652
+ "text": ""
9653
+ }
9654
+ },
9655
+ "description": "Determines the arrow icon based on the consumer-defined `arrowDirection`."
9656
+ },
9657
+ {
9658
+ "kind": "method",
9659
+ "name": "inferDividerType",
9660
+ "privacy": "private",
9661
+ "description": "Infers the type of divider based on the kind of slot present.",
9662
+ "parameters": [
9663
+ {
9664
+ "description": "default slot of divider",
9665
+ "name": "slot"
9666
+ }
9667
+ ]
9668
+ }
9669
+ ],
9670
+ "attributes": [
9671
+ {
9672
+ "name": "orientation",
9673
+ "type": {
9674
+ "text": "DividerOrientation"
9675
+ },
9676
+ "description": "Two orientations of divider\n- **horizontal**: A thin, horizontal line with 0.0625rem width.\n- **vertical**: A thin, vertical line with 0.0625rem width.\n\nNote: We do not support \"Vertical Text Divider\" as of now.",
9677
+ "default": "horizontal",
9678
+ "fieldName": "orientation"
9679
+ },
9680
+ {
9681
+ "name": "variant",
9682
+ "type": {
9683
+ "text": "DividerVariant"
9684
+ },
9685
+ "description": "Two variants of divider\n- **solid**: Solid line.\n- **gradient**: Gradient Line that fades on either sides of the divider.",
9686
+ "default": "solid",
9687
+ "fieldName": "variant"
9688
+ },
9689
+ {
9690
+ "name": "arrow-direction",
9691
+ "type": {
9692
+ "text": "Directions"
9693
+ },
9694
+ "description": "Direction of the arrow icon, if applicable.\n- **positive**\n- **negative**\n\nNote: Positive and Negative directions are defined based on Cartesian plane.",
9695
+ "default": "'negative'",
9696
+ "fieldName": "arrowDirection"
9697
+ },
9698
+ {
9699
+ "name": "button-position",
9700
+ "type": {
9701
+ "text": "Directions"
9702
+ },
9703
+ "description": "Position of the button, if applicable.\n- **positive**\n- **negative**\n\nNote: Positive and Negative directions are defined based on Cartesian plane.",
9704
+ "default": "'negative'",
9705
+ "fieldName": "buttonPosition"
9706
+ }
9707
+ ],
9708
+ "superclass": {
9709
+ "name": "Component",
9710
+ "module": "/src/models"
9711
+ },
9712
+ "tagName": "mdc-divider",
9713
+ "jsDoc": "/**\n * `mdc-divider` is a component that provides a line to separate and organize content.\n * It can also include a button or text positioned centrally, allowing users to interact with the layout.\n *\n * **Divider Orientation:**\n * - **Horizontal**: A thin, horizontal line.\n * - **Vertical**: A thin, vertical line.\n *\n * **Divider Variants:**\n * - **solid**: Solid line.\n * - **gradient**: Gradient Line.\n *\n * **Divider Types:**\n * - The type of divider is inferred based on the kind of slot present.\n * - **Primary**: A simple horizontal or vertical divider.\n * - **Text**: A horizontal divider with a text label in the center.\n * - **Grabber Button**: A horizontal or vertical divider with a styled button in the center.\n *\n * **Accessibility:**\n * - When the slot is replaced by an `mdc-button`:\n * - `aria-label` should be passed to the `mdc-button`.\n * - `aria-expanded` should be passed to the `mdc-button`.\n *\n * **Notes:**\n * - If the slot is replaced by an invalid tag name or contains multiple elements,\n * the divider defaults to the **Primary** type.\n * - To override the styles of the divider, use the provided CSS custom properties.\n *\n * @tagname mdc-divider\n *\n * @cssproperty --mdc-divider-background-color - background color of the divider\n * @cssproperty --mdc-divider-width - width of the divider\n * @cssproperty --mdc-divider-horizontal-gradient - gradient of the horizontal divider\n * @cssproperty --mdc-divider-vertical-gradient - gradient of the vertical divider\n * @cssproperty --mdc-divider-text-size - font size of label in the text divider\n * @cssproperty --mdc-divider-text-color - font color of label in the text divider\n * @cssproperty --mdc-divider-text-margin - left and right margin of label in the text divider\n * @cssproperty --mdc-divider-text-line-height - line height of label in the text divider\n * @cssproperty --mdc-divider-grabber-button-background-color-normal - background color of the grabber button\n * in rest state\n * @cssproperty --mdc-divider-grabber-button-background-color-hover - background color of the grabber button\n * in hover state\n * @cssproperty --mdc-divider-grabber-button-background-color-pressed - background color of the grabber button\n * in pressed state\n * @cssproperty --mdc-divider-grabber-button-border-color - border color of the grabber button\n * @cssproperty --mdc-divider-grabber-button-border-radius - border radius of the grabber button\n */",
9714
+ "customElement": true
9715
+ }
9716
+ ],
9717
+ "exports": [
9718
+ {
9719
+ "kind": "js",
9720
+ "name": "default",
9721
+ "declaration": {
9722
+ "name": "Divider",
9723
+ "module": "components/divider/divider.component.js"
9724
+ }
9725
+ }
9726
+ ]
9727
+ },
9482
9728
  {
9483
9729
  "kind": "javascript-module",
9484
9730
  "path": "components/dialog/dialog.component.js",
@@ -10545,259 +10791,13 @@
10545
10791
  },
10546
10792
  {
10547
10793
  "kind": "javascript-module",
10548
- "path": "components/divider/divider.component.js",
10794
+ "path": "components/filterchip/filterchip.component.js",
10549
10795
  "declarations": [
10550
10796
  {
10551
10797
  "kind": "class",
10552
- "description": "`mdc-divider` is a component that provides a line to separate and organize content.\nIt can also include a button or text positioned centrally, allowing users to interact with the layout.\n\n**Divider Orientation:**\n- **Horizontal**: A thin, horizontal line.\n- **Vertical**: A thin, vertical line.\n\n**Divider Variants:**\n- **solid**: Solid line.\n- **gradient**: Gradient Line.\n\n**Divider Types:**\n- The type of divider is inferred based on the kind of slot present.\n - **Primary**: A simple horizontal or vertical divider.\n - **Text**: A horizontal divider with a text label in the center.\n - **Grabber Button**: A horizontal or vertical divider with a styled button in the center.\n\n**Accessibility:**\n- When the slot is replaced by an `mdc-button`:\n - `aria-label` should be passed to the `mdc-button`.\n - `aria-expanded` should be passed to the `mdc-button`.\n\n**Notes:**\n- If the slot is replaced by an invalid tag name or contains multiple elements,\n the divider defaults to the **Primary** type.\n- To override the styles of the divider, use the provided CSS custom properties.",
10553
- "name": "Divider",
10554
- "cssProperties": [
10555
- {
10556
- "description": "background color of the divider",
10557
- "name": "--mdc-divider-background-color"
10558
- },
10559
- {
10560
- "description": "width of the divider",
10561
- "name": "--mdc-divider-width"
10562
- },
10563
- {
10564
- "description": "gradient of the horizontal divider",
10565
- "name": "--mdc-divider-horizontal-gradient"
10566
- },
10567
- {
10568
- "description": "gradient of the vertical divider",
10569
- "name": "--mdc-divider-vertical-gradient"
10570
- },
10571
- {
10572
- "description": "font size of label in the text divider",
10573
- "name": "--mdc-divider-text-size"
10574
- },
10575
- {
10576
- "description": "font color of label in the text divider",
10577
- "name": "--mdc-divider-text-color"
10578
- },
10579
- {
10580
- "description": "left and right margin of label in the text divider",
10581
- "name": "--mdc-divider-text-margin"
10582
- },
10583
- {
10584
- "description": "line height of label in the text divider",
10585
- "name": "--mdc-divider-text-line-height"
10586
- },
10587
- {
10588
- "description": "background color of the grabber button in rest state",
10589
- "name": "--mdc-divider-grabber-button-background-color-normal"
10590
- },
10591
- {
10592
- "description": "background color of the grabber button in hover state",
10593
- "name": "--mdc-divider-grabber-button-background-color-hover"
10594
- },
10595
- {
10596
- "description": "background color of the grabber button in pressed state",
10597
- "name": "--mdc-divider-grabber-button-background-color-pressed"
10598
- },
10599
- {
10600
- "description": "border color of the grabber button",
10601
- "name": "--mdc-divider-grabber-button-border-color"
10602
- },
10603
- {
10604
- "description": "border radius of the grabber button",
10605
- "name": "--mdc-divider-grabber-button-border-radius"
10606
- }
10607
- ],
10608
- "members": [
10609
- {
10610
- "kind": "field",
10611
- "name": "orientation",
10612
- "type": {
10613
- "text": "DividerOrientation"
10614
- },
10615
- "description": "Two orientations of divider\n- **horizontal**: A thin, horizontal line with 0.0625rem width.\n- **vertical**: A thin, vertical line with 0.0625rem width.\n\nNote: We do not support \"Vertical Text Divider\" as of now.",
10616
- "default": "horizontal",
10617
- "attribute": "orientation",
10618
- "reflects": true
10619
- },
10620
- {
10621
- "kind": "field",
10622
- "name": "variant",
10623
- "type": {
10624
- "text": "DividerVariant"
10625
- },
10626
- "description": "Two variants of divider\n- **solid**: Solid line.\n- **gradient**: Gradient Line that fades on either sides of the divider.",
10627
- "default": "solid",
10628
- "attribute": "variant",
10629
- "reflects": true
10630
- },
10631
- {
10632
- "kind": "field",
10633
- "name": "arrowDirection",
10634
- "type": {
10635
- "text": "Directions"
10636
- },
10637
- "description": "Direction of the arrow icon, if applicable.\n- **positive**\n- **negative**\n\nNote: Positive and Negative directions are defined based on Cartesian plane.",
10638
- "default": "'negative'",
10639
- "attribute": "arrow-direction",
10640
- "reflects": true
10641
- },
10642
- {
10643
- "kind": "field",
10644
- "name": "buttonPosition",
10645
- "type": {
10646
- "text": "Directions"
10647
- },
10648
- "description": "Position of the button, if applicable.\n- **positive**\n- **negative**\n\nNote: Positive and Negative directions are defined based on Cartesian plane.",
10649
- "default": "'negative'",
10650
- "attribute": "button-position",
10651
- "reflects": true
10652
- },
10653
- {
10654
- "kind": "method",
10655
- "name": "setVariant",
10656
- "privacy": "private",
10657
- "parameters": [
10658
- {
10659
- "name": "variant",
10660
- "type": {
10661
- "text": "DividerVariant"
10662
- },
10663
- "description": "The variant to set."
10664
- }
10665
- ],
10666
- "description": "Sets the variant attribute for the divider component.\nIf the provided variant is not included in the DIVIDER_VARIANT,\nit defaults to the value specified in DEFAULTS.VARIANT."
10667
- },
10668
- {
10669
- "kind": "method",
10670
- "name": "setOrientation",
10671
- "privacy": "private",
10672
- "parameters": [
10673
- {
10674
- "name": "orientation",
10675
- "type": {
10676
- "text": "DividerOrientation"
10677
- },
10678
- "description": "The orientation to set."
10679
- }
10680
- ],
10681
- "description": "Sets the orientation attribute for the divider component.\nIf the provided orientation is not included in the DIVIDER_ORIENTATION,\nit defaults to the value specified in DEFAULTS.ORIENTATION."
10682
- },
10683
- {
10684
- "kind": "method",
10685
- "name": "ensureValidDirections",
10686
- "privacy": "private",
10687
- "description": "Sets the buttonPosition and arrowDirection attribute for the divider component.\nIf the provided buttonPosition and arrowDirection are not included in the DIRECTIONS,\nit defaults to the value specified in DIRECTIONS based on the ORIENTATION.",
10688
- "parameters": [
10689
- {
10690
- "description": "The buttonPosition to set.",
10691
- "name": "buttonPosition"
10692
- },
10693
- {
10694
- "description": "The arrowDirection to set.",
10695
- "name": "arrowDirection"
10696
- }
10697
- ]
10698
- },
10699
- {
10700
- "kind": "method",
10701
- "name": "setGrabberButton",
10702
- "privacy": "private",
10703
- "return": {
10704
- "type": {
10705
- "text": "void"
10706
- }
10707
- },
10708
- "description": "Configures the grabber button within the divider.\n\n- Sets the `prefix-icon` attribute for the grabber button based\non the `arrow-direction` and `orientation` properties.\n\nThis method updates the DOM element dynamically if a grabber button is present."
10709
- },
10710
- {
10711
- "kind": "method",
10712
- "name": "getArrowIcon",
10713
- "privacy": "private",
10714
- "return": {
10715
- "type": {
10716
- "text": ""
10717
- }
10718
- },
10719
- "description": "Determines the arrow icon based on the consumer-defined `arrowDirection`."
10720
- },
10721
- {
10722
- "kind": "method",
10723
- "name": "inferDividerType",
10724
- "privacy": "private",
10725
- "description": "Infers the type of divider based on the kind of slot present.",
10726
- "parameters": [
10727
- {
10728
- "description": "default slot of divider",
10729
- "name": "slot"
10730
- }
10731
- ]
10732
- }
10733
- ],
10734
- "attributes": [
10735
- {
10736
- "name": "orientation",
10737
- "type": {
10738
- "text": "DividerOrientation"
10739
- },
10740
- "description": "Two orientations of divider\n- **horizontal**: A thin, horizontal line with 0.0625rem width.\n- **vertical**: A thin, vertical line with 0.0625rem width.\n\nNote: We do not support \"Vertical Text Divider\" as of now.",
10741
- "default": "horizontal",
10742
- "fieldName": "orientation"
10743
- },
10744
- {
10745
- "name": "variant",
10746
- "type": {
10747
- "text": "DividerVariant"
10748
- },
10749
- "description": "Two variants of divider\n- **solid**: Solid line.\n- **gradient**: Gradient Line that fades on either sides of the divider.",
10750
- "default": "solid",
10751
- "fieldName": "variant"
10752
- },
10753
- {
10754
- "name": "arrow-direction",
10755
- "type": {
10756
- "text": "Directions"
10757
- },
10758
- "description": "Direction of the arrow icon, if applicable.\n- **positive**\n- **negative**\n\nNote: Positive and Negative directions are defined based on Cartesian plane.",
10759
- "default": "'negative'",
10760
- "fieldName": "arrowDirection"
10761
- },
10762
- {
10763
- "name": "button-position",
10764
- "type": {
10765
- "text": "Directions"
10766
- },
10767
- "description": "Position of the button, if applicable.\n- **positive**\n- **negative**\n\nNote: Positive and Negative directions are defined based on Cartesian plane.",
10768
- "default": "'negative'",
10769
- "fieldName": "buttonPosition"
10770
- }
10771
- ],
10772
- "superclass": {
10773
- "name": "Component",
10774
- "module": "/src/models"
10775
- },
10776
- "tagName": "mdc-divider",
10777
- "jsDoc": "/**\n * `mdc-divider` is a component that provides a line to separate and organize content.\n * It can also include a button or text positioned centrally, allowing users to interact with the layout.\n *\n * **Divider Orientation:**\n * - **Horizontal**: A thin, horizontal line.\n * - **Vertical**: A thin, vertical line.\n *\n * **Divider Variants:**\n * - **solid**: Solid line.\n * - **gradient**: Gradient Line.\n *\n * **Divider Types:**\n * - The type of divider is inferred based on the kind of slot present.\n * - **Primary**: A simple horizontal or vertical divider.\n * - **Text**: A horizontal divider with a text label in the center.\n * - **Grabber Button**: A horizontal or vertical divider with a styled button in the center.\n *\n * **Accessibility:**\n * - When the slot is replaced by an `mdc-button`:\n * - `aria-label` should be passed to the `mdc-button`.\n * - `aria-expanded` should be passed to the `mdc-button`.\n *\n * **Notes:**\n * - If the slot is replaced by an invalid tag name or contains multiple elements,\n * the divider defaults to the **Primary** type.\n * - To override the styles of the divider, use the provided CSS custom properties.\n *\n * @tagname mdc-divider\n *\n * @cssproperty --mdc-divider-background-color - background color of the divider\n * @cssproperty --mdc-divider-width - width of the divider\n * @cssproperty --mdc-divider-horizontal-gradient - gradient of the horizontal divider\n * @cssproperty --mdc-divider-vertical-gradient - gradient of the vertical divider\n * @cssproperty --mdc-divider-text-size - font size of label in the text divider\n * @cssproperty --mdc-divider-text-color - font color of label in the text divider\n * @cssproperty --mdc-divider-text-margin - left and right margin of label in the text divider\n * @cssproperty --mdc-divider-text-line-height - line height of label in the text divider\n * @cssproperty --mdc-divider-grabber-button-background-color-normal - background color of the grabber button\n * in rest state\n * @cssproperty --mdc-divider-grabber-button-background-color-hover - background color of the grabber button\n * in hover state\n * @cssproperty --mdc-divider-grabber-button-background-color-pressed - background color of the grabber button\n * in pressed state\n * @cssproperty --mdc-divider-grabber-button-border-color - border color of the grabber button\n * @cssproperty --mdc-divider-grabber-button-border-radius - border radius of the grabber button\n */",
10778
- "customElement": true
10779
- }
10780
- ],
10781
- "exports": [
10782
- {
10783
- "kind": "js",
10784
- "name": "default",
10785
- "declaration": {
10786
- "name": "Divider",
10787
- "module": "components/divider/divider.component.js"
10788
- }
10789
- }
10790
- ]
10791
- },
10792
- {
10793
- "kind": "javascript-module",
10794
- "path": "components/filterchip/filterchip.component.js",
10795
- "declarations": [
10796
- {
10797
- "kind": "class",
10798
- "description": "mdc-filterchip component is an interactive chip that consumers can use to select or deselect.\nThey can be found with lists or tables as quick filters.\n\nThis component is built on top of the mdc-chip component.",
10799
- "name": "FilterChip",
10800
- "members": [
10798
+ "description": "mdc-filterchip component is an interactive chip that consumers can use to select or deselect.\nThey can be found with lists or tables as quick filters.\n\nThis component is built on top of the mdc-chip component.",
10799
+ "name": "FilterChip",
10800
+ "members": [
10801
10801
  {
10802
10802
  "kind": "field",
10803
10803
  "name": "selected",
@@ -12732,16 +12732,6 @@
12732
12732
  "description": "Aria label for the trailing button. If trailing button is set to true, this label is used for the clear button.",
12733
12733
  "attribute": "clear-aria-label"
12734
12734
  },
12735
- {
12736
- "kind": "method",
12737
- "name": "handleValueChange",
12738
- "description": "Handles the value change of the input field.\nSets the form value and updates the validity of the input field.",
12739
- "return": {
12740
- "type": {
12741
- "text": ""
12742
- }
12743
- }
12744
- },
12745
12735
  {
12746
12736
  "kind": "method",
12747
12737
  "name": "setInputValidity",
@@ -12892,7 +12882,7 @@
12892
12882
  "type": {
12893
12883
  "text": "string | undefined"
12894
12884
  },
12895
- "description": "Custom validation message that will override the default message and displayed when the input is invalid.",
12885
+ "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.",
12896
12886
  "attribute": "validation-message",
12897
12887
  "reflects": true,
12898
12888
  "inheritedFrom": {
@@ -13363,7 +13353,7 @@
13363
13353
  "type": {
13364
13354
  "text": "string | undefined"
13365
13355
  },
13366
- "description": "Custom validation message that will override the default message and displayed when the input is invalid.",
13356
+ "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.",
13367
13357
  "fieldName": "validationMessage",
13368
13358
  "inheritedFrom": {
13369
13359
  "name": "FormInternalsMixin",
@@ -15527,15 +15517,15 @@
15527
15517
  },
15528
15518
  {
15529
15519
  "kind": "javascript-module",
15530
- "path": "components/menuitemcheckbox/menuitemcheckbox.component.js",
15520
+ "path": "components/menuitem/menuitem.component.js",
15531
15521
  "declarations": [
15532
15522
  {
15533
15523
  "kind": "class",
15534
- "description": "A menuitemcheckbox component is a checkable menuitem.\nThere should be no focusable descendants inside this menuitemcheckbox component.\n\nThe `checked` attribute indicates whether the menuitemcheckbox is checked or not.\n\nMenu item checkbox has `name` and `value` attribute that can be used to identify the menu item when it is selected.\n\nThe `indicator` attribute is used to differentiate between <b>checkbox</b>, <b>checkmark</b>, <b>toggle</b> and <b>none</b>.\nBy default, the `indicator` is set to <b>checkbox</b>.<br/>\n\nThe checkbox will always be positioned on the leading side of the menuitem label and\nthe toggle and checkmark will always be positioned on the trailing side.\n\nThe checkbox will have the possible states of `true` or `false`.\nIf the indicator is set to <b>checkmark</b> and if the `checked` attribute is set to `true`,\nthen the checkmark will be displayed. if not, then no indicator will be displayed.\n\nThe forth options for the `indicator` is <b>none</b>, which will not display any indicator at all.\nIt is intended to be used for customised menu items where the indicator is implemented differently.\nFor example, you can use a custom icon or a different visual element to indicate the state of the menu item.\nMake sure the new indicator is accessible.\n\nIf you want only one item in a group to be checked, consider using menuitemradio component.",
15535
- "name": "MenuItemCheckbox",
15524
+ "description": "menuitem component is inherited by listitem component with the role set `menuitem`.<br/>\nA menu item can contain an icon on the leading or trailing side.\n\nThe leading and trailing slots can be used to display controls and text.<br/>\nBased on the leading/trailing slot, the position of the controls and text can be adjusted.\n\nPlease use element with role=menu as a parent element even when there is only menuitem for a11y purpose.\nFor example mdc-menupopover or mdc-menubar.\n\nMenu item has `name` and `value` attribute that can be used to identify the menu item when it is selected.",
15525
+ "name": "MenuItem",
15536
15526
  "slots": [
15537
15527
  {
15538
- "description": "slot for menu item checkbox controls to appear of leading end.",
15528
+ "description": "slot for menu item controls to appear of leading end.",
15539
15529
  "name": "leading-controls",
15540
15530
  "inheritedFrom": {
15541
15531
  "name": "ListItem",
@@ -15543,7 +15533,7 @@
15543
15533
  }
15544
15534
  },
15545
15535
  {
15546
- "description": "slot for menu item checkbox primary label.",
15536
+ "description": "slot for menu item primary label.",
15547
15537
  "name": "leading-text-primary-label",
15548
15538
  "inheritedFrom": {
15549
15539
  "name": "ListItem",
@@ -15551,7 +15541,7 @@
15551
15541
  }
15552
15542
  },
15553
15543
  {
15554
- "description": "slot for menu item checkbox secondary label.",
15544
+ "description": "slot for menu item secondary label.",
15555
15545
  "name": "leading-text-secondary-label",
15556
15546
  "inheritedFrom": {
15557
15547
  "name": "ListItem",
@@ -15559,7 +15549,7 @@
15559
15549
  }
15560
15550
  },
15561
15551
  {
15562
- "description": "slot for menu item checkbox tertiary label.",
15552
+ "description": "slot for menu item tertiary label.",
15563
15553
  "name": "leading-text-tertiary-label",
15564
15554
  "inheritedFrom": {
15565
15555
  "name": "ListItem",
@@ -15567,7 +15557,7 @@
15567
15557
  }
15568
15558
  },
15569
15559
  {
15570
- "description": "slot for menu item checkbox side header text.",
15560
+ "description": "slot for menu item side header text.",
15571
15561
  "name": "trailing-text-side-header",
15572
15562
  "inheritedFrom": {
15573
15563
  "name": "ListItem",
@@ -15575,7 +15565,7 @@
15575
15565
  }
15576
15566
  },
15577
15567
  {
15578
- "description": "slot for menu item checkbox subline text.",
15568
+ "description": "slot for menu item subline text.",
15579
15569
  "name": "trailing-text-subline",
15580
15570
  "inheritedFrom": {
15581
15571
  "name": "ListItem",
@@ -15583,7 +15573,7 @@
15583
15573
  }
15584
15574
  },
15585
15575
  {
15586
- "description": "slot for menu item checkbox controls to appear of trailing end.",
15576
+ "description": "slot for menu item controls to appear of trailing end.",
15587
15577
  "name": "trailing-controls",
15588
15578
  "inheritedFrom": {
15589
15579
  "name": "ListItem",
@@ -15592,67 +15582,6 @@
15592
15582
  }
15593
15583
  ],
15594
15584
  "members": [
15595
- {
15596
- "kind": "field",
15597
- "name": "checked",
15598
- "type": {
15599
- "text": "boolean"
15600
- },
15601
- "default": "false",
15602
- "description": "The checked attribute is used to indicate that the menuitemcheckbox is checked or not.",
15603
- "attribute": "checked",
15604
- "reflects": true
15605
- },
15606
- {
15607
- "kind": "field",
15608
- "name": "indicator",
15609
- "type": {
15610
- "text": "Indicator"
15611
- },
15612
- "description": "The indicator attribute is used to differentiate between <b>checkbox</b> and <b>toggle</b>.",
15613
- "default": "'checkbox'",
15614
- "attribute": "indicator",
15615
- "reflects": true
15616
- },
15617
- {
15618
- "kind": "field",
15619
- "name": "handleMouseClick",
15620
- "privacy": "private",
15621
- "description": "Handles click events to toggle checked state\nIf the menuitemcheckbox is disabled, it does nothing.\nIf the menuitemcheckbox is not disabled, it toggles the `checked` state between `true` and `false`."
15622
- },
15623
- {
15624
- "kind": "method",
15625
- "name": "staticCheckbox",
15626
- "privacy": "private",
15627
- "return": {
15628
- "type": {
15629
- "text": ""
15630
- }
15631
- },
15632
- "description": "Returns a static checkbox element if the indicator is set to checkbox.\nIf the indicator is not set to checkbox, it returns nothing."
15633
- },
15634
- {
15635
- "kind": "method",
15636
- "name": "staticToggle",
15637
- "privacy": "private",
15638
- "return": {
15639
- "type": {
15640
- "text": ""
15641
- }
15642
- },
15643
- "description": "Returns a static toggle element if the indicator is set to toggle.\nIf the indicator is not set to toggle, it returns nothing.\n\nThe toggle will always be positioned on the trailing side of the menuitem label."
15644
- },
15645
- {
15646
- "kind": "method",
15647
- "name": "getCheckmarkIcon",
15648
- "privacy": "private",
15649
- "return": {
15650
- "type": {
15651
- "text": ""
15652
- }
15653
- },
15654
- "description": "Returns a checkmark icon if the indicator is set to checkmark and the checked state is true.\nIf the indicator is not set to checkmark or the checked state is false, it returns nothing.\n\nThe checkmark icon will always be positioned on the trailing side of the menuitem label."
15655
- },
15656
15585
  {
15657
15586
  "kind": "field",
15658
15587
  "name": "arrowPosition",
@@ -15661,11 +15590,7 @@
15661
15590
  },
15662
15591
  "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.",
15663
15592
  "attribute": "arrow-position",
15664
- "reflects": true,
15665
- "inheritedFrom": {
15666
- "name": "MenuItem",
15667
- "module": "components/menuitem/menuitem.component.js"
15668
- }
15593
+ "reflects": true
15669
15594
  },
15670
15595
  {
15671
15596
  "kind": "field",
@@ -15675,11 +15600,7 @@
15675
15600
  },
15676
15601
  "description": "Defines the direction the arrow icon points.\n- `'positive'`: Arrow points toward the trailing side.\n- `'negative'`: Arrow points toward the leading side.",
15677
15602
  "attribute": "arrow-direction",
15678
- "reflects": true,
15679
- "inheritedFrom": {
15680
- "name": "MenuItem",
15681
- "module": "components/menuitem/menuitem.component.js"
15682
- }
15603
+ "reflects": true
15683
15604
  },
15684
15605
  {
15685
15606
  "kind": "field",
@@ -15690,11 +15611,7 @@
15690
15611
  "default": "undefined",
15691
15612
  "description": "The name attribute is used to identify the menu item when it is selected.",
15692
15613
  "attribute": "name",
15693
- "reflects": true,
15694
- "inheritedFrom": {
15695
- "name": "MenuItem",
15696
- "module": "components/menuitem/menuitem.component.js"
15697
- }
15614
+ "reflects": true
15698
15615
  },
15699
15616
  {
15700
15617
  "kind": "field",
@@ -15705,11 +15622,7 @@
15705
15622
  "default": "undefined",
15706
15623
  "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.",
15707
15624
  "attribute": "value",
15708
- "reflects": true,
15709
- "inheritedFrom": {
15710
- "name": "MenuItem",
15711
- "module": "components/menuitem/menuitem.component.js"
15712
- }
15625
+ "reflects": true
15713
15626
  },
15714
15627
  {
15715
15628
  "kind": "method",
@@ -15753,11 +15666,7 @@
15753
15666
  "description": "The keyboard event that triggered the action."
15754
15667
  }
15755
15668
  ],
15756
- "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.",
15757
- "inheritedFrom": {
15758
- "name": "MenuItem",
15759
- "module": "components/menuitem/menuitem.component.js"
15760
- }
15669
+ "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."
15761
15670
  },
15762
15671
  {
15763
15672
  "kind": "method",
@@ -16094,12 +16003,7 @@
16094
16003
  ],
16095
16004
  "events": [
16096
16005
  {
16097
- "description": "(React: onChange) This event is dispatched when the menuitemcheckbox changes.",
16098
- "name": "change",
16099
- "reactName": "onChange"
16100
- },
16101
- {
16102
- "description": "(React: onClick) This event is dispatched when the menuitemcheckbox is clicked.",
16006
+ "description": "(React: onClick) This event is dispatched when the menuitem is clicked.",
16103
16007
  "name": "click",
16104
16008
  "reactName": "onClick",
16105
16009
  "inheritedFrom": {
@@ -16107,15 +16011,6 @@
16107
16011
  "module": "src/components/listitem/listitem.component.ts"
16108
16012
  }
16109
16013
  },
16110
- {
16111
- "description": "(React: onFocus) This event is dispatched when the menuitemcheckbox receives focus.",
16112
- "name": "focus",
16113
- "reactName": "onFocus",
16114
- "inheritedFrom": {
16115
- "name": "ListItem",
16116
- "module": "src/components/listitem/listitem.component.ts"
16117
- }
16118
- },
16119
16014
  {
16120
16015
  "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the menuitem.",
16121
16016
  "name": "keydown",
@@ -16133,38 +16028,25 @@
16133
16028
  "name": "ListItem",
16134
16029
  "module": "src/components/listitem/listitem.component.ts"
16135
16030
  }
16031
+ },
16032
+ {
16033
+ "description": "(React: onFocus) This event is dispatched when the menuitem receives focus.",
16034
+ "name": "focus",
16035
+ "reactName": "onFocus",
16036
+ "inheritedFrom": {
16037
+ "name": "ListItem",
16038
+ "module": "src/components/listitem/listitem.component.ts"
16039
+ }
16136
16040
  }
16137
16041
  ],
16138
16042
  "attributes": [
16139
- {
16140
- "name": "checked",
16141
- "type": {
16142
- "text": "boolean"
16143
- },
16144
- "default": "false",
16145
- "description": "The checked attribute is used to indicate that the menuitemcheckbox is checked or not.",
16146
- "fieldName": "checked"
16147
- },
16148
- {
16149
- "name": "indicator",
16150
- "type": {
16151
- "text": "Indicator"
16152
- },
16153
- "description": "The indicator attribute is used to differentiate between <b>checkbox</b> and <b>toggle</b>.",
16154
- "default": "'checkbox'",
16155
- "fieldName": "indicator"
16156
- },
16157
16043
  {
16158
16044
  "name": "arrow-position",
16159
16045
  "type": {
16160
16046
  "text": "ArrowPositions | undefined"
16161
16047
  },
16162
16048
  "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.",
16163
- "fieldName": "arrowPosition",
16164
- "inheritedFrom": {
16165
- "name": "MenuItem",
16166
- "module": "src/components/menuitem/menuitem.component.ts"
16167
- }
16049
+ "fieldName": "arrowPosition"
16168
16050
  },
16169
16051
  {
16170
16052
  "name": "arrow-direction",
@@ -16172,11 +16054,7 @@
16172
16054
  "text": "ArrowDirections | undefined"
16173
16055
  },
16174
16056
  "description": "Defines the direction the arrow icon points.\n- `'positive'`: Arrow points toward the trailing side.\n- `'negative'`: Arrow points toward the leading side.",
16175
- "fieldName": "arrowDirection",
16176
- "inheritedFrom": {
16177
- "name": "MenuItem",
16178
- "module": "src/components/menuitem/menuitem.component.ts"
16179
- }
16057
+ "fieldName": "arrowDirection"
16180
16058
  },
16181
16059
  {
16182
16060
  "name": "name",
@@ -16185,11 +16063,7 @@
16185
16063
  },
16186
16064
  "default": "undefined",
16187
16065
  "description": "The name attribute is used to identify the menu item when it is selected.",
16188
- "fieldName": "name",
16189
- "inheritedFrom": {
16190
- "name": "MenuItem",
16191
- "module": "src/components/menuitem/menuitem.component.ts"
16192
- }
16066
+ "fieldName": "name"
16193
16067
  },
16194
16068
  {
16195
16069
  "name": "value",
@@ -16198,11 +16072,7 @@
16198
16072
  },
16199
16073
  "default": "undefined",
16200
16074
  "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.",
16201
- "fieldName": "value",
16202
- "inheritedFrom": {
16203
- "name": "MenuItem",
16204
- "module": "src/components/menuitem/menuitem.component.ts"
16205
- }
16075
+ "fieldName": "value"
16206
16076
  },
16207
16077
  {
16208
16078
  "name": "disabled",
@@ -16343,11 +16213,11 @@
16343
16213
  }
16344
16214
  ],
16345
16215
  "superclass": {
16346
- "name": "MenuItem",
16347
- "module": "/src/components/menuitem/menuitem.component"
16216
+ "name": "ListItem",
16217
+ "module": "/src/components/listitem/listitem.component"
16348
16218
  },
16349
- "tagName": "mdc-menuitemcheckbox",
16350
- "jsDoc": "/**\n * A menuitemcheckbox component is a checkable menuitem.\n * There should be no focusable descendants inside this menuitemcheckbox component.\n *\n * The `checked` attribute indicates whether the menuitemcheckbox is checked or not.\n *\n * Menu item checkbox has `name` and `value` attribute that can be used to identify the menu item when it is selected.\n *\n * The `indicator` attribute is used to differentiate between <b>checkbox</b>, <b>checkmark</b>, <b>toggle</b> and <b>none</b>.\n * By default, the `indicator` is set to <b>checkbox</b>.<br/>\n *\n * The checkbox will always be positioned on the leading side of the menuitem label and\n * the toggle and checkmark will always be positioned on the trailing side.\n *\n * The checkbox will have the possible states of `true` or `false`.\n * If the indicator is set to <b>checkmark</b> and if the `checked` attribute is set to `true`,\n * then the checkmark will be displayed. if not, then no indicator will be displayed.\n *\n * The forth options for the `indicator` is <b>none</b>, which will not display any indicator at all.\n * It is intended to be used for customised menu items where the indicator is implemented differently.\n * For example, you can use a custom icon or a different visual element to indicate the state of the menu item.\n * Make sure the new indicator is accessible.\n *\n * If you want only one item in a group to be checked, consider using menuitemradio component.\n *\n * @dependency mdc-staticcheckbox\n * @dependency mdc-statictoggle\n * @dependency mdc-icon\n *\n * @tagname mdc-menuitemcheckbox\n *\n * @slot leading-controls - slot for menu item checkbox controls to appear of leading end.\n * @slot leading-text-primary-label - slot for menu item checkbox primary label.\n * @slot leading-text-secondary-label - slot for menu item checkbox secondary label.\n * @slot leading-text-tertiary-label - slot for menu item checkbox tertiary label.\n * @slot trailing-text-side-header - slot for menu item checkbox side header text.\n * @slot trailing-text-subline - slot for menu item checkbox subline text.\n * @slot trailing-controls - slot for menu item checkbox controls to appear of trailing end.\n *\n * @event change - (React: onChange) This event is dispatched when the menuitemcheckbox changes.\n * @event click - (React: onClick) This event is dispatched when the menuitemcheckbox is clicked.\n * @event focus - (React: onFocus) This event is dispatched when the menuitemcheckbox receives focus.\n */",
16219
+ "tagName": "mdc-menuitem",
16220
+ "jsDoc": "/**\n * menuitem component is inherited by listitem component with the role set `menuitem`.<br/>\n * A menu item can contain an icon on the leading or trailing side.\n *\n * The leading and trailing slots can be used to display controls and text.<br/>\n * Based on the leading/trailing slot, the position of the controls and text can be adjusted.\n *\n * Please use element with role=menu as a parent element even when there is only menuitem for a11y purpose.\n * For example mdc-menupopover or mdc-menubar.\n *\n * Menu item has `name` and `value` attribute that can be used to identify the menu item when it is selected.\n *\n * @dependency mdc-text\n * @dependency mdc-icon\n * @dependency mdc-tooltip\n *\n * @tagname mdc-menuitem\n *\n * @slot leading-controls - slot for menu item controls to appear of leading end.\n * @slot leading-text-primary-label - slot for menu item primary label.\n * @slot leading-text-secondary-label - slot for menu item secondary label.\n * @slot leading-text-tertiary-label - slot for menu item tertiary label.\n * @slot trailing-text-side-header - slot for menu item side header text.\n * @slot trailing-text-subline - slot for menu item subline text.\n * @slot trailing-controls - slot for menu item controls to appear of trailing end.\n *\n * @event click - (React: onClick) This event is dispatched when the menuitem is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the menuitem.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the menuitem.\n * @event focus - (React: onFocus) This event is dispatched when the menuitem receives focus.\n */",
16351
16221
  "customElement": true,
16352
16222
  "cssProperties": [
16353
16223
  {
@@ -16422,23 +16292,23 @@
16422
16292
  "kind": "js",
16423
16293
  "name": "default",
16424
16294
  "declaration": {
16425
- "name": "MenuItemCheckbox",
16426
- "module": "components/menuitemcheckbox/menuitemcheckbox.component.js"
16295
+ "name": "MenuItem",
16296
+ "module": "components/menuitem/menuitem.component.js"
16427
16297
  }
16428
16298
  }
16429
16299
  ]
16430
16300
  },
16431
16301
  {
16432
16302
  "kind": "javascript-module",
16433
- "path": "components/menuitemradio/menuitemradio.component.js",
16303
+ "path": "components/menuitemcheckbox/menuitemcheckbox.component.js",
16434
16304
  "declarations": [
16435
16305
  {
16436
16306
  "kind": "class",
16437
- "description": "A menuitemradio component is a checkable menuitem that is used in a menu.\nA menuitemradio should be checked only one at a time. <br/>\nThere should be no focusable descendants inside this menuitemradio component.\n\nThe `checked` menuitemradio attribute is used to indicate that the menuitemradio is checked or not.\n\nMenu item radio has `name` and `value` attribute that can be used to identify the menu item when it is selected.\n\nIf you want more than one item in a group to be checked, consider using menuitemcheckbox component.\n\nThe `indicator` attribute is used to differentiate between <b>radio</b>, <b>checkmark</b> and <b>none</b>.\nBy default, the `indicator` is set to <b>radio</b>.<br/>\n\nThe checkbox will always be positioned on the leading side of the menuitem label and\nthe checkmark will always be positioned on the trailing side.\n\nThe radio will have the possible states of `true` or `false`.\nIf the indicator is set to <b>checkmark</b> and if the `checked` attribute is set to `true`,\nthen the checkmark will be displayed. if not, then no indicator will be displayed.\n\nThe third options for the `indicator` is <b>none</b>, which will not display any indicator at all.\nIt is intended to be used for customised menu items where the indicator is implemented differently.\nFor example, you can use a custom icon or a different visual element to indicate the state of the menu item.\nMake sure the new indicator is accessible.",
16438
- "name": "MenuItemRadio",
16307
+ "description": "A menuitemcheckbox component is a checkable menuitem.\nThere should be no focusable descendants inside this menuitemcheckbox component.\n\nThe `checked` attribute indicates whether the menuitemcheckbox is checked or not.\n\nMenu item checkbox has `name` and `value` attribute that can be used to identify the menu item when it is selected.\n\nThe `indicator` attribute is used to differentiate between <b>checkbox</b>, <b>checkmark</b>, <b>toggle</b> and <b>none</b>.\nBy default, the `indicator` is set to <b>checkbox</b>.<br/>\n\nThe checkbox will always be positioned on the leading side of the menuitem label and\nthe toggle and checkmark will always be positioned on the trailing side.\n\nThe checkbox will have the possible states of `true` or `false`.\nIf the indicator is set to <b>checkmark</b> and if the `checked` attribute is set to `true`,\nthen the checkmark will be displayed. if not, then no indicator will be displayed.\n\nThe forth options for the `indicator` is <b>none</b>, which will not display any indicator at all.\nIt is intended to be used for customised menu items where the indicator is implemented differently.\nFor example, you can use a custom icon or a different visual element to indicate the state of the menu item.\nMake sure the new indicator is accessible.\n\nIf you want only one item in a group to be checked, consider using menuitemradio component.",
16308
+ "name": "MenuItemCheckbox",
16439
16309
  "slots": [
16440
16310
  {
16441
- "description": "slot for menu item radio controls to appear of leading end.",
16311
+ "description": "slot for menu item checkbox controls to appear of leading end.",
16442
16312
  "name": "leading-controls",
16443
16313
  "inheritedFrom": {
16444
16314
  "name": "ListItem",
@@ -16446,7 +16316,7 @@
16446
16316
  }
16447
16317
  },
16448
16318
  {
16449
- "description": "slot for menu item radio primary label.",
16319
+ "description": "slot for menu item checkbox primary label.",
16450
16320
  "name": "leading-text-primary-label",
16451
16321
  "inheritedFrom": {
16452
16322
  "name": "ListItem",
@@ -16454,7 +16324,7 @@
16454
16324
  }
16455
16325
  },
16456
16326
  {
16457
- "description": "slot for menu item radio secondary label.",
16327
+ "description": "slot for menu item checkbox secondary label.",
16458
16328
  "name": "leading-text-secondary-label",
16459
16329
  "inheritedFrom": {
16460
16330
  "name": "ListItem",
@@ -16462,7 +16332,7 @@
16462
16332
  }
16463
16333
  },
16464
16334
  {
16465
- "description": "slot for menu item radio tertiary label.",
16335
+ "description": "slot for menu item checkbox tertiary label.",
16466
16336
  "name": "leading-text-tertiary-label",
16467
16337
  "inheritedFrom": {
16468
16338
  "name": "ListItem",
@@ -16470,7 +16340,7 @@
16470
16340
  }
16471
16341
  },
16472
16342
  {
16473
- "description": "slot for menu item radio side header text.",
16343
+ "description": "slot for menu item checkbox side header text.",
16474
16344
  "name": "trailing-text-side-header",
16475
16345
  "inheritedFrom": {
16476
16346
  "name": "ListItem",
@@ -16478,7 +16348,7 @@
16478
16348
  }
16479
16349
  },
16480
16350
  {
16481
- "description": "slot for menu item radio subline text.",
16351
+ "description": "slot for menu item checkbox subline text.",
16482
16352
  "name": "trailing-text-subline",
16483
16353
  "inheritedFrom": {
16484
16354
  "name": "ListItem",
@@ -16486,7 +16356,7 @@
16486
16356
  }
16487
16357
  },
16488
16358
  {
16489
- "description": "slot for menu item radio controls to appear of trailing end.",
16359
+ "description": "slot for menu item checkbox controls to appear of trailing end.",
16490
16360
  "name": "trailing-controls",
16491
16361
  "inheritedFrom": {
16492
16362
  "name": "ListItem",
@@ -16502,7 +16372,7 @@
16502
16372
  "text": "boolean"
16503
16373
  },
16504
16374
  "default": "false",
16505
- "description": "The aria-checked attribute is used to indicate that the menuitemradio is checked or not.",
16375
+ "description": "The checked attribute is used to indicate that the menuitemcheckbox is checked or not.",
16506
16376
  "attribute": "checked",
16507
16377
  "reflects": true
16508
16378
  },
@@ -16512,53 +16382,42 @@
16512
16382
  "type": {
16513
16383
  "text": "Indicator"
16514
16384
  },
16515
- "description": "The indicator attribute is used to differentiate between <b>radio</b>, <b>checkmark</b> and <b>none</b>.",
16516
- "default": "'radio'",
16385
+ "description": "The indicator attribute is used to differentiate between <b>checkbox</b> and <b>toggle</b>.",
16386
+ "default": "'checkbox'",
16517
16387
  "attribute": "indicator",
16518
16388
  "reflects": true
16519
16389
  },
16520
16390
  {
16521
- "kind": "method",
16522
- "name": "getAllRadiosWithinSameGroup",
16391
+ "kind": "field",
16392
+ "name": "handleMouseClick",
16523
16393
  "privacy": "private",
16524
- "return": {
16525
- "type": {
16526
- "text": "MenuItemRadio[]"
16527
- }
16528
- },
16529
- "description": "Returns all radios within the same group (name)."
16394
+ "description": "Handles click events to toggle checked state\nIf the menuitemcheckbox is disabled, it does nothing.\nIf the menuitemcheckbox is not disabled, it toggles the `checked` state between `true` and `false`."
16530
16395
  },
16531
16396
  {
16532
16397
  "kind": "method",
16533
- "name": "updateOtherRadiosCheckedState",
16398
+ "name": "staticCheckbox",
16534
16399
  "privacy": "private",
16535
16400
  "return": {
16536
16401
  "type": {
16537
- "text": "void"
16402
+ "text": ""
16538
16403
  }
16539
16404
  },
16540
- "description": "Updates the checked state of all other radios in the same group.\nThis method is called when a radio is clicked to ensure that only one radio in the group can be checked at a time.\nIt sets the `checked` property of all other radios in the same group to `false`."
16541
- },
16542
- {
16543
- "kind": "field",
16544
- "name": "handleMouseClick",
16545
- "privacy": "private",
16546
- "description": "Handles click events to set checked state and uncheck siblings in the same group and container.\nIf the menuitemradio is not checked, it sets its checked state to `true`\nand sets all other menuitemradio elements of the same group with checked state to `false`."
16405
+ "description": "Returns a static checkbox element if the indicator is set to checkbox.\nIf the indicator is not set to checkbox, it returns nothing."
16547
16406
  },
16548
16407
  {
16549
16408
  "kind": "method",
16550
- "name": "renderStaticRadio",
16409
+ "name": "staticToggle",
16551
16410
  "privacy": "private",
16552
16411
  "return": {
16553
16412
  "type": {
16554
16413
  "text": ""
16555
16414
  }
16556
16415
  },
16557
- "description": "Returns a static checkbox element if the indicator is set to checkbox.\nIf the indicator is not set to checkbox, it returns nothing."
16416
+ "description": "Returns a static toggle element if the indicator is set to toggle.\nIf the indicator is not set to toggle, it returns nothing.\n\nThe toggle will always be positioned on the trailing side of the menuitem label."
16558
16417
  },
16559
16418
  {
16560
16419
  "kind": "method",
16561
- "name": "renderCheckmarkIcon",
16420
+ "name": "getCheckmarkIcon",
16562
16421
  "privacy": "private",
16563
16422
  "return": {
16564
16423
  "type": {
@@ -17008,12 +16867,12 @@
17008
16867
  ],
17009
16868
  "events": [
17010
16869
  {
17011
- "description": "(React: onChange) This event is dispatched when the menuitemradio changes.",
16870
+ "description": "(React: onChange) This event is dispatched when the menuitemcheckbox changes.",
17012
16871
  "name": "change",
17013
16872
  "reactName": "onChange"
17014
16873
  },
17015
16874
  {
17016
- "description": "(React: onClick) This event is dispatched when the menuitemradio is clicked.",
16875
+ "description": "(React: onClick) This event is dispatched when the menuitemcheckbox is clicked.",
17017
16876
  "name": "click",
17018
16877
  "reactName": "onClick",
17019
16878
  "inheritedFrom": {
@@ -17022,7 +16881,7 @@
17022
16881
  }
17023
16882
  },
17024
16883
  {
17025
- "description": "(React: onFocus) This event is dispatched when the menuitemradio receives focus.",
16884
+ "description": "(React: onFocus) This event is dispatched when the menuitemcheckbox receives focus.",
17026
16885
  "name": "focus",
17027
16886
  "reactName": "onFocus",
17028
16887
  "inheritedFrom": {
@@ -17056,7 +16915,7 @@
17056
16915
  "text": "boolean"
17057
16916
  },
17058
16917
  "default": "false",
17059
- "description": "The aria-checked attribute is used to indicate that the menuitemradio is checked or not.",
16918
+ "description": "The checked attribute is used to indicate that the menuitemcheckbox is checked or not.",
17060
16919
  "fieldName": "checked"
17061
16920
  },
17062
16921
  {
@@ -17064,8 +16923,8 @@
17064
16923
  "type": {
17065
16924
  "text": "Indicator"
17066
16925
  },
17067
- "description": "The indicator attribute is used to differentiate between <b>radio</b>, <b>checkmark</b> and <b>none</b>.",
17068
- "default": "'radio'",
16926
+ "description": "The indicator attribute is used to differentiate between <b>checkbox</b> and <b>toggle</b>.",
16927
+ "default": "'checkbox'",
17069
16928
  "fieldName": "indicator"
17070
16929
  },
17071
16930
  {
@@ -17260,8 +17119,8 @@
17260
17119
  "name": "MenuItem",
17261
17120
  "module": "/src/components/menuitem/menuitem.component"
17262
17121
  },
17263
- "tagName": "mdc-menuitemradio",
17264
- "jsDoc": "/**\n * A menuitemradio component is a checkable menuitem that is used in a menu.\n * A menuitemradio should be checked only one at a time. <br/>\n * There should be no focusable descendants inside this menuitemradio component.\n *\n * The `checked` menuitemradio attribute is used to indicate that the menuitemradio is checked or not.\n *\n * Menu item radio has `name` and `value` attribute that can be used to identify the menu item when it is selected.\n *\n * If you want more than one item in a group to be checked, consider using menuitemcheckbox component.\n *\n * The `indicator` attribute is used to differentiate between <b>radio</b>, <b>checkmark</b> and <b>none</b>.\n * By default, the `indicator` is set to <b>radio</b>.<br/>\n *\n * The checkbox will always be positioned on the leading side of the menuitem label and\n * the checkmark will always be positioned on the trailing side.\n *\n * The radio will have the possible states of `true` or `false`.\n * If the indicator is set to <b>checkmark</b> and if the `checked` attribute is set to `true`,\n * then the checkmark will be displayed. if not, then no indicator will be displayed.\n *\n * The third options for the `indicator` is <b>none</b>, which will not display any indicator at all.\n * It is intended to be used for customised menu items where the indicator is implemented differently.\n * For example, you can use a custom icon or a different visual element to indicate the state of the menu item.\n * Make sure the new indicator is accessible.\n *\n * @dependency mdc-icon\n * @dependency mdc-staticradio\n * @dependency mdc-text\n * @dependency mdc-tooltip\n *\n * @tagname mdc-menuitemradio\n *\n * @slot leading-controls - slot for menu item radio controls to appear of leading end.\n * @slot leading-text-primary-label - slot for menu item radio primary label.\n * @slot leading-text-secondary-label - slot for menu item radio secondary label.\n * @slot leading-text-tertiary-label - slot for menu item radio tertiary label.\n * @slot trailing-text-side-header - slot for menu item radio side header text.\n * @slot trailing-text-subline - slot for menu item radio subline text.\n * @slot trailing-controls - slot for menu item radio controls to appear of trailing end.\n *\n * @event change - (React: onChange) This event is dispatched when the menuitemradio changes.\n * @event click - (React: onClick) This event is dispatched when the menuitemradio is clicked.\n * @event focus - (React: onFocus) This event is dispatched when the menuitemradio receives focus.\n */",
17122
+ "tagName": "mdc-menuitemcheckbox",
17123
+ "jsDoc": "/**\n * A menuitemcheckbox component is a checkable menuitem.\n * There should be no focusable descendants inside this menuitemcheckbox component.\n *\n * The `checked` attribute indicates whether the menuitemcheckbox is checked or not.\n *\n * Menu item checkbox has `name` and `value` attribute that can be used to identify the menu item when it is selected.\n *\n * The `indicator` attribute is used to differentiate between <b>checkbox</b>, <b>checkmark</b>, <b>toggle</b> and <b>none</b>.\n * By default, the `indicator` is set to <b>checkbox</b>.<br/>\n *\n * The checkbox will always be positioned on the leading side of the menuitem label and\n * the toggle and checkmark will always be positioned on the trailing side.\n *\n * The checkbox will have the possible states of `true` or `false`.\n * If the indicator is set to <b>checkmark</b> and if the `checked` attribute is set to `true`,\n * then the checkmark will be displayed. if not, then no indicator will be displayed.\n *\n * The forth options for the `indicator` is <b>none</b>, which will not display any indicator at all.\n * It is intended to be used for customised menu items where the indicator is implemented differently.\n * For example, you can use a custom icon or a different visual element to indicate the state of the menu item.\n * Make sure the new indicator is accessible.\n *\n * If you want only one item in a group to be checked, consider using menuitemradio component.\n *\n * @dependency mdc-staticcheckbox\n * @dependency mdc-statictoggle\n * @dependency mdc-icon\n *\n * @tagname mdc-menuitemcheckbox\n *\n * @slot leading-controls - slot for menu item checkbox controls to appear of leading end.\n * @slot leading-text-primary-label - slot for menu item checkbox primary label.\n * @slot leading-text-secondary-label - slot for menu item checkbox secondary label.\n * @slot leading-text-tertiary-label - slot for menu item checkbox tertiary label.\n * @slot trailing-text-side-header - slot for menu item checkbox side header text.\n * @slot trailing-text-subline - slot for menu item checkbox subline text.\n * @slot trailing-controls - slot for menu item checkbox controls to appear of trailing end.\n *\n * @event change - (React: onChange) This event is dispatched when the menuitemcheckbox changes.\n * @event click - (React: onClick) This event is dispatched when the menuitemcheckbox is clicked.\n * @event focus - (React: onFocus) This event is dispatched when the menuitemcheckbox receives focus.\n */",
17265
17124
  "customElement": true,
17266
17125
  "cssProperties": [
17267
17126
  {
@@ -17336,23 +17195,23 @@
17336
17195
  "kind": "js",
17337
17196
  "name": "default",
17338
17197
  "declaration": {
17339
- "name": "MenuItemRadio",
17340
- "module": "components/menuitemradio/menuitemradio.component.js"
17198
+ "name": "MenuItemCheckbox",
17199
+ "module": "components/menuitemcheckbox/menuitemcheckbox.component.js"
17341
17200
  }
17342
17201
  }
17343
17202
  ]
17344
17203
  },
17345
17204
  {
17346
17205
  "kind": "javascript-module",
17347
- "path": "components/menuitem/menuitem.component.js",
17206
+ "path": "components/menuitemradio/menuitemradio.component.js",
17348
17207
  "declarations": [
17349
17208
  {
17350
17209
  "kind": "class",
17351
- "description": "menuitem component is inherited by listitem component with the role set `menuitem`.<br/>\nA menu item can contain an icon on the leading or trailing side.\n\nThe leading and trailing slots can be used to display controls and text.<br/>\nBased on the leading/trailing slot, the position of the controls and text can be adjusted.\n\nPlease use element with role=menu as a parent element even when there is only menuitem for a11y purpose.\nFor example mdc-menupopover or mdc-menubar.\n\nMenu item has `name` and `value` attribute that can be used to identify the menu item when it is selected.",
17352
- "name": "MenuItem",
17210
+ "description": "A menuitemradio component is a checkable menuitem that is used in a menu.\nA menuitemradio should be checked only one at a time. <br/>\nThere should be no focusable descendants inside this menuitemradio component.\n\nThe `checked` menuitemradio attribute is used to indicate that the menuitemradio is checked or not.\n\nMenu item radio has `name` and `value` attribute that can be used to identify the menu item when it is selected.\n\nIf you want more than one item in a group to be checked, consider using menuitemcheckbox component.\n\nThe `indicator` attribute is used to differentiate between <b>radio</b>, <b>checkmark</b> and <b>none</b>.\nBy default, the `indicator` is set to <b>radio</b>.<br/>\n\nThe checkbox will always be positioned on the leading side of the menuitem label and\nthe checkmark will always be positioned on the trailing side.\n\nThe radio will have the possible states of `true` or `false`.\nIf the indicator is set to <b>checkmark</b> and if the `checked` attribute is set to `true`,\nthen the checkmark will be displayed. if not, then no indicator will be displayed.\n\nThe third options for the `indicator` is <b>none</b>, which will not display any indicator at all.\nIt is intended to be used for customised menu items where the indicator is implemented differently.\nFor example, you can use a custom icon or a different visual element to indicate the state of the menu item.\nMake sure the new indicator is accessible.",
17211
+ "name": "MenuItemRadio",
17353
17212
  "slots": [
17354
17213
  {
17355
- "description": "slot for menu item controls to appear of leading end.",
17214
+ "description": "slot for menu item radio controls to appear of leading end.",
17356
17215
  "name": "leading-controls",
17357
17216
  "inheritedFrom": {
17358
17217
  "name": "ListItem",
@@ -17360,7 +17219,7 @@
17360
17219
  }
17361
17220
  },
17362
17221
  {
17363
- "description": "slot for menu item primary label.",
17222
+ "description": "slot for menu item radio primary label.",
17364
17223
  "name": "leading-text-primary-label",
17365
17224
  "inheritedFrom": {
17366
17225
  "name": "ListItem",
@@ -17368,7 +17227,7 @@
17368
17227
  }
17369
17228
  },
17370
17229
  {
17371
- "description": "slot for menu item secondary label.",
17230
+ "description": "slot for menu item radio secondary label.",
17372
17231
  "name": "leading-text-secondary-label",
17373
17232
  "inheritedFrom": {
17374
17233
  "name": "ListItem",
@@ -17376,7 +17235,7 @@
17376
17235
  }
17377
17236
  },
17378
17237
  {
17379
- "description": "slot for menu item tertiary label.",
17238
+ "description": "slot for menu item radio tertiary label.",
17380
17239
  "name": "leading-text-tertiary-label",
17381
17240
  "inheritedFrom": {
17382
17241
  "name": "ListItem",
@@ -17384,7 +17243,7 @@
17384
17243
  }
17385
17244
  },
17386
17245
  {
17387
- "description": "slot for menu item side header text.",
17246
+ "description": "slot for menu item radio side header text.",
17388
17247
  "name": "trailing-text-side-header",
17389
17248
  "inheritedFrom": {
17390
17249
  "name": "ListItem",
@@ -17392,7 +17251,7 @@
17392
17251
  }
17393
17252
  },
17394
17253
  {
17395
- "description": "slot for menu item subline text.",
17254
+ "description": "slot for menu item radio subline text.",
17396
17255
  "name": "trailing-text-subline",
17397
17256
  "inheritedFrom": {
17398
17257
  "name": "ListItem",
@@ -17400,7 +17259,7 @@
17400
17259
  }
17401
17260
  },
17402
17261
  {
17403
- "description": "slot for menu item controls to appear of trailing end.",
17262
+ "description": "slot for menu item radio controls to appear of trailing end.",
17404
17263
  "name": "trailing-controls",
17405
17264
  "inheritedFrom": {
17406
17265
  "name": "ListItem",
@@ -17409,6 +17268,78 @@
17409
17268
  }
17410
17269
  ],
17411
17270
  "members": [
17271
+ {
17272
+ "kind": "field",
17273
+ "name": "checked",
17274
+ "type": {
17275
+ "text": "boolean"
17276
+ },
17277
+ "default": "false",
17278
+ "description": "The aria-checked attribute is used to indicate that the menuitemradio is checked or not.",
17279
+ "attribute": "checked",
17280
+ "reflects": true
17281
+ },
17282
+ {
17283
+ "kind": "field",
17284
+ "name": "indicator",
17285
+ "type": {
17286
+ "text": "Indicator"
17287
+ },
17288
+ "description": "The indicator attribute is used to differentiate between <b>radio</b>, <b>checkmark</b> and <b>none</b>.",
17289
+ "default": "'radio'",
17290
+ "attribute": "indicator",
17291
+ "reflects": true
17292
+ },
17293
+ {
17294
+ "kind": "method",
17295
+ "name": "getAllRadiosWithinSameGroup",
17296
+ "privacy": "private",
17297
+ "return": {
17298
+ "type": {
17299
+ "text": "MenuItemRadio[]"
17300
+ }
17301
+ },
17302
+ "description": "Returns all radios within the same group (name)."
17303
+ },
17304
+ {
17305
+ "kind": "method",
17306
+ "name": "updateOtherRadiosCheckedState",
17307
+ "privacy": "private",
17308
+ "return": {
17309
+ "type": {
17310
+ "text": "void"
17311
+ }
17312
+ },
17313
+ "description": "Updates the checked state of all other radios in the same group.\nThis method is called when a radio is clicked to ensure that only one radio in the group can be checked at a time.\nIt sets the `checked` property of all other radios in the same group to `false`."
17314
+ },
17315
+ {
17316
+ "kind": "field",
17317
+ "name": "handleMouseClick",
17318
+ "privacy": "private",
17319
+ "description": "Handles click events to set checked state and uncheck siblings in the same group and container.\nIf the menuitemradio is not checked, it sets its checked state to `true`\nand sets all other menuitemradio elements of the same group with checked state to `false`."
17320
+ },
17321
+ {
17322
+ "kind": "method",
17323
+ "name": "renderStaticRadio",
17324
+ "privacy": "private",
17325
+ "return": {
17326
+ "type": {
17327
+ "text": ""
17328
+ }
17329
+ },
17330
+ "description": "Returns a static checkbox element if the indicator is set to checkbox.\nIf the indicator is not set to checkbox, it returns nothing."
17331
+ },
17332
+ {
17333
+ "kind": "method",
17334
+ "name": "renderCheckmarkIcon",
17335
+ "privacy": "private",
17336
+ "return": {
17337
+ "type": {
17338
+ "text": ""
17339
+ }
17340
+ },
17341
+ "description": "Returns a checkmark icon if the indicator is set to checkmark and the checked state is true.\nIf the indicator is not set to checkmark or the checked state is false, it returns nothing.\n\nThe checkmark icon will always be positioned on the trailing side of the menuitem label."
17342
+ },
17412
17343
  {
17413
17344
  "kind": "field",
17414
17345
  "name": "arrowPosition",
@@ -17417,7 +17348,11 @@
17417
17348
  },
17418
17349
  "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.",
17419
17350
  "attribute": "arrow-position",
17420
- "reflects": true
17351
+ "reflects": true,
17352
+ "inheritedFrom": {
17353
+ "name": "MenuItem",
17354
+ "module": "components/menuitem/menuitem.component.js"
17355
+ }
17421
17356
  },
17422
17357
  {
17423
17358
  "kind": "field",
@@ -17427,7 +17362,11 @@
17427
17362
  },
17428
17363
  "description": "Defines the direction the arrow icon points.\n- `'positive'`: Arrow points toward the trailing side.\n- `'negative'`: Arrow points toward the leading side.",
17429
17364
  "attribute": "arrow-direction",
17430
- "reflects": true
17365
+ "reflects": true,
17366
+ "inheritedFrom": {
17367
+ "name": "MenuItem",
17368
+ "module": "components/menuitem/menuitem.component.js"
17369
+ }
17431
17370
  },
17432
17371
  {
17433
17372
  "kind": "field",
@@ -17438,7 +17377,11 @@
17438
17377
  "default": "undefined",
17439
17378
  "description": "The name attribute is used to identify the menu item when it is selected.",
17440
17379
  "attribute": "name",
17441
- "reflects": true
17380
+ "reflects": true,
17381
+ "inheritedFrom": {
17382
+ "name": "MenuItem",
17383
+ "module": "components/menuitem/menuitem.component.js"
17384
+ }
17442
17385
  },
17443
17386
  {
17444
17387
  "kind": "field",
@@ -17449,7 +17392,11 @@
17449
17392
  "default": "undefined",
17450
17393
  "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.",
17451
17394
  "attribute": "value",
17452
- "reflects": true
17395
+ "reflects": true,
17396
+ "inheritedFrom": {
17397
+ "name": "MenuItem",
17398
+ "module": "components/menuitem/menuitem.component.js"
17399
+ }
17453
17400
  },
17454
17401
  {
17455
17402
  "kind": "method",
@@ -17493,7 +17440,11 @@
17493
17440
  "description": "The keyboard event that triggered the action."
17494
17441
  }
17495
17442
  ],
17496
- "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."
17443
+ "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.",
17444
+ "inheritedFrom": {
17445
+ "name": "MenuItem",
17446
+ "module": "components/menuitem/menuitem.component.js"
17447
+ }
17497
17448
  },
17498
17449
  {
17499
17450
  "kind": "method",
@@ -17830,7 +17781,12 @@
17830
17781
  ],
17831
17782
  "events": [
17832
17783
  {
17833
- "description": "(React: onClick) This event is dispatched when the menuitem is clicked.",
17784
+ "description": "(React: onChange) This event is dispatched when the menuitemradio changes.",
17785
+ "name": "change",
17786
+ "reactName": "onChange"
17787
+ },
17788
+ {
17789
+ "description": "(React: onClick) This event is dispatched when the menuitemradio is clicked.",
17834
17790
  "name": "click",
17835
17791
  "reactName": "onClick",
17836
17792
  "inheritedFrom": {
@@ -17839,27 +17795,27 @@
17839
17795
  }
17840
17796
  },
17841
17797
  {
17842
- "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the menuitem.",
17843
- "name": "keydown",
17844
- "reactName": "onKeyDown",
17798
+ "description": "(React: onFocus) This event is dispatched when the menuitemradio receives focus.",
17799
+ "name": "focus",
17800
+ "reactName": "onFocus",
17845
17801
  "inheritedFrom": {
17846
17802
  "name": "ListItem",
17847
17803
  "module": "src/components/listitem/listitem.component.ts"
17848
17804
  }
17849
17805
  },
17850
17806
  {
17851
- "description": "(React: onKeyUp) This event is dispatched when a key is released on the menuitem.",
17852
- "name": "keyup",
17853
- "reactName": "onKeyUp",
17807
+ "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the menuitem.",
17808
+ "name": "keydown",
17809
+ "reactName": "onKeyDown",
17854
17810
  "inheritedFrom": {
17855
17811
  "name": "ListItem",
17856
17812
  "module": "src/components/listitem/listitem.component.ts"
17857
17813
  }
17858
17814
  },
17859
17815
  {
17860
- "description": "(React: onFocus) This event is dispatched when the menuitem receives focus.",
17861
- "name": "focus",
17862
- "reactName": "onFocus",
17816
+ "description": "(React: onKeyUp) This event is dispatched when a key is released on the menuitem.",
17817
+ "name": "keyup",
17818
+ "reactName": "onKeyUp",
17863
17819
  "inheritedFrom": {
17864
17820
  "name": "ListItem",
17865
17821
  "module": "src/components/listitem/listitem.component.ts"
@@ -17867,13 +17823,35 @@
17867
17823
  }
17868
17824
  ],
17869
17825
  "attributes": [
17826
+ {
17827
+ "name": "checked",
17828
+ "type": {
17829
+ "text": "boolean"
17830
+ },
17831
+ "default": "false",
17832
+ "description": "The aria-checked attribute is used to indicate that the menuitemradio is checked or not.",
17833
+ "fieldName": "checked"
17834
+ },
17835
+ {
17836
+ "name": "indicator",
17837
+ "type": {
17838
+ "text": "Indicator"
17839
+ },
17840
+ "description": "The indicator attribute is used to differentiate between <b>radio</b>, <b>checkmark</b> and <b>none</b>.",
17841
+ "default": "'radio'",
17842
+ "fieldName": "indicator"
17843
+ },
17870
17844
  {
17871
17845
  "name": "arrow-position",
17872
17846
  "type": {
17873
17847
  "text": "ArrowPositions | undefined"
17874
17848
  },
17875
17849
  "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.",
17876
- "fieldName": "arrowPosition"
17850
+ "fieldName": "arrowPosition",
17851
+ "inheritedFrom": {
17852
+ "name": "MenuItem",
17853
+ "module": "src/components/menuitem/menuitem.component.ts"
17854
+ }
17877
17855
  },
17878
17856
  {
17879
17857
  "name": "arrow-direction",
@@ -17881,7 +17859,11 @@
17881
17859
  "text": "ArrowDirections | undefined"
17882
17860
  },
17883
17861
  "description": "Defines the direction the arrow icon points.\n- `'positive'`: Arrow points toward the trailing side.\n- `'negative'`: Arrow points toward the leading side.",
17884
- "fieldName": "arrowDirection"
17862
+ "fieldName": "arrowDirection",
17863
+ "inheritedFrom": {
17864
+ "name": "MenuItem",
17865
+ "module": "src/components/menuitem/menuitem.component.ts"
17866
+ }
17885
17867
  },
17886
17868
  {
17887
17869
  "name": "name",
@@ -17890,7 +17872,11 @@
17890
17872
  },
17891
17873
  "default": "undefined",
17892
17874
  "description": "The name attribute is used to identify the menu item when it is selected.",
17893
- "fieldName": "name"
17875
+ "fieldName": "name",
17876
+ "inheritedFrom": {
17877
+ "name": "MenuItem",
17878
+ "module": "src/components/menuitem/menuitem.component.ts"
17879
+ }
17894
17880
  },
17895
17881
  {
17896
17882
  "name": "value",
@@ -17899,7 +17885,11 @@
17899
17885
  },
17900
17886
  "default": "undefined",
17901
17887
  "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.",
17902
- "fieldName": "value"
17888
+ "fieldName": "value",
17889
+ "inheritedFrom": {
17890
+ "name": "MenuItem",
17891
+ "module": "src/components/menuitem/menuitem.component.ts"
17892
+ }
17903
17893
  },
17904
17894
  {
17905
17895
  "name": "disabled",
@@ -18040,11 +18030,11 @@
18040
18030
  }
18041
18031
  ],
18042
18032
  "superclass": {
18043
- "name": "ListItem",
18044
- "module": "/src/components/listitem/listitem.component"
18033
+ "name": "MenuItem",
18034
+ "module": "/src/components/menuitem/menuitem.component"
18045
18035
  },
18046
- "tagName": "mdc-menuitem",
18047
- "jsDoc": "/**\n * menuitem component is inherited by listitem component with the role set `menuitem`.<br/>\n * A menu item can contain an icon on the leading or trailing side.\n *\n * The leading and trailing slots can be used to display controls and text.<br/>\n * Based on the leading/trailing slot, the position of the controls and text can be adjusted.\n *\n * Please use element with role=menu as a parent element even when there is only menuitem for a11y purpose.\n * For example mdc-menupopover or mdc-menubar.\n *\n * Menu item has `name` and `value` attribute that can be used to identify the menu item when it is selected.\n *\n * @dependency mdc-text\n * @dependency mdc-icon\n * @dependency mdc-tooltip\n *\n * @tagname mdc-menuitem\n *\n * @slot leading-controls - slot for menu item controls to appear of leading end.\n * @slot leading-text-primary-label - slot for menu item primary label.\n * @slot leading-text-secondary-label - slot for menu item secondary label.\n * @slot leading-text-tertiary-label - slot for menu item tertiary label.\n * @slot trailing-text-side-header - slot for menu item side header text.\n * @slot trailing-text-subline - slot for menu item subline text.\n * @slot trailing-controls - slot for menu item controls to appear of trailing end.\n *\n * @event click - (React: onClick) This event is dispatched when the menuitem is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the menuitem.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the menuitem.\n * @event focus - (React: onFocus) This event is dispatched when the menuitem receives focus.\n */",
18036
+ "tagName": "mdc-menuitemradio",
18037
+ "jsDoc": "/**\n * A menuitemradio component is a checkable menuitem that is used in a menu.\n * A menuitemradio should be checked only one at a time. <br/>\n * There should be no focusable descendants inside this menuitemradio component.\n *\n * The `checked` menuitemradio attribute is used to indicate that the menuitemradio is checked or not.\n *\n * Menu item radio has `name` and `value` attribute that can be used to identify the menu item when it is selected.\n *\n * If you want more than one item in a group to be checked, consider using menuitemcheckbox component.\n *\n * The `indicator` attribute is used to differentiate between <b>radio</b>, <b>checkmark</b> and <b>none</b>.\n * By default, the `indicator` is set to <b>radio</b>.<br/>\n *\n * The checkbox will always be positioned on the leading side of the menuitem label and\n * the checkmark will always be positioned on the trailing side.\n *\n * The radio will have the possible states of `true` or `false`.\n * If the indicator is set to <b>checkmark</b> and if the `checked` attribute is set to `true`,\n * then the checkmark will be displayed. if not, then no indicator will be displayed.\n *\n * The third options for the `indicator` is <b>none</b>, which will not display any indicator at all.\n * It is intended to be used for customised menu items where the indicator is implemented differently.\n * For example, you can use a custom icon or a different visual element to indicate the state of the menu item.\n * Make sure the new indicator is accessible.\n *\n * @dependency mdc-icon\n * @dependency mdc-staticradio\n * @dependency mdc-text\n * @dependency mdc-tooltip\n *\n * @tagname mdc-menuitemradio\n *\n * @slot leading-controls - slot for menu item radio controls to appear of leading end.\n * @slot leading-text-primary-label - slot for menu item radio primary label.\n * @slot leading-text-secondary-label - slot for menu item radio secondary label.\n * @slot leading-text-tertiary-label - slot for menu item radio tertiary label.\n * @slot trailing-text-side-header - slot for menu item radio side header text.\n * @slot trailing-text-subline - slot for menu item radio subline text.\n * @slot trailing-controls - slot for menu item radio controls to appear of trailing end.\n *\n * @event change - (React: onChange) This event is dispatched when the menuitemradio changes.\n * @event click - (React: onClick) This event is dispatched when the menuitemradio is clicked.\n * @event focus - (React: onFocus) This event is dispatched when the menuitemradio receives focus.\n */",
18048
18038
  "customElement": true,
18049
18039
  "cssProperties": [
18050
18040
  {
@@ -18119,8 +18109,8 @@
18119
18109
  "kind": "js",
18120
18110
  "name": "default",
18121
18111
  "declaration": {
18122
- "name": "MenuItem",
18123
- "module": "components/menuitem/menuitem.component.js"
18112
+ "name": "MenuItemRadio",
18113
+ "module": "components/menuitemradio/menuitemradio.component.js"
18124
18114
  }
18125
18115
  }
18126
18116
  ]
@@ -21897,7 +21887,7 @@
21897
21887
  "type": {
21898
21888
  "text": "string | undefined"
21899
21889
  },
21900
- "description": "Custom validation message that will override the default message and displayed when the input is invalid.",
21890
+ "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.",
21901
21891
  "attribute": "validation-message",
21902
21892
  "reflects": true,
21903
21893
  "inheritedFrom": {
@@ -22414,7 +22404,7 @@
22414
22404
  "type": {
22415
22405
  "text": "string | undefined"
22416
22406
  },
22417
- "description": "Custom validation message that will override the default message and displayed when the input is invalid.",
22407
+ "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.",
22418
22408
  "fieldName": "validationMessage",
22419
22409
  "inheritedFrom": {
22420
22410
  "name": "FormInternalsMixin",
@@ -22456,188 +22446,1463 @@
22456
22446
  "default": "'full-width'",
22457
22447
  "fieldName": "variant",
22458
22448
  "inheritedFrom": {
22459
- "name": "ListItem",
22460
- "module": "src/components/listitem/listitem.component.ts"
22449
+ "name": "ListItem",
22450
+ "module": "src/components/listitem/listitem.component.ts"
22451
+ }
22452
+ },
22453
+ {
22454
+ "name": "label",
22455
+ "type": {
22456
+ "text": "string | undefined"
22457
+ },
22458
+ "description": "The primary label of the list item.\nThis appears on the leading side of the list item.",
22459
+ "fieldName": "label",
22460
+ "inheritedFrom": {
22461
+ "name": "ListItem",
22462
+ "module": "src/components/listitem/listitem.component.ts"
22463
+ }
22464
+ },
22465
+ {
22466
+ "name": "secondary-label",
22467
+ "type": {
22468
+ "text": "string | undefined"
22469
+ },
22470
+ "description": "The secondary label of the list item.\nThis appears on the leading side of the list item.",
22471
+ "fieldName": "secondaryLabel",
22472
+ "inheritedFrom": {
22473
+ "name": "ListItem",
22474
+ "module": "src/components/listitem/listitem.component.ts"
22475
+ }
22476
+ },
22477
+ {
22478
+ "name": "tertiary-label",
22479
+ "type": {
22480
+ "text": "string | undefined"
22481
+ },
22482
+ "description": "The tertiary label of the list item.\nThis appears on the leading side of the list item.",
22483
+ "fieldName": "tertiaryLabel",
22484
+ "inheritedFrom": {
22485
+ "name": "ListItem",
22486
+ "module": "src/components/listitem/listitem.component.ts"
22487
+ }
22488
+ },
22489
+ {
22490
+ "name": "side-header-text",
22491
+ "type": {
22492
+ "text": "string | undefined"
22493
+ },
22494
+ "description": "The header text of the list item.\nThis appears on the trailing side of the list item.",
22495
+ "fieldName": "sideHeaderText",
22496
+ "inheritedFrom": {
22497
+ "name": "ListItem",
22498
+ "module": "src/components/listitem/listitem.component.ts"
22499
+ }
22500
+ },
22501
+ {
22502
+ "name": "subline-text",
22503
+ "type": {
22504
+ "text": "string | undefined"
22505
+ },
22506
+ "description": "The subline text of the list item.\nThis appears on the trailing side of the list item.",
22507
+ "fieldName": "sublineText",
22508
+ "inheritedFrom": {
22509
+ "name": "ListItem",
22510
+ "module": "src/components/listitem/listitem.component.ts"
22511
+ }
22512
+ },
22513
+ {
22514
+ "name": "soft-disabled",
22515
+ "type": {
22516
+ "text": "boolean | undefined"
22517
+ },
22518
+ "description": "Indicates whether the element is soft disabled.\nWhen set to `true`, the element appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe element behaves like a disabled element, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
22519
+ "default": "undefined",
22520
+ "fieldName": "softDisabled",
22521
+ "inheritedFrom": {
22522
+ "name": "ListItem",
22523
+ "module": "src/components/listitem/listitem.component.ts"
22524
+ }
22525
+ },
22526
+ {
22527
+ "name": "tooltip-text",
22528
+ "type": {
22529
+ "text": "string | undefined"
22530
+ },
22531
+ "description": "The tooltip text is displayed on hover of the list item.",
22532
+ "fieldName": "tooltipText",
22533
+ "inheritedFrom": {
22534
+ "name": "ListItem",
22535
+ "module": "src/components/listitem/listitem.component.ts"
22536
+ }
22537
+ },
22538
+ {
22539
+ "name": "tooltip-placement",
22540
+ "type": {
22541
+ "text": "PopoverPlacement"
22542
+ },
22543
+ "description": "The tooltip placement of the list item. If the tooltip text is present,\nthen this tooltip placement will be applied.",
22544
+ "default": "'top'",
22545
+ "fieldName": "tooltipPlacement",
22546
+ "inheritedFrom": {
22547
+ "name": "ListItem",
22548
+ "module": "src/components/listitem/listitem.component.ts"
22549
+ }
22550
+ }
22551
+ ],
22552
+ "mixins": [
22553
+ {
22554
+ "name": "FormInternalsMixin",
22555
+ "module": "/src/utils/mixins/FormInternalsMixin"
22556
+ }
22557
+ ],
22558
+ "superclass": {
22559
+ "name": "ListItem",
22560
+ "module": "/src/components/listitem/listitem.component"
22561
+ },
22562
+ "tagName": "mdc-option",
22563
+ "jsDoc": "/**\n * option component, which is used as a list item in a select component.<br/>\n * We can pass an icon which will be displayed in leading position of the option label text.\n * We can pass a tooltip which will be displayed on hover of the option label text.\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 * @slot default - This is a default/unnamed slot\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 */",
22564
+ "customElement": true,
22565
+ "cssProperties": [
22566
+ {
22567
+ "description": "Allows customization of the default background color.",
22568
+ "name": "--mdc-listitem-default-background-color",
22569
+ "inheritedFrom": {
22570
+ "name": "ListItem",
22571
+ "module": "src/components/listitem/listitem.component.ts"
22572
+ }
22573
+ },
22574
+ {
22575
+ "description": "Allows customization of the background color on hover.",
22576
+ "name": "--mdc-listitem-background-color-hover",
22577
+ "inheritedFrom": {
22578
+ "name": "ListItem",
22579
+ "module": "src/components/listitem/listitem.component.ts"
22580
+ }
22581
+ },
22582
+ {
22583
+ "description": "Allows customization of the background color when pressed.",
22584
+ "name": "--mdc-listitem-background-color-active",
22585
+ "inheritedFrom": {
22586
+ "name": "ListItem",
22587
+ "module": "src/components/listitem/listitem.component.ts"
22588
+ }
22589
+ },
22590
+ {
22591
+ "description": "Allows customization of the primary label, side header and subline text slot color.",
22592
+ "name": "--mdc-listitem-primary-label-color",
22593
+ "inheritedFrom": {
22594
+ "name": "ListItem",
22595
+ "module": "src/components/listitem/listitem.component.ts"
22596
+ }
22597
+ },
22598
+ {
22599
+ "description": "Allows customization of the secondary and tertiary label text slot color.",
22600
+ "name": "--mdc-listitem-secondary-label-color",
22601
+ "inheritedFrom": {
22602
+ "name": "ListItem",
22603
+ "module": "src/components/listitem/listitem.component.ts"
22604
+ }
22605
+ },
22606
+ {
22607
+ "description": "Allows customization of the disabled color.",
22608
+ "name": "--mdc-listitem-disabled-color",
22609
+ "inheritedFrom": {
22610
+ "name": "ListItem",
22611
+ "module": "src/components/listitem/listitem.component.ts"
22612
+ }
22613
+ },
22614
+ {
22615
+ "description": "Allows customization of column gap.",
22616
+ "name": "--mdc-listitem-column-gap",
22617
+ "inheritedFrom": {
22618
+ "name": "ListItem",
22619
+ "module": "src/components/listitem/listitem.component.ts"
22620
+ }
22621
+ },
22622
+ {
22623
+ "description": "Allows customization of padding left and right.",
22624
+ "name": "--mdc-listitem-padding-left-and-right",
22625
+ "inheritedFrom": {
22626
+ "name": "ListItem",
22627
+ "module": "src/components/listitem/listitem.component.ts"
22628
+ }
22629
+ }
22630
+ ]
22631
+ }
22632
+ ],
22633
+ "exports": [
22634
+ {
22635
+ "kind": "js",
22636
+ "name": "default",
22637
+ "declaration": {
22638
+ "name": "Option",
22639
+ "module": "components/option/option.component.js"
22640
+ }
22641
+ }
22642
+ ]
22643
+ },
22644
+ {
22645
+ "kind": "javascript-module",
22646
+ "path": "components/password/password.component.js",
22647
+ "declarations": [
22648
+ {
22649
+ "kind": "class",
22650
+ "description": "`mdc-password` is a component that allows users to input their password.\n It extends the `mdc-input` component and provides additional features specific to password fields.\n It contains:\n- `label` field - describe the password field.\n- `password` field - contains the value\n- `help-text` or `validation-message` - displayed below the password field.\n- `help-text-type` - type of the help text, can be 'default', 'error', 'warning', 'success', 'priority'.\n- `show-hide-button-aria-label` - aria label for the trailing show/hide button.\n- all the attributes of the native password field.",
22651
+ "name": "Password",
22652
+ "cssProperties": [
22653
+ {
22654
+ "description": "Border color for the password container when disabled",
22655
+ "name": "--mdc-input-disabled-border-color",
22656
+ "inheritedFrom": {
22657
+ "name": "Input",
22658
+ "module": "src/components/input/input.component.ts"
22659
+ }
22660
+ },
22661
+ {
22662
+ "description": "Text color for the password field when disabled",
22663
+ "name": "--mdc-input-disabled-text-color",
22664
+ "inheritedFrom": {
22665
+ "name": "Input",
22666
+ "module": "src/components/input/input.component.ts"
22667
+ }
22668
+ },
22669
+ {
22670
+ "description": "Background color for the password field when disabled",
22671
+ "name": "--mdc-input-disabled-background-color",
22672
+ "inheritedFrom": {
22673
+ "name": "Input",
22674
+ "module": "src/components/input/input.component.ts"
22675
+ }
22676
+ },
22677
+ {
22678
+ "description": "Border color for the password container",
22679
+ "name": "--mdc-input-border-color",
22680
+ "inheritedFrom": {
22681
+ "name": "Input",
22682
+ "module": "src/components/input/input.component.ts"
22683
+ }
22684
+ },
22685
+ {
22686
+ "description": "Text color for the password field",
22687
+ "name": "--mdc-input-text-color",
22688
+ "inheritedFrom": {
22689
+ "name": "Input",
22690
+ "module": "src/components/input/input.component.ts"
22691
+ }
22692
+ },
22693
+ {
22694
+ "description": "Background color for the password field",
22695
+ "name": "--mdc-input-background-color",
22696
+ "inheritedFrom": {
22697
+ "name": "Input",
22698
+ "module": "src/components/input/input.component.ts"
22699
+ }
22700
+ },
22701
+ {
22702
+ "description": "Background color for the selected text",
22703
+ "name": "--mdc-input-selection-background-color",
22704
+ "inheritedFrom": {
22705
+ "name": "Input",
22706
+ "module": "src/components/input/input.component.ts"
22707
+ }
22708
+ },
22709
+ {
22710
+ "description": "Text color for the selected text",
22711
+ "name": "--mdc-input-selection-text-color",
22712
+ "inheritedFrom": {
22713
+ "name": "Input",
22714
+ "module": "src/components/input/input.component.ts"
22715
+ }
22716
+ },
22717
+ {
22718
+ "description": "Text color for the help text",
22719
+ "name": "--mdc-input-support-text-color",
22720
+ "inheritedFrom": {
22721
+ "name": "Input",
22722
+ "module": "src/components/input/input.component.ts"
22723
+ }
22724
+ },
22725
+ {
22726
+ "description": "Background color for the password field when hovered",
22727
+ "name": "--mdc-input-hover-background-color",
22728
+ "inheritedFrom": {
22729
+ "name": "Input",
22730
+ "module": "src/components/input/input.component.ts"
22731
+ }
22732
+ },
22733
+ {
22734
+ "description": "Background color for the password field when focused",
22735
+ "name": "--mdc-input-focused-background-color",
22736
+ "inheritedFrom": {
22737
+ "name": "Input",
22738
+ "module": "src/components/input/input.component.ts"
22739
+ }
22740
+ },
22741
+ {
22742
+ "description": "Border color for the password container when focused",
22743
+ "name": "--mdc-input-focused-border-color",
22744
+ "inheritedFrom": {
22745
+ "name": "Input",
22746
+ "module": "src/components/input/input.component.ts"
22747
+ }
22748
+ },
22749
+ {
22750
+ "description": "Border color for the password container when error",
22751
+ "name": "--mdc-input-error-border-color",
22752
+ "inheritedFrom": {
22753
+ "name": "Input",
22754
+ "module": "src/components/input/input.component.ts"
22755
+ }
22756
+ },
22757
+ {
22758
+ "description": "Border color for the password container when warning",
22759
+ "name": "--mdc-input-warning-border-color",
22760
+ "inheritedFrom": {
22761
+ "name": "Input",
22762
+ "module": "src/components/input/input.component.ts"
22763
+ }
22764
+ },
22765
+ {
22766
+ "description": "Border color for the password container when success",
22767
+ "name": "--mdc-input-success-border-color",
22768
+ "inheritedFrom": {
22769
+ "name": "Input",
22770
+ "module": "src/components/input/input.component.ts"
22771
+ }
22772
+ },
22773
+ {
22774
+ "description": "Border color for the password container when primary",
22775
+ "name": "--mdc-input-primary-border-color",
22776
+ "inheritedFrom": {
22777
+ "name": "Input",
22778
+ "module": "src/components/input/input.component.ts"
22779
+ }
22780
+ }
22781
+ ],
22782
+ "members": [
22783
+ {
22784
+ "kind": "field",
22785
+ "name": "showHideButtonAriaLabel",
22786
+ "type": {
22787
+ "text": "string"
22788
+ },
22789
+ "default": "''",
22790
+ "description": "Aria label for the show or hide password icon button.",
22791
+ "attribute": "show-hide-button-aria-label"
22792
+ },
22793
+ {
22794
+ "kind": "field",
22795
+ "name": "helpTextType",
22796
+ "type": {
22797
+ "text": "ValidationType"
22798
+ },
22799
+ "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
22800
+ "attribute": "help-text-type",
22801
+ "reflects": true,
22802
+ "inheritedFrom": {
22803
+ "name": "FormfieldWrapper",
22804
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
22805
+ }
22806
+ },
22807
+ {
22808
+ "kind": "field",
22809
+ "name": "showPassword",
22810
+ "type": {
22811
+ "text": "boolean"
22812
+ },
22813
+ "privacy": "private",
22814
+ "default": "false",
22815
+ "description": "Internal state to track whether the password is visible (shown as text) or hidden (shown as password)."
22816
+ },
22817
+ {
22818
+ "kind": "method",
22819
+ "name": "toggleShowPassword",
22820
+ "privacy": "private",
22821
+ "description": "Toggles the visibility of the password."
22822
+ },
22823
+ {
22824
+ "kind": "method",
22825
+ "name": "renderTrailingButton",
22826
+ "privacy": "protected",
22827
+ "parameters": [
22828
+ {
22829
+ "name": "show",
22830
+ "default": "false"
22831
+ }
22832
+ ],
22833
+ "description": "Renders the trailing button for showing or hiding the password.",
22834
+ "return": {
22835
+ "type": {
22836
+ "text": ""
22837
+ }
22838
+ },
22839
+ "inheritedFrom": {
22840
+ "name": "Input",
22841
+ "module": "components/input/input.component.js"
22842
+ }
22843
+ },
22844
+ {
22845
+ "kind": "method",
22846
+ "name": "renderInputElement",
22847
+ "privacy": "protected",
22848
+ "parameters": [
22849
+ {
22850
+ "name": "_",
22851
+ "type": {
22852
+ "text": "InputType"
22853
+ }
22854
+ },
22855
+ {
22856
+ "name": "hidePlaceholder",
22857
+ "optional": true,
22858
+ "type": {
22859
+ "text": "boolean"
22860
+ }
22861
+ }
22862
+ ],
22863
+ "description": "Renders the input element for the password field.",
22864
+ "inheritedFrom": {
22865
+ "name": "Input",
22866
+ "module": "components/input/input.component.js"
22867
+ }
22868
+ },
22869
+ {
22870
+ "kind": "field",
22871
+ "name": "name",
22872
+ "type": {
22873
+ "text": "string"
22874
+ },
22875
+ "default": "''",
22876
+ "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
22877
+ "attribute": "name",
22878
+ "reflects": true,
22879
+ "inheritedFrom": {
22880
+ "name": "FormInternalsMixin",
22881
+ "module": "utils/mixins/FormInternalsMixin.js"
22882
+ }
22883
+ },
22884
+ {
22885
+ "kind": "field",
22886
+ "name": "value",
22887
+ "type": {
22888
+ "text": "string"
22889
+ },
22890
+ "default": "''",
22891
+ "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
22892
+ "attribute": "value",
22893
+ "reflects": true,
22894
+ "inheritedFrom": {
22895
+ "name": "FormInternalsMixin",
22896
+ "module": "utils/mixins/FormInternalsMixin.js"
22897
+ }
22898
+ },
22899
+ {
22900
+ "kind": "field",
22901
+ "name": "validationMessage",
22902
+ "type": {
22903
+ "text": "string | undefined"
22904
+ },
22905
+ "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.",
22906
+ "attribute": "validation-message",
22907
+ "reflects": true,
22908
+ "inheritedFrom": {
22909
+ "name": "FormInternalsMixin",
22910
+ "module": "utils/mixins/FormInternalsMixin.js"
22911
+ }
22912
+ },
22913
+ {
22914
+ "kind": "field",
22915
+ "name": "validity",
22916
+ "type": {
22917
+ "text": "ValidityState"
22918
+ },
22919
+ "readonly": true,
22920
+ "inheritedFrom": {
22921
+ "name": "FormInternalsMixin",
22922
+ "module": "utils/mixins/FormInternalsMixin.js"
22923
+ }
22924
+ },
22925
+ {
22926
+ "kind": "field",
22927
+ "name": "willValidate",
22928
+ "readonly": true,
22929
+ "inheritedFrom": {
22930
+ "name": "FormInternalsMixin",
22931
+ "module": "utils/mixins/FormInternalsMixin.js"
22932
+ }
22933
+ },
22934
+ {
22935
+ "kind": "method",
22936
+ "name": "setValidity",
22937
+ "description": "Sets the validity of the input field based on the input field's validity.",
22938
+ "return": {
22939
+ "type": {
22940
+ "text": ""
22941
+ }
22942
+ },
22943
+ "inheritedFrom": {
22944
+ "name": "FormInternalsMixin",
22945
+ "module": "utils/mixins/FormInternalsMixin.js"
22946
+ }
22947
+ },
22948
+ {
22949
+ "kind": "method",
22950
+ "name": "checkValidity",
22951
+ "return": {
22952
+ "type": {
22953
+ "text": "boolean"
22954
+ }
22955
+ },
22956
+ "inheritedFrom": {
22957
+ "name": "FormInternalsMixin",
22958
+ "module": "utils/mixins/FormInternalsMixin.js"
22959
+ }
22960
+ },
22961
+ {
22962
+ "kind": "method",
22963
+ "name": "reportValidity",
22964
+ "inheritedFrom": {
22965
+ "name": "FormInternalsMixin",
22966
+ "module": "utils/mixins/FormInternalsMixin.js"
22967
+ }
22968
+ },
22969
+ {
22970
+ "kind": "field",
22971
+ "name": "dataAriaLabel",
22972
+ "type": {
22973
+ "text": "string | null"
22974
+ },
22975
+ "default": "null",
22976
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
22977
+ "attribute": "data-aria-label",
22978
+ "reflects": true,
22979
+ "inheritedFrom": {
22980
+ "name": "DataAriaLabelMixin",
22981
+ "module": "utils/mixins/DataAriaLabelMixin.js"
22982
+ }
22983
+ },
22984
+ {
22985
+ "kind": "field",
22986
+ "name": "placeholder",
22987
+ "type": {
22988
+ "text": "string"
22989
+ },
22990
+ "default": "''",
22991
+ "description": "The placeholder text that is displayed when the input field is empty.",
22992
+ "attribute": "placeholder",
22993
+ "inheritedFrom": {
22994
+ "name": "Input",
22995
+ "module": "components/input/input.component.js"
22996
+ }
22997
+ },
22998
+ {
22999
+ "kind": "field",
23000
+ "name": "readonly",
23001
+ "type": {
23002
+ "text": "boolean"
23003
+ },
23004
+ "default": "false",
23005
+ "description": "readonly attribute of the input field. If true, the input field is read-only.",
23006
+ "attribute": "readonly",
23007
+ "inheritedFrom": {
23008
+ "name": "Input",
23009
+ "module": "components/input/input.component.js"
23010
+ }
23011
+ },
23012
+ {
23013
+ "kind": "field",
23014
+ "name": "prefixText",
23015
+ "type": {
23016
+ "text": "string | undefined"
23017
+ },
23018
+ "description": "The prefix text that is displayed before the input field. It has a max length of 10 characters.\nWhen the prefix text is set, make sure to set the 'data-aria-label'\nattribute with the appropriate value for accessibility.",
23019
+ "attribute": "prefix-text",
23020
+ "inheritedFrom": {
23021
+ "name": "Input",
23022
+ "module": "components/input/input.component.js"
23023
+ }
23024
+ },
23025
+ {
23026
+ "kind": "field",
23027
+ "name": "leadingIcon",
23028
+ "type": {
23029
+ "text": "IconNames | undefined"
23030
+ },
23031
+ "description": "The leading icon that is displayed before the input field.",
23032
+ "attribute": "leading-icon",
23033
+ "inheritedFrom": {
23034
+ "name": "Input",
23035
+ "module": "components/input/input.component.js"
23036
+ }
23037
+ },
23038
+ {
23039
+ "kind": "field",
23040
+ "name": "trailingButton",
23041
+ "type": {
23042
+ "text": "boolean"
23043
+ },
23044
+ "default": "false",
23045
+ "description": "The trailing button when set to true, shows a clear button that clears the input field.",
23046
+ "attribute": "trailing-button",
23047
+ "inheritedFrom": {
23048
+ "name": "Input",
23049
+ "module": "components/input/input.component.js"
23050
+ }
23051
+ },
23052
+ {
23053
+ "kind": "field",
23054
+ "name": "maxlength",
23055
+ "type": {
23056
+ "text": "number | undefined"
23057
+ },
23058
+ "description": "The maximum number of characters that the input field can accept.",
23059
+ "attribute": "maxlength",
23060
+ "inheritedFrom": {
23061
+ "name": "Input",
23062
+ "module": "components/input/input.component.js"
23063
+ }
23064
+ },
23065
+ {
23066
+ "kind": "field",
23067
+ "name": "minlength",
23068
+ "type": {
23069
+ "text": "number | undefined"
23070
+ },
23071
+ "description": "The minimum number of characters that the input field can accept.",
23072
+ "attribute": "minlength",
23073
+ "inheritedFrom": {
23074
+ "name": "Input",
23075
+ "module": "components/input/input.component.js"
23076
+ }
23077
+ },
23078
+ {
23079
+ "kind": "field",
23080
+ "name": "autocapitalize",
23081
+ "type": {
23082
+ "text": "AutoCapitalizeType"
23083
+ },
23084
+ "description": "The autocapitalize attribute of the input field.",
23085
+ "default": "'off'",
23086
+ "attribute": "autocapitalize",
23087
+ "inheritedFrom": {
23088
+ "name": "Input",
23089
+ "module": "components/input/input.component.js"
23090
+ }
23091
+ },
23092
+ {
23093
+ "kind": "field",
23094
+ "name": "autocomplete",
23095
+ "type": {
23096
+ "text": "AutoCompleteType"
23097
+ },
23098
+ "description": "The autocomplete attribute of the input field.",
23099
+ "default": "'off'",
23100
+ "attribute": "autocomplete",
23101
+ "inheritedFrom": {
23102
+ "name": "Input",
23103
+ "module": "components/input/input.component.js"
23104
+ }
23105
+ },
23106
+ {
23107
+ "kind": "field",
23108
+ "name": "autofocus",
23109
+ "type": {
23110
+ "text": "boolean"
23111
+ },
23112
+ "default": "false",
23113
+ "description": "If true, the input field is focused when the component is rendered.",
23114
+ "attribute": "autofocus",
23115
+ "inheritedFrom": {
23116
+ "name": "Input",
23117
+ "module": "components/input/input.component.js"
23118
+ }
23119
+ },
23120
+ {
23121
+ "kind": "field",
23122
+ "name": "dirname",
23123
+ "type": {
23124
+ "text": "string | undefined"
23125
+ },
23126
+ "description": "Specifies the name of the directionality of text for submission purposes (e.g., \"rtl\" for right-to-left).",
23127
+ "attribute": "dirname",
23128
+ "inheritedFrom": {
23129
+ "name": "Input",
23130
+ "module": "components/input/input.component.js"
23131
+ }
23132
+ },
23133
+ {
23134
+ "kind": "field",
23135
+ "name": "pattern",
23136
+ "type": {
23137
+ "text": "string | undefined"
23138
+ },
23139
+ "description": "The pattern attribute of the input field.\nSpecifies a regular expression that the input value must match for validation purposes.",
23140
+ "attribute": "pattern",
23141
+ "inheritedFrom": {
23142
+ "name": "Input",
23143
+ "module": "components/input/input.component.js"
23144
+ }
23145
+ },
23146
+ {
23147
+ "kind": "field",
23148
+ "name": "list",
23149
+ "type": {
23150
+ "text": "string | undefined"
23151
+ },
23152
+ "description": "The list attribute of the input field.\nIdentifies a list of pre-defined options to suggest to the user.",
23153
+ "attribute": "list",
23154
+ "inheritedFrom": {
23155
+ "name": "Input",
23156
+ "module": "components/input/input.component.js"
23157
+ }
23158
+ },
23159
+ {
23160
+ "kind": "field",
23161
+ "name": "size",
23162
+ "type": {
23163
+ "text": "number | undefined | undefined"
23164
+ },
23165
+ "description": "The size attribute of the input field.\nSpecifies the width of the input field.",
23166
+ "default": "undefined",
23167
+ "attribute": "size",
23168
+ "inheritedFrom": {
23169
+ "name": "Input",
23170
+ "module": "components/input/input.component.js"
23171
+ }
23172
+ },
23173
+ {
23174
+ "kind": "field",
23175
+ "name": "clearAriaLabel",
23176
+ "type": {
23177
+ "text": "string"
23178
+ },
23179
+ "default": "''",
23180
+ "description": "Aria label for the trailing button. If trailing button is set to true, this label is used for the clear button.",
23181
+ "attribute": "clear-aria-label",
23182
+ "inheritedFrom": {
23183
+ "name": "Input",
23184
+ "module": "components/input/input.component.js"
23185
+ }
23186
+ },
23187
+ {
23188
+ "kind": "method",
23189
+ "name": "setInputValidity",
23190
+ "privacy": "private",
23191
+ "inheritedFrom": {
23192
+ "name": "Input",
23193
+ "module": "components/input/input.component.js"
23194
+ }
23195
+ },
23196
+ {
23197
+ "kind": "method",
23198
+ "name": "updateValue",
23199
+ "privacy": "private",
23200
+ "description": "Updates the value of the input field.\nSets the form value.",
23201
+ "return": {
23202
+ "type": {
23203
+ "text": ""
23204
+ }
23205
+ },
23206
+ "inheritedFrom": {
23207
+ "name": "Input",
23208
+ "module": "components/input/input.component.js"
23209
+ }
23210
+ },
23211
+ {
23212
+ "kind": "method",
23213
+ "name": "onInput",
23214
+ "privacy": "private",
23215
+ "description": "Handles the input event of the input field.\nUpdates the value and sets the validity of the input field.",
23216
+ "inheritedFrom": {
23217
+ "name": "Input",
23218
+ "module": "components/input/input.component.js"
23219
+ }
23220
+ },
23221
+ {
23222
+ "kind": "method",
23223
+ "name": "onChange",
23224
+ "privacy": "private",
23225
+ "parameters": [
23226
+ {
23227
+ "name": "event",
23228
+ "type": {
23229
+ "text": "Event"
23230
+ },
23231
+ "description": "Event which contains information about the value change."
23232
+ }
23233
+ ],
23234
+ "description": "Handles the change event of the input field.\nUpdates the value and sets the validity of the input field.\n\nThe 'change' event does not bubble up through the shadow DOM as it was not composed.\nTherefore, we need to re-dispatch the same event to ensure it is propagated correctly.\nRead more: https://developer.mozilla.org/en-US/docs/Web/API/Event/composed",
23235
+ "inheritedFrom": {
23236
+ "name": "Input",
23237
+ "module": "components/input/input.component.js"
23238
+ }
23239
+ },
23240
+ {
23241
+ "kind": "method",
23242
+ "name": "handleKeyDown",
23243
+ "privacy": "protected",
23244
+ "parameters": [
23245
+ {
23246
+ "name": "event",
23247
+ "type": {
23248
+ "text": "KeyboardEvent"
23249
+ },
23250
+ "description": "Keyboard event"
23251
+ }
23252
+ ],
23253
+ "description": "Handles the keydown event of the input field.\nIf the key pressed is 'Enter', it submits the form.",
23254
+ "inheritedFrom": {
23255
+ "name": "Input",
23256
+ "module": "components/input/input.component.js"
23257
+ }
23258
+ },
23259
+ {
23260
+ "kind": "method",
23261
+ "name": "renderLeadingIcon",
23262
+ "privacy": "protected",
23263
+ "description": "Renders the leading icon before the input field.\nIf the leading icon is not set, it will not be displayed.",
23264
+ "return": {
23265
+ "type": {
23266
+ "text": ""
23267
+ }
23268
+ },
23269
+ "inheritedFrom": {
23270
+ "name": "Input",
23271
+ "module": "components/input/input.component.js"
23272
+ }
23273
+ },
23274
+ {
23275
+ "kind": "method",
23276
+ "name": "renderPrefixText",
23277
+ "privacy": "protected",
23278
+ "description": "Renders the prefix text before the input field.\nIf the prefix text is more than 10 characters,\n- it will not be displayed.\n- the validation messsage will be displayed.\n\n Note: We are setting aria-hidden so that the screen reader does not read the prefix text.\n The consumers should set the appropriate aria-label for the input field using 'data-aria-label' attribute.",
23279
+ "return": {
23280
+ "type": {
23281
+ "text": ""
23282
+ }
23283
+ },
23284
+ "inheritedFrom": {
23285
+ "name": "Input",
23286
+ "module": "components/input/input.component.js"
23287
+ }
23288
+ },
23289
+ {
23290
+ "kind": "method",
23291
+ "name": "clearInputText",
23292
+ "privacy": "protected",
23293
+ "description": "Clears the input field.",
23294
+ "inheritedFrom": {
23295
+ "name": "Input",
23296
+ "module": "components/input/input.component.js"
23297
+ }
23298
+ },
23299
+ {
23300
+ "kind": "field",
23301
+ "name": "disabled",
23302
+ "type": {
23303
+ "text": "boolean | undefined"
23304
+ },
23305
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
23306
+ "default": "undefined",
23307
+ "attribute": "disabled",
23308
+ "reflects": true,
23309
+ "inheritedFrom": {
23310
+ "name": "FormfieldWrapper",
23311
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
23312
+ }
23313
+ },
23314
+ {
23315
+ "kind": "field",
23316
+ "name": "label",
23317
+ "type": {
23318
+ "text": "string | undefined"
23319
+ },
23320
+ "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
23321
+ "attribute": "label",
23322
+ "reflects": true,
23323
+ "inheritedFrom": {
23324
+ "name": "FormfieldWrapper",
23325
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
23326
+ }
23327
+ },
23328
+ {
23329
+ "kind": "field",
23330
+ "name": "required",
23331
+ "type": {
23332
+ "text": "boolean"
23333
+ },
23334
+ "default": "false",
23335
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
23336
+ "attribute": "required",
23337
+ "reflects": true,
23338
+ "inheritedFrom": {
23339
+ "name": "FormfieldWrapper",
23340
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
23341
+ }
23342
+ },
23343
+ {
23344
+ "kind": "field",
23345
+ "name": "id",
23346
+ "type": {
23347
+ "text": "string"
23348
+ },
23349
+ "default": "''",
23350
+ "description": "The unique id of the input field. It is used to link the input field with the label.",
23351
+ "attribute": "id",
23352
+ "inheritedFrom": {
23353
+ "name": "FormfieldWrapper",
23354
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
23355
+ }
23356
+ },
23357
+ {
23358
+ "kind": "field",
23359
+ "name": "helpText",
23360
+ "type": {
23361
+ "text": "string | undefined"
23362
+ },
23363
+ "description": "The help text that is displayed below the input field.",
23364
+ "attribute": "help-text",
23365
+ "reflects": true,
23366
+ "inheritedFrom": {
23367
+ "name": "FormfieldWrapper",
23368
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
23369
+ }
23370
+ },
23371
+ {
23372
+ "kind": "field",
23373
+ "name": "toggletipText",
23374
+ "type": {
23375
+ "text": "string | undefined"
23376
+ },
23377
+ "description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
23378
+ "attribute": "toggletip-text",
23379
+ "reflects": true,
23380
+ "inheritedFrom": {
23381
+ "name": "FormfieldWrapper",
23382
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
23383
+ }
23384
+ },
23385
+ {
23386
+ "kind": "field",
23387
+ "name": "toggletipPlacement",
23388
+ "type": {
23389
+ "text": "PopoverPlacement"
23390
+ },
23391
+ "description": "The placement of the toggletip that is displayed when the info icon is hovered.",
23392
+ "default": "'top'",
23393
+ "attribute": "toggletip-placement",
23394
+ "reflects": true,
23395
+ "inheritedFrom": {
23396
+ "name": "FormfieldWrapper",
23397
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
23398
+ }
23399
+ },
23400
+ {
23401
+ "kind": "field",
23402
+ "name": "infoIconAriaLabel",
23403
+ "type": {
23404
+ "text": "string | undefined"
23405
+ },
23406
+ "description": "Aria label for the info icon that is displayed next to the label when `toggletipText` is set.\nThis is used for accessibility purposes to provide a description of the icon.",
23407
+ "attribute": "info-icon-aria-label",
23408
+ "reflects": true,
23409
+ "inheritedFrom": {
23410
+ "name": "FormfieldWrapper",
23411
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
23412
+ }
23413
+ },
23414
+ {
23415
+ "kind": "method",
23416
+ "name": "renderLabelElement",
23417
+ "privacy": "protected",
23418
+ "description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
23419
+ "return": {
23420
+ "type": {
23421
+ "text": ""
23422
+ }
23423
+ },
23424
+ "inheritedFrom": {
23425
+ "name": "FormfieldWrapper",
23426
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
23427
+ }
23428
+ },
23429
+ {
23430
+ "kind": "method",
23431
+ "name": "renderHelpTextIcon",
23432
+ "privacy": "protected",
23433
+ "description": "creates the helpertext icon based on the helpTextType for validation.\nIf the helpTextType is not set, it defaults to 'default' and it doesn't display any icon.",
23434
+ "return": {
23435
+ "type": {
23436
+ "text": ""
23437
+ }
23438
+ },
23439
+ "inheritedFrom": {
23440
+ "name": "FormfieldWrapper",
23441
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
23442
+ }
23443
+ },
23444
+ {
23445
+ "kind": "method",
23446
+ "name": "renderHelpText",
23447
+ "privacy": "protected",
23448
+ "description": "creates the helper text component when the helpertext value is set.\nIt is also used to display the validation message based on the helpTextType.",
23449
+ "return": {
23450
+ "type": {
23451
+ "text": ""
23452
+ }
23453
+ },
23454
+ "inheritedFrom": {
23455
+ "name": "FormfieldWrapper",
23456
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
23457
+ }
23458
+ },
23459
+ {
23460
+ "kind": "method",
23461
+ "name": "renderLabel",
23462
+ "privacy": "protected",
23463
+ "description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
23464
+ "return": {
23465
+ "type": {
23466
+ "text": ""
23467
+ }
23468
+ },
23469
+ "inheritedFrom": {
23470
+ "name": "FormfieldWrapper",
23471
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
23472
+ }
23473
+ },
23474
+ {
23475
+ "kind": "method",
23476
+ "name": "renderHelperText",
23477
+ "privacy": "protected",
23478
+ "description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
23479
+ "return": {
23480
+ "type": {
23481
+ "text": ""
23482
+ }
23483
+ },
23484
+ "inheritedFrom": {
23485
+ "name": "FormfieldWrapper",
23486
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
23487
+ }
23488
+ }
23489
+ ],
23490
+ "events": [
23491
+ {
23492
+ "description": "(React: onInput) This event is dispatched when the value of the password field changes (every press).",
23493
+ "name": "input",
23494
+ "reactName": "onInput",
23495
+ "inheritedFrom": {
23496
+ "name": "Input",
23497
+ "module": "src/components/input/input.component.ts"
23498
+ }
23499
+ },
23500
+ {
23501
+ "description": "(React: onChange) This event is dispatched when the value of the password field changes (on blur).",
23502
+ "name": "change",
23503
+ "reactName": "onChange",
23504
+ "inheritedFrom": {
23505
+ "name": "Input",
23506
+ "module": "src/components/input/input.component.ts"
23507
+ }
23508
+ },
23509
+ {
23510
+ "description": "(React: onFocus) This event is dispatched when the password receives focus.",
23511
+ "name": "focus",
23512
+ "reactName": "onFocus",
23513
+ "inheritedFrom": {
23514
+ "name": "Input",
23515
+ "module": "src/components/input/input.component.ts"
23516
+ }
23517
+ },
23518
+ {
23519
+ "description": "(React: onBlur) This event is dispatched when the password loses focus.",
23520
+ "name": "blur",
23521
+ "reactName": "onBlur",
23522
+ "inheritedFrom": {
23523
+ "name": "Input",
23524
+ "module": "src/components/input/input.component.ts"
23525
+ }
23526
+ },
23527
+ {
23528
+ "type": {
23529
+ "text": "EventConstructor"
23530
+ },
23531
+ "inheritedFrom": {
23532
+ "name": "Input",
23533
+ "module": "src/components/input/input.component.ts"
23534
+ }
23535
+ }
23536
+ ],
23537
+ "attributes": [
23538
+ {
23539
+ "name": "show-hide-button-aria-label",
23540
+ "type": {
23541
+ "text": "string"
23542
+ },
23543
+ "default": "''",
23544
+ "description": "Aria label for the show or hide password icon button.",
23545
+ "fieldName": "showHideButtonAriaLabel"
23546
+ },
23547
+ {
23548
+ "name": "help-text-type",
23549
+ "type": {
23550
+ "text": "ValidationType"
23551
+ },
23552
+ "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
23553
+ "fieldName": "helpTextType",
23554
+ "inheritedFrom": {
23555
+ "name": "FormfieldWrapper",
23556
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
23557
+ }
23558
+ },
23559
+ {
23560
+ "name": "name",
23561
+ "type": {
23562
+ "text": "string"
23563
+ },
23564
+ "default": "''",
23565
+ "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
23566
+ "fieldName": "name",
23567
+ "inheritedFrom": {
23568
+ "name": "FormInternalsMixin",
23569
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
23570
+ }
23571
+ },
23572
+ {
23573
+ "name": "value",
23574
+ "type": {
23575
+ "text": "string"
23576
+ },
23577
+ "default": "''",
23578
+ "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
23579
+ "fieldName": "value",
23580
+ "inheritedFrom": {
23581
+ "name": "FormInternalsMixin",
23582
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
23583
+ }
23584
+ },
23585
+ {
23586
+ "name": "validation-message",
23587
+ "type": {
23588
+ "text": "string | undefined"
23589
+ },
23590
+ "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.",
23591
+ "fieldName": "validationMessage",
23592
+ "inheritedFrom": {
23593
+ "name": "FormInternalsMixin",
23594
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
23595
+ }
23596
+ },
23597
+ {
23598
+ "name": "data-aria-label",
23599
+ "type": {
23600
+ "text": "string | null"
23601
+ },
23602
+ "default": "null",
23603
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
23604
+ "fieldName": "dataAriaLabel",
23605
+ "inheritedFrom": {
23606
+ "name": "DataAriaLabelMixin",
23607
+ "module": "src/utils/mixins/DataAriaLabelMixin.ts"
23608
+ }
23609
+ },
23610
+ {
23611
+ "name": "placeholder",
23612
+ "type": {
23613
+ "text": "string"
23614
+ },
23615
+ "default": "''",
23616
+ "description": "The placeholder text that is displayed when the input field is empty.",
23617
+ "fieldName": "placeholder",
23618
+ "inheritedFrom": {
23619
+ "name": "Input",
23620
+ "module": "src/components/input/input.component.ts"
23621
+ }
23622
+ },
23623
+ {
23624
+ "name": "readonly",
23625
+ "type": {
23626
+ "text": "boolean"
23627
+ },
23628
+ "default": "false",
23629
+ "description": "readonly attribute of the input field. If true, the input field is read-only.",
23630
+ "fieldName": "readonly",
23631
+ "inheritedFrom": {
23632
+ "name": "Input",
23633
+ "module": "src/components/input/input.component.ts"
23634
+ }
23635
+ },
23636
+ {
23637
+ "name": "prefix-text",
23638
+ "type": {
23639
+ "text": "string | undefined"
23640
+ },
23641
+ "description": "The prefix text that is displayed before the input field. It has a max length of 10 characters.\nWhen the prefix text is set, make sure to set the 'data-aria-label'\nattribute with the appropriate value for accessibility.",
23642
+ "fieldName": "prefixText",
23643
+ "inheritedFrom": {
23644
+ "name": "Input",
23645
+ "module": "src/components/input/input.component.ts"
23646
+ }
23647
+ },
23648
+ {
23649
+ "name": "leading-icon",
23650
+ "type": {
23651
+ "text": "IconNames | undefined"
23652
+ },
23653
+ "description": "The leading icon that is displayed before the input field.",
23654
+ "fieldName": "leadingIcon",
23655
+ "inheritedFrom": {
23656
+ "name": "Input",
23657
+ "module": "src/components/input/input.component.ts"
23658
+ }
23659
+ },
23660
+ {
23661
+ "name": "trailing-button",
23662
+ "type": {
23663
+ "text": "boolean"
23664
+ },
23665
+ "default": "false",
23666
+ "description": "The trailing button when set to true, shows a clear button that clears the input field.",
23667
+ "fieldName": "trailingButton",
23668
+ "inheritedFrom": {
23669
+ "name": "Input",
23670
+ "module": "src/components/input/input.component.ts"
23671
+ }
23672
+ },
23673
+ {
23674
+ "name": "maxlength",
23675
+ "type": {
23676
+ "text": "number | undefined"
23677
+ },
23678
+ "description": "The maximum number of characters that the input field can accept.",
23679
+ "fieldName": "maxlength",
23680
+ "inheritedFrom": {
23681
+ "name": "Input",
23682
+ "module": "src/components/input/input.component.ts"
23683
+ }
23684
+ },
23685
+ {
23686
+ "name": "minlength",
23687
+ "type": {
23688
+ "text": "number | undefined"
23689
+ },
23690
+ "description": "The minimum number of characters that the input field can accept.",
23691
+ "fieldName": "minlength",
23692
+ "inheritedFrom": {
23693
+ "name": "Input",
23694
+ "module": "src/components/input/input.component.ts"
23695
+ }
23696
+ },
23697
+ {
23698
+ "name": "autocapitalize",
23699
+ "type": {
23700
+ "text": "AutoCapitalizeType"
23701
+ },
23702
+ "description": "The autocapitalize attribute of the input field.",
23703
+ "default": "'off'",
23704
+ "fieldName": "autocapitalize",
23705
+ "inheritedFrom": {
23706
+ "name": "Input",
23707
+ "module": "src/components/input/input.component.ts"
22461
23708
  }
22462
23709
  },
22463
23710
  {
22464
- "name": "label",
23711
+ "name": "autocomplete",
22465
23712
  "type": {
22466
- "text": "string | undefined"
23713
+ "text": "AutoCompleteType"
22467
23714
  },
22468
- "description": "The primary label of the list item.\nThis appears on the leading side of the list item.",
22469
- "fieldName": "label",
23715
+ "description": "The autocomplete attribute of the input field.",
23716
+ "default": "'off'",
23717
+ "fieldName": "autocomplete",
22470
23718
  "inheritedFrom": {
22471
- "name": "ListItem",
22472
- "module": "src/components/listitem/listitem.component.ts"
23719
+ "name": "Input",
23720
+ "module": "src/components/input/input.component.ts"
22473
23721
  }
22474
23722
  },
22475
23723
  {
22476
- "name": "secondary-label",
23724
+ "name": "autofocus",
22477
23725
  "type": {
22478
- "text": "string | undefined"
23726
+ "text": "boolean"
22479
23727
  },
22480
- "description": "The secondary label of the list item.\nThis appears on the leading side of the list item.",
22481
- "fieldName": "secondaryLabel",
23728
+ "default": "false",
23729
+ "description": "If true, the input field is focused when the component is rendered.",
23730
+ "fieldName": "autofocus",
22482
23731
  "inheritedFrom": {
22483
- "name": "ListItem",
22484
- "module": "src/components/listitem/listitem.component.ts"
23732
+ "name": "Input",
23733
+ "module": "src/components/input/input.component.ts"
22485
23734
  }
22486
23735
  },
22487
23736
  {
22488
- "name": "tertiary-label",
23737
+ "name": "dirname",
22489
23738
  "type": {
22490
23739
  "text": "string | undefined"
22491
23740
  },
22492
- "description": "The tertiary label of the list item.\nThis appears on the leading side of the list item.",
22493
- "fieldName": "tertiaryLabel",
23741
+ "description": "Specifies the name of the directionality of text for submission purposes (e.g., \"rtl\" for right-to-left).",
23742
+ "fieldName": "dirname",
22494
23743
  "inheritedFrom": {
22495
- "name": "ListItem",
22496
- "module": "src/components/listitem/listitem.component.ts"
23744
+ "name": "Input",
23745
+ "module": "src/components/input/input.component.ts"
22497
23746
  }
22498
23747
  },
22499
23748
  {
22500
- "name": "side-header-text",
23749
+ "name": "pattern",
22501
23750
  "type": {
22502
23751
  "text": "string | undefined"
22503
23752
  },
22504
- "description": "The header text of the list item.\nThis appears on the trailing side of the list item.",
22505
- "fieldName": "sideHeaderText",
23753
+ "description": "The pattern attribute of the input field.\nSpecifies a regular expression that the input value must match for validation purposes.",
23754
+ "fieldName": "pattern",
22506
23755
  "inheritedFrom": {
22507
- "name": "ListItem",
22508
- "module": "src/components/listitem/listitem.component.ts"
23756
+ "name": "Input",
23757
+ "module": "src/components/input/input.component.ts"
22509
23758
  }
22510
23759
  },
22511
23760
  {
22512
- "name": "subline-text",
23761
+ "name": "list",
22513
23762
  "type": {
22514
23763
  "text": "string | undefined"
22515
23764
  },
22516
- "description": "The subline text of the list item.\nThis appears on the trailing side of the list item.",
22517
- "fieldName": "sublineText",
23765
+ "description": "The list attribute of the input field.\nIdentifies a list of pre-defined options to suggest to the user.",
23766
+ "fieldName": "list",
22518
23767
  "inheritedFrom": {
22519
- "name": "ListItem",
22520
- "module": "src/components/listitem/listitem.component.ts"
23768
+ "name": "Input",
23769
+ "module": "src/components/input/input.component.ts"
22521
23770
  }
22522
23771
  },
22523
23772
  {
22524
- "name": "soft-disabled",
23773
+ "name": "size",
22525
23774
  "type": {
22526
- "text": "boolean | undefined"
23775
+ "text": "number | undefined | undefined"
22527
23776
  },
22528
- "description": "Indicates whether the element is soft disabled.\nWhen set to `true`, the element appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe element behaves like a disabled element, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
23777
+ "description": "The size attribute of the input field.\nSpecifies the width of the input field.",
22529
23778
  "default": "undefined",
22530
- "fieldName": "softDisabled",
23779
+ "fieldName": "size",
22531
23780
  "inheritedFrom": {
22532
- "name": "ListItem",
22533
- "module": "src/components/listitem/listitem.component.ts"
23781
+ "name": "Input",
23782
+ "module": "src/components/input/input.component.ts"
22534
23783
  }
22535
23784
  },
22536
23785
  {
22537
- "name": "tooltip-text",
23786
+ "name": "clear-aria-label",
22538
23787
  "type": {
22539
- "text": "string | undefined"
23788
+ "text": "string"
22540
23789
  },
22541
- "description": "The tooltip text is displayed on hover of the list item.",
22542
- "fieldName": "tooltipText",
23790
+ "default": "''",
23791
+ "description": "Aria label for the trailing button. If trailing button is set to true, this label is used for the clear button.",
23792
+ "fieldName": "clearAriaLabel",
22543
23793
  "inheritedFrom": {
22544
- "name": "ListItem",
22545
- "module": "src/components/listitem/listitem.component.ts"
23794
+ "name": "Input",
23795
+ "module": "src/components/input/input.component.ts"
22546
23796
  }
22547
23797
  },
22548
23798
  {
22549
- "name": "tooltip-placement",
23799
+ "name": "disabled",
22550
23800
  "type": {
22551
- "text": "PopoverPlacement"
23801
+ "text": "boolean | undefined"
22552
23802
  },
22553
- "description": "The tooltip placement of the list item. If the tooltip text is present,\nthen this tooltip placement will be applied.",
22554
- "default": "'top'",
22555
- "fieldName": "tooltipPlacement",
22556
- "inheritedFrom": {
22557
- "name": "ListItem",
22558
- "module": "src/components/listitem/listitem.component.ts"
22559
- }
22560
- }
22561
- ],
22562
- "mixins": [
22563
- {
22564
- "name": "FormInternalsMixin",
22565
- "module": "/src/utils/mixins/FormInternalsMixin"
22566
- }
22567
- ],
22568
- "superclass": {
22569
- "name": "ListItem",
22570
- "module": "/src/components/listitem/listitem.component"
22571
- },
22572
- "tagName": "mdc-option",
22573
- "jsDoc": "/**\n * option component, which is used as a list item in a select component.<br/>\n * We can pass an icon which will be displayed in leading position of the option label text.\n * We can pass a tooltip which will be displayed on hover of the option label text.\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 * @slot default - This is a default/unnamed slot\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 */",
22574
- "customElement": true,
22575
- "cssProperties": [
22576
- {
22577
- "description": "Allows customization of the default background color.",
22578
- "name": "--mdc-listitem-default-background-color",
23803
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
23804
+ "default": "undefined",
23805
+ "fieldName": "disabled",
22579
23806
  "inheritedFrom": {
22580
- "name": "ListItem",
22581
- "module": "src/components/listitem/listitem.component.ts"
23807
+ "name": "FormfieldWrapper",
23808
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
22582
23809
  }
22583
23810
  },
22584
23811
  {
22585
- "description": "Allows customization of the background color on hover.",
22586
- "name": "--mdc-listitem-background-color-hover",
23812
+ "name": "label",
23813
+ "type": {
23814
+ "text": "string | undefined"
23815
+ },
23816
+ "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
23817
+ "fieldName": "label",
22587
23818
  "inheritedFrom": {
22588
- "name": "ListItem",
22589
- "module": "src/components/listitem/listitem.component.ts"
23819
+ "name": "FormfieldWrapper",
23820
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
22590
23821
  }
22591
23822
  },
22592
23823
  {
22593
- "description": "Allows customization of the background color when pressed.",
22594
- "name": "--mdc-listitem-background-color-active",
23824
+ "name": "required",
23825
+ "type": {
23826
+ "text": "boolean"
23827
+ },
23828
+ "default": "false",
23829
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
23830
+ "fieldName": "required",
22595
23831
  "inheritedFrom": {
22596
- "name": "ListItem",
22597
- "module": "src/components/listitem/listitem.component.ts"
23832
+ "name": "FormfieldWrapper",
23833
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
22598
23834
  }
22599
23835
  },
22600
23836
  {
22601
- "description": "Allows customization of the primary label, side header and subline text slot color.",
22602
- "name": "--mdc-listitem-primary-label-color",
23837
+ "name": "id",
23838
+ "type": {
23839
+ "text": "string"
23840
+ },
23841
+ "default": "''",
23842
+ "description": "The unique id of the input field. It is used to link the input field with the label.",
23843
+ "fieldName": "id",
22603
23844
  "inheritedFrom": {
22604
- "name": "ListItem",
22605
- "module": "src/components/listitem/listitem.component.ts"
23845
+ "name": "FormfieldWrapper",
23846
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
22606
23847
  }
22607
23848
  },
22608
23849
  {
22609
- "description": "Allows customization of the secondary and tertiary label text slot color.",
22610
- "name": "--mdc-listitem-secondary-label-color",
23850
+ "name": "help-text",
23851
+ "type": {
23852
+ "text": "string | undefined"
23853
+ },
23854
+ "description": "The help text that is displayed below the input field.",
23855
+ "fieldName": "helpText",
22611
23856
  "inheritedFrom": {
22612
- "name": "ListItem",
22613
- "module": "src/components/listitem/listitem.component.ts"
23857
+ "name": "FormfieldWrapper",
23858
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
22614
23859
  }
22615
23860
  },
22616
23861
  {
22617
- "description": "Allows customization of the disabled color.",
22618
- "name": "--mdc-listitem-disabled-color",
23862
+ "name": "toggletip-text",
23863
+ "type": {
23864
+ "text": "string | undefined"
23865
+ },
23866
+ "description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
23867
+ "fieldName": "toggletipText",
22619
23868
  "inheritedFrom": {
22620
- "name": "ListItem",
22621
- "module": "src/components/listitem/listitem.component.ts"
23869
+ "name": "FormfieldWrapper",
23870
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
22622
23871
  }
22623
23872
  },
22624
23873
  {
22625
- "description": "Allows customization of column gap.",
22626
- "name": "--mdc-listitem-column-gap",
23874
+ "name": "toggletip-placement",
23875
+ "type": {
23876
+ "text": "PopoverPlacement"
23877
+ },
23878
+ "description": "The placement of the toggletip that is displayed when the info icon is hovered.",
23879
+ "default": "'top'",
23880
+ "fieldName": "toggletipPlacement",
22627
23881
  "inheritedFrom": {
22628
- "name": "ListItem",
22629
- "module": "src/components/listitem/listitem.component.ts"
23882
+ "name": "FormfieldWrapper",
23883
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
22630
23884
  }
22631
23885
  },
22632
23886
  {
22633
- "description": "Allows customization of padding left and right.",
22634
- "name": "--mdc-listitem-padding-left-and-right",
23887
+ "name": "info-icon-aria-label",
23888
+ "type": {
23889
+ "text": "string | undefined"
23890
+ },
23891
+ "description": "Aria label for the info icon that is displayed next to the label when `toggletipText` is set.\nThis is used for accessibility purposes to provide a description of the icon.",
23892
+ "fieldName": "infoIconAriaLabel",
22635
23893
  "inheritedFrom": {
22636
- "name": "ListItem",
22637
- "module": "src/components/listitem/listitem.component.ts"
23894
+ "name": "FormfieldWrapper",
23895
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
22638
23896
  }
22639
23897
  }
22640
- ]
23898
+ ],
23899
+ "superclass": {
23900
+ "name": "Input",
23901
+ "module": "/src/components/input/input.component"
23902
+ },
23903
+ "tagName": "mdc-password",
23904
+ "jsDoc": "/**\n * `mdc-password` is a component that allows users to input their password.\n * It extends the `mdc-input` component and provides additional features specific to password fields.\n * It contains:\n * - `label` field - describe the password field.\n * - `password` field - contains the value\n * - `help-text` or `validation-message` - displayed below the password field.\n * - `help-text-type` - type of the help text, can be 'default', 'error', 'warning', 'success', 'priority'.\n * - `show-hide-button-aria-label` - aria label for the trailing show/hide button.\n * - all the attributes of the native password field.\n *\n * @tagname mdc-password\n *\n * @event input - (React: onInput) This event is dispatched when the value of the password field changes (every press).\n * @event change - (React: onChange) This event is dispatched when the value of the password field changes (on blur).\n * @event focus - (React: onFocus) This event is dispatched when the password receives focus.\n * @event blur - (React: onBlur) This event is dispatched when the password loses focus.\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n * @dependency mdc-button\n * @dependency mdc-toggletip\n *\n * @cssproperty --mdc-input-disabled-border-color - Border color for the password container when disabled\n * @cssproperty --mdc-input-disabled-text-color - Text color for the password field when disabled\n * @cssproperty --mdc-input-disabled-background-color - Background color for the password field when disabled\n * @cssproperty --mdc-input-border-color - Border color for the password container\n * @cssproperty --mdc-input-text-color - Text color for the password field\n * @cssproperty --mdc-input-background-color - Background color for the password field\n * @cssproperty --mdc-input-selection-background-color - Background color for the selected text\n * @cssproperty --mdc-input-selection-text-color - Text color for the selected text\n * @cssproperty --mdc-input-support-text-color - Text color for the help text\n * @cssproperty --mdc-input-hover-background-color - Background color for the password field when hovered\n * @cssproperty --mdc-input-focused-background-color - Background color for the password field when focused\n * @cssproperty --mdc-input-focused-border-color - Border color for the password container when focused\n * @cssproperty --mdc-input-error-border-color - Border color for the password container when error\n * @cssproperty --mdc-input-warning-border-color - Border color for the password container when warning\n * @cssproperty --mdc-input-success-border-color - Border color for the password container when success\n * @cssproperty --mdc-input-primary-border-color - Border color for the password container when primary\n *\n */",
23905
+ "customElement": true
22641
23906
  }
22642
23907
  ],
22643
23908
  "exports": [
@@ -22645,8 +23910,8 @@
22645
23910
  "kind": "js",
22646
23911
  "name": "default",
22647
23912
  "declaration": {
22648
- "name": "Option",
22649
- "module": "components/option/option.component.js"
23913
+ "name": "Password",
23914
+ "module": "components/password/password.component.js"
22650
23915
  }
22651
23916
  }
22652
23917
  ]
@@ -25559,7 +26824,7 @@
25559
26824
  "type": {
25560
26825
  "text": "string | undefined"
25561
26826
  },
25562
- "description": "Custom validation message that will override the default message and displayed when the input is invalid.",
26827
+ "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.",
25563
26828
  "attribute": "validation-message",
25564
26829
  "reflects": true,
25565
26830
  "inheritedFrom": {
@@ -25919,7 +27184,7 @@
25919
27184
  "type": {
25920
27185
  "text": "string | undefined"
25921
27186
  },
25922
- "description": "Custom validation message that will override the default message and displayed when the input is invalid.",
27187
+ "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.",
25923
27188
  "fieldName": "validationMessage",
25924
27189
  "inheritedFrom": {
25925
27190
  "name": "FormInternalsMixin",
@@ -26765,7 +28030,7 @@
26765
28030
  "type": {
26766
28031
  "text": "string | undefined"
26767
28032
  },
26768
- "description": "Custom validation message that will override the default message and displayed when the input is invalid.",
28033
+ "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.",
26769
28034
  "attribute": "validation-message",
26770
28035
  "reflects": true,
26771
28036
  "inheritedFrom": {
@@ -27047,20 +28312,6 @@
27047
28312
  "module": "components/input/input.component.js"
27048
28313
  }
27049
28314
  },
27050
- {
27051
- "kind": "method",
27052
- "name": "handleValueChange",
27053
- "description": "Handles the value change of the input field.\nSets the form value and updates the validity of the input field.",
27054
- "return": {
27055
- "type": {
27056
- "text": ""
27057
- }
27058
- },
27059
- "inheritedFrom": {
27060
- "name": "Input",
27061
- "module": "components/input/input.component.js"
27062
- }
27063
- },
27064
28315
  {
27065
28316
  "kind": "method",
27066
28317
  "name": "setInputValidity",
@@ -27430,7 +28681,7 @@
27430
28681
  "type": {
27431
28682
  "text": "string | undefined"
27432
28683
  },
27433
- "description": "Custom validation message that will override the default message and displayed when the input is invalid.",
28684
+ "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.",
27434
28685
  "fieldName": "validationMessage",
27435
28686
  "inheritedFrom": {
27436
28687
  "name": "FormInternalsMixin",
@@ -27947,7 +29198,7 @@
27947
29198
  "declarations": [
27948
29199
  {
27949
29200
  "kind": "class",
27950
- "description": "The mdc-select component is a dropdown selection control that allows users to pick an option from a predefined list.\nIt is designed to work with `mdc-option` for individual options and `mdc-optgroup` for grouping related options.\nThe component ensures accessibility and usability while handling various use cases,\nincluding long text truncation with tooltip support.",
29201
+ "description": "The mdc-select component is a dropdown selection control that allows users to pick an option from a predefined list.\nIt is designed to work with `mdc-option` for individual options and `mdc-optgroup` for grouping related options.\nThe component ensures accessibility and usability while handling various use cases,\nincluding long text truncation with tooltip support.\n\nTo set a default option, use the `selected` attribute on the `mdc-option` element.",
27951
29202
  "name": "Select",
27952
29203
  "slots": [
27953
29204
  {
@@ -28090,6 +29341,24 @@
28090
29341
  }
28091
29342
  ]
28092
29343
  },
29344
+ {
29345
+ "kind": "method",
29346
+ "name": "dispatchInput",
29347
+ "privacy": "private",
29348
+ "return": {
29349
+ "type": {
29350
+ "text": "void"
29351
+ }
29352
+ },
29353
+ "parameters": [
29354
+ {
29355
+ "name": "value",
29356
+ "type": {
29357
+ "text": "string"
29358
+ }
29359
+ }
29360
+ ]
29361
+ },
28093
29362
  {
28094
29363
  "kind": "method",
28095
29364
  "name": "handlePopoverOnOpen",
@@ -28320,7 +29589,7 @@
28320
29589
  "type": {
28321
29590
  "text": "string | undefined"
28322
29591
  },
28323
- "description": "Custom validation message that will override the default message and displayed when the input is invalid.",
29592
+ "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.",
28324
29593
  "attribute": "validation-message",
28325
29594
  "reflects": true,
28326
29595
  "inheritedFrom": {
@@ -28613,6 +29882,14 @@
28613
29882
  "description": "(React: onChange) This event is dispatched when the select is changed.",
28614
29883
  "reactName": "onChange"
28615
29884
  },
29885
+ {
29886
+ "name": "input",
29887
+ "type": {
29888
+ "text": "CustomEvent"
29889
+ },
29890
+ "description": "(React: onInput) This event is dispatched when the select is changed.",
29891
+ "reactName": "onInput"
29892
+ },
28616
29893
  {
28617
29894
  "description": "(React: onClick) This event is dispatched when the select is clicked.",
28618
29895
  "name": "click",
@@ -28687,7 +29964,7 @@
28687
29964
  "type": {
28688
29965
  "text": "string | undefined"
28689
29966
  },
28690
- "description": "Custom validation message that will override the default message and displayed when the input is invalid.",
29967
+ "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.",
28691
29968
  "fieldName": "validationMessage",
28692
29969
  "inheritedFrom": {
28693
29970
  "name": "FormInternalsMixin",
@@ -28835,7 +30112,7 @@
28835
30112
  "module": "/src/components/formfieldwrapper/formfieldwrapper.component"
28836
30113
  },
28837
30114
  "tagName": "mdc-select",
28838
- "jsDoc": "/**\n * The mdc-select component is a dropdown selection control that allows users to pick an option from a predefined list.\n * It is designed to work with `mdc-option` for individual options and `mdc-optgroup` for grouping related options.\n * The component ensures accessibility and usability while handling various use cases,\n * including long text truncation with tooltip support.\n *\n * @dependency mdc-button\n * @dependency mdc-icon\n * @dependency mdc-popover\n * @dependency mdc-text\n * @dependency mdc-toggletip\n *\n * @tagname mdc-select\n *\n * @slot default - This is a default/unnamed slot for options and/or option group.\n *\n * @event click - (React: onClick) This event is dispatched when the select is clicked.\n * @event change - (React: onChange) This event is dispatched when the select is changed.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the select.\n * @event focus - (React: onFocus) This event is dispatched when the select receives focus.\n */",
30115
+ "jsDoc": "/**\n * The mdc-select component is a dropdown selection control that allows users to pick an option from a predefined list.\n * It is designed to work with `mdc-option` for individual options and `mdc-optgroup` for grouping related options.\n * The component ensures accessibility and usability while handling various use cases,\n * including long text truncation with tooltip support.\n *\n * To set a default option, use the `selected` attribute on the `mdc-option` element.\n *\n * @dependency mdc-button\n * @dependency mdc-icon\n * @dependency mdc-popover\n * @dependency mdc-text\n * @dependency mdc-toggletip\n *\n * @tagname mdc-select\n *\n * @slot default - This is a default/unnamed slot for options and/or option group.\n *\n * @event click - (React: onClick) This event is dispatched when the select is clicked.\n * @event change - (React: onChange) This event is dispatched when the select is changed.\n * @event input - (React: onInput) This event is dispatched when the select is changed.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the select.\n * @event focus - (React: onFocus) This event is dispatched when the select receives focus.\n */",
28839
30116
  "customElement": true
28840
30117
  }
28841
30118
  ],
@@ -30980,7 +32257,7 @@
30980
32257
  "type": {
30981
32258
  "text": "string | undefined"
30982
32259
  },
30983
- "description": "Custom validation message that will override the default message and displayed when the input is invalid.",
32260
+ "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.",
30984
32261
  "attribute": "validation-message",
30985
32262
  "reflects": true,
30986
32263
  "inheritedFrom": {
@@ -31428,7 +32705,7 @@
31428
32705
  "type": {
31429
32706
  "text": "string | undefined"
31430
32707
  },
31431
- "description": "Custom validation message that will override the default message and displayed when the input is invalid.",
32708
+ "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.",
31432
32709
  "fieldName": "validationMessage",
31433
32710
  "inheritedFrom": {
31434
32711
  "name": "FormInternalsMixin",
@@ -31913,7 +33190,7 @@
31913
33190
  "type": {
31914
33191
  "text": "string | undefined"
31915
33192
  },
31916
- "description": "Custom validation message that will override the default message and displayed when the input is invalid.",
33193
+ "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.",
31917
33194
  "attribute": "validation-message",
31918
33195
  "reflects": true,
31919
33196
  "inheritedFrom": {
@@ -32273,7 +33550,7 @@
32273
33550
  "type": {
32274
33551
  "text": "string | undefined"
32275
33552
  },
32276
- "description": "Custom validation message that will override the default message and displayed when the input is invalid.",
33553
+ "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.",
32277
33554
  "fieldName": "validationMessage",
32278
33555
  "inheritedFrom": {
32279
33556
  "name": "FormInternalsMixin",
@@ -37908,7 +39185,7 @@
37908
39185
  "type": {
37909
39186
  "text": "string | undefined"
37910
39187
  },
37911
- "description": "Custom validation message that will override the default message and displayed when the input is invalid.",
39188
+ "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.",
37912
39189
  "attribute": "validation-message",
37913
39190
  "reflects": true
37914
39191
  },
@@ -37973,7 +39250,7 @@
37973
39250
  "type": {
37974
39251
  "text": "string | undefined"
37975
39252
  },
37976
- "description": "Custom validation message that will override the default message and displayed when the input is invalid.",
39253
+ "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.",
37977
39254
  "fieldName": "validationMessage"
37978
39255
  }
37979
39256
  ],