@momentum-design/components 0.95.5 → 0.95.6

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.
@@ -9589,518 +9589,449 @@
9589
9589
  },
9590
9590
  {
9591
9591
  "kind": "javascript-module",
9592
- "path": "components/divider/divider.component.js",
9592
+ "path": "components/dialog/dialog.component.js",
9593
9593
  "declarations": [
9594
9594
  {
9595
9595
  "kind": "class",
9596
- "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.",
9597
- "name": "Divider",
9596
+ "description": "Dialog component is a modal dialog that can be used to display information or prompt the user for input.\nIt can be used to create custom dialogs where content for the body and footer actions is provided by the consumer.\nThe dialog is available in 5 sizes: small, medium, large, xlarge and fullscreen. It may also receive custom styling/sizing.\nThe dialog interrupts the user and will block interaction with the rest of the application until it is closed.\n\nThe dialog can be controlled solely through the `visible` property, no trigger element is required.\nIf a `triggerId` is provided, the dialog will manage focus with that element, otherwise it will\nremember the previously focused element before the dialog was opened.\n\nThe dialog is a controlled component, meaning it does not have its own state management for visibility.\nUse the `visible` property to control the visibility of the dialog.\nUse the `onClose` event to handle the close action of the dialog (fired when Close button is clicked\nor Escape is pressed).\n\nDialog component have 2 variants: default and promotional.\n\n**Accessibility notes for consuming (have to be explicitly set when you consume the component)**\n\n- The dialog should have an aria-label or aria-labelledby attribute to provide a label for screen readers.\n- Use aria-labelledby to reference the ID of the element that labels the dialog when there is no visible title.\n\n**Note: Programmatic show/hide requires the ? prefix on the visible attribute**\n- Use `?visible=true/false` as an attribute instead of `visible=true/false`\n- Reference docs for more info: https://lit.dev/docs/templates/expressions/#boolean-attribute-expressions",
9597
+ "name": "Dialog",
9598
9598
  "cssProperties": [
9599
9599
  {
9600
- "description": "background color of the divider",
9601
- "name": "--mdc-divider-background-color"
9602
- },
9603
- {
9604
- "description": "width of the divider",
9605
- "name": "--mdc-divider-width"
9600
+ "description": "primary background color of the dialog",
9601
+ "name": "--mdc-dialog-primary-background-color"
9606
9602
  },
9607
9603
  {
9608
- "description": "gradient of the horizontal divider",
9609
- "name": "--mdc-divider-horizontal-gradient"
9604
+ "description": "border color of the dialog",
9605
+ "name": "--mdc-dialog-border-color"
9610
9606
  },
9611
9607
  {
9612
- "description": "gradient of the vertical divider",
9613
- "name": "--mdc-divider-vertical-gradient"
9608
+ "description": "text color of the header/title of the dialog",
9609
+ "name": "--mdc-dialog-header-text-color"
9614
9610
  },
9615
9611
  {
9616
- "description": "font size of label in the text divider",
9617
- "name": "--mdc-divider-text-size"
9612
+ "description": "text color of the below header description of the dialog",
9613
+ "name": "--mdc-dialog-description-text-color"
9618
9614
  },
9619
9615
  {
9620
- "description": "font color of label in the text divider",
9621
- "name": "--mdc-divider-text-color"
9616
+ "description": "elevation of the dialog",
9617
+ "name": "--mdc-dialog-elevation-3"
9622
9618
  },
9623
9619
  {
9624
- "description": "left and right margin of label in the text divider",
9625
- "name": "--mdc-divider-text-margin"
9626
- },
9620
+ "description": "width of the dialog",
9621
+ "name": "--mdc-dialog-width"
9622
+ }
9623
+ ],
9624
+ "slots": [
9627
9625
  {
9628
- "description": "line height of label in the text divider",
9629
- "name": "--mdc-divider-text-line-height"
9626
+ "description": "Slot for the dialog header content. This can be used to pass custom header content.",
9627
+ "name": "header-prefix"
9630
9628
  },
9631
9629
  {
9632
- "description": "background color of the grabber button in rest state",
9633
- "name": "--mdc-divider-grabber-button-background-color-normal"
9630
+ "description": "Slot for the dialog body content",
9631
+ "name": "dialog-body"
9634
9632
  },
9635
9633
  {
9636
- "description": "background color of the grabber button in hover state",
9637
- "name": "--mdc-divider-grabber-button-background-color-hover"
9634
+ "description": "This slot is for passing `mdc-link` component within the footer section.",
9635
+ "name": "footer-link"
9638
9636
  },
9639
9637
  {
9640
- "description": "background color of the grabber button in pressed state",
9641
- "name": "--mdc-divider-grabber-button-background-color-pressed"
9638
+ "description": "This slot is for passing secondary variant of `mdc-button` component within the footer section.",
9639
+ "name": "footer-button-secondary"
9642
9640
  },
9643
9641
  {
9644
- "description": "border color of the grabber button",
9645
- "name": "--mdc-divider-grabber-button-border-color"
9642
+ "description": "This slot is for passing primary variant of `mdc-button` component within the footer section.",
9643
+ "name": "footer-button-primary"
9646
9644
  },
9647
9645
  {
9648
- "description": "border radius of the grabber button",
9649
- "name": "--mdc-divider-grabber-button-border-radius"
9646
+ "description": " This slot is for passing custom footer content. Only use this if really needed, using the footer-link and footer-button slots is preferred",
9647
+ "name": "footer"
9650
9648
  }
9651
9649
  ],
9652
9650
  "members": [
9653
9651
  {
9654
9652
  "kind": "field",
9655
- "name": "orientation",
9653
+ "name": "id",
9656
9654
  "type": {
9657
- "text": "DividerOrientation"
9655
+ "text": "string"
9658
9656
  },
9659
- "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.",
9660
- "default": "horizontal",
9661
- "attribute": "orientation",
9657
+ "default": "''",
9658
+ "description": "The unique ID of the dialog",
9659
+ "attribute": "id",
9662
9660
  "reflects": true
9663
9661
  },
9664
9662
  {
9665
9663
  "kind": "field",
9666
- "name": "variant",
9664
+ "name": "triggerId",
9667
9665
  "type": {
9668
- "text": "DividerVariant"
9666
+ "text": "string | undefined"
9669
9667
  },
9670
- "description": "Two variants of divider\n- **solid**: Solid line.\n- **gradient**: Gradient Line that fades on either sides of the divider.",
9671
- "default": "solid",
9672
- "attribute": "variant",
9668
+ "description": "The ID of the element that triggers the dialog",
9669
+ "default": "undefined",
9670
+ "attribute": "triggerId",
9673
9671
  "reflects": true
9674
9672
  },
9675
9673
  {
9676
9674
  "kind": "field",
9677
- "name": "arrowDirection",
9675
+ "name": "visible",
9678
9676
  "type": {
9679
- "text": "Directions"
9677
+ "text": "boolean"
9680
9678
  },
9681
- "description": "Direction of the arrow icon, if applicable.\n- **positive**\n- **negative**\n\nNote: Positive and Negative directions are defined based on Cartesian plane.",
9682
- "default": "'negative'",
9683
- "attribute": "arrow-direction",
9679
+ "description": "The visibility of the dialog\n\nDialog is a controlled component, visible is the only property that controls the visibility of the dialog.",
9680
+ "default": "false",
9681
+ "attribute": "visible",
9684
9682
  "reflects": true
9685
9683
  },
9686
9684
  {
9687
9685
  "kind": "field",
9688
- "name": "buttonPosition",
9686
+ "name": "zIndex",
9689
9687
  "type": {
9690
- "text": "Directions"
9688
+ "text": "number"
9691
9689
  },
9692
- "description": "Position of the button, if applicable.\n- **positive**\n- **negative**\n\nNote: Positive and Negative directions are defined based on Cartesian plane.",
9693
- "default": "'negative'",
9694
- "attribute": "button-position",
9690
+ "description": "The z-index of the dialog\n\nThe backdrop will have z-index of `zIndex - 1`",
9691
+ "default": "1000",
9692
+ "attribute": "z-index",
9695
9693
  "reflects": true
9696
9694
  },
9697
9695
  {
9698
- "kind": "method",
9699
- "name": "setVariant",
9700
- "privacy": "private",
9701
- "parameters": [
9702
- {
9703
- "name": "variant",
9704
- "type": {
9705
- "text": "DividerVariant"
9706
- },
9707
- "description": "The variant to set."
9708
- }
9709
- ],
9710
- "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."
9696
+ "kind": "field",
9697
+ "name": "size",
9698
+ "type": {
9699
+ "text": "DialogSize"
9700
+ },
9701
+ "description": "The size of the dialog, can be 'small' (432px width), 'medium' (656px width), 'large' (992px width), 'xlarge' (90% width) or 'fullscreen' (100% width).",
9702
+ "default": "small",
9703
+ "attribute": "size",
9704
+ "reflects": true
9711
9705
  },
9712
9706
  {
9713
- "kind": "method",
9714
- "name": "setOrientation",
9715
- "privacy": "private",
9716
- "parameters": [
9717
- {
9718
- "name": "orientation",
9719
- "type": {
9720
- "text": "DividerOrientation"
9721
- },
9722
- "description": "The orientation to set."
9723
- }
9724
- ],
9725
- "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."
9707
+ "kind": "field",
9708
+ "name": "variant",
9709
+ "type": {
9710
+ "text": "DialogVariant"
9711
+ },
9712
+ "description": "The variant of the dialog, can be 'default' or 'promotional'",
9713
+ "default": "default",
9714
+ "attribute": "variant",
9715
+ "reflects": true
9726
9716
  },
9727
9717
  {
9728
- "kind": "method",
9729
- "name": "ensureValidDirections",
9730
- "privacy": "private",
9731
- "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.",
9732
- "parameters": [
9733
- {
9734
- "description": "The buttonPosition to set.",
9735
- "name": "buttonPosition"
9736
- },
9737
- {
9738
- "description": "The arrowDirection to set.",
9739
- "name": "arrowDirection"
9740
- }
9741
- ]
9718
+ "kind": "field",
9719
+ "name": "closeButtonAriaLabel",
9720
+ "type": {
9721
+ "text": "string | null"
9722
+ },
9723
+ "default": "null",
9724
+ "description": "Defines a string value for the aria-label attribute for close button accessibility",
9725
+ "attribute": "close-button-aria-label"
9742
9726
  },
9743
9727
  {
9744
- "kind": "method",
9745
- "name": "setGrabberButton",
9746
- "privacy": "private",
9747
- "return": {
9748
- "type": {
9749
- "text": "void"
9750
- }
9728
+ "kind": "field",
9729
+ "name": "ariaLabel",
9730
+ "type": {
9731
+ "text": "string | null"
9751
9732
  },
9752
- "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."
9733
+ "default": "null",
9734
+ "description": "Defines a string value for the aria-label attribute when header is not used",
9735
+ "attribute": "aria-label",
9736
+ "reflects": true
9753
9737
  },
9754
9738
  {
9755
- "kind": "method",
9756
- "name": "getArrowIcon",
9757
- "privacy": "private",
9758
- "return": {
9759
- "type": {
9760
- "text": ""
9761
- }
9739
+ "kind": "field",
9740
+ "name": "ariaLabelledby",
9741
+ "type": {
9742
+ "text": "string | null"
9762
9743
  },
9763
- "description": "Determines the arrow icon based on the consumer-defined `arrowDirection`."
9744
+ "default": "null",
9745
+ "description": "Defines a string value for the aria-labelledby attribute that refers to the element\nlabeling the dialog for accessibility",
9746
+ "attribute": "aria-labelledby",
9747
+ "reflects": true
9764
9748
  },
9765
9749
  {
9766
- "kind": "method",
9767
- "name": "inferDividerType",
9768
- "privacy": "private",
9769
- "description": "Infers the type of divider based on the kind of slot present.",
9770
- "parameters": [
9771
- {
9772
- "description": "default slot of divider",
9773
- "name": "slot"
9774
- }
9775
- ]
9776
- }
9777
- ],
9778
- "attributes": [
9779
- {
9780
- "name": "orientation",
9750
+ "kind": "field",
9751
+ "name": "ariaDescribedBy",
9781
9752
  "type": {
9782
- "text": "DividerOrientation"
9753
+ "text": "string | null"
9783
9754
  },
9784
- "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.",
9785
- "default": "horizontal",
9786
- "fieldName": "orientation"
9755
+ "default": "null",
9756
+ "description": "Defines a string value for the aria-describedby attribute that refers to the element\ndescribing the dialog for accessibility",
9757
+ "attribute": "aria-describedby",
9758
+ "reflects": true
9787
9759
  },
9788
9760
  {
9789
- "name": "variant",
9761
+ "kind": "field",
9762
+ "name": "ariaDescription",
9790
9763
  "type": {
9791
- "text": "DividerVariant"
9764
+ "text": "string | null"
9792
9765
  },
9793
- "description": "Two variants of divider\n- **solid**: Solid line.\n- **gradient**: Gradient Line that fades on either sides of the divider.",
9794
- "default": "solid",
9795
- "fieldName": "variant"
9766
+ "default": "null",
9767
+ "description": "Defines a string value for the aria-description attribute that refers to the element\ndescribing the dialog for accessibility",
9768
+ "attribute": "aria-description",
9769
+ "reflects": true
9796
9770
  },
9797
9771
  {
9798
- "name": "arrow-direction",
9772
+ "kind": "field",
9773
+ "name": "headerText",
9799
9774
  "type": {
9800
- "text": "Directions"
9775
+ "text": "string | undefined"
9801
9776
  },
9802
- "description": "Direction of the arrow icon, if applicable.\n- **positive**\n- **negative**\n\nNote: Positive and Negative directions are defined based on Cartesian plane.",
9803
- "default": "'negative'",
9804
- "fieldName": "arrowDirection"
9777
+ "description": "Defines a string value to display as the title of the dialog",
9778
+ "attribute": "header-text",
9779
+ "reflects": true
9805
9780
  },
9806
9781
  {
9807
- "name": "button-position",
9782
+ "kind": "field",
9783
+ "name": "descriptionText",
9808
9784
  "type": {
9809
- "text": "Directions"
9785
+ "text": "string | undefined"
9810
9786
  },
9811
- "description": "Position of the button, if applicable.\n- **positive**\n- **negative**\n\nNote: Positive and Negative directions are defined based on Cartesian plane.",
9812
- "default": "'negative'",
9813
- "fieldName": "buttonPosition"
9814
- }
9815
- ],
9816
- "superclass": {
9817
- "name": "Component",
9818
- "module": "/src/models"
9819
- },
9820
- "tagName": "mdc-divider",
9821
- "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 */",
9822
- "customElement": true
9823
- }
9824
- ],
9825
- "exports": [
9826
- {
9827
- "kind": "js",
9828
- "name": "default",
9829
- "declaration": {
9830
- "name": "Divider",
9831
- "module": "components/divider/divider.component.js"
9832
- }
9833
- }
9834
- ]
9835
- },
9836
- {
9837
- "kind": "javascript-module",
9838
- "path": "components/filterchip/filterchip.component.js",
9839
- "declarations": [
9840
- {
9841
- "kind": "class",
9842
- "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.",
9843
- "name": "FilterChip",
9844
- "members": [
9787
+ "description": "Defines a string value to display as the under-header description of the dialog",
9788
+ "attribute": "description-text",
9789
+ "reflects": true
9790
+ },
9845
9791
  {
9846
9792
  "kind": "field",
9847
- "name": "selected",
9793
+ "name": "headerTagName",
9848
9794
  "type": {
9849
- "text": "boolean"
9795
+ "text": "string"
9850
9796
  },
9851
- "default": "false",
9852
- "description": "The selected state of the filterchip.",
9853
- "attribute": "selected",
9797
+ "description": "The html tag to be used for the header text",
9798
+ "attribute": "header-tag-name",
9854
9799
  "reflects": true
9855
9800
  },
9856
9801
  {
9857
- "kind": "method",
9858
- "name": "setSelected",
9859
- "privacy": "private",
9860
- "parameters": [
9861
- {
9862
- "name": "selected",
9863
- "type": {
9864
- "text": "boolean"
9865
- },
9866
- "description": "The selected state of the filterchip."
9867
- }
9868
- ],
9869
- "description": "Sets the selected state of the filterchip along with the icon.\naria-pressed attribute is also set to true or false."
9870
- },
9871
- {
9872
- "kind": "method",
9873
- "name": "executeAction",
9874
- "privacy": "protected",
9875
- "inheritedFrom": {
9876
- "name": "Buttonsimple",
9877
- "module": "components/buttonsimple/buttonsimple.component.js"
9802
+ "kind": "field",
9803
+ "name": "descriptionTagName",
9804
+ "type": {
9805
+ "text": "string"
9878
9806
  },
9879
- "return": {
9880
- "type": {
9881
- "text": "void"
9882
- }
9883
- }
9807
+ "description": "The html tag to be used for the below-header description text",
9808
+ "attribute": "description-tag-name",
9809
+ "reflects": true
9884
9810
  },
9885
9811
  {
9886
9812
  "kind": "field",
9887
- "name": "iconName",
9813
+ "name": "role",
9888
9814
  "type": {
9889
- "text": "IconNames | undefined"
9815
+ "text": "DialogRole"
9890
9816
  },
9891
- "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
9892
- "attribute": "icon-name",
9893
- "inheritedFrom": {
9894
- "name": "IconNameMixin",
9895
- "module": "utils/mixins/IconNameMixin.js"
9896
- }
9817
+ "description": "Role of the dialog",
9818
+ "default": "dialog",
9819
+ "attribute": "role",
9820
+ "reflects": true
9897
9821
  },
9898
9822
  {
9899
9823
  "kind": "field",
9900
- "name": "color",
9824
+ "name": "disableAriaHasPopup",
9901
9825
  "type": {
9902
- "text": "ColorType"
9826
+ "text": "boolean"
9903
9827
  },
9904
- "description": "The color of the chip. It supports the following colors\n- default\n- cobalt\n- gold\n- lime\n- mint\n- orange\n- pink\n- purple\n- slate\n- violet",
9905
- "default": "default",
9906
- "attribute": "color",
9907
- "reflects": true,
9908
- "inheritedFrom": {
9909
- "name": "Chip",
9910
- "module": "components/chip/chip.component.js"
9911
- }
9828
+ "description": "Disable setting the aria-haspopup attribute on trigger element.\nMake sure to set this to true when the popover is extended and its role\nis not 'dialog' or 'alertdialog' i.e. listbox, menu, etc.",
9829
+ "default": "false",
9830
+ "attribute": "disable-aria-haspopup",
9831
+ "reflects": true
9912
9832
  },
9913
9833
  {
9914
9834
  "kind": "field",
9915
- "name": "label",
9835
+ "name": "focusTrap",
9916
9836
  "type": {
9917
- "text": "string"
9837
+ "text": "boolean"
9918
9838
  },
9919
- "default": "''",
9920
- "description": "The visible label text of the chip.\n\nWe recommend limiting the <b>maximum length of the label text to 20 characters</b>,\nincluding empty spaces to split words.",
9921
- "attribute": "label",
9839
+ "privacy": "protected",
9840
+ "description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.\n\nNOTE: this should only be disabled in rare cases! By default a Modal Dialog\nshould trap focus always.",
9841
+ "default": "true",
9842
+ "attribute": "focus-trap",
9843
+ "reflects": true,
9922
9844
  "inheritedFrom": {
9923
- "name": "Chip",
9924
- "module": "components/chip/chip.component.js"
9845
+ "name": "FocusTrapMixin",
9846
+ "module": "utils/mixins/FocusTrapMixin.js"
9925
9847
  }
9926
9848
  },
9927
9849
  {
9928
9850
  "kind": "method",
9929
- "name": "renderIcon",
9851
+ "name": "closeDialog",
9930
9852
  "privacy": "private",
9931
- "description": "Renders the icon element if available.",
9932
- "return": {
9933
- "type": {
9934
- "text": ""
9853
+ "description": "Fired when Close Button is clicked or Escape key is pressed.\nThis method dispatches the close event. Setting visible to false\nhas to be done by the consumer of the component."
9854
+ },
9855
+ {
9856
+ "kind": "method",
9857
+ "name": "isOpenUpdated",
9858
+ "privacy": "private",
9859
+ "parameters": [
9860
+ {
9861
+ "name": "oldValue",
9862
+ "type": {
9863
+ "text": "boolean | undefined"
9864
+ },
9865
+ "description": "The old value of the visible property."
9866
+ },
9867
+ {
9868
+ "name": "newValue",
9869
+ "type": {
9870
+ "text": "boolean"
9871
+ },
9872
+ "description": "The new value of the visible property."
9935
9873
  }
9936
- },
9937
- "inheritedFrom": {
9938
- "name": "Chip",
9939
- "module": "components/chip/chip.component.js"
9940
- }
9874
+ ],
9875
+ "description": "Handles the dialog visibility change.\nHandles the exit event to close the dialog."
9941
9876
  },
9942
9877
  {
9943
9878
  "kind": "field",
9944
- "name": "autofocus",
9879
+ "name": "preventScroll",
9945
9880
  "type": {
9946
9881
  "text": "boolean"
9947
9882
  },
9948
- "default": "false",
9949
- "description": "This property indicates whether the element should receive focus automatically when it is rendered.",
9950
- "attribute": "autofocus",
9951
- "reflects": true,
9883
+ "privacy": "protected",
9884
+ "description": "Prevent outside scrolling when element is shown.\n\nIMPLEMENT THIS IN YOUR COMPONENT.",
9952
9885
  "inheritedFrom": {
9953
- "name": "Buttonsimple",
9954
- "module": "components/buttonsimple/buttonsimple.component.js"
9886
+ "name": "PreventScrollMixin",
9887
+ "module": "utils/mixins/PreventScrollMixin.js"
9955
9888
  }
9956
9889
  },
9957
9890
  {
9958
- "kind": "field",
9959
- "name": "tabIndex",
9960
- "type": {
9961
- "text": "number"
9962
- },
9963
- "default": "0",
9964
- "description": "This property specifies the tab order of the element.",
9965
- "attribute": "tabIndex",
9966
- "reflects": true,
9891
+ "kind": "method",
9892
+ "name": "activatePreventScroll",
9893
+ "privacy": "protected",
9967
9894
  "inheritedFrom": {
9968
- "name": "Buttonsimple",
9969
- "module": "components/buttonsimple/buttonsimple.component.js"
9895
+ "name": "PreventScrollMixin",
9896
+ "module": "utils/mixins/PreventScrollMixin.js"
9970
9897
  }
9971
9898
  },
9972
9899
  {
9973
- "kind": "field",
9974
- "name": "disabled",
9975
- "type": {
9976
- "text": "boolean | undefined"
9977
- },
9978
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
9979
- "default": "undefined",
9980
- "attribute": "disabled",
9981
- "reflects": true,
9900
+ "kind": "method",
9901
+ "name": "deactivatePreventScroll",
9902
+ "privacy": "protected",
9982
9903
  "inheritedFrom": {
9983
- "name": "Buttonsimple",
9984
- "module": "components/buttonsimple/buttonsimple.component.js"
9904
+ "name": "PreventScrollMixin",
9905
+ "module": "utils/mixins/PreventScrollMixin.js"
9985
9906
  }
9986
9907
  },
9987
9908
  {
9988
9909
  "kind": "field",
9989
- "name": "active",
9910
+ "name": "shouldFocusTrapWrap",
9990
9911
  "type": {
9991
- "text": "boolean | undefined"
9912
+ "text": "boolean"
9992
9913
  },
9993
- "description": "The button's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the button is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the button is in an inactive state, indicating it is toggled off.\n\nThis attribute is used to set the provided `ariaStateKey` to true or false.",
9994
- "default": "undefined",
9995
- "attribute": "active",
9914
+ "default": "true",
9915
+ "description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `focusTrap` is true.",
9916
+ "attribute": "should-focus-trap-wrap",
9996
9917
  "reflects": true,
9997
9918
  "inheritedFrom": {
9998
- "name": "Buttonsimple",
9999
- "module": "components/buttonsimple/buttonsimple.component.js"
9919
+ "name": "FocusTrapMixin",
9920
+ "module": "utils/mixins/FocusTrapMixin.js"
10000
9921
  }
10001
9922
  },
10002
9923
  {
10003
- "kind": "field",
10004
- "name": "softDisabled",
10005
- "type": {
10006
- "text": "boolean | undefined"
10007
- },
10008
- "description": "Indicates whether the button is soft disabled.\nWhen set to `true`, the button 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 button behaves like a disabled button, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
10009
- "default": "undefined",
10010
- "attribute": "soft-disabled",
10011
- "reflects": true,
9924
+ "kind": "method",
9925
+ "name": "setIsFocusTrapActivated",
9926
+ "privacy": "private",
9927
+ "parameters": [
9928
+ {
9929
+ "name": "isActivated",
9930
+ "type": {
9931
+ "text": "boolean"
9932
+ }
9933
+ }
9934
+ ],
10012
9935
  "inheritedFrom": {
10013
- "name": "Buttonsimple",
10014
- "module": "components/buttonsimple/buttonsimple.component.js"
9936
+ "name": "FocusTrapMixin",
9937
+ "module": "utils/mixins/FocusTrapMixin.js"
10015
9938
  }
10016
9939
  },
10017
9940
  {
10018
- "kind": "field",
10019
- "name": "size",
10020
- "type": {
10021
- "text": "ButtonSize"
10022
- },
10023
- "description": "Simplebutton size is a super set of all the sizes supported by children components.",
10024
- "default": "32",
10025
- "attribute": "size",
10026
- "reflects": true,
9941
+ "kind": "method",
9942
+ "name": "activateFocusTrap",
9943
+ "privacy": "public",
9944
+ "description": "Activate the focus trap",
10027
9945
  "inheritedFrom": {
10028
- "name": "Buttonsimple",
10029
- "module": "components/buttonsimple/buttonsimple.component.js"
9946
+ "name": "FocusTrapMixin",
9947
+ "module": "utils/mixins/FocusTrapMixin.js"
10030
9948
  }
10031
9949
  },
10032
9950
  {
10033
- "kind": "field",
10034
- "name": "role",
10035
- "description": "This property defines the ARIA role for the element. By default, it is set to 'button'.\nConsumers should override this role when:\n- The element is being used in a context where a different role is more appropriate.\n- Custom behaviors are implemented that require a specific ARIA role for accessibility purposes.",
10036
- "default": "button",
10037
- "attribute": "role",
10038
- "reflects": true,
9951
+ "kind": "method",
9952
+ "name": "deactivateFocusTrap",
9953
+ "privacy": "public",
9954
+ "description": "Deactivate the focus trap.",
10039
9955
  "inheritedFrom": {
10040
- "name": "Buttonsimple",
10041
- "module": "components/buttonsimple/buttonsimple.component.js"
9956
+ "name": "FocusTrapMixin",
9957
+ "module": "utils/mixins/FocusTrapMixin.js"
10042
9958
  }
10043
9959
  },
10044
9960
  {
10045
- "kind": "field",
10046
- "name": "ariaStateKey",
10047
- "type": {
10048
- "text": "string | undefined"
9961
+ "kind": "method",
9962
+ "name": "hasNoClientRects",
9963
+ "privacy": "private",
9964
+ "parameters": [
9965
+ {
9966
+ "name": "element",
9967
+ "type": {
9968
+ "text": "HTMLElement"
9969
+ },
9970
+ "description": "The element to check."
9971
+ }
9972
+ ],
9973
+ "description": "Checks if the element has no client rectangles (not visible in the viewport).",
9974
+ "return": {
9975
+ "type": {
9976
+ "text": ""
9977
+ }
10049
9978
  },
10050
- "description": "This property defines the ARIA state key, which will be toggled when the\nButton is set to `active`.\nThe default value is 'aria-pressed', which is commonly used for toggle buttons.\n\nConsumers can override this property to use a different ARIA state key if needed.\nIn case multiple aria attributes should be toggled, they can be passed in as\na comma separated string.\nFor example: `aria-pressed,aria-expanded`",
10051
- "default": "'aria-pressed' (when)",
10052
- "attribute": "ariaStateKey",
10053
- "reflects": true,
10054
9979
  "inheritedFrom": {
10055
- "name": "Buttonsimple",
10056
- "module": "components/buttonsimple/buttonsimple.component.js"
9980
+ "name": "FocusTrapMixin",
9981
+ "module": "utils/mixins/FocusTrapMixin.js"
10057
9982
  }
10058
9983
  },
10059
9984
  {
10060
- "kind": "field",
10061
- "name": "type",
10062
- "type": {
10063
- "text": "ButtonType"
9985
+ "kind": "method",
9986
+ "name": "hasZeroDimensions",
9987
+ "privacy": "private",
9988
+ "parameters": [
9989
+ {
9990
+ "name": "element",
9991
+ "type": {
9992
+ "text": "HTMLElement"
9993
+ },
9994
+ "description": "The element to check."
9995
+ }
9996
+ ],
9997
+ "description": "Checks if the element has zero dimensions (width and height are both 0).",
9998
+ "return": {
9999
+ "type": {
10000
+ "text": ""
10001
+ }
10064
10002
  },
10065
- "description": "This property defines the type attribute for the button element.\nThe type attribute specifies the behavior of the button when it is clicked.\n- **submit**: The button submits the form data to the server.\n- **reset**: The button resets the form data to its initial state.\n- **button**: The button does nothing when clicked.",
10066
- "default": "button",
10067
- "attribute": "type",
10068
- "reflects": true,
10069
10003
  "inheritedFrom": {
10070
- "name": "Buttonsimple",
10071
- "module": "components/buttonsimple/buttonsimple.component.js"
10004
+ "name": "FocusTrapMixin",
10005
+ "module": "utils/mixins/FocusTrapMixin.js"
10072
10006
  }
10073
10007
  },
10074
10008
  {
10075
10009
  "kind": "method",
10076
- "name": "setActive",
10077
- "privacy": "protected",
10010
+ "name": "isNotVisible",
10011
+ "privacy": "private",
10078
10012
  "parameters": [
10079
10013
  {
10080
10014
  "name": "element",
10081
10015
  "type": {
10082
10016
  "text": "HTMLElement"
10083
10017
  },
10084
- "description": "The button element"
10085
- },
10086
- {
10087
- "name": "active",
10088
- "optional": true,
10089
- "type": {
10090
- "text": "boolean"
10091
- },
10092
- "description": "The active state of the element"
10018
+ "description": "The element to check."
10093
10019
  }
10094
10020
  ],
10095
- "description": "Sets the ariaStateKey attributes based on the active state of the button.",
10021
+ "description": "Determines if the element is not visible in the DOM.",
10022
+ "return": {
10023
+ "type": {
10024
+ "text": ""
10025
+ }
10026
+ },
10096
10027
  "inheritedFrom": {
10097
- "name": "Buttonsimple",
10098
- "module": "components/buttonsimple/buttonsimple.component.js"
10028
+ "name": "FocusTrapMixin",
10029
+ "module": "utils/mixins/FocusTrapMixin.js"
10099
10030
  }
10100
10031
  },
10101
10032
  {
10102
10033
  "kind": "method",
10103
- "name": "setSoftDisabled",
10034
+ "name": "hasHiddenStyle",
10104
10035
  "privacy": "private",
10105
10036
  "parameters": [
10106
10037
  {
@@ -10108,26 +10039,23 @@
10108
10039
  "type": {
10109
10040
  "text": "HTMLElement"
10110
10041
  },
10111
- "description": "The button element."
10112
- },
10113
- {
10114
- "name": "softDisabled",
10115
- "optional": true,
10116
- "type": {
10117
- "text": "boolean"
10118
- },
10119
- "description": "The soft-disabled state."
10042
+ "description": "The element to check."
10120
10043
  }
10121
10044
  ],
10122
- "description": "Sets the soft-disabled attribute for the button.\nWhen soft-disabled, the button looks to be disabled but remains focusable and clickable.\nAlso sets/removes aria-disabled attribute.",
10045
+ "description": "Checks if the element has inline styles that make it hidden.",
10046
+ "return": {
10047
+ "type": {
10048
+ "text": ""
10049
+ }
10050
+ },
10123
10051
  "inheritedFrom": {
10124
- "name": "Buttonsimple",
10125
- "module": "components/buttonsimple/buttonsimple.component.js"
10052
+ "name": "FocusTrapMixin",
10053
+ "module": "utils/mixins/FocusTrapMixin.js"
10126
10054
  }
10127
10055
  },
10128
10056
  {
10129
10057
  "kind": "method",
10130
- "name": "setDisabled",
10058
+ "name": "hasComputedHidden",
10131
10059
  "privacy": "private",
10132
10060
  "parameters": [
10133
10061
  {
@@ -10135,1125 +10063,1199 @@
10135
10063
  "type": {
10136
10064
  "text": "HTMLElement"
10137
10065
  },
10138
- "description": "The button element."
10139
- },
10066
+ "description": "The element to check."
10067
+ }
10068
+ ],
10069
+ "description": "Checks if the element is hidden by a computed style.",
10070
+ "return": {
10071
+ "type": {
10072
+ "text": ""
10073
+ }
10074
+ },
10075
+ "inheritedFrom": {
10076
+ "name": "FocusTrapMixin",
10077
+ "module": "utils/mixins/FocusTrapMixin.js"
10078
+ }
10079
+ },
10080
+ {
10081
+ "kind": "method",
10082
+ "name": "isHidden",
10083
+ "privacy": "private",
10084
+ "parameters": [
10140
10085
  {
10141
- "name": "disabled",
10086
+ "name": "element",
10142
10087
  "type": {
10143
- "text": "boolean"
10088
+ "text": "HTMLElement"
10144
10089
  },
10145
- "description": "The disabled state."
10090
+ "description": "The element to check."
10146
10091
  }
10147
10092
  ],
10148
- "description": "Sets the disabled attribute for the button.\nWhen disabled, the button is not focusable or clickable, and tabindex is set to -1.\nThe previous tabindex is stored and restored when enabled.\nAlso sets/removes aria-disabled attribute.",
10093
+ "description": "Checks if the element is hidden from the user.",
10094
+ "return": {
10095
+ "type": {
10096
+ "text": ""
10097
+ }
10098
+ },
10149
10099
  "inheritedFrom": {
10150
- "name": "Buttonsimple",
10151
- "module": "components/buttonsimple/buttonsimple.component.js"
10100
+ "name": "FocusTrapMixin",
10101
+ "module": "utils/mixins/FocusTrapMixin.js"
10152
10102
  }
10153
10103
  },
10154
10104
  {
10155
10105
  "kind": "method",
10156
- "name": "triggerClickEvent",
10106
+ "name": "isDisabled",
10157
10107
  "privacy": "private",
10108
+ "parameters": [
10109
+ {
10110
+ "name": "element",
10111
+ "type": {
10112
+ "text": "any"
10113
+ },
10114
+ "description": "The element to check."
10115
+ }
10116
+ ],
10117
+ "description": "Checks if the element is disabled.",
10118
+ "return": {
10119
+ "type": {
10120
+ "text": ""
10121
+ }
10122
+ },
10158
10123
  "inheritedFrom": {
10159
- "name": "Buttonsimple",
10160
- "module": "components/buttonsimple/buttonsimple.component.js"
10124
+ "name": "FocusTrapMixin",
10125
+ "module": "utils/mixins/FocusTrapMixin.js"
10161
10126
  }
10162
10127
  },
10163
10128
  {
10164
10129
  "kind": "method",
10165
- "name": "handleBlur",
10130
+ "name": "isNotTabbable",
10166
10131
  "privacy": "private",
10167
- "description": "In case the button is pressed and the focus is lost while pressing,\nthe pressed class is removed.",
10132
+ "parameters": [
10133
+ {
10134
+ "name": "element",
10135
+ "type": {
10136
+ "text": "HTMLElement"
10137
+ },
10138
+ "description": "The element to check."
10139
+ }
10140
+ ],
10141
+ "description": "Checks if the element is not tabbable.",
10142
+ "return": {
10143
+ "type": {
10144
+ "text": ""
10145
+ }
10146
+ },
10168
10147
  "inheritedFrom": {
10169
- "name": "Buttonsimple",
10170
- "module": "components/buttonsimple/buttonsimple.component.js"
10148
+ "name": "FocusTrapMixin",
10149
+ "module": "utils/mixins/FocusTrapMixin.js"
10171
10150
  }
10172
10151
  },
10173
10152
  {
10174
10153
  "kind": "method",
10175
- "name": "handleKeyDown",
10154
+ "name": "isInteractiveElement",
10176
10155
  "privacy": "private",
10156
+ "return": {
10157
+ "type": {
10158
+ "text": ""
10159
+ }
10160
+ },
10177
10161
  "parameters": [
10178
10162
  {
10179
- "name": "event",
10163
+ "name": "element",
10180
10164
  "type": {
10181
- "text": "KeyboardEvent"
10165
+ "text": "HTMLElement"
10182
10166
  },
10183
- "description": "The keyboard event."
10167
+ "description": "The element to check."
10184
10168
  }
10185
10169
  ],
10186
- "description": "Handles the keydown event on the button.\nIf the key is 'Enter' or 'Space', the button is pressed.\nIf the key is 'Enter', the button is pressed. The native HTML button works in the same way.\nIf the key is 'Space', the button's default is prevent to avoid scrolling etc in the host application.",
10170
+ "description": "Checks if the element is interactive.",
10187
10171
  "inheritedFrom": {
10188
- "name": "Buttonsimple",
10189
- "module": "components/buttonsimple/buttonsimple.component.js"
10172
+ "name": "FocusTrapMixin",
10173
+ "module": "utils/mixins/FocusTrapMixin.js"
10190
10174
  }
10191
10175
  },
10192
10176
  {
10193
10177
  "kind": "method",
10194
- "name": "handleKeyUp",
10178
+ "name": "isFocusable",
10195
10179
  "privacy": "private",
10196
10180
  "parameters": [
10197
10181
  {
10198
- "name": "event",
10182
+ "name": "element",
10199
10183
  "type": {
10200
- "text": "KeyboardEvent"
10184
+ "text": "HTMLElement"
10201
10185
  },
10202
- "description": "The keyboard event."
10186
+ "description": "The element to check."
10203
10187
  }
10204
10188
  ],
10205
- "description": "Handles the keyup event on the button.\nIf the key is 'Enter' or 'Space', the button is clicked.\nIf the key is 'Space', the button is pressed. The native HTML button works in the same way.",
10189
+ "description": "Checks if the element is focusable.",
10190
+ "return": {
10191
+ "type": {
10192
+ "text": ""
10193
+ }
10194
+ },
10206
10195
  "inheritedFrom": {
10207
- "name": "Buttonsimple",
10208
- "module": "components/buttonsimple/buttonsimple.component.js"
10196
+ "name": "FocusTrapMixin",
10197
+ "module": "utils/mixins/FocusTrapMixin.js"
10209
10198
  }
10210
- }
10211
- ],
10212
- "attributes": [
10213
- {
10214
- "name": "selected",
10215
- "type": {
10216
- "text": "boolean"
10217
- },
10218
- "default": "false",
10219
- "description": "The selected state of the filterchip.",
10220
- "fieldName": "selected"
10221
10199
  },
10222
10200
  {
10223
- "name": "icon-name",
10224
- "type": {
10225
- "text": "IconNames | undefined"
10226
- },
10227
- "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
10228
- "fieldName": "iconName",
10229
- "inheritedFrom": {
10230
- "name": "IconNameMixin",
10231
- "module": "src/utils/mixins/IconNameMixin.ts"
10232
- }
10233
- },
10234
- {
10235
- "name": "color",
10236
- "type": {
10237
- "text": "ColorType"
10238
- },
10239
- "description": "The color of the chip. It supports the following colors\n- default\n- cobalt\n- gold\n- lime\n- mint\n- orange\n- pink\n- purple\n- slate\n- violet",
10240
- "default": "default",
10241
- "fieldName": "color",
10242
- "inheritedFrom": {
10243
- "name": "Chip",
10244
- "module": "src/components/chip/chip.component.ts"
10245
- }
10246
- },
10247
- {
10248
- "name": "label",
10249
- "type": {
10250
- "text": "string"
10201
+ "kind": "method",
10202
+ "name": "findFocusable",
10203
+ "privacy": "private",
10204
+ "return": {
10205
+ "type": {
10206
+ "text": ""
10207
+ }
10251
10208
  },
10252
- "default": "''",
10253
- "description": "The visible label text of the chip.\n\nWe recommend limiting the <b>maximum length of the label text to 20 characters</b>,\nincluding empty spaces to split words.",
10254
- "fieldName": "label",
10209
+ "parameters": [
10210
+ {
10211
+ "name": "root",
10212
+ "type": {
10213
+ "text": "ShadowRoot | HTMLElement"
10214
+ },
10215
+ "description": "The root element to search for focusable elements."
10216
+ },
10217
+ {
10218
+ "name": "matches",
10219
+ "default": "new Set()",
10220
+ "type": {
10221
+ "text": "Set<HTMLElement>"
10222
+ },
10223
+ "description": "The set of focusable elements."
10224
+ }
10225
+ ],
10226
+ "description": "Recursively finds all focusable elements within the given root and its descendants.\n\nMake sure this is performant, as it will be called multiple times.",
10255
10227
  "inheritedFrom": {
10256
- "name": "Chip",
10257
- "module": "src/components/chip/chip.component.ts"
10228
+ "name": "FocusTrapMixin",
10229
+ "module": "utils/mixins/FocusTrapMixin.js"
10258
10230
  }
10259
10231
  },
10260
10232
  {
10261
- "name": "autofocus",
10262
- "type": {
10263
- "text": "boolean"
10264
- },
10265
- "default": "false",
10266
- "description": "This property indicates whether the element should receive focus automatically when it is rendered.",
10267
- "fieldName": "autofocus",
10233
+ "kind": "method",
10234
+ "name": "setFocusableElements",
10235
+ "privacy": "private",
10236
+ "description": "Updates the list of focusable elements within the component's shadow root.",
10268
10237
  "inheritedFrom": {
10269
- "name": "Buttonsimple",
10270
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
10238
+ "name": "FocusTrapMixin",
10239
+ "module": "utils/mixins/FocusTrapMixin.js"
10271
10240
  }
10272
10241
  },
10273
10242
  {
10274
- "name": "tabIndex",
10275
- "type": {
10276
- "text": "number"
10277
- },
10278
- "default": "0",
10279
- "description": "This property specifies the tab order of the element.",
10280
- "fieldName": "tabIndex",
10243
+ "kind": "method",
10244
+ "name": "setInitialFocus",
10245
+ "privacy": "public",
10246
+ "parameters": [
10247
+ {
10248
+ "name": "elementIndexToReceiveFocus",
10249
+ "default": "0",
10250
+ "type": {
10251
+ "text": "number"
10252
+ },
10253
+ "description": "The index of the preferable element to focus."
10254
+ }
10255
+ ],
10256
+ "description": "Sets the initial focus within the container.",
10281
10257
  "inheritedFrom": {
10282
- "name": "Buttonsimple",
10283
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
10258
+ "name": "FocusTrapMixin",
10259
+ "module": "utils/mixins/FocusTrapMixin.js"
10284
10260
  }
10285
10261
  },
10286
10262
  {
10287
- "name": "disabled",
10288
- "type": {
10289
- "text": "boolean | undefined"
10263
+ "kind": "method",
10264
+ "name": "calculateNextIndex",
10265
+ "privacy": "private",
10266
+ "parameters": [
10267
+ {
10268
+ "name": "currentIndex",
10269
+ "type": {
10270
+ "text": "number"
10271
+ },
10272
+ "description": "The current index."
10273
+ },
10274
+ {
10275
+ "name": "step",
10276
+ "type": {
10277
+ "text": "number"
10278
+ },
10279
+ "description": "The step to calculate the next index."
10280
+ }
10281
+ ],
10282
+ "description": "Calculates the next index for the focus trap.",
10283
+ "return": {
10284
+ "type": {
10285
+ "text": ""
10286
+ }
10290
10287
  },
10291
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
10292
- "default": "undefined",
10293
- "fieldName": "disabled",
10294
10288
  "inheritedFrom": {
10295
- "name": "Buttonsimple",
10296
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
10289
+ "name": "FocusTrapMixin",
10290
+ "module": "utils/mixins/FocusTrapMixin.js"
10297
10291
  }
10298
10292
  },
10299
10293
  {
10300
- "name": "active",
10301
- "type": {
10302
- "text": "boolean | undefined"
10294
+ "kind": "method",
10295
+ "name": "getDeepActiveElement",
10296
+ "privacy": "private",
10297
+ "description": "Returns the deepest active element in the shadow DOM.",
10298
+ "return": {
10299
+ "type": {
10300
+ "text": ""
10301
+ }
10303
10302
  },
10304
- "description": "The button's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the button is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the button is in an inactive state, indicating it is toggled off.\n\nThis attribute is used to set the provided `ariaStateKey` to true or false.",
10305
- "default": "undefined",
10306
- "fieldName": "active",
10307
10303
  "inheritedFrom": {
10308
- "name": "Buttonsimple",
10309
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
10304
+ "name": "FocusTrapMixin",
10305
+ "module": "utils/mixins/FocusTrapMixin.js"
10310
10306
  }
10311
10307
  },
10312
10308
  {
10313
- "name": "soft-disabled",
10314
- "type": {
10315
- "text": "boolean | undefined"
10309
+ "kind": "method",
10310
+ "name": "findElement",
10311
+ "privacy": "private",
10312
+ "parameters": [
10313
+ {
10314
+ "name": "activeElement",
10315
+ "type": {
10316
+ "text": "HTMLElement"
10317
+ },
10318
+ "description": "The active element."
10319
+ }
10320
+ ],
10321
+ "description": "Finds the index of the active element within the focusable elements.",
10322
+ "return": {
10323
+ "type": {
10324
+ "text": ""
10325
+ }
10316
10326
  },
10317
- "description": "Indicates whether the button is soft disabled.\nWhen set to `true`, the button 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 button behaves like a disabled button, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
10318
- "default": "undefined",
10319
- "fieldName": "softDisabled",
10320
10327
  "inheritedFrom": {
10321
- "name": "Buttonsimple",
10322
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
10328
+ "name": "FocusTrapMixin",
10329
+ "module": "utils/mixins/FocusTrapMixin.js"
10323
10330
  }
10324
10331
  },
10325
10332
  {
10326
- "name": "size",
10327
- "type": {
10328
- "text": "ButtonSize"
10333
+ "kind": "method",
10334
+ "name": "isEqualFocusNode",
10335
+ "privacy": "private",
10336
+ "parameters": [
10337
+ {
10338
+ "name": "activeElement",
10339
+ "type": {
10340
+ "text": "HTMLElement"
10341
+ },
10342
+ "description": "The active element."
10343
+ },
10344
+ {
10345
+ "name": "element",
10346
+ "type": {
10347
+ "text": "HTMLElement"
10348
+ },
10349
+ "description": "The element to compare."
10350
+ }
10351
+ ],
10352
+ "description": "Checks if the active element is equal to the given element.",
10353
+ "return": {
10354
+ "type": {
10355
+ "text": ""
10356
+ }
10329
10357
  },
10330
- "description": "Simplebutton size is a super set of all the sizes supported by children components.",
10331
- "default": "32",
10332
- "fieldName": "size",
10333
10358
  "inheritedFrom": {
10334
- "name": "Buttonsimple",
10335
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
10359
+ "name": "FocusTrapMixin",
10360
+ "module": "utils/mixins/FocusTrapMixin.js"
10336
10361
  }
10337
10362
  },
10338
10363
  {
10339
- "name": "role",
10340
- "description": "This property defines the ARIA role for the element. By default, it is set to 'button'.\nConsumers should override this role when:\n- The element is being used in a context where a different role is more appropriate.\n- Custom behaviors are implemented that require a specific ARIA role for accessibility purposes.",
10341
- "default": "button",
10342
- "fieldName": "role",
10364
+ "kind": "method",
10365
+ "name": "trapFocus",
10366
+ "privacy": "private",
10367
+ "parameters": [
10368
+ {
10369
+ "name": "event",
10370
+ "type": {
10371
+ "text": "KeyboardEvent"
10372
+ }
10373
+ },
10374
+ {
10375
+ "description": "The direction of the focus trap.\nIf true, the focus will be trapped in the previous element.",
10376
+ "name": "direction"
10377
+ }
10378
+ ],
10379
+ "description": "Traps focus within the container.",
10343
10380
  "inheritedFrom": {
10344
- "name": "Buttonsimple",
10345
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
10381
+ "name": "FocusTrapMixin",
10382
+ "module": "utils/mixins/FocusTrapMixin.js"
10346
10383
  }
10347
10384
  },
10348
10385
  {
10349
- "name": "ariaStateKey",
10350
- "type": {
10351
- "text": "string | undefined"
10352
- },
10353
- "description": "This property defines the ARIA state key, which will be toggled when the\nButton is set to `active`.\nThe default value is 'aria-pressed', which is commonly used for toggle buttons.\n\nConsumers can override this property to use a different ARIA state key if needed.\nIn case multiple aria attributes should be toggled, they can be passed in as\na comma separated string.\nFor example: `aria-pressed,aria-expanded`",
10354
- "default": "'aria-pressed' (when)",
10355
- "fieldName": "ariaStateKey",
10386
+ "kind": "method",
10387
+ "name": "handleTabKeydown",
10388
+ "privacy": "private",
10389
+ "parameters": [
10390
+ {
10391
+ "name": "event",
10392
+ "type": {
10393
+ "text": "KeyboardEvent"
10394
+ },
10395
+ "description": "The keyboard event."
10396
+ }
10397
+ ],
10398
+ "description": "Traps focus within the container.",
10356
10399
  "inheritedFrom": {
10357
- "name": "Buttonsimple",
10358
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
10400
+ "name": "FocusTrapMixin",
10401
+ "module": "utils/mixins/FocusTrapMixin.js"
10359
10402
  }
10360
10403
  },
10361
10404
  {
10362
- "name": "type",
10363
- "type": {
10364
- "text": "ButtonType"
10405
+ "kind": "method",
10406
+ "name": "renderFooter",
10407
+ "privacy": "protected",
10408
+ "description": "Renders the footer of the card if footer-link,\nfooter-button-primary, or footer-button-secondary slots are provided",
10409
+ "return": {
10410
+ "type": {
10411
+ "text": ""
10412
+ }
10365
10413
  },
10366
- "description": "This property defines the type attribute for the button element.\nThe type attribute specifies the behavior of the button when it is clicked.\n- **submit**: The button submits the form data to the server.\n- **reset**: The button resets the form data to its initial state.\n- **button**: The button does nothing when clicked.",
10367
- "default": "button",
10368
- "fieldName": "type",
10369
10414
  "inheritedFrom": {
10370
- "name": "Buttonsimple",
10371
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
10372
- }
10373
- }
10374
- ],
10375
- "superclass": {
10376
- "name": "Chip",
10377
- "module": "/src/components/chip/chip.component"
10378
- },
10379
- "tagName": "mdc-filterchip",
10380
- "jsDoc": "/**\n * mdc-filterchip component is an interactive chip that consumers can use to select or deselect.\n * They can be found with lists or tables as quick filters.\n *\n * This component is built on top of the mdc-chip component.\n *\n * @tagname mdc-filterchip\n *\n */",
10381
- "customElement": true,
10382
- "cssProperties": [
10383
- {
10384
- "description": "The color of the chip.",
10385
- "name": "--mdc-chip-color",
10386
- "inheritedFrom": {
10387
- "name": "Chip",
10388
- "module": "src/components/chip/chip.component.ts"
10389
- }
10390
- },
10391
- {
10392
- "description": "The border color of the chip.",
10393
- "name": "--mdc-chip-border-color",
10394
- "inheritedFrom": {
10395
- "name": "Chip",
10396
- "module": "src/components/chip/chip.component.ts"
10397
- }
10398
- },
10399
- {
10400
- "description": "The background color of the chip.",
10401
- "name": "--mdc-chip-background-color",
10402
- "inheritedFrom": {
10403
- "name": "Chip",
10404
- "module": "src/components/chip/chip.component.ts"
10415
+ "name": "FooterMixin",
10416
+ "module": "utils/mixins/FooterMixin.js"
10405
10417
  }
10406
10418
  }
10407
10419
  ],
10408
10420
  "events": [
10409
10421
  {
10410
- "description": "(React: onClick) This event is dispatched when the button is clicked.",
10411
- "name": "click",
10412
- "reactName": "onClick",
10413
- "inheritedFrom": {
10414
- "name": "Buttonsimple",
10415
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
10416
- }
10417
- },
10418
- {
10419
- "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the button.",
10420
- "name": "keydown",
10421
- "reactName": "onKeyDown",
10422
- "inheritedFrom": {
10423
- "name": "Buttonsimple",
10424
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
10425
- }
10426
- },
10427
- {
10428
- "description": "(React: onKeyUp) This event is dispatched when a key is released on the button.",
10429
- "name": "keyup",
10430
- "reactName": "onKeyUp",
10431
- "inheritedFrom": {
10432
- "name": "Buttonsimple",
10433
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
10434
- }
10435
- },
10436
- {
10437
- "description": "(React: onFocus) This event is dispatched when the button receives focus.",
10438
- "name": "focus",
10439
- "reactName": "onFocus",
10440
- "inheritedFrom": {
10441
- "name": "Buttonsimple",
10442
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
10443
- }
10444
- }
10445
- ]
10446
- }
10447
- ],
10448
- "exports": [
10449
- {
10450
- "kind": "js",
10451
- "name": "default",
10452
- "declaration": {
10453
- "name": "FilterChip",
10454
- "module": "components/filterchip/filterchip.component.js"
10455
- }
10456
- }
10457
- ]
10458
- },
10459
- {
10460
- "kind": "javascript-module",
10461
- "path": "components/dialog/dialog.component.js",
10462
- "declarations": [
10463
- {
10464
- "kind": "class",
10465
- "description": "Dialog component is a modal dialog that can be used to display information or prompt the user for input.\nIt can be used to create custom dialogs where content for the body and footer actions is provided by the consumer.\nThe dialog is available in 5 sizes: small, medium, large, xlarge and fullscreen. It may also receive custom styling/sizing.\nThe dialog interrupts the user and will block interaction with the rest of the application until it is closed.\n\nThe dialog can be controlled solely through the `visible` property, no trigger element is required.\nIf a `triggerId` is provided, the dialog will manage focus with that element, otherwise it will\nremember the previously focused element before the dialog was opened.\n\nThe dialog is a controlled component, meaning it does not have its own state management for visibility.\nUse the `visible` property to control the visibility of the dialog.\nUse the `onClose` event to handle the close action of the dialog (fired when Close button is clicked\nor Escape is pressed).\n\nDialog component have 2 variants: default and promotional.\n\n**Accessibility notes for consuming (have to be explicitly set when you consume the component)**\n\n- The dialog should have an aria-label or aria-labelledby attribute to provide a label for screen readers.\n- Use aria-labelledby to reference the ID of the element that labels the dialog when there is no visible title.\n\n**Note: Programmatic show/hide requires the ? prefix on the visible attribute**\n- Use `?visible=true/false` as an attribute instead of `visible=true/false`\n- Reference docs for more info: https://lit.dev/docs/templates/expressions/#boolean-attribute-expressions",
10466
- "name": "Dialog",
10467
- "cssProperties": [
10468
- {
10469
- "description": "primary background color of the dialog",
10470
- "name": "--mdc-dialog-primary-background-color"
10471
- },
10472
- {
10473
- "description": "border color of the dialog",
10474
- "name": "--mdc-dialog-border-color"
10475
- },
10476
- {
10477
- "description": "text color of the header/title of the dialog",
10478
- "name": "--mdc-dialog-header-text-color"
10479
- },
10480
- {
10481
- "description": "text color of the below header description of the dialog",
10482
- "name": "--mdc-dialog-description-text-color"
10483
- },
10484
- {
10485
- "description": "elevation of the dialog",
10486
- "name": "--mdc-dialog-elevation-3"
10487
- },
10488
- {
10489
- "description": "width of the dialog",
10490
- "name": "--mdc-dialog-width"
10491
- }
10492
- ],
10493
- "slots": [
10494
- {
10495
- "description": "Slot for the dialog header content. This can be used to pass custom header content.",
10496
- "name": "header-prefix"
10497
- },
10498
- {
10499
- "description": "Slot for the dialog body content",
10500
- "name": "dialog-body"
10422
+ "description": "(React: onShown) Dispatched when the dialog is shown",
10423
+ "name": "shown",
10424
+ "reactName": "onShown"
10501
10425
  },
10502
10426
  {
10503
- "description": "This slot is for passing `mdc-link` component within the footer section.",
10504
- "name": "footer-link"
10427
+ "description": "(React: onHidden) Dispatched when the dialog is hidden",
10428
+ "name": "hidden",
10429
+ "reactName": "onHidden"
10505
10430
  },
10506
10431
  {
10507
- "description": "This slot is for passing secondary variant of `mdc-button` component within the footer section.",
10508
- "name": "footer-button-secondary"
10432
+ "description": "(React: onCreated) Dispatched when the dialog is created (added to the DOM)",
10433
+ "name": "created",
10434
+ "reactName": "onCreated"
10509
10435
  },
10510
10436
  {
10511
- "description": "This slot is for passing primary variant of `mdc-button` component within the footer section.",
10512
- "name": "footer-button-primary"
10437
+ "description": "(React: onDestroyed) Dispatched when the dialog is destroyed (removed from the DOM)",
10438
+ "name": "destroyed",
10439
+ "reactName": "onDestroyed"
10513
10440
  },
10514
10441
  {
10515
- "description": " This slot is for passing custom footer content. Only use this if really needed, using the footer-link and footer-button slots is preferred",
10516
- "name": "footer"
10442
+ "description": "(React: onClose) Dispatched when the Close Button is clicked or Escape key is pressed (this does not hide the dialog)",
10443
+ "name": "close",
10444
+ "reactName": "onClose"
10517
10445
  }
10518
10446
  ],
10519
- "members": [
10447
+ "attributes": [
10520
10448
  {
10521
- "kind": "field",
10522
10449
  "name": "id",
10523
10450
  "type": {
10524
10451
  "text": "string"
10525
10452
  },
10526
10453
  "default": "''",
10527
10454
  "description": "The unique ID of the dialog",
10528
- "attribute": "id",
10529
- "reflects": true
10455
+ "fieldName": "id"
10530
10456
  },
10531
10457
  {
10532
- "kind": "field",
10533
10458
  "name": "triggerId",
10534
10459
  "type": {
10535
10460
  "text": "string | undefined"
10536
10461
  },
10537
10462
  "description": "The ID of the element that triggers the dialog",
10538
10463
  "default": "undefined",
10539
- "attribute": "triggerId",
10540
- "reflects": true
10464
+ "fieldName": "triggerId"
10541
10465
  },
10542
10466
  {
10543
- "kind": "field",
10544
10467
  "name": "visible",
10545
10468
  "type": {
10546
10469
  "text": "boolean"
10547
10470
  },
10548
10471
  "description": "The visibility of the dialog\n\nDialog is a controlled component, visible is the only property that controls the visibility of the dialog.",
10549
10472
  "default": "false",
10550
- "attribute": "visible",
10551
- "reflects": true
10473
+ "fieldName": "visible"
10552
10474
  },
10553
10475
  {
10554
- "kind": "field",
10555
- "name": "zIndex",
10476
+ "name": "z-index",
10556
10477
  "type": {
10557
10478
  "text": "number"
10558
10479
  },
10559
10480
  "description": "The z-index of the dialog\n\nThe backdrop will have z-index of `zIndex - 1`",
10560
10481
  "default": "1000",
10561
- "attribute": "z-index",
10562
- "reflects": true
10482
+ "fieldName": "zIndex"
10563
10483
  },
10564
10484
  {
10565
- "kind": "field",
10566
10485
  "name": "size",
10567
10486
  "type": {
10568
10487
  "text": "DialogSize"
10569
10488
  },
10570
10489
  "description": "The size of the dialog, can be 'small' (432px width), 'medium' (656px width), 'large' (992px width), 'xlarge' (90% width) or 'fullscreen' (100% width).",
10571
10490
  "default": "small",
10572
- "attribute": "size",
10573
- "reflects": true
10491
+ "fieldName": "size"
10574
10492
  },
10575
10493
  {
10576
- "kind": "field",
10577
10494
  "name": "variant",
10578
10495
  "type": {
10579
10496
  "text": "DialogVariant"
10580
10497
  },
10581
10498
  "description": "The variant of the dialog, can be 'default' or 'promotional'",
10582
10499
  "default": "default",
10583
- "attribute": "variant",
10584
- "reflects": true
10500
+ "fieldName": "variant"
10585
10501
  },
10586
10502
  {
10587
- "kind": "field",
10588
- "name": "closeButtonAriaLabel",
10503
+ "name": "close-button-aria-label",
10589
10504
  "type": {
10590
10505
  "text": "string | null"
10591
10506
  },
10592
10507
  "default": "null",
10593
10508
  "description": "Defines a string value for the aria-label attribute for close button accessibility",
10594
- "attribute": "close-button-aria-label"
10509
+ "fieldName": "closeButtonAriaLabel"
10595
10510
  },
10596
10511
  {
10597
- "kind": "field",
10598
- "name": "ariaLabel",
10512
+ "name": "aria-label",
10599
10513
  "type": {
10600
10514
  "text": "string | null"
10601
10515
  },
10602
10516
  "default": "null",
10603
10517
  "description": "Defines a string value for the aria-label attribute when header is not used",
10604
- "attribute": "aria-label",
10605
- "reflects": true
10518
+ "fieldName": "ariaLabel"
10606
10519
  },
10607
10520
  {
10608
- "kind": "field",
10609
- "name": "ariaLabelledby",
10521
+ "name": "aria-labelledby",
10610
10522
  "type": {
10611
10523
  "text": "string | null"
10612
10524
  },
10613
10525
  "default": "null",
10614
10526
  "description": "Defines a string value for the aria-labelledby attribute that refers to the element\nlabeling the dialog for accessibility",
10615
- "attribute": "aria-labelledby",
10616
- "reflects": true
10527
+ "fieldName": "ariaLabelledby"
10617
10528
  },
10618
10529
  {
10619
- "kind": "field",
10620
- "name": "ariaDescribedBy",
10530
+ "name": "aria-describedby",
10621
10531
  "type": {
10622
10532
  "text": "string | null"
10623
10533
  },
10624
10534
  "default": "null",
10625
10535
  "description": "Defines a string value for the aria-describedby attribute that refers to the element\ndescribing the dialog for accessibility",
10626
- "attribute": "aria-describedby",
10627
- "reflects": true
10536
+ "fieldName": "ariaDescribedBy"
10628
10537
  },
10629
10538
  {
10630
- "kind": "field",
10631
- "name": "ariaDescription",
10539
+ "name": "aria-description",
10632
10540
  "type": {
10633
10541
  "text": "string | null"
10634
10542
  },
10635
10543
  "default": "null",
10636
10544
  "description": "Defines a string value for the aria-description attribute that refers to the element\ndescribing the dialog for accessibility",
10637
- "attribute": "aria-description",
10638
- "reflects": true
10545
+ "fieldName": "ariaDescription"
10639
10546
  },
10640
10547
  {
10641
- "kind": "field",
10642
- "name": "headerText",
10548
+ "name": "header-text",
10643
10549
  "type": {
10644
10550
  "text": "string | undefined"
10645
10551
  },
10646
10552
  "description": "Defines a string value to display as the title of the dialog",
10647
- "attribute": "header-text",
10648
- "reflects": true
10553
+ "fieldName": "headerText"
10649
10554
  },
10650
10555
  {
10651
- "kind": "field",
10652
- "name": "descriptionText",
10556
+ "name": "description-text",
10653
10557
  "type": {
10654
10558
  "text": "string | undefined"
10655
10559
  },
10656
10560
  "description": "Defines a string value to display as the under-header description of the dialog",
10657
- "attribute": "description-text",
10658
- "reflects": true
10561
+ "fieldName": "descriptionText"
10659
10562
  },
10660
10563
  {
10661
- "kind": "field",
10662
- "name": "headerTagName",
10564
+ "name": "header-tag-name",
10663
10565
  "type": {
10664
10566
  "text": "string"
10665
10567
  },
10666
10568
  "description": "The html tag to be used for the header text",
10667
- "attribute": "header-tag-name",
10668
- "reflects": true
10569
+ "fieldName": "headerTagName"
10669
10570
  },
10670
10571
  {
10671
- "kind": "field",
10672
- "name": "descriptionTagName",
10572
+ "name": "description-tag-name",
10673
10573
  "type": {
10674
10574
  "text": "string"
10675
10575
  },
10676
10576
  "description": "The html tag to be used for the below-header description text",
10677
- "attribute": "description-tag-name",
10678
- "reflects": true
10577
+ "fieldName": "descriptionTagName"
10679
10578
  },
10680
10579
  {
10681
- "kind": "field",
10682
10580
  "name": "role",
10683
10581
  "type": {
10684
10582
  "text": "DialogRole"
10685
10583
  },
10686
10584
  "description": "Role of the dialog",
10687
10585
  "default": "dialog",
10688
- "attribute": "role",
10689
- "reflects": true
10586
+ "fieldName": "role"
10690
10587
  },
10691
10588
  {
10692
- "kind": "field",
10693
- "name": "disableAriaHasPopup",
10589
+ "name": "disable-aria-haspopup",
10694
10590
  "type": {
10695
10591
  "text": "boolean"
10696
10592
  },
10697
10593
  "description": "Disable setting the aria-haspopup attribute on trigger element.\nMake sure to set this to true when the popover is extended and its role\nis not 'dialog' or 'alertdialog' i.e. listbox, menu, etc.",
10698
10594
  "default": "false",
10699
- "attribute": "disable-aria-haspopup",
10700
- "reflects": true
10595
+ "fieldName": "disableAriaHasPopup"
10701
10596
  },
10702
10597
  {
10703
- "kind": "field",
10704
- "name": "focusTrap",
10598
+ "name": "focus-trap",
10705
10599
  "type": {
10706
10600
  "text": "boolean"
10707
10601
  },
10708
- "privacy": "protected",
10709
10602
  "description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.\n\nNOTE: this should only be disabled in rare cases! By default a Modal Dialog\nshould trap focus always.",
10710
10603
  "default": "true",
10711
- "attribute": "focus-trap",
10712
- "reflects": true,
10604
+ "fieldName": "focusTrap"
10605
+ },
10606
+ {
10607
+ "name": "should-focus-trap-wrap",
10608
+ "type": {
10609
+ "text": "boolean"
10610
+ },
10611
+ "default": "true",
10612
+ "description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `focusTrap` is true.",
10613
+ "fieldName": "shouldFocusTrapWrap",
10713
10614
  "inheritedFrom": {
10714
10615
  "name": "FocusTrapMixin",
10715
- "module": "utils/mixins/FocusTrapMixin.js"
10616
+ "module": "src/utils/mixins/FocusTrapMixin.ts"
10716
10617
  }
10618
+ }
10619
+ ],
10620
+ "mixins": [
10621
+ {
10622
+ "name": "PreventScrollMixin",
10623
+ "module": "/src/utils/mixins/PreventScrollMixin"
10717
10624
  },
10718
10625
  {
10719
- "kind": "method",
10720
- "name": "closeDialog",
10721
- "privacy": "private",
10722
- "description": "Fired when Close Button is clicked or Escape key is pressed.\nThis method dispatches the close event. Setting visible to false\nhas to be done by the consumer of the component."
10626
+ "name": "FocusTrapMixin",
10627
+ "module": "/src/utils/mixins/FocusTrapMixin"
10723
10628
  },
10724
10629
  {
10725
- "kind": "method",
10726
- "name": "isOpenUpdated",
10727
- "privacy": "private",
10728
- "parameters": [
10729
- {
10730
- "name": "oldValue",
10731
- "type": {
10732
- "text": "boolean | undefined"
10733
- },
10734
- "description": "The old value of the visible property."
10735
- },
10736
- {
10737
- "name": "newValue",
10738
- "type": {
10739
- "text": "boolean"
10740
- },
10741
- "description": "The new value of the visible property."
10742
- }
10743
- ],
10744
- "description": "Handles the dialog visibility change.\nHandles the exit event to close the dialog."
10630
+ "name": "FooterMixin",
10631
+ "module": "/src/utils/mixins/FooterMixin"
10632
+ }
10633
+ ],
10634
+ "superclass": {
10635
+ "name": "Component",
10636
+ "module": "/src/models"
10637
+ },
10638
+ "tagName": "mdc-dialog",
10639
+ "jsDoc": "/**\n * Dialog component is a modal dialog that can be used to display information or prompt the user for input.\n * It can be used to create custom dialogs where content for the body and footer actions is provided by the consumer.\n * The dialog is available in 5 sizes: small, medium, large, xlarge and fullscreen. It may also receive custom styling/sizing.\n * The dialog interrupts the user and will block interaction with the rest of the application until it is closed.\n *\n * The dialog can be controlled solely through the `visible` property, no trigger element is required.\n * If a `triggerId` is provided, the dialog will manage focus with that element, otherwise it will\n * remember the previously focused element before the dialog was opened.\n *\n * The dialog is a controlled component, meaning it does not have its own state management for visibility.\n * Use the `visible` property to control the visibility of the dialog.\n * Use the `onClose` event to handle the close action of the dialog (fired when Close button is clicked\n * or Escape is pressed).\n *\n * Dialog component have 2 variants: default and promotional.\n *\n * **Accessibility notes for consuming (have to be explicitly set when you consume the component)**\n *\n * - The dialog should have an aria-label or aria-labelledby attribute to provide a label for screen readers.\n * - Use aria-labelledby to reference the ID of the element that labels the dialog when there is no visible title.\n *\n * **Note: Programmatic show/hide requires the ? prefix on the visible attribute**\n * - Use `?visible=true/false` as an attribute instead of `visible=true/false`\n * - Reference docs for more info: https://lit.dev/docs/templates/expressions/#boolean-attribute-expressions\n *\n * @dependency mdc-button\n * @dependency mdc-text\n *\n * @tagname mdc-dialog\n *\n * @event shown - (React: onShown) Dispatched when the dialog is shown\n * @event hidden - (React: onHidden) Dispatched when the dialog is hidden\n * @event created - (React: onCreated) Dispatched when the dialog is created (added to the DOM)\n * @event destroyed - (React: onDestroyed) Dispatched when the dialog is destroyed (removed from the DOM)\n * @event close - (React: onClose) Dispatched when the Close Button is clicked or Escape key is pressed\n * (this does not hide the dialog)\n *\n * @cssproperty --mdc-dialog-primary-background-color - primary background color of the dialog\n * @cssproperty --mdc-dialog-border-color - border color of the dialog\n * @cssproperty --mdc-dialog-header-text-color - text color of the header/title of the dialog\n * @cssproperty --mdc-dialog-description-text-color - text color of the below header description of the dialog\n * @cssproperty --mdc-dialog-elevation-3 - elevation of the dialog\n * @cssproperty --mdc-dialog-width - width of the dialog\n *\n * @slot header-prefix - Slot for the dialog header content. This can be used to pass custom header content.\n * @slot dialog-body - Slot for the dialog body content\n * @slot footer-link - This slot is for passing `mdc-link` component within the footer section.\n * @slot footer-button-secondary - This slot is for passing secondary variant of `mdc-button` component\n * within the footer section.\n * @slot footer-button-primary - This slot is for passing primary variant of\n * `mdc-button` component within the footer section.\n * @slot footer - This slot is for passing custom footer content. Only use this if really needed,\n * using the footer-link and footer-button slots is preferred\n */",
10640
+ "customElement": true
10641
+ }
10642
+ ],
10643
+ "exports": [
10644
+ {
10645
+ "kind": "js",
10646
+ "name": "default",
10647
+ "declaration": {
10648
+ "name": "Dialog",
10649
+ "module": "components/dialog/dialog.component.js"
10650
+ }
10651
+ }
10652
+ ]
10653
+ },
10654
+ {
10655
+ "kind": "javascript-module",
10656
+ "path": "components/divider/divider.component.js",
10657
+ "declarations": [
10658
+ {
10659
+ "kind": "class",
10660
+ "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.",
10661
+ "name": "Divider",
10662
+ "cssProperties": [
10663
+ {
10664
+ "description": "background color of the divider",
10665
+ "name": "--mdc-divider-background-color"
10666
+ },
10667
+ {
10668
+ "description": "width of the divider",
10669
+ "name": "--mdc-divider-width"
10670
+ },
10671
+ {
10672
+ "description": "gradient of the horizontal divider",
10673
+ "name": "--mdc-divider-horizontal-gradient"
10674
+ },
10675
+ {
10676
+ "description": "gradient of the vertical divider",
10677
+ "name": "--mdc-divider-vertical-gradient"
10678
+ },
10679
+ {
10680
+ "description": "font size of label in the text divider",
10681
+ "name": "--mdc-divider-text-size"
10682
+ },
10683
+ {
10684
+ "description": "font color of label in the text divider",
10685
+ "name": "--mdc-divider-text-color"
10686
+ },
10687
+ {
10688
+ "description": "left and right margin of label in the text divider",
10689
+ "name": "--mdc-divider-text-margin"
10690
+ },
10691
+ {
10692
+ "description": "line height of label in the text divider",
10693
+ "name": "--mdc-divider-text-line-height"
10694
+ },
10695
+ {
10696
+ "description": "background color of the grabber button in rest state",
10697
+ "name": "--mdc-divider-grabber-button-background-color-normal"
10698
+ },
10699
+ {
10700
+ "description": "background color of the grabber button in hover state",
10701
+ "name": "--mdc-divider-grabber-button-background-color-hover"
10702
+ },
10703
+ {
10704
+ "description": "background color of the grabber button in pressed state",
10705
+ "name": "--mdc-divider-grabber-button-background-color-pressed"
10706
+ },
10707
+ {
10708
+ "description": "border color of the grabber button",
10709
+ "name": "--mdc-divider-grabber-button-border-color"
10745
10710
  },
10711
+ {
10712
+ "description": "border radius of the grabber button",
10713
+ "name": "--mdc-divider-grabber-button-border-radius"
10714
+ }
10715
+ ],
10716
+ "members": [
10746
10717
  {
10747
10718
  "kind": "field",
10748
- "name": "preventScroll",
10719
+ "name": "orientation",
10749
10720
  "type": {
10750
- "text": "boolean"
10721
+ "text": "DividerOrientation"
10751
10722
  },
10752
- "privacy": "protected",
10753
- "description": "Prevent outside scrolling when element is shown.\n\nIMPLEMENT THIS IN YOUR COMPONENT.",
10754
- "inheritedFrom": {
10755
- "name": "PreventScrollMixin",
10756
- "module": "utils/mixins/PreventScrollMixin.js"
10757
- }
10723
+ "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.",
10724
+ "default": "horizontal",
10725
+ "attribute": "orientation",
10726
+ "reflects": true
10758
10727
  },
10759
10728
  {
10760
- "kind": "method",
10761
- "name": "activatePreventScroll",
10762
- "privacy": "protected",
10763
- "inheritedFrom": {
10764
- "name": "PreventScrollMixin",
10765
- "module": "utils/mixins/PreventScrollMixin.js"
10766
- }
10729
+ "kind": "field",
10730
+ "name": "variant",
10731
+ "type": {
10732
+ "text": "DividerVariant"
10733
+ },
10734
+ "description": "Two variants of divider\n- **solid**: Solid line.\n- **gradient**: Gradient Line that fades on either sides of the divider.",
10735
+ "default": "solid",
10736
+ "attribute": "variant",
10737
+ "reflects": true
10767
10738
  },
10768
10739
  {
10769
- "kind": "method",
10770
- "name": "deactivatePreventScroll",
10771
- "privacy": "protected",
10772
- "inheritedFrom": {
10773
- "name": "PreventScrollMixin",
10774
- "module": "utils/mixins/PreventScrollMixin.js"
10775
- }
10740
+ "kind": "field",
10741
+ "name": "arrowDirection",
10742
+ "type": {
10743
+ "text": "Directions"
10744
+ },
10745
+ "description": "Direction of the arrow icon, if applicable.\n- **positive**\n- **negative**\n\nNote: Positive and Negative directions are defined based on Cartesian plane.",
10746
+ "default": "'negative'",
10747
+ "attribute": "arrow-direction",
10748
+ "reflects": true
10776
10749
  },
10777
10750
  {
10778
10751
  "kind": "field",
10779
- "name": "shouldFocusTrapWrap",
10752
+ "name": "buttonPosition",
10780
10753
  "type": {
10781
- "text": "boolean"
10754
+ "text": "Directions"
10782
10755
  },
10783
- "default": "true",
10784
- "description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `focusTrap` is true.",
10785
- "attribute": "should-focus-trap-wrap",
10786
- "reflects": true,
10787
- "inheritedFrom": {
10788
- "name": "FocusTrapMixin",
10789
- "module": "utils/mixins/FocusTrapMixin.js"
10790
- }
10756
+ "description": "Position of the button, if applicable.\n- **positive**\n- **negative**\n\nNote: Positive and Negative directions are defined based on Cartesian plane.",
10757
+ "default": "'negative'",
10758
+ "attribute": "button-position",
10759
+ "reflects": true
10791
10760
  },
10792
10761
  {
10793
10762
  "kind": "method",
10794
- "name": "setIsFocusTrapActivated",
10763
+ "name": "setVariant",
10795
10764
  "privacy": "private",
10796
10765
  "parameters": [
10797
10766
  {
10798
- "name": "isActivated",
10767
+ "name": "variant",
10799
10768
  "type": {
10800
- "text": "boolean"
10801
- }
10769
+ "text": "DividerVariant"
10770
+ },
10771
+ "description": "The variant to set."
10802
10772
  }
10803
10773
  ],
10804
- "inheritedFrom": {
10805
- "name": "FocusTrapMixin",
10806
- "module": "utils/mixins/FocusTrapMixin.js"
10807
- }
10774
+ "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."
10808
10775
  },
10809
10776
  {
10810
10777
  "kind": "method",
10811
- "name": "activateFocusTrap",
10812
- "privacy": "public",
10813
- "description": "Activate the focus trap",
10814
- "inheritedFrom": {
10815
- "name": "FocusTrapMixin",
10816
- "module": "utils/mixins/FocusTrapMixin.js"
10817
- }
10778
+ "name": "setOrientation",
10779
+ "privacy": "private",
10780
+ "parameters": [
10781
+ {
10782
+ "name": "orientation",
10783
+ "type": {
10784
+ "text": "DividerOrientation"
10785
+ },
10786
+ "description": "The orientation to set."
10787
+ }
10788
+ ],
10789
+ "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."
10818
10790
  },
10819
10791
  {
10820
10792
  "kind": "method",
10821
- "name": "deactivateFocusTrap",
10822
- "privacy": "public",
10823
- "description": "Deactivate the focus trap.",
10824
- "inheritedFrom": {
10825
- "name": "FocusTrapMixin",
10826
- "module": "utils/mixins/FocusTrapMixin.js"
10827
- }
10793
+ "name": "ensureValidDirections",
10794
+ "privacy": "private",
10795
+ "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.",
10796
+ "parameters": [
10797
+ {
10798
+ "description": "The buttonPosition to set.",
10799
+ "name": "buttonPosition"
10800
+ },
10801
+ {
10802
+ "description": "The arrowDirection to set.",
10803
+ "name": "arrowDirection"
10804
+ }
10805
+ ]
10828
10806
  },
10829
10807
  {
10830
10808
  "kind": "method",
10831
- "name": "hasNoClientRects",
10809
+ "name": "setGrabberButton",
10832
10810
  "privacy": "private",
10833
- "parameters": [
10834
- {
10835
- "name": "element",
10836
- "type": {
10837
- "text": "HTMLElement"
10838
- },
10839
- "description": "The element to check."
10811
+ "return": {
10812
+ "type": {
10813
+ "text": "void"
10840
10814
  }
10841
- ],
10842
- "description": "Checks if the element has no client rectangles (not visible in the viewport).",
10815
+ },
10816
+ "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."
10817
+ },
10818
+ {
10819
+ "kind": "method",
10820
+ "name": "getArrowIcon",
10821
+ "privacy": "private",
10843
10822
  "return": {
10844
10823
  "type": {
10845
10824
  "text": ""
10846
10825
  }
10847
10826
  },
10848
- "inheritedFrom": {
10849
- "name": "FocusTrapMixin",
10850
- "module": "utils/mixins/FocusTrapMixin.js"
10851
- }
10827
+ "description": "Determines the arrow icon based on the consumer-defined `arrowDirection`."
10852
10828
  },
10853
10829
  {
10854
10830
  "kind": "method",
10855
- "name": "hasZeroDimensions",
10831
+ "name": "inferDividerType",
10856
10832
  "privacy": "private",
10833
+ "description": "Infers the type of divider based on the kind of slot present.",
10857
10834
  "parameters": [
10858
10835
  {
10859
- "name": "element",
10860
- "type": {
10861
- "text": "HTMLElement"
10862
- },
10863
- "description": "The element to check."
10864
- }
10865
- ],
10866
- "description": "Checks if the element has zero dimensions (width and height are both 0).",
10867
- "return": {
10868
- "type": {
10869
- "text": ""
10836
+ "description": "default slot of divider",
10837
+ "name": "slot"
10870
10838
  }
10839
+ ]
10840
+ }
10841
+ ],
10842
+ "attributes": [
10843
+ {
10844
+ "name": "orientation",
10845
+ "type": {
10846
+ "text": "DividerOrientation"
10871
10847
  },
10872
- "inheritedFrom": {
10873
- "name": "FocusTrapMixin",
10874
- "module": "utils/mixins/FocusTrapMixin.js"
10875
- }
10848
+ "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.",
10849
+ "default": "horizontal",
10850
+ "fieldName": "orientation"
10851
+ },
10852
+ {
10853
+ "name": "variant",
10854
+ "type": {
10855
+ "text": "DividerVariant"
10856
+ },
10857
+ "description": "Two variants of divider\n- **solid**: Solid line.\n- **gradient**: Gradient Line that fades on either sides of the divider.",
10858
+ "default": "solid",
10859
+ "fieldName": "variant"
10860
+ },
10861
+ {
10862
+ "name": "arrow-direction",
10863
+ "type": {
10864
+ "text": "Directions"
10865
+ },
10866
+ "description": "Direction of the arrow icon, if applicable.\n- **positive**\n- **negative**\n\nNote: Positive and Negative directions are defined based on Cartesian plane.",
10867
+ "default": "'negative'",
10868
+ "fieldName": "arrowDirection"
10869
+ },
10870
+ {
10871
+ "name": "button-position",
10872
+ "type": {
10873
+ "text": "Directions"
10874
+ },
10875
+ "description": "Position of the button, if applicable.\n- **positive**\n- **negative**\n\nNote: Positive and Negative directions are defined based on Cartesian plane.",
10876
+ "default": "'negative'",
10877
+ "fieldName": "buttonPosition"
10878
+ }
10879
+ ],
10880
+ "superclass": {
10881
+ "name": "Component",
10882
+ "module": "/src/models"
10883
+ },
10884
+ "tagName": "mdc-divider",
10885
+ "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 */",
10886
+ "customElement": true
10887
+ }
10888
+ ],
10889
+ "exports": [
10890
+ {
10891
+ "kind": "js",
10892
+ "name": "default",
10893
+ "declaration": {
10894
+ "name": "Divider",
10895
+ "module": "components/divider/divider.component.js"
10896
+ }
10897
+ }
10898
+ ]
10899
+ },
10900
+ {
10901
+ "kind": "javascript-module",
10902
+ "path": "components/filterchip/filterchip.component.js",
10903
+ "declarations": [
10904
+ {
10905
+ "kind": "class",
10906
+ "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.",
10907
+ "name": "FilterChip",
10908
+ "members": [
10909
+ {
10910
+ "kind": "field",
10911
+ "name": "selected",
10912
+ "type": {
10913
+ "text": "boolean"
10914
+ },
10915
+ "default": "false",
10916
+ "description": "The selected state of the filterchip.",
10917
+ "attribute": "selected",
10918
+ "reflects": true
10876
10919
  },
10877
10920
  {
10878
10921
  "kind": "method",
10879
- "name": "isNotVisible",
10922
+ "name": "setSelected",
10880
10923
  "privacy": "private",
10881
10924
  "parameters": [
10882
10925
  {
10883
- "name": "element",
10926
+ "name": "selected",
10884
10927
  "type": {
10885
- "text": "HTMLElement"
10928
+ "text": "boolean"
10886
10929
  },
10887
- "description": "The element to check."
10930
+ "description": "The selected state of the filterchip."
10888
10931
  }
10889
10932
  ],
10890
- "description": "Determines if the element is not visible in the DOM.",
10933
+ "description": "Sets the selected state of the filterchip along with the icon.\naria-pressed attribute is also set to true or false."
10934
+ },
10935
+ {
10936
+ "kind": "method",
10937
+ "name": "executeAction",
10938
+ "privacy": "protected",
10939
+ "inheritedFrom": {
10940
+ "name": "Buttonsimple",
10941
+ "module": "components/buttonsimple/buttonsimple.component.js"
10942
+ },
10891
10943
  "return": {
10892
10944
  "type": {
10893
- "text": ""
10945
+ "text": "void"
10894
10946
  }
10947
+ }
10948
+ },
10949
+ {
10950
+ "kind": "field",
10951
+ "name": "iconName",
10952
+ "type": {
10953
+ "text": "IconNames | undefined"
10954
+ },
10955
+ "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
10956
+ "attribute": "icon-name",
10957
+ "inheritedFrom": {
10958
+ "name": "IconNameMixin",
10959
+ "module": "utils/mixins/IconNameMixin.js"
10960
+ }
10961
+ },
10962
+ {
10963
+ "kind": "field",
10964
+ "name": "color",
10965
+ "type": {
10966
+ "text": "ColorType"
10895
10967
  },
10968
+ "description": "The color of the chip. It supports the following colors\n- default\n- cobalt\n- gold\n- lime\n- mint\n- orange\n- pink\n- purple\n- slate\n- violet",
10969
+ "default": "default",
10970
+ "attribute": "color",
10971
+ "reflects": true,
10896
10972
  "inheritedFrom": {
10897
- "name": "FocusTrapMixin",
10898
- "module": "utils/mixins/FocusTrapMixin.js"
10973
+ "name": "Chip",
10974
+ "module": "components/chip/chip.component.js"
10899
10975
  }
10900
10976
  },
10901
10977
  {
10902
- "kind": "method",
10903
- "name": "hasHiddenStyle",
10904
- "privacy": "private",
10905
- "parameters": [
10906
- {
10907
- "name": "element",
10908
- "type": {
10909
- "text": "HTMLElement"
10910
- },
10911
- "description": "The element to check."
10912
- }
10913
- ],
10914
- "description": "Checks if the element has inline styles that make it hidden.",
10915
- "return": {
10916
- "type": {
10917
- "text": ""
10918
- }
10978
+ "kind": "field",
10979
+ "name": "label",
10980
+ "type": {
10981
+ "text": "string"
10919
10982
  },
10983
+ "default": "''",
10984
+ "description": "The visible label text of the chip.\n\nWe recommend limiting the <b>maximum length of the label text to 20 characters</b>,\nincluding empty spaces to split words.",
10985
+ "attribute": "label",
10920
10986
  "inheritedFrom": {
10921
- "name": "FocusTrapMixin",
10922
- "module": "utils/mixins/FocusTrapMixin.js"
10987
+ "name": "Chip",
10988
+ "module": "components/chip/chip.component.js"
10923
10989
  }
10924
10990
  },
10925
10991
  {
10926
10992
  "kind": "method",
10927
- "name": "hasComputedHidden",
10993
+ "name": "renderIcon",
10928
10994
  "privacy": "private",
10929
- "parameters": [
10930
- {
10931
- "name": "element",
10932
- "type": {
10933
- "text": "HTMLElement"
10934
- },
10935
- "description": "The element to check."
10936
- }
10937
- ],
10938
- "description": "Checks if the element is hidden by a computed style.",
10995
+ "description": "Renders the icon element if available.",
10939
10996
  "return": {
10940
10997
  "type": {
10941
10998
  "text": ""
10942
10999
  }
10943
11000
  },
10944
11001
  "inheritedFrom": {
10945
- "name": "FocusTrapMixin",
10946
- "module": "utils/mixins/FocusTrapMixin.js"
11002
+ "name": "Chip",
11003
+ "module": "components/chip/chip.component.js"
10947
11004
  }
10948
11005
  },
10949
11006
  {
10950
- "kind": "method",
10951
- "name": "isHidden",
10952
- "privacy": "private",
10953
- "parameters": [
10954
- {
10955
- "name": "element",
10956
- "type": {
10957
- "text": "HTMLElement"
10958
- },
10959
- "description": "The element to check."
10960
- }
10961
- ],
10962
- "description": "Checks if the element is hidden from the user.",
10963
- "return": {
10964
- "type": {
10965
- "text": ""
10966
- }
11007
+ "kind": "field",
11008
+ "name": "autofocus",
11009
+ "type": {
11010
+ "text": "boolean"
10967
11011
  },
11012
+ "default": "false",
11013
+ "description": "This property indicates whether the element should receive focus automatically when it is rendered.",
11014
+ "attribute": "autofocus",
11015
+ "reflects": true,
10968
11016
  "inheritedFrom": {
10969
- "name": "FocusTrapMixin",
10970
- "module": "utils/mixins/FocusTrapMixin.js"
11017
+ "name": "Buttonsimple",
11018
+ "module": "components/buttonsimple/buttonsimple.component.js"
10971
11019
  }
10972
11020
  },
10973
11021
  {
10974
- "kind": "method",
10975
- "name": "isDisabled",
10976
- "privacy": "private",
10977
- "parameters": [
10978
- {
10979
- "name": "element",
10980
- "type": {
10981
- "text": "any"
10982
- },
10983
- "description": "The element to check."
10984
- }
10985
- ],
10986
- "description": "Checks if the element is disabled.",
10987
- "return": {
10988
- "type": {
10989
- "text": ""
10990
- }
11022
+ "kind": "field",
11023
+ "name": "tabIndex",
11024
+ "type": {
11025
+ "text": "number"
10991
11026
  },
11027
+ "default": "0",
11028
+ "description": "This property specifies the tab order of the element.",
11029
+ "attribute": "tabIndex",
11030
+ "reflects": true,
10992
11031
  "inheritedFrom": {
10993
- "name": "FocusTrapMixin",
10994
- "module": "utils/mixins/FocusTrapMixin.js"
11032
+ "name": "Buttonsimple",
11033
+ "module": "components/buttonsimple/buttonsimple.component.js"
10995
11034
  }
10996
11035
  },
10997
11036
  {
10998
- "kind": "method",
10999
- "name": "isNotTabbable",
11000
- "privacy": "private",
11001
- "parameters": [
11002
- {
11003
- "name": "element",
11004
- "type": {
11005
- "text": "HTMLElement"
11006
- },
11007
- "description": "The element to check."
11008
- }
11009
- ],
11010
- "description": "Checks if the element is not tabbable.",
11011
- "return": {
11012
- "type": {
11013
- "text": ""
11014
- }
11037
+ "kind": "field",
11038
+ "name": "disabled",
11039
+ "type": {
11040
+ "text": "boolean | undefined"
11015
11041
  },
11042
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
11043
+ "default": "undefined",
11044
+ "attribute": "disabled",
11045
+ "reflects": true,
11016
11046
  "inheritedFrom": {
11017
- "name": "FocusTrapMixin",
11018
- "module": "utils/mixins/FocusTrapMixin.js"
11047
+ "name": "Buttonsimple",
11048
+ "module": "components/buttonsimple/buttonsimple.component.js"
11019
11049
  }
11020
11050
  },
11021
11051
  {
11022
- "kind": "method",
11023
- "name": "isInteractiveElement",
11024
- "privacy": "private",
11025
- "return": {
11026
- "type": {
11027
- "text": ""
11028
- }
11052
+ "kind": "field",
11053
+ "name": "active",
11054
+ "type": {
11055
+ "text": "boolean | undefined"
11029
11056
  },
11030
- "parameters": [
11031
- {
11032
- "name": "element",
11033
- "type": {
11034
- "text": "HTMLElement"
11035
- },
11036
- "description": "The element to check."
11037
- }
11038
- ],
11039
- "description": "Checks if the element is interactive.",
11057
+ "description": "The button's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the button is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the button is in an inactive state, indicating it is toggled off.\n\nThis attribute is used to set the provided `ariaStateKey` to true or false.",
11058
+ "default": "undefined",
11059
+ "attribute": "active",
11060
+ "reflects": true,
11040
11061
  "inheritedFrom": {
11041
- "name": "FocusTrapMixin",
11042
- "module": "utils/mixins/FocusTrapMixin.js"
11062
+ "name": "Buttonsimple",
11063
+ "module": "components/buttonsimple/buttonsimple.component.js"
11043
11064
  }
11044
11065
  },
11045
11066
  {
11046
- "kind": "method",
11047
- "name": "isFocusable",
11048
- "privacy": "private",
11049
- "parameters": [
11050
- {
11051
- "name": "element",
11052
- "type": {
11053
- "text": "HTMLElement"
11054
- },
11055
- "description": "The element to check."
11056
- }
11057
- ],
11058
- "description": "Checks if the element is focusable.",
11059
- "return": {
11060
- "type": {
11061
- "text": ""
11062
- }
11067
+ "kind": "field",
11068
+ "name": "softDisabled",
11069
+ "type": {
11070
+ "text": "boolean | undefined"
11063
11071
  },
11072
+ "description": "Indicates whether the button is soft disabled.\nWhen set to `true`, the button 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 button behaves like a disabled button, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
11073
+ "default": "undefined",
11074
+ "attribute": "soft-disabled",
11075
+ "reflects": true,
11064
11076
  "inheritedFrom": {
11065
- "name": "FocusTrapMixin",
11066
- "module": "utils/mixins/FocusTrapMixin.js"
11077
+ "name": "Buttonsimple",
11078
+ "module": "components/buttonsimple/buttonsimple.component.js"
11067
11079
  }
11068
11080
  },
11069
11081
  {
11070
- "kind": "method",
11071
- "name": "findFocusable",
11072
- "privacy": "private",
11073
- "return": {
11074
- "type": {
11075
- "text": ""
11076
- }
11082
+ "kind": "field",
11083
+ "name": "size",
11084
+ "type": {
11085
+ "text": "ButtonSize"
11077
11086
  },
11078
- "parameters": [
11079
- {
11080
- "name": "root",
11081
- "type": {
11082
- "text": "ShadowRoot | HTMLElement"
11083
- },
11084
- "description": "The root element to search for focusable elements."
11085
- },
11086
- {
11087
- "name": "matches",
11088
- "default": "new Set()",
11089
- "type": {
11090
- "text": "Set<HTMLElement>"
11091
- },
11092
- "description": "The set of focusable elements."
11093
- }
11094
- ],
11095
- "description": "Recursively finds all focusable elements within the given root and its descendants.\n\nMake sure this is performant, as it will be called multiple times.",
11087
+ "description": "Simplebutton size is a super set of all the sizes supported by children components.",
11088
+ "default": "32",
11089
+ "attribute": "size",
11090
+ "reflects": true,
11096
11091
  "inheritedFrom": {
11097
- "name": "FocusTrapMixin",
11098
- "module": "utils/mixins/FocusTrapMixin.js"
11092
+ "name": "Buttonsimple",
11093
+ "module": "components/buttonsimple/buttonsimple.component.js"
11099
11094
  }
11100
11095
  },
11101
11096
  {
11102
- "kind": "method",
11103
- "name": "setFocusableElements",
11104
- "privacy": "private",
11105
- "description": "Updates the list of focusable elements within the component's shadow root.",
11097
+ "kind": "field",
11098
+ "name": "role",
11099
+ "description": "This property defines the ARIA role for the element. By default, it is set to 'button'.\nConsumers should override this role when:\n- The element is being used in a context where a different role is more appropriate.\n- Custom behaviors are implemented that require a specific ARIA role for accessibility purposes.",
11100
+ "default": "button",
11101
+ "attribute": "role",
11102
+ "reflects": true,
11103
+ "inheritedFrom": {
11104
+ "name": "Buttonsimple",
11105
+ "module": "components/buttonsimple/buttonsimple.component.js"
11106
+ }
11107
+ },
11108
+ {
11109
+ "kind": "field",
11110
+ "name": "ariaStateKey",
11111
+ "type": {
11112
+ "text": "string | undefined"
11113
+ },
11114
+ "description": "This property defines the ARIA state key, which will be toggled when the\nButton is set to `active`.\nThe default value is 'aria-pressed', which is commonly used for toggle buttons.\n\nConsumers can override this property to use a different ARIA state key if needed.\nIn case multiple aria attributes should be toggled, they can be passed in as\na comma separated string.\nFor example: `aria-pressed,aria-expanded`",
11115
+ "default": "'aria-pressed' (when)",
11116
+ "attribute": "ariaStateKey",
11117
+ "reflects": true,
11106
11118
  "inheritedFrom": {
11107
- "name": "FocusTrapMixin",
11108
- "module": "utils/mixins/FocusTrapMixin.js"
11119
+ "name": "Buttonsimple",
11120
+ "module": "components/buttonsimple/buttonsimple.component.js"
11109
11121
  }
11110
11122
  },
11111
11123
  {
11112
- "kind": "method",
11113
- "name": "setInitialFocus",
11114
- "privacy": "public",
11115
- "parameters": [
11116
- {
11117
- "name": "elementIndexToReceiveFocus",
11118
- "default": "0",
11119
- "type": {
11120
- "text": "number"
11121
- },
11122
- "description": "The index of the preferable element to focus."
11123
- }
11124
- ],
11125
- "description": "Sets the initial focus within the container.",
11124
+ "kind": "field",
11125
+ "name": "type",
11126
+ "type": {
11127
+ "text": "ButtonType"
11128
+ },
11129
+ "description": "This property defines the type attribute for the button element.\nThe type attribute specifies the behavior of the button when it is clicked.\n- **submit**: The button submits the form data to the server.\n- **reset**: The button resets the form data to its initial state.\n- **button**: The button does nothing when clicked.",
11130
+ "default": "button",
11131
+ "attribute": "type",
11132
+ "reflects": true,
11126
11133
  "inheritedFrom": {
11127
- "name": "FocusTrapMixin",
11128
- "module": "utils/mixins/FocusTrapMixin.js"
11134
+ "name": "Buttonsimple",
11135
+ "module": "components/buttonsimple/buttonsimple.component.js"
11129
11136
  }
11130
11137
  },
11131
11138
  {
11132
11139
  "kind": "method",
11133
- "name": "calculateNextIndex",
11134
- "privacy": "private",
11140
+ "name": "setActive",
11141
+ "privacy": "protected",
11135
11142
  "parameters": [
11136
11143
  {
11137
- "name": "currentIndex",
11144
+ "name": "element",
11138
11145
  "type": {
11139
- "text": "number"
11146
+ "text": "HTMLElement"
11140
11147
  },
11141
- "description": "The current index."
11148
+ "description": "The button element"
11142
11149
  },
11143
11150
  {
11144
- "name": "step",
11151
+ "name": "active",
11152
+ "optional": true,
11145
11153
  "type": {
11146
- "text": "number"
11154
+ "text": "boolean"
11147
11155
  },
11148
- "description": "The step to calculate the next index."
11156
+ "description": "The active state of the element"
11149
11157
  }
11150
11158
  ],
11151
- "description": "Calculates the next index for the focus trap.",
11152
- "return": {
11153
- "type": {
11154
- "text": ""
11155
- }
11156
- },
11157
- "inheritedFrom": {
11158
- "name": "FocusTrapMixin",
11159
- "module": "utils/mixins/FocusTrapMixin.js"
11160
- }
11161
- },
11162
- {
11163
- "kind": "method",
11164
- "name": "getDeepActiveElement",
11165
- "privacy": "private",
11166
- "description": "Returns the deepest active element in the shadow DOM.",
11167
- "return": {
11168
- "type": {
11169
- "text": ""
11170
- }
11171
- },
11159
+ "description": "Sets the ariaStateKey attributes based on the active state of the button.",
11172
11160
  "inheritedFrom": {
11173
- "name": "FocusTrapMixin",
11174
- "module": "utils/mixins/FocusTrapMixin.js"
11161
+ "name": "Buttonsimple",
11162
+ "module": "components/buttonsimple/buttonsimple.component.js"
11175
11163
  }
11176
11164
  },
11177
11165
  {
11178
11166
  "kind": "method",
11179
- "name": "findElement",
11167
+ "name": "setSoftDisabled",
11180
11168
  "privacy": "private",
11181
11169
  "parameters": [
11182
11170
  {
11183
- "name": "activeElement",
11171
+ "name": "element",
11184
11172
  "type": {
11185
11173
  "text": "HTMLElement"
11186
11174
  },
11187
- "description": "The active element."
11175
+ "description": "The button element."
11176
+ },
11177
+ {
11178
+ "name": "softDisabled",
11179
+ "optional": true,
11180
+ "type": {
11181
+ "text": "boolean"
11182
+ },
11183
+ "description": "The soft-disabled state."
11188
11184
  }
11189
11185
  ],
11190
- "description": "Finds the index of the active element within the focusable elements.",
11191
- "return": {
11192
- "type": {
11193
- "text": ""
11194
- }
11195
- },
11186
+ "description": "Sets the soft-disabled attribute for the button.\nWhen soft-disabled, the button looks to be disabled but remains focusable and clickable.\nAlso sets/removes aria-disabled attribute.",
11196
11187
  "inheritedFrom": {
11197
- "name": "FocusTrapMixin",
11198
- "module": "utils/mixins/FocusTrapMixin.js"
11188
+ "name": "Buttonsimple",
11189
+ "module": "components/buttonsimple/buttonsimple.component.js"
11199
11190
  }
11200
11191
  },
11201
11192
  {
11202
11193
  "kind": "method",
11203
- "name": "isEqualFocusNode",
11194
+ "name": "setDisabled",
11204
11195
  "privacy": "private",
11205
11196
  "parameters": [
11206
11197
  {
11207
- "name": "activeElement",
11198
+ "name": "element",
11208
11199
  "type": {
11209
11200
  "text": "HTMLElement"
11210
11201
  },
11211
- "description": "The active element."
11202
+ "description": "The button element."
11212
11203
  },
11213
11204
  {
11214
- "name": "element",
11205
+ "name": "disabled",
11215
11206
  "type": {
11216
- "text": "HTMLElement"
11207
+ "text": "boolean"
11217
11208
  },
11218
- "description": "The element to compare."
11209
+ "description": "The disabled state."
11219
11210
  }
11220
11211
  ],
11221
- "description": "Checks if the active element is equal to the given element.",
11222
- "return": {
11223
- "type": {
11224
- "text": ""
11225
- }
11226
- },
11212
+ "description": "Sets the disabled attribute for the button.\nWhen disabled, the button is not focusable or clickable, and tabindex is set to -1.\nThe previous tabindex is stored and restored when enabled.\nAlso sets/removes aria-disabled attribute.",
11227
11213
  "inheritedFrom": {
11228
- "name": "FocusTrapMixin",
11229
- "module": "utils/mixins/FocusTrapMixin.js"
11214
+ "name": "Buttonsimple",
11215
+ "module": "components/buttonsimple/buttonsimple.component.js"
11230
11216
  }
11231
11217
  },
11232
11218
  {
11233
11219
  "kind": "method",
11234
- "name": "trapFocus",
11220
+ "name": "triggerClickEvent",
11221
+ "privacy": "private",
11222
+ "inheritedFrom": {
11223
+ "name": "Buttonsimple",
11224
+ "module": "components/buttonsimple/buttonsimple.component.js"
11225
+ }
11226
+ },
11227
+ {
11228
+ "kind": "method",
11229
+ "name": "handleBlur",
11230
+ "privacy": "private",
11231
+ "description": "In case the button is pressed and the focus is lost while pressing,\nthe pressed class is removed.",
11232
+ "inheritedFrom": {
11233
+ "name": "Buttonsimple",
11234
+ "module": "components/buttonsimple/buttonsimple.component.js"
11235
+ }
11236
+ },
11237
+ {
11238
+ "kind": "method",
11239
+ "name": "handleKeyDown",
11235
11240
  "privacy": "private",
11236
11241
  "parameters": [
11237
11242
  {
11238
11243
  "name": "event",
11239
11244
  "type": {
11240
11245
  "text": "KeyboardEvent"
11241
- }
11242
- },
11243
- {
11244
- "description": "The direction of the focus trap.\nIf true, the focus will be trapped in the previous element.",
11245
- "name": "direction"
11246
+ },
11247
+ "description": "The keyboard event."
11246
11248
  }
11247
11249
  ],
11248
- "description": "Traps focus within the container.",
11250
+ "description": "Handles the keydown event on the button.\nIf the key is 'Enter' or 'Space', the button is pressed.\nIf the key is 'Enter', the button is pressed. The native HTML button works in the same way.\nIf the key is 'Space', the button's default is prevent to avoid scrolling etc in the host application.",
11249
11251
  "inheritedFrom": {
11250
- "name": "FocusTrapMixin",
11251
- "module": "utils/mixins/FocusTrapMixin.js"
11252
+ "name": "Buttonsimple",
11253
+ "module": "components/buttonsimple/buttonsimple.component.js"
11252
11254
  }
11253
11255
  },
11254
11256
  {
11255
11257
  "kind": "method",
11256
- "name": "handleTabKeydown",
11258
+ "name": "handleKeyUp",
11257
11259
  "privacy": "private",
11258
11260
  "parameters": [
11259
11261
  {
@@ -11264,249 +11266,247 @@
11264
11266
  "description": "The keyboard event."
11265
11267
  }
11266
11268
  ],
11267
- "description": "Traps focus within the container.",
11268
- "inheritedFrom": {
11269
- "name": "FocusTrapMixin",
11270
- "module": "utils/mixins/FocusTrapMixin.js"
11271
- }
11272
- },
11273
- {
11274
- "kind": "method",
11275
- "name": "renderFooter",
11276
- "privacy": "protected",
11277
- "description": "Renders the footer of the card if footer-link,\nfooter-button-primary, or footer-button-secondary slots are provided",
11278
- "return": {
11279
- "type": {
11280
- "text": ""
11281
- }
11282
- },
11269
+ "description": "Handles the keyup event on the button.\nIf the key is 'Enter' or 'Space', the button is clicked.\nIf the key is 'Space', the button is pressed. The native HTML button works in the same way.",
11283
11270
  "inheritedFrom": {
11284
- "name": "FooterMixin",
11285
- "module": "utils/mixins/FooterMixin.js"
11271
+ "name": "Buttonsimple",
11272
+ "module": "components/buttonsimple/buttonsimple.component.js"
11286
11273
  }
11287
11274
  }
11288
11275
  ],
11289
- "events": [
11290
- {
11291
- "description": "(React: onShown) Dispatched when the dialog is shown",
11292
- "name": "shown",
11293
- "reactName": "onShown"
11294
- },
11295
- {
11296
- "description": "(React: onHidden) Dispatched when the dialog is hidden",
11297
- "name": "hidden",
11298
- "reactName": "onHidden"
11299
- },
11300
- {
11301
- "description": "(React: onCreated) Dispatched when the dialog is created (added to the DOM)",
11302
- "name": "created",
11303
- "reactName": "onCreated"
11304
- },
11305
- {
11306
- "description": "(React: onDestroyed) Dispatched when the dialog is destroyed (removed from the DOM)",
11307
- "name": "destroyed",
11308
- "reactName": "onDestroyed"
11309
- },
11310
- {
11311
- "description": "(React: onClose) Dispatched when the Close Button is clicked or Escape key is pressed (this does not hide the dialog)",
11312
- "name": "close",
11313
- "reactName": "onClose"
11314
- }
11315
- ],
11316
11276
  "attributes": [
11317
11277
  {
11318
- "name": "id",
11319
- "type": {
11320
- "text": "string"
11321
- },
11322
- "default": "''",
11323
- "description": "The unique ID of the dialog",
11324
- "fieldName": "id"
11325
- },
11326
- {
11327
- "name": "triggerId",
11328
- "type": {
11329
- "text": "string | undefined"
11330
- },
11331
- "description": "The ID of the element that triggers the dialog",
11332
- "default": "undefined",
11333
- "fieldName": "triggerId"
11334
- },
11335
- {
11336
- "name": "visible",
11278
+ "name": "selected",
11337
11279
  "type": {
11338
11280
  "text": "boolean"
11339
11281
  },
11340
- "description": "The visibility of the dialog\n\nDialog is a controlled component, visible is the only property that controls the visibility of the dialog.",
11341
11282
  "default": "false",
11342
- "fieldName": "visible"
11343
- },
11344
- {
11345
- "name": "z-index",
11346
- "type": {
11347
- "text": "number"
11348
- },
11349
- "description": "The z-index of the dialog\n\nThe backdrop will have z-index of `zIndex - 1`",
11350
- "default": "1000",
11351
- "fieldName": "zIndex"
11352
- },
11353
- {
11354
- "name": "size",
11355
- "type": {
11356
- "text": "DialogSize"
11357
- },
11358
- "description": "The size of the dialog, can be 'small' (432px width), 'medium' (656px width), 'large' (992px width), 'xlarge' (90% width) or 'fullscreen' (100% width).",
11359
- "default": "small",
11360
- "fieldName": "size"
11361
- },
11362
- {
11363
- "name": "variant",
11364
- "type": {
11365
- "text": "DialogVariant"
11366
- },
11367
- "description": "The variant of the dialog, can be 'default' or 'promotional'",
11368
- "default": "default",
11369
- "fieldName": "variant"
11283
+ "description": "The selected state of the filterchip.",
11284
+ "fieldName": "selected"
11370
11285
  },
11371
11286
  {
11372
- "name": "close-button-aria-label",
11287
+ "name": "icon-name",
11373
11288
  "type": {
11374
- "text": "string | null"
11289
+ "text": "IconNames | undefined"
11375
11290
  },
11376
- "default": "null",
11377
- "description": "Defines a string value for the aria-label attribute for close button accessibility",
11378
- "fieldName": "closeButtonAriaLabel"
11291
+ "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
11292
+ "fieldName": "iconName",
11293
+ "inheritedFrom": {
11294
+ "name": "IconNameMixin",
11295
+ "module": "src/utils/mixins/IconNameMixin.ts"
11296
+ }
11379
11297
  },
11380
11298
  {
11381
- "name": "aria-label",
11299
+ "name": "color",
11382
11300
  "type": {
11383
- "text": "string | null"
11301
+ "text": "ColorType"
11384
11302
  },
11385
- "default": "null",
11386
- "description": "Defines a string value for the aria-label attribute when header is not used",
11387
- "fieldName": "ariaLabel"
11303
+ "description": "The color of the chip. It supports the following colors\n- default\n- cobalt\n- gold\n- lime\n- mint\n- orange\n- pink\n- purple\n- slate\n- violet",
11304
+ "default": "default",
11305
+ "fieldName": "color",
11306
+ "inheritedFrom": {
11307
+ "name": "Chip",
11308
+ "module": "src/components/chip/chip.component.ts"
11309
+ }
11388
11310
  },
11389
11311
  {
11390
- "name": "aria-labelledby",
11312
+ "name": "label",
11391
11313
  "type": {
11392
- "text": "string | null"
11314
+ "text": "string"
11393
11315
  },
11394
- "default": "null",
11395
- "description": "Defines a string value for the aria-labelledby attribute that refers to the element\nlabeling the dialog for accessibility",
11396
- "fieldName": "ariaLabelledby"
11316
+ "default": "''",
11317
+ "description": "The visible label text of the chip.\n\nWe recommend limiting the <b>maximum length of the label text to 20 characters</b>,\nincluding empty spaces to split words.",
11318
+ "fieldName": "label",
11319
+ "inheritedFrom": {
11320
+ "name": "Chip",
11321
+ "module": "src/components/chip/chip.component.ts"
11322
+ }
11397
11323
  },
11398
11324
  {
11399
- "name": "aria-describedby",
11325
+ "name": "autofocus",
11400
11326
  "type": {
11401
- "text": "string | null"
11327
+ "text": "boolean"
11402
11328
  },
11403
- "default": "null",
11404
- "description": "Defines a string value for the aria-describedby attribute that refers to the element\ndescribing the dialog for accessibility",
11405
- "fieldName": "ariaDescribedBy"
11329
+ "default": "false",
11330
+ "description": "This property indicates whether the element should receive focus automatically when it is rendered.",
11331
+ "fieldName": "autofocus",
11332
+ "inheritedFrom": {
11333
+ "name": "Buttonsimple",
11334
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
11335
+ }
11406
11336
  },
11407
11337
  {
11408
- "name": "aria-description",
11338
+ "name": "tabIndex",
11409
11339
  "type": {
11410
- "text": "string | null"
11340
+ "text": "number"
11411
11341
  },
11412
- "default": "null",
11413
- "description": "Defines a string value for the aria-description attribute that refers to the element\ndescribing the dialog for accessibility",
11414
- "fieldName": "ariaDescription"
11342
+ "default": "0",
11343
+ "description": "This property specifies the tab order of the element.",
11344
+ "fieldName": "tabIndex",
11345
+ "inheritedFrom": {
11346
+ "name": "Buttonsimple",
11347
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
11348
+ }
11415
11349
  },
11416
11350
  {
11417
- "name": "header-text",
11351
+ "name": "disabled",
11418
11352
  "type": {
11419
- "text": "string | undefined"
11353
+ "text": "boolean | undefined"
11420
11354
  },
11421
- "description": "Defines a string value to display as the title of the dialog",
11422
- "fieldName": "headerText"
11355
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
11356
+ "default": "undefined",
11357
+ "fieldName": "disabled",
11358
+ "inheritedFrom": {
11359
+ "name": "Buttonsimple",
11360
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
11361
+ }
11423
11362
  },
11424
11363
  {
11425
- "name": "description-text",
11364
+ "name": "active",
11426
11365
  "type": {
11427
- "text": "string | undefined"
11366
+ "text": "boolean | undefined"
11428
11367
  },
11429
- "description": "Defines a string value to display as the under-header description of the dialog",
11430
- "fieldName": "descriptionText"
11368
+ "description": "The button's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the button is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the button is in an inactive state, indicating it is toggled off.\n\nThis attribute is used to set the provided `ariaStateKey` to true or false.",
11369
+ "default": "undefined",
11370
+ "fieldName": "active",
11371
+ "inheritedFrom": {
11372
+ "name": "Buttonsimple",
11373
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
11374
+ }
11431
11375
  },
11432
11376
  {
11433
- "name": "header-tag-name",
11377
+ "name": "soft-disabled",
11434
11378
  "type": {
11435
- "text": "string"
11379
+ "text": "boolean | undefined"
11436
11380
  },
11437
- "description": "The html tag to be used for the header text",
11438
- "fieldName": "headerTagName"
11381
+ "description": "Indicates whether the button is soft disabled.\nWhen set to `true`, the button 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 button behaves like a disabled button, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
11382
+ "default": "undefined",
11383
+ "fieldName": "softDisabled",
11384
+ "inheritedFrom": {
11385
+ "name": "Buttonsimple",
11386
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
11387
+ }
11439
11388
  },
11440
11389
  {
11441
- "name": "description-tag-name",
11390
+ "name": "size",
11442
11391
  "type": {
11443
- "text": "string"
11392
+ "text": "ButtonSize"
11444
11393
  },
11445
- "description": "The html tag to be used for the below-header description text",
11446
- "fieldName": "descriptionTagName"
11394
+ "description": "Simplebutton size is a super set of all the sizes supported by children components.",
11395
+ "default": "32",
11396
+ "fieldName": "size",
11397
+ "inheritedFrom": {
11398
+ "name": "Buttonsimple",
11399
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
11400
+ }
11447
11401
  },
11448
11402
  {
11449
11403
  "name": "role",
11450
- "type": {
11451
- "text": "DialogRole"
11452
- },
11453
- "description": "Role of the dialog",
11454
- "default": "dialog",
11455
- "fieldName": "role"
11404
+ "description": "This property defines the ARIA role for the element. By default, it is set to 'button'.\nConsumers should override this role when:\n- The element is being used in a context where a different role is more appropriate.\n- Custom behaviors are implemented that require a specific ARIA role for accessibility purposes.",
11405
+ "default": "button",
11406
+ "fieldName": "role",
11407
+ "inheritedFrom": {
11408
+ "name": "Buttonsimple",
11409
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
11410
+ }
11456
11411
  },
11457
11412
  {
11458
- "name": "disable-aria-haspopup",
11413
+ "name": "ariaStateKey",
11459
11414
  "type": {
11460
- "text": "boolean"
11415
+ "text": "string | undefined"
11461
11416
  },
11462
- "description": "Disable setting the aria-haspopup attribute on trigger element.\nMake sure to set this to true when the popover is extended and its role\nis not 'dialog' or 'alertdialog' i.e. listbox, menu, etc.",
11463
- "default": "false",
11464
- "fieldName": "disableAriaHasPopup"
11417
+ "description": "This property defines the ARIA state key, which will be toggled when the\nButton is set to `active`.\nThe default value is 'aria-pressed', which is commonly used for toggle buttons.\n\nConsumers can override this property to use a different ARIA state key if needed.\nIn case multiple aria attributes should be toggled, they can be passed in as\na comma separated string.\nFor example: `aria-pressed,aria-expanded`",
11418
+ "default": "'aria-pressed' (when)",
11419
+ "fieldName": "ariaStateKey",
11420
+ "inheritedFrom": {
11421
+ "name": "Buttonsimple",
11422
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
11423
+ }
11465
11424
  },
11466
11425
  {
11467
- "name": "focus-trap",
11426
+ "name": "type",
11468
11427
  "type": {
11469
- "text": "boolean"
11428
+ "text": "ButtonType"
11470
11429
  },
11471
- "description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.\n\nNOTE: this should only be disabled in rare cases! By default a Modal Dialog\nshould trap focus always.",
11472
- "default": "true",
11473
- "fieldName": "focusTrap"
11430
+ "description": "This property defines the type attribute for the button element.\nThe type attribute specifies the behavior of the button when it is clicked.\n- **submit**: The button submits the form data to the server.\n- **reset**: The button resets the form data to its initial state.\n- **button**: The button does nothing when clicked.",
11431
+ "default": "button",
11432
+ "fieldName": "type",
11433
+ "inheritedFrom": {
11434
+ "name": "Buttonsimple",
11435
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
11436
+ }
11437
+ }
11438
+ ],
11439
+ "superclass": {
11440
+ "name": "Chip",
11441
+ "module": "/src/components/chip/chip.component"
11442
+ },
11443
+ "tagName": "mdc-filterchip",
11444
+ "jsDoc": "/**\n * mdc-filterchip component is an interactive chip that consumers can use to select or deselect.\n * They can be found with lists or tables as quick filters.\n *\n * This component is built on top of the mdc-chip component.\n *\n * @tagname mdc-filterchip\n *\n */",
11445
+ "customElement": true,
11446
+ "cssProperties": [
11447
+ {
11448
+ "description": "The color of the chip.",
11449
+ "name": "--mdc-chip-color",
11450
+ "inheritedFrom": {
11451
+ "name": "Chip",
11452
+ "module": "src/components/chip/chip.component.ts"
11453
+ }
11474
11454
  },
11475
11455
  {
11476
- "name": "should-focus-trap-wrap",
11477
- "type": {
11478
- "text": "boolean"
11479
- },
11480
- "default": "true",
11481
- "description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `focusTrap` is true.",
11482
- "fieldName": "shouldFocusTrapWrap",
11456
+ "description": "The border color of the chip.",
11457
+ "name": "--mdc-chip-border-color",
11483
11458
  "inheritedFrom": {
11484
- "name": "FocusTrapMixin",
11485
- "module": "src/utils/mixins/FocusTrapMixin.ts"
11459
+ "name": "Chip",
11460
+ "module": "src/components/chip/chip.component.ts"
11461
+ }
11462
+ },
11463
+ {
11464
+ "description": "The background color of the chip.",
11465
+ "name": "--mdc-chip-background-color",
11466
+ "inheritedFrom": {
11467
+ "name": "Chip",
11468
+ "module": "src/components/chip/chip.component.ts"
11486
11469
  }
11487
11470
  }
11488
11471
  ],
11489
- "mixins": [
11472
+ "events": [
11490
11473
  {
11491
- "name": "PreventScrollMixin",
11492
- "module": "/src/utils/mixins/PreventScrollMixin"
11474
+ "description": "(React: onClick) This event is dispatched when the button is clicked.",
11475
+ "name": "click",
11476
+ "reactName": "onClick",
11477
+ "inheritedFrom": {
11478
+ "name": "Buttonsimple",
11479
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
11480
+ }
11493
11481
  },
11494
11482
  {
11495
- "name": "FocusTrapMixin",
11496
- "module": "/src/utils/mixins/FocusTrapMixin"
11483
+ "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the button.",
11484
+ "name": "keydown",
11485
+ "reactName": "onKeyDown",
11486
+ "inheritedFrom": {
11487
+ "name": "Buttonsimple",
11488
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
11489
+ }
11497
11490
  },
11498
11491
  {
11499
- "name": "FooterMixin",
11500
- "module": "/src/utils/mixins/FooterMixin"
11492
+ "description": "(React: onKeyUp) This event is dispatched when a key is released on the button.",
11493
+ "name": "keyup",
11494
+ "reactName": "onKeyUp",
11495
+ "inheritedFrom": {
11496
+ "name": "Buttonsimple",
11497
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
11498
+ }
11499
+ },
11500
+ {
11501
+ "description": "(React: onFocus) This event is dispatched when the button receives focus.",
11502
+ "name": "focus",
11503
+ "reactName": "onFocus",
11504
+ "inheritedFrom": {
11505
+ "name": "Buttonsimple",
11506
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
11507
+ }
11501
11508
  }
11502
- ],
11503
- "superclass": {
11504
- "name": "Component",
11505
- "module": "/src/models"
11506
- },
11507
- "tagName": "mdc-dialog",
11508
- "jsDoc": "/**\n * Dialog component is a modal dialog that can be used to display information or prompt the user for input.\n * It can be used to create custom dialogs where content for the body and footer actions is provided by the consumer.\n * The dialog is available in 5 sizes: small, medium, large, xlarge and fullscreen. It may also receive custom styling/sizing.\n * The dialog interrupts the user and will block interaction with the rest of the application until it is closed.\n *\n * The dialog can be controlled solely through the `visible` property, no trigger element is required.\n * If a `triggerId` is provided, the dialog will manage focus with that element, otherwise it will\n * remember the previously focused element before the dialog was opened.\n *\n * The dialog is a controlled component, meaning it does not have its own state management for visibility.\n * Use the `visible` property to control the visibility of the dialog.\n * Use the `onClose` event to handle the close action of the dialog (fired when Close button is clicked\n * or Escape is pressed).\n *\n * Dialog component have 2 variants: default and promotional.\n *\n * **Accessibility notes for consuming (have to be explicitly set when you consume the component)**\n *\n * - The dialog should have an aria-label or aria-labelledby attribute to provide a label for screen readers.\n * - Use aria-labelledby to reference the ID of the element that labels the dialog when there is no visible title.\n *\n * **Note: Programmatic show/hide requires the ? prefix on the visible attribute**\n * - Use `?visible=true/false` as an attribute instead of `visible=true/false`\n * - Reference docs for more info: https://lit.dev/docs/templates/expressions/#boolean-attribute-expressions\n *\n * @dependency mdc-button\n * @dependency mdc-text\n *\n * @tagname mdc-dialog\n *\n * @event shown - (React: onShown) Dispatched when the dialog is shown\n * @event hidden - (React: onHidden) Dispatched when the dialog is hidden\n * @event created - (React: onCreated) Dispatched when the dialog is created (added to the DOM)\n * @event destroyed - (React: onDestroyed) Dispatched when the dialog is destroyed (removed from the DOM)\n * @event close - (React: onClose) Dispatched when the Close Button is clicked or Escape key is pressed\n * (this does not hide the dialog)\n *\n * @cssproperty --mdc-dialog-primary-background-color - primary background color of the dialog\n * @cssproperty --mdc-dialog-border-color - border color of the dialog\n * @cssproperty --mdc-dialog-header-text-color - text color of the header/title of the dialog\n * @cssproperty --mdc-dialog-description-text-color - text color of the below header description of the dialog\n * @cssproperty --mdc-dialog-elevation-3 - elevation of the dialog\n * @cssproperty --mdc-dialog-width - width of the dialog\n *\n * @slot header-prefix - Slot for the dialog header content. This can be used to pass custom header content.\n * @slot dialog-body - Slot for the dialog body content\n * @slot footer-link - This slot is for passing `mdc-link` component within the footer section.\n * @slot footer-button-secondary - This slot is for passing secondary variant of `mdc-button` component\n * within the footer section.\n * @slot footer-button-primary - This slot is for passing primary variant of\n * `mdc-button` component within the footer section.\n * @slot footer - This slot is for passing custom footer content. Only use this if really needed,\n * using the footer-link and footer-button slots is preferred\n */",
11509
- "customElement": true
11509
+ ]
11510
11510
  }
11511
11511
  ],
11512
11512
  "exports": [
@@ -11514,8 +11514,8 @@
11514
11514
  "kind": "js",
11515
11515
  "name": "default",
11516
11516
  "declaration": {
11517
- "name": "Dialog",
11518
- "module": "components/dialog/dialog.component.js"
11517
+ "name": "FilterChip",
11518
+ "module": "components/filterchip/filterchip.component.js"
11519
11519
  }
11520
11520
  }
11521
11521
  ]
@@ -33284,14 +33284,6 @@
33284
33284
  {
33285
33285
  "description": "Option to override the color of the scrollbar thumb.",
33286
33286
  "name": "--mdc-themeprovider-scrollbar-thumb-color"
33287
- },
33288
- {
33289
- "description": "Option to override the color of the scrollbar thumb on hover. Applicable only on webkit browsers.",
33290
- "name": "--mdc-themeprovider-scrollbar-thumb-hover-color"
33291
- },
33292
- {
33293
- "description": "Option to override the color of the scrollbar thumb on press. Applicable only on webkit browsers.",
33294
- "name": "--mdc-themeprovider-scrollbar-thumb-active-color"
33295
33287
  }
33296
33288
  ],
33297
33289
  "slots": [
@@ -33351,7 +33343,7 @@
33351
33343
  "module": "/src/models"
33352
33344
  },
33353
33345
  "tagName": "mdc-themeprovider",
33354
- "jsDoc": "/**\n * ThemeProvider component, which sets the passed in themeclass as class.\n * If the themeclass switches, the existing themeclass will be removed as a class\n * and the new themeclass will be added.\n *\n * CSS variables defined in the themeclass will be used for the styling of child dom nodes.\n *\n * Available Momentum theme classes:\n *\n * `mds-theme-stable-darkWebex`, `mds-theme-stable-lightWebex`\n *\n * `mds-theme-stable-darkBronzeWebex`, `mds-theme-stable-lightBronzeWebex`\n *\n * `mds-theme-stable-darkIndigoWebex`, `mds-theme-stable-lightIndigoWebex`\n *\n * `mds-theme-stable-darkJadeWebex`, `mds-theme-stable-lightJadeWebex`\n *\n * `mds-theme-stable-darkLavenderWebex`, `mds-theme-stable-lightLavenderWebex`\n *\n * `mds-theme-stable-darkRoseWebex`, `mds-theme-stable-lightRoseWebex`\n *\n * Themeclass context can be be consumed from Lit child components\n * (see providerUtils.consume for how to consume)\n *\n * ThemeProvider also includes basic font defaults for text.\n *\n * @tagname mdc-themeprovider\n *\n * @slot - children\n *\n * @cssproperty --mdc-themeprovider-color-default - Option to override the default color,\n * default: color-theme-text-primary-normal\n * @cssproperty --mdc-themeprovider-font-family - Option to override the font family,\n * default: `Momentum` (from momentum-design/fonts)\n * @cssproperty --mdc-themeprovider-font-weight - Option to override the font weight, default: `400`\n * @cssproperty --mdc-themeprovider-letter-spacing-adjustment - Option to override the default letter-spacing,\n * default: `-0.25px` (this is to match the old CiscoSans)\n * @cssproperty --mdc-themeprovider-font-feature-settings - Option to override the font feature settings,\n * default: `\"ss02\" on`\n * @cssproperty --mdc-themeprovider-scrollbar-track-color - Option to override the color of the scrollbar track.\n * @cssproperty --mdc-themeprovider-scrollbar-thumb-color - Option to override the color of the scrollbar thumb.\n * @cssproperty --mdc-themeprovider-scrollbar-thumb-hover-color - Option to override the color of the\n * scrollbar thumb on hover. Applicable only on webkit browsers.\n * @cssproperty --mdc-themeprovider-scrollbar-thumb-active-color - Option to override the color of the\n * scrollbar thumb on press. Applicable only on webkit browsers.\n */",
33346
+ "jsDoc": "/**\n * ThemeProvider component, which sets the passed in themeclass as class.\n * If the themeclass switches, the existing themeclass will be removed as a class\n * and the new themeclass will be added.\n *\n * CSS variables defined in the themeclass will be used for the styling of child dom nodes.\n *\n * Available Momentum theme classes:\n *\n * `mds-theme-stable-darkWebex`, `mds-theme-stable-lightWebex`\n *\n * `mds-theme-stable-darkBronzeWebex`, `mds-theme-stable-lightBronzeWebex`\n *\n * `mds-theme-stable-darkIndigoWebex`, `mds-theme-stable-lightIndigoWebex`\n *\n * `mds-theme-stable-darkJadeWebex`, `mds-theme-stable-lightJadeWebex`\n *\n * `mds-theme-stable-darkLavenderWebex`, `mds-theme-stable-lightLavenderWebex`\n *\n * `mds-theme-stable-darkRoseWebex`, `mds-theme-stable-lightRoseWebex`\n *\n * Themeclass context can be be consumed from Lit child components\n * (see providerUtils.consume for how to consume)\n *\n * ThemeProvider also includes basic font defaults for text.\n *\n * @tagname mdc-themeprovider\n *\n * @slot - children\n *\n * @cssproperty --mdc-themeprovider-color-default - Option to override the default color,\n * default: color-theme-text-primary-normal\n * @cssproperty --mdc-themeprovider-font-family - Option to override the font family,\n * default: `Momentum` (from momentum-design/fonts)\n * @cssproperty --mdc-themeprovider-font-weight - Option to override the font weight, default: `400`\n * @cssproperty --mdc-themeprovider-letter-spacing-adjustment - Option to override the default letter-spacing,\n * default: `-0.25px` (this is to match the old CiscoSans)\n * @cssproperty --mdc-themeprovider-font-feature-settings - Option to override the font feature settings,\n * default: `\"ss02\" on`\n * @cssproperty --mdc-themeprovider-scrollbar-track-color - Option to override the color of the scrollbar track.\n * @cssproperty --mdc-themeprovider-scrollbar-thumb-color - Option to override the color of the scrollbar thumb.\n */",
33355
33347
  "customElement": true
33356
33348
  }
33357
33349
  ],