@momentum-design/components 0.94.0 → 0.95.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -7759,336 +7759,229 @@
7759
7759
  },
7760
7760
  {
7761
7761
  "kind": "javascript-module",
7762
- "path": "components/dialog/dialog.component.js",
7762
+ "path": "components/coachmark/coachmark.component.js",
7763
7763
  "declarations": [
7764
7764
  {
7765
7765
  "kind": "class",
7766
- "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",
7767
- "name": "Dialog",
7766
+ "description": "Coachmark component based on top of the popover component,\nwith the default value of certain properties changed.",
7767
+ "name": "Coachmark",
7768
7768
  "cssProperties": [
7769
7769
  {
7770
- "description": "primary background color of the dialog",
7771
- "name": "--mdc-dialog-primary-background-color"
7770
+ "description": "radius of the arrow border",
7771
+ "name": "--mdc-popover-arrow-border-radius",
7772
+ "inheritedFrom": {
7773
+ "name": "Popover",
7774
+ "module": "src/components/popover/popover.component.ts"
7775
+ }
7772
7776
  },
7773
7777
  {
7774
- "description": "border color of the dialog",
7775
- "name": "--mdc-dialog-border-color"
7778
+ "description": "border of the arrow",
7779
+ "name": "--mdc-popover-arrow-border",
7780
+ "inheritedFrom": {
7781
+ "name": "Popover",
7782
+ "module": "src/components/popover/popover.component.ts"
7783
+ }
7776
7784
  },
7777
7785
  {
7778
- "description": "text color of the header/title of the dialog",
7779
- "name": "--mdc-dialog-header-text-color"
7786
+ "description": "primary background color of the popover",
7787
+ "name": "--mdc-popover-primary-background-color",
7788
+ "inheritedFrom": {
7789
+ "name": "Popover",
7790
+ "module": "src/components/popover/popover.component.ts"
7791
+ }
7780
7792
  },
7781
7793
  {
7782
- "description": "text color of the below header description of the dialog",
7783
- "name": "--mdc-dialog-description-text-color"
7794
+ "description": "border color of the popover",
7795
+ "name": "--mdc-popover-border-color",
7796
+ "inheritedFrom": {
7797
+ "name": "Popover",
7798
+ "module": "src/components/popover/popover.component.ts"
7799
+ }
7784
7800
  },
7785
7801
  {
7786
- "description": "elevation of the dialog",
7787
- "name": "--mdc-dialog-elevation-3"
7802
+ "description": "inverted background color of the popover",
7803
+ "name": "--mdc-popover-inverted-background-color",
7804
+ "inheritedFrom": {
7805
+ "name": "Popover",
7806
+ "module": "src/components/popover/popover.component.ts"
7807
+ }
7788
7808
  },
7789
7809
  {
7790
- "description": "width of the dialog",
7791
- "name": "--mdc-dialog-width"
7792
- }
7793
- ],
7794
- "slots": [
7795
- {
7796
- "description": "Slot for the dialog header content. This can be used to pass custom header content.",
7797
- "name": "header-prefix"
7810
+ "description": "inverted border color of the popover",
7811
+ "name": "--mdc-popover-inverted-border-color",
7812
+ "inheritedFrom": {
7813
+ "name": "Popover",
7814
+ "module": "src/components/popover/popover.component.ts"
7815
+ }
7798
7816
  },
7799
7817
  {
7800
- "description": "Slot for the dialog body content",
7801
- "name": "dialog-body"
7818
+ "description": "inverted text color of the popover",
7819
+ "name": "--mdc-popover-inverted-text-color",
7820
+ "inheritedFrom": {
7821
+ "name": "Popover",
7822
+ "module": "src/components/popover/popover.component.ts"
7823
+ }
7802
7824
  },
7803
7825
  {
7804
- "description": "This slot is for passing `mdc-link` component within the footer section.",
7805
- "name": "footer-link"
7826
+ "description": "elevation of the popover",
7827
+ "name": "--mdc-popover-elevation-3",
7828
+ "inheritedFrom": {
7829
+ "name": "Popover",
7830
+ "module": "src/components/popover/popover.component.ts"
7831
+ }
7806
7832
  },
7807
7833
  {
7808
- "description": "This slot is for passing secondary variant of `mdc-button` component within the footer section.",
7809
- "name": "footer-button-secondary"
7834
+ "description": "max width of the popover",
7835
+ "name": "--mdc-popover-max-width",
7836
+ "inheritedFrom": {
7837
+ "name": "Popover",
7838
+ "module": "src/components/popover/popover.component.ts"
7839
+ }
7810
7840
  },
7811
7841
  {
7812
- "description": "This slot is for passing primary variant of `mdc-button` component within the footer section.",
7813
- "name": "footer-button-primary"
7814
- },
7842
+ "description": "max height of the popover",
7843
+ "name": "--mdc-popover-max-height",
7844
+ "inheritedFrom": {
7845
+ "name": "Popover",
7846
+ "module": "src/components/popover/popover.component.ts"
7847
+ }
7848
+ }
7849
+ ],
7850
+ "slots": [
7815
7851
  {
7816
- "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",
7817
- "name": "footer"
7852
+ "description": "Default slot for modal container",
7853
+ "name": "",
7854
+ "inheritedFrom": {
7855
+ "name": "Popover",
7856
+ "module": "src/components/popover/popover.component.ts"
7857
+ }
7818
7858
  }
7819
7859
  ],
7820
7860
  "members": [
7821
7861
  {
7822
7862
  "kind": "field",
7823
- "name": "id",
7863
+ "name": "trigger",
7824
7864
  "type": {
7825
- "text": "string"
7865
+ "text": "PopoverTrigger"
7826
7866
  },
7827
- "default": "''",
7828
- "description": "The unique ID of the dialog",
7829
- "attribute": "id",
7830
- "reflects": true
7867
+ "description": "Determines the events that cause the Coachmark to show.\nMultiple event names should be separated by spaces.\nFor example to allow both click and hover, use 'click mouseenter' as the trigger.\n- **click**\n- **mouseenter**\n- **focusin**\n- **manual**",
7868
+ "default": "manual",
7869
+ "attribute": "trigger",
7870
+ "reflects": true,
7871
+ "inheritedFrom": {
7872
+ "name": "Popover",
7873
+ "module": "components/popover/popover.component.js"
7874
+ }
7831
7875
  },
7832
7876
  {
7833
7877
  "kind": "field",
7834
- "name": "triggerId",
7878
+ "name": "showArrow",
7835
7879
  "type": {
7836
- "text": "string | undefined"
7880
+ "text": "boolean"
7837
7881
  },
7838
- "description": "The ID of the element that triggers the dialog",
7839
- "default": "undefined",
7840
- "attribute": "triggerId",
7841
- "reflects": true
7882
+ "description": "The arrow visibility of the Coachmark.",
7883
+ "default": "true",
7884
+ "attribute": "show-arrow",
7885
+ "reflects": true,
7886
+ "inheritedFrom": {
7887
+ "name": "Popover",
7888
+ "module": "components/popover/popover.component.js"
7889
+ }
7842
7890
  },
7843
7891
  {
7844
7892
  "kind": "field",
7845
- "name": "visible",
7893
+ "name": "closeButton",
7846
7894
  "type": {
7847
7895
  "text": "boolean"
7848
7896
  },
7849
- "description": "The visibility of the dialog\n\nDialog is a controlled component, visible is the only property that controls the visibility of the dialog.",
7850
- "default": "false",
7851
- "attribute": "visible",
7852
- "reflects": true
7897
+ "description": "The close button visibility of the Coachmark.",
7898
+ "default": "true",
7899
+ "attribute": "close-button",
7900
+ "reflects": true,
7901
+ "inheritedFrom": {
7902
+ "name": "Popover",
7903
+ "module": "components/popover/popover.component.js"
7904
+ }
7853
7905
  },
7854
7906
  {
7855
7907
  "kind": "field",
7856
- "name": "zIndex",
7908
+ "name": "disableAriaExpanded",
7857
7909
  "type": {
7858
- "text": "number"
7910
+ "text": "boolean"
7859
7911
  },
7860
- "description": "The z-index of the dialog\n\nThe backdrop will have z-index of `zIndex - 1`",
7861
- "default": "1000",
7862
- "attribute": "z-index",
7863
- "reflects": true
7912
+ "description": "Disable aria-expanded attribute on trigger element.",
7913
+ "default": "true",
7914
+ "attribute": "disable-aria-expanded",
7915
+ "reflects": true,
7916
+ "inheritedFrom": {
7917
+ "name": "Popover",
7918
+ "module": "components/popover/popover.component.js"
7919
+ }
7864
7920
  },
7865
7921
  {
7866
7922
  "kind": "field",
7867
- "name": "size",
7923
+ "name": "preventScroll",
7868
7924
  "type": {
7869
- "text": "DialogSize"
7925
+ "text": "boolean"
7870
7926
  },
7871
- "description": "The size of the dialog, can be 'small' (432px width), 'medium' (656px width), 'large' (992px width), 'xlarge' (90% width) or 'fullscreen' (100% width).",
7872
- "default": "small",
7873
- "attribute": "size",
7874
- "reflects": true
7927
+ "description": "Prevent outside scrolling when element is shown.\n\nIMPLEMENT THIS IN YOUR COMPONENT.",
7928
+ "default": "false",
7929
+ "attribute": "prevent-scroll",
7930
+ "reflects": true,
7931
+ "privacy": "protected",
7932
+ "inheritedFrom": {
7933
+ "name": "Popover",
7934
+ "module": "components/popover/popover.component.js"
7935
+ }
7875
7936
  },
7876
7937
  {
7877
- "kind": "field",
7878
- "name": "variant",
7879
- "type": {
7880
- "text": "DialogVariant"
7881
- },
7882
- "description": "The variant of the dialog, can be 'default' or 'promotional'",
7883
- "default": "default",
7884
- "attribute": "variant",
7885
- "reflects": true
7938
+ "kind": "method",
7939
+ "name": "activatePreventScroll",
7940
+ "privacy": "protected",
7941
+ "inheritedFrom": {
7942
+ "name": "PreventScrollMixin",
7943
+ "module": "utils/mixins/PreventScrollMixin.js"
7944
+ }
7886
7945
  },
7887
7946
  {
7888
- "kind": "field",
7889
- "name": "closeButtonAriaLabel",
7890
- "type": {
7891
- "text": "string | null"
7892
- },
7893
- "default": "null",
7894
- "description": "Defines a string value for the aria-label attribute for close button accessibility",
7895
- "attribute": "close-button-aria-label"
7947
+ "kind": "method",
7948
+ "name": "deactivatePreventScroll",
7949
+ "privacy": "protected",
7950
+ "inheritedFrom": {
7951
+ "name": "PreventScrollMixin",
7952
+ "module": "utils/mixins/PreventScrollMixin.js"
7953
+ }
7896
7954
  },
7897
7955
  {
7898
7956
  "kind": "field",
7899
- "name": "ariaLabel",
7957
+ "name": "focusTrap",
7900
7958
  "type": {
7901
- "text": "string | null"
7959
+ "text": "boolean"
7902
7960
  },
7903
- "default": "null",
7904
- "description": "Defines a string value for the aria-label attribute when header is not used",
7905
- "attribute": "aria-label",
7906
- "reflects": true
7961
+ "description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.\n\nIMPLEMENT THIS IN YOUR COMPONENT.",
7962
+ "default": "false",
7963
+ "attribute": "focus-trap",
7964
+ "reflects": true,
7965
+ "privacy": "protected",
7966
+ "inheritedFrom": {
7967
+ "name": "Popover",
7968
+ "module": "components/popover/popover.component.js"
7969
+ }
7907
7970
  },
7908
7971
  {
7909
7972
  "kind": "field",
7910
- "name": "ariaLabelledby",
7973
+ "name": "shouldFocusTrapWrap",
7911
7974
  "type": {
7912
- "text": "string | null"
7975
+ "text": "boolean"
7913
7976
  },
7914
- "default": "null",
7915
- "description": "Defines a string value for the aria-labelledby attribute that refers to the element\nlabeling the dialog for accessibility",
7916
- "attribute": "aria-labelledby",
7917
- "reflects": true
7918
- },
7919
- {
7920
- "kind": "field",
7921
- "name": "ariaDescribedBy",
7922
- "type": {
7923
- "text": "string | null"
7924
- },
7925
- "default": "null",
7926
- "description": "Defines a string value for the aria-describedby attribute that refers to the element\ndescribing the dialog for accessibility",
7927
- "attribute": "aria-describedby",
7928
- "reflects": true
7929
- },
7930
- {
7931
- "kind": "field",
7932
- "name": "ariaDescription",
7933
- "type": {
7934
- "text": "string | null"
7935
- },
7936
- "default": "null",
7937
- "description": "Defines a string value for the aria-description attribute that refers to the element\ndescribing the dialog for accessibility",
7938
- "attribute": "aria-description",
7939
- "reflects": true
7940
- },
7941
- {
7942
- "kind": "field",
7943
- "name": "headerText",
7944
- "type": {
7945
- "text": "string | undefined"
7946
- },
7947
- "description": "Defines a string value to display as the title of the dialog",
7948
- "attribute": "header-text",
7949
- "reflects": true
7950
- },
7951
- {
7952
- "kind": "field",
7953
- "name": "descriptionText",
7954
- "type": {
7955
- "text": "string | undefined"
7956
- },
7957
- "description": "Defines a string value to display as the under-header description of the dialog",
7958
- "attribute": "description-text",
7959
- "reflects": true
7960
- },
7961
- {
7962
- "kind": "field",
7963
- "name": "headerTagName",
7964
- "type": {
7965
- "text": "string"
7966
- },
7967
- "description": "The html tag to be used for the header text",
7968
- "attribute": "header-tag-name",
7969
- "reflects": true
7970
- },
7971
- {
7972
- "kind": "field",
7973
- "name": "descriptionTagName",
7974
- "type": {
7975
- "text": "string"
7976
- },
7977
- "description": "The html tag to be used for the below-header description text",
7978
- "attribute": "description-tag-name",
7979
- "reflects": true
7980
- },
7981
- {
7982
- "kind": "field",
7983
- "name": "role",
7984
- "type": {
7985
- "text": "DialogRole"
7986
- },
7987
- "description": "Role of the dialog",
7988
- "default": "dialog",
7989
- "attribute": "role",
7990
- "reflects": true
7991
- },
7992
- {
7993
- "kind": "field",
7994
- "name": "disableAriaHasPopup",
7995
- "type": {
7996
- "text": "boolean"
7997
- },
7998
- "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.",
7999
- "default": "false",
8000
- "attribute": "disable-aria-haspopup",
8001
- "reflects": true
8002
- },
8003
- {
8004
- "kind": "field",
8005
- "name": "focusTrap",
8006
- "type": {
8007
- "text": "boolean"
8008
- },
8009
- "privacy": "protected",
8010
- "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.",
8011
- "default": "true",
8012
- "attribute": "focus-trap",
8013
- "reflects": true,
8014
- "inheritedFrom": {
8015
- "name": "FocusTrapMixin",
8016
- "module": "utils/mixins/FocusTrapMixin.js"
8017
- }
8018
- },
8019
- {
8020
- "kind": "method",
8021
- "name": "closeDialog",
8022
- "privacy": "private",
8023
- "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."
8024
- },
8025
- {
8026
- "kind": "method",
8027
- "name": "isOpenUpdated",
8028
- "privacy": "private",
8029
- "parameters": [
8030
- {
8031
- "name": "oldValue",
8032
- "type": {
8033
- "text": "boolean | undefined"
8034
- },
8035
- "description": "The old value of the visible property."
8036
- },
8037
- {
8038
- "name": "newValue",
8039
- "type": {
8040
- "text": "boolean"
8041
- },
8042
- "description": "The new value of the visible property."
8043
- }
8044
- ],
8045
- "description": "Handles the dialog visibility change.\nHandles the exit event to close the dialog."
8046
- },
8047
- {
8048
- "kind": "field",
8049
- "name": "preventScroll",
8050
- "type": {
8051
- "text": "boolean"
8052
- },
8053
- "privacy": "protected",
8054
- "description": "Prevent outside scrolling when element is shown.\n\nIMPLEMENT THIS IN YOUR COMPONENT.",
8055
- "inheritedFrom": {
8056
- "name": "PreventScrollMixin",
8057
- "module": "utils/mixins/PreventScrollMixin.js"
8058
- }
8059
- },
8060
- {
8061
- "kind": "method",
8062
- "name": "activatePreventScroll",
8063
- "privacy": "protected",
8064
- "inheritedFrom": {
8065
- "name": "PreventScrollMixin",
8066
- "module": "utils/mixins/PreventScrollMixin.js"
8067
- }
8068
- },
8069
- {
8070
- "kind": "method",
8071
- "name": "deactivatePreventScroll",
8072
- "privacy": "protected",
8073
- "inheritedFrom": {
8074
- "name": "PreventScrollMixin",
8075
- "module": "utils/mixins/PreventScrollMixin.js"
8076
- }
8077
- },
8078
- {
8079
- "kind": "field",
8080
- "name": "shouldFocusTrapWrap",
8081
- "type": {
8082
- "text": "boolean"
8083
- },
8084
- "default": "true",
8085
- "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.",
8086
- "attribute": "should-focus-trap-wrap",
8087
- "reflects": true,
8088
- "inheritedFrom": {
8089
- "name": "FocusTrapMixin",
8090
- "module": "utils/mixins/FocusTrapMixin.js"
8091
- }
7977
+ "default": "true",
7978
+ "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.",
7979
+ "attribute": "should-focus-trap-wrap",
7980
+ "reflects": true,
7981
+ "inheritedFrom": {
7982
+ "name": "FocusTrapMixin",
7983
+ "module": "utils/mixins/FocusTrapMixin.js"
7984
+ }
8092
7985
  },
8093
7986
  {
8094
7987
  "kind": "method",
@@ -8572,365 +8465,359 @@
8572
8465
  }
8573
8466
  },
8574
8467
  {
8575
- "kind": "method",
8576
- "name": "renderFooter",
8577
- "privacy": "protected",
8578
- "description": "Renders the footer of the card if footer-link,\nfooter-button-primary, or footer-button-secondary slots are provided",
8579
- "return": {
8580
- "type": {
8581
- "text": ""
8582
- }
8583
- },
8584
- "inheritedFrom": {
8585
- "name": "CardAndDialogFooterMixin",
8586
- "module": "utils/mixins/CardAndDialogFooterMixin.js"
8587
- }
8588
- }
8589
- ],
8590
- "events": [
8591
- {
8592
- "description": "(React: onShown) Dispatched when the dialog is shown",
8593
- "name": "shown",
8594
- "reactName": "onShown"
8595
- },
8596
- {
8597
- "description": "(React: onHidden) Dispatched when the dialog is hidden",
8598
- "name": "hidden",
8599
- "reactName": "onHidden"
8600
- },
8601
- {
8602
- "description": "(React: onCreated) Dispatched when the dialog is created (added to the DOM)",
8603
- "name": "created",
8604
- "reactName": "onCreated"
8605
- },
8606
- {
8607
- "description": "(React: onDestroyed) Dispatched when the dialog is destroyed (removed from the DOM)",
8608
- "name": "destroyed",
8609
- "reactName": "onDestroyed"
8610
- },
8611
- {
8612
- "description": "(React: onClose) Dispatched when the Close Button is clicked or Escape key is pressed (this does not hide the dialog)",
8613
- "name": "close",
8614
- "reactName": "onClose"
8615
- }
8616
- ],
8617
- "attributes": [
8618
- {
8468
+ "kind": "field",
8619
8469
  "name": "id",
8620
8470
  "type": {
8621
8471
  "text": "string"
8622
8472
  },
8623
8473
  "default": "''",
8624
- "description": "The unique ID of the dialog",
8625
- "fieldName": "id"
8474
+ "description": "The unique ID of the popover.",
8475
+ "attribute": "id",
8476
+ "reflects": true,
8477
+ "inheritedFrom": {
8478
+ "name": "Popover",
8479
+ "module": "components/popover/popover.component.js"
8480
+ }
8626
8481
  },
8627
8482
  {
8628
- "name": "triggerId",
8483
+ "kind": "field",
8484
+ "name": "triggerID",
8629
8485
  "type": {
8630
- "text": "string | undefined"
8486
+ "text": "string"
8631
8487
  },
8632
- "description": "The ID of the element that triggers the dialog",
8633
- "default": "undefined",
8634
- "fieldName": "triggerId"
8488
+ "default": "''",
8489
+ "description": "The ID of the element that triggers the popover.\nThis attribute is required for the popover to work.",
8490
+ "attribute": "triggerID",
8491
+ "reflects": true,
8492
+ "inheritedFrom": {
8493
+ "name": "Popover",
8494
+ "module": "components/popover/popover.component.js"
8495
+ }
8635
8496
  },
8636
8497
  {
8637
- "name": "visible",
8498
+ "kind": "field",
8499
+ "name": "placement",
8638
8500
  "type": {
8639
- "text": "boolean"
8501
+ "text": "PopoverPlacement"
8640
8502
  },
8641
- "description": "The visibility of the dialog\n\nDialog is a controlled component, visible is the only property that controls the visibility of the dialog.",
8642
- "default": "false",
8643
- "fieldName": "visible"
8503
+ "description": "The placement of the popover.\n- **top**\n- **top-start**\n- **top-end**\n- **bottom**\n- **bottom-start**\n- **bottom-end**\n- **left**\n- **left-start**\n- **left-end**\n- **right**\n- **right-start**\n- **right-end**",
8504
+ "default": "bottom",
8505
+ "attribute": "placement",
8506
+ "reflects": true,
8507
+ "inheritedFrom": {
8508
+ "name": "Popover",
8509
+ "module": "components/popover/popover.component.js"
8510
+ }
8644
8511
  },
8645
8512
  {
8646
- "name": "z-index",
8513
+ "kind": "field",
8514
+ "name": "color",
8647
8515
  "type": {
8648
- "text": "number"
8516
+ "text": "PopoverColor"
8649
8517
  },
8650
- "description": "The z-index of the dialog\n\nThe backdrop will have z-index of `zIndex - 1`",
8651
- "default": "1000",
8652
- "fieldName": "zIndex"
8518
+ "description": "Color of the popover\n- **tonal**\n- **contrast**",
8519
+ "default": "tonal",
8520
+ "attribute": "color",
8521
+ "reflects": true,
8522
+ "inheritedFrom": {
8523
+ "name": "Popover",
8524
+ "module": "components/popover/popover.component.js"
8525
+ }
8653
8526
  },
8654
8527
  {
8655
- "name": "size",
8528
+ "kind": "field",
8529
+ "name": "visible",
8656
8530
  "type": {
8657
- "text": "DialogSize"
8531
+ "text": "boolean"
8658
8532
  },
8659
- "description": "The size of the dialog, can be 'small' (432px width), 'medium' (656px width), 'large' (992px width), 'xlarge' (90% width) or 'fullscreen' (100% width).",
8660
- "default": "small",
8661
- "fieldName": "size"
8533
+ "description": "The visibility of the popover.",
8534
+ "default": "false",
8535
+ "attribute": "visible",
8536
+ "reflects": true,
8537
+ "inheritedFrom": {
8538
+ "name": "Popover",
8539
+ "module": "components/popover/popover.component.js"
8540
+ }
8662
8541
  },
8663
8542
  {
8664
- "name": "variant",
8543
+ "kind": "field",
8544
+ "name": "offset",
8665
8545
  "type": {
8666
- "text": "DialogVariant"
8546
+ "text": "number"
8667
8547
  },
8668
- "description": "The variant of the dialog, can be 'default' or 'promotional'",
8669
- "default": "default",
8670
- "fieldName": "variant"
8548
+ "description": "The offset of the popover.",
8549
+ "default": "4",
8550
+ "attribute": "offset",
8551
+ "reflects": true,
8552
+ "inheritedFrom": {
8553
+ "name": "Popover",
8554
+ "module": "components/popover/popover.component.js"
8555
+ }
8671
8556
  },
8672
8557
  {
8673
- "name": "close-button-aria-label",
8558
+ "kind": "field",
8559
+ "name": "boundary",
8674
8560
  "type": {
8675
- "text": "string | null"
8561
+ "text": "'clippingAncestors' | string"
8676
8562
  },
8677
- "default": "null",
8678
- "description": "Defines a string value for the aria-label attribute for close button accessibility",
8679
- "fieldName": "closeButtonAriaLabel"
8563
+ "description": "This describes the clipping element(s) or area that overflow will be checked relative to.\nThe default is 'clippingAncestors', which are the overflow ancestors which will cause the\nelement to be clipped.\n\nPossible values:\n - 'clippingAncestors'\n - any css selector",
8564
+ "default": "'clippingAncestors'",
8565
+ "attribute": "boundary",
8566
+ "reflects": true,
8567
+ "inheritedFrom": {
8568
+ "name": "Popover",
8569
+ "module": "components/popover/popover.component.js"
8570
+ }
8680
8571
  },
8681
8572
  {
8682
- "name": "aria-label",
8573
+ "kind": "field",
8574
+ "name": "boundaryRoot",
8683
8575
  "type": {
8684
- "text": "string | null"
8576
+ "text": "'viewport' | 'document'"
8685
8577
  },
8686
- "default": "null",
8687
- "description": "Defines a string value for the aria-label attribute when header is not used",
8688
- "fieldName": "ariaLabel"
8578
+ "description": "This describes the root boundary that the element will be checked for overflow relative to.\nThe default is 'viewport', which is the area of the page the user can see on the screen.\n\nThe other string option is 'document', which is the entire page outside the viewport.",
8579
+ "default": "'viewport'",
8580
+ "attribute": "boundary-root",
8581
+ "reflects": true,
8582
+ "inheritedFrom": {
8583
+ "name": "Popover",
8584
+ "module": "components/popover/popover.component.js"
8585
+ }
8689
8586
  },
8690
8587
  {
8691
- "name": "aria-labelledby",
8588
+ "kind": "field",
8589
+ "name": "boundaryPadding",
8692
8590
  "type": {
8693
- "text": "string | null"
8591
+ "text": "undefined | number"
8694
8592
  },
8695
- "default": "null",
8696
- "description": "Defines a string value for the aria-labelledby attribute that refers to the element\nlabeling the dialog for accessibility",
8697
- "fieldName": "ariaLabelledby"
8593
+ "description": "Virtual padding around the boundary to check for overflow.\nSo the popover will not be placed on top of the edge of the boundary.\n\nDefault works well for most cases, but you can set this to customise it when necessary.",
8594
+ "default": "undefined",
8595
+ "attribute": "boundary-padding",
8596
+ "reflects": true,
8597
+ "inheritedFrom": {
8598
+ "name": "Popover",
8599
+ "module": "components/popover/popover.component.js"
8600
+ }
8698
8601
  },
8699
8602
  {
8700
- "name": "aria-describedby",
8603
+ "kind": "field",
8604
+ "name": "interactive",
8701
8605
  "type": {
8702
- "text": "string | null"
8606
+ "text": "boolean"
8703
8607
  },
8704
- "default": "null",
8705
- "description": "Defines a string value for the aria-describedby attribute that refers to the element\ndescribing the dialog for accessibility",
8706
- "fieldName": "ariaDescribedBy"
8608
+ "description": "Determines whether the popover is interactive.\nMake sure to set focusTrap to true to keep the focus inside the popover in case necessary.\nSetting interactive to true will not automatically set focusTrap!",
8609
+ "default": "false",
8610
+ "attribute": "interactive",
8611
+ "reflects": true,
8612
+ "inheritedFrom": {
8613
+ "name": "Popover",
8614
+ "module": "components/popover/popover.component.js"
8615
+ }
8707
8616
  },
8708
8617
  {
8709
- "name": "aria-description",
8618
+ "kind": "field",
8619
+ "name": "delay",
8710
8620
  "type": {
8711
- "text": "string | null"
8621
+ "text": "string"
8712
8622
  },
8713
- "default": "null",
8714
- "description": "Defines a string value for the aria-description attribute that refers to the element\ndescribing the dialog for accessibility",
8715
- "fieldName": "ariaDescription"
8623
+ "description": "The delay of the show/hide popover.",
8624
+ "default": "0,0",
8625
+ "attribute": "delay",
8626
+ "reflects": true,
8627
+ "inheritedFrom": {
8628
+ "name": "Popover",
8629
+ "module": "components/popover/popover.component.js"
8630
+ }
8716
8631
  },
8717
8632
  {
8718
- "name": "header-text",
8633
+ "kind": "field",
8634
+ "name": "hideOnEscape",
8719
8635
  "type": {
8720
- "text": "string | undefined"
8636
+ "text": "boolean"
8721
8637
  },
8722
- "description": "Defines a string value to display as the title of the dialog",
8723
- "fieldName": "headerText"
8638
+ "description": "Hide popover on escape key press.",
8639
+ "default": "false",
8640
+ "attribute": "hide-on-escape",
8641
+ "reflects": true,
8642
+ "inheritedFrom": {
8643
+ "name": "Popover",
8644
+ "module": "components/popover/popover.component.js"
8645
+ }
8724
8646
  },
8725
8647
  {
8726
- "name": "description-text",
8648
+ "kind": "field",
8649
+ "name": "propagateEventOnEscape",
8727
8650
  "type": {
8728
- "text": "string | undefined"
8651
+ "text": "boolean"
8729
8652
  },
8730
- "description": "Defines a string value to display as the under-header description of the dialog",
8731
- "fieldName": "descriptionText"
8653
+ "description": "Propagates the event, when the escape key is pressed (only when pressed inside the popover)\nIf true, the escape key press close the popover and will propagate the keydown event.\nIf false, the escape key press will close the popover but will not propagate the keydown event.\n(set to false to prevent the event from bubbling up to the document).\n\nThis only works when `hideOnEscape` is true.",
8654
+ "default": "false",
8655
+ "attribute": "propagate-event-on-escape",
8656
+ "reflects": true,
8657
+ "inheritedFrom": {
8658
+ "name": "Popover",
8659
+ "module": "components/popover/popover.component.js"
8660
+ }
8732
8661
  },
8733
8662
  {
8734
- "name": "header-tag-name",
8663
+ "kind": "field",
8664
+ "name": "hideOnBlur",
8735
8665
  "type": {
8736
- "text": "string"
8666
+ "text": "boolean"
8737
8667
  },
8738
- "description": "The html tag to be used for the header text",
8739
- "fieldName": "headerTagName"
8668
+ "description": "Hide popover on blur.",
8669
+ "default": "false",
8670
+ "attribute": "hide-on-blur",
8671
+ "reflects": true,
8672
+ "inheritedFrom": {
8673
+ "name": "Popover",
8674
+ "module": "components/popover/popover.component.js"
8675
+ }
8740
8676
  },
8741
8677
  {
8742
- "name": "description-tag-name",
8678
+ "kind": "field",
8679
+ "name": "hideOnOutsideClick",
8743
8680
  "type": {
8744
- "text": "string"
8681
+ "text": "boolean"
8745
8682
  },
8746
- "description": "The html tag to be used for the below-header description text",
8747
- "fieldName": "descriptionTagName"
8683
+ "description": "Hide on outside click of the popover.",
8684
+ "default": "false",
8685
+ "attribute": "hide-on-outside-click",
8686
+ "reflects": true,
8687
+ "inheritedFrom": {
8688
+ "name": "Popover",
8689
+ "module": "components/popover/popover.component.js"
8690
+ }
8748
8691
  },
8749
8692
  {
8750
- "name": "role",
8693
+ "kind": "field",
8694
+ "name": "focusBackToTrigger",
8751
8695
  "type": {
8752
- "text": "DialogRole"
8696
+ "text": "boolean"
8753
8697
  },
8754
- "description": "Role of the dialog",
8755
- "default": "dialog",
8756
- "fieldName": "role"
8698
+ "description": "The focus back to trigger after the popover hide.",
8699
+ "default": "false",
8700
+ "attribute": "focus-back-to-trigger",
8701
+ "reflects": true,
8702
+ "inheritedFrom": {
8703
+ "name": "Popover",
8704
+ "module": "components/popover/popover.component.js"
8705
+ }
8757
8706
  },
8758
8707
  {
8759
- "name": "disable-aria-haspopup",
8708
+ "kind": "field",
8709
+ "name": "backdrop",
8760
8710
  "type": {
8761
8711
  "text": "boolean"
8762
8712
  },
8763
- "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.",
8713
+ "description": "Determines whether the popover with backdrop.\nOther than popover and trigger element, the rest of the screen will be covered with a backdrop.",
8764
8714
  "default": "false",
8765
- "fieldName": "disableAriaHasPopup"
8715
+ "attribute": "backdrop",
8716
+ "reflects": true,
8717
+ "inheritedFrom": {
8718
+ "name": "Popover",
8719
+ "module": "components/popover/popover.component.js"
8720
+ }
8766
8721
  },
8767
8722
  {
8768
- "name": "focus-trap",
8723
+ "kind": "field",
8724
+ "name": "flip",
8769
8725
  "type": {
8770
8726
  "text": "boolean"
8771
8727
  },
8772
- "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.",
8728
+ "description": "Changes the placement of popover to keep it in view when scrolling.",
8773
8729
  "default": "true",
8774
- "fieldName": "focusTrap"
8730
+ "attribute": "flip",
8731
+ "reflects": true,
8732
+ "inheritedFrom": {
8733
+ "name": "Popover",
8734
+ "module": "components/popover/popover.component.js"
8735
+ }
8775
8736
  },
8776
8737
  {
8777
- "name": "should-focus-trap-wrap",
8738
+ "kind": "field",
8739
+ "name": "size",
8778
8740
  "type": {
8779
8741
  "text": "boolean"
8780
8742
  },
8781
- "default": "true",
8782
- "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.",
8783
- "fieldName": "shouldFocusTrapWrap",
8743
+ "description": "Changes the size of popover to keep it in view when scrolling.",
8744
+ "default": "false",
8745
+ "attribute": "size",
8746
+ "reflects": true,
8784
8747
  "inheritedFrom": {
8785
- "name": "FocusTrapMixin",
8786
- "module": "src/utils/mixins/FocusTrapMixin.ts"
8748
+ "name": "Popover",
8749
+ "module": "components/popover/popover.component.js"
8787
8750
  }
8788
- }
8789
- ],
8790
- "mixins": [
8751
+ },
8791
8752
  {
8792
- "name": "PreventScrollMixin",
8793
- "module": "/src/utils/mixins/PreventScrollMixin"
8753
+ "kind": "field",
8754
+ "name": "zIndex",
8755
+ "type": {
8756
+ "text": "number"
8757
+ },
8758
+ "description": "The z-index of the popover.",
8759
+ "default": "1000",
8760
+ "attribute": "z-index",
8761
+ "reflects": true,
8762
+ "inheritedFrom": {
8763
+ "name": "Popover",
8764
+ "module": "components/popover/popover.component.js"
8765
+ }
8794
8766
  },
8795
8767
  {
8796
- "name": "FocusTrapMixin",
8797
- "module": "/src/utils/mixins/FocusTrapMixin"
8798
- },
8799
- {
8800
- "name": "CardAndDialogFooterMixin",
8801
- "module": "/src/utils/mixins/CardAndDialogFooterMixin"
8802
- }
8803
- ],
8804
- "superclass": {
8805
- "name": "Component",
8806
- "module": "/src/models"
8807
- },
8808
- "tagName": "mdc-dialog",
8809
- "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 */",
8810
- "customElement": true
8811
- }
8812
- ],
8813
- "exports": [
8814
- {
8815
- "kind": "js",
8816
- "name": "default",
8817
- "declaration": {
8818
- "name": "Dialog",
8819
- "module": "components/dialog/dialog.component.js"
8820
- }
8821
- }
8822
- ]
8823
- },
8824
- {
8825
- "kind": "javascript-module",
8826
- "path": "components/coachmark/coachmark.component.js",
8827
- "declarations": [
8828
- {
8829
- "kind": "class",
8830
- "description": "Coachmark component based on top of the popover component,\nwith the default value of certain properties changed.",
8831
- "name": "Coachmark",
8832
- "cssProperties": [
8833
- {
8834
- "description": "radius of the arrow border",
8835
- "name": "--mdc-popover-arrow-border-radius",
8836
- "inheritedFrom": {
8837
- "name": "Popover",
8838
- "module": "src/components/popover/popover.component.ts"
8839
- }
8840
- },
8841
- {
8842
- "description": "border of the arrow",
8843
- "name": "--mdc-popover-arrow-border",
8844
- "inheritedFrom": {
8845
- "name": "Popover",
8846
- "module": "src/components/popover/popover.component.ts"
8847
- }
8848
- },
8849
- {
8850
- "description": "primary background color of the popover",
8851
- "name": "--mdc-popover-primary-background-color",
8852
- "inheritedFrom": {
8853
- "name": "Popover",
8854
- "module": "src/components/popover/popover.component.ts"
8855
- }
8856
- },
8857
- {
8858
- "description": "border color of the popover",
8859
- "name": "--mdc-popover-border-color",
8860
- "inheritedFrom": {
8861
- "name": "Popover",
8862
- "module": "src/components/popover/popover.component.ts"
8863
- }
8864
- },
8865
- {
8866
- "description": "inverted background color of the popover",
8867
- "name": "--mdc-popover-inverted-background-color",
8868
- "inheritedFrom": {
8869
- "name": "Popover",
8870
- "module": "src/components/popover/popover.component.ts"
8871
- }
8872
- },
8873
- {
8874
- "description": "inverted border color of the popover",
8875
- "name": "--mdc-popover-inverted-border-color",
8876
- "inheritedFrom": {
8877
- "name": "Popover",
8878
- "module": "src/components/popover/popover.component.ts"
8879
- }
8880
- },
8881
- {
8882
- "description": "inverted text color of the popover",
8883
- "name": "--mdc-popover-inverted-text-color",
8768
+ "kind": "field",
8769
+ "name": "appendTo",
8770
+ "type": {
8771
+ "text": "string | undefined"
8772
+ },
8773
+ "description": "Element ID that the popover append to.",
8774
+ "default": "''",
8775
+ "attribute": "append-to",
8776
+ "reflects": true,
8884
8777
  "inheritedFrom": {
8885
8778
  "name": "Popover",
8886
- "module": "src/components/popover/popover.component.ts"
8779
+ "module": "components/popover/popover.component.js"
8887
8780
  }
8888
8781
  },
8889
8782
  {
8890
- "description": "elevation of the popover",
8891
- "name": "--mdc-popover-elevation-3",
8783
+ "kind": "field",
8784
+ "name": "closeButtonAriaLabel",
8785
+ "type": {
8786
+ "text": "string | null"
8787
+ },
8788
+ "default": "null",
8789
+ "description": "aria-label attribute to be set for close button accessibility.",
8790
+ "attribute": "close-button-aria-label",
8791
+ "reflects": true,
8892
8792
  "inheritedFrom": {
8893
8793
  "name": "Popover",
8894
- "module": "src/components/popover/popover.component.ts"
8794
+ "module": "components/popover/popover.component.js"
8895
8795
  }
8896
8796
  },
8897
8797
  {
8898
- "description": "max width of the popover",
8899
- "name": "--mdc-popover-max-width",
8798
+ "kind": "field",
8799
+ "name": "role",
8800
+ "type": {
8801
+ "text": "HTMLElement['role']"
8802
+ },
8803
+ "description": "Role of the popover",
8804
+ "default": "dialog",
8805
+ "attribute": "role",
8806
+ "reflects": true,
8900
8807
  "inheritedFrom": {
8901
8808
  "name": "Popover",
8902
- "module": "src/components/popover/popover.component.ts"
8809
+ "module": "components/popover/popover.component.js"
8903
8810
  }
8904
8811
  },
8905
- {
8906
- "description": "max height of the popover",
8907
- "name": "--mdc-popover-max-height",
8908
- "inheritedFrom": {
8909
- "name": "Popover",
8910
- "module": "src/components/popover/popover.component.ts"
8911
- }
8912
- }
8913
- ],
8914
- "slots": [
8915
- {
8916
- "description": "Default slot for modal container",
8917
- "name": "",
8918
- "inheritedFrom": {
8919
- "name": "Popover",
8920
- "module": "src/components/popover/popover.component.ts"
8921
- }
8922
- }
8923
- ],
8924
- "members": [
8925
8812
  {
8926
8813
  "kind": "field",
8927
- "name": "trigger",
8814
+ "name": "ariaLabelledby",
8928
8815
  "type": {
8929
- "text": "PopoverTrigger"
8816
+ "text": "string | null"
8930
8817
  },
8931
- "description": "Determines the events that cause the Coachmark to show.\nMultiple event names should be separated by spaces.\nFor example to allow both click and hover, use 'click mouseenter' as the trigger.\n- **click**\n- **mouseenter**\n- **focusin**\n- **manual**",
8932
- "default": "manual",
8933
- "attribute": "trigger",
8818
+ "default": "null",
8819
+ "description": "aria-labelledby for an interactive popover only, defaults to the trigger component id.\nUsed in nested cases where the triggerComponent isn't the actual button.",
8820
+ "attribute": "aria-labelledby",
8934
8821
  "reflects": true,
8935
8822
  "inheritedFrom": {
8936
8823
  "name": "Popover",
@@ -8939,13 +8826,13 @@
8939
8826
  },
8940
8827
  {
8941
8828
  "kind": "field",
8942
- "name": "showArrow",
8829
+ "name": "ariaDescribedby",
8943
8830
  "type": {
8944
- "text": "boolean"
8831
+ "text": "string | null"
8945
8832
  },
8946
- "description": "The arrow visibility of the Coachmark.",
8947
- "default": "true",
8948
- "attribute": "show-arrow",
8833
+ "default": "null",
8834
+ "description": "aria-describedby of the popover.",
8835
+ "attribute": "aria-describedby",
8949
8836
  "reflects": true,
8950
8837
  "inheritedFrom": {
8951
8838
  "name": "Popover",
@@ -8954,13 +8841,13 @@
8954
8841
  },
8955
8842
  {
8956
8843
  "kind": "field",
8957
- "name": "closeButton",
8844
+ "name": "disableAriaHasPopup",
8958
8845
  "type": {
8959
8846
  "text": "boolean"
8960
8847
  },
8961
- "description": "The close button visibility of the Coachmark.",
8962
- "default": "true",
8963
- "attribute": "close-button",
8848
+ "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.",
8849
+ "default": "false",
8850
+ "attribute": "disable-aria-haspopup",
8964
8851
  "reflects": true,
8965
8852
  "inheritedFrom": {
8966
8853
  "name": "Popover",
@@ -8969,14 +8856,12 @@
8969
8856
  },
8970
8857
  {
8971
8858
  "kind": "field",
8972
- "name": "disableAriaExpanded",
8859
+ "name": "arrowElement",
8973
8860
  "type": {
8974
- "text": "boolean"
8861
+ "text": "HTMLElement | null"
8975
8862
  },
8976
- "description": "Disable aria-expanded attribute on trigger element.",
8977
- "default": "true",
8978
- "attribute": "disable-aria-expanded",
8979
- "reflects": true,
8863
+ "privacy": "public",
8864
+ "default": "null",
8980
8865
  "inheritedFrom": {
8981
8866
  "name": "Popover",
8982
8867
  "module": "components/popover/popover.component.js"
@@ -8984,15 +8869,12 @@
8984
8869
  },
8985
8870
  {
8986
8871
  "kind": "field",
8987
- "name": "preventScroll",
8872
+ "name": "triggerElement",
8988
8873
  "type": {
8989
- "text": "boolean"
8874
+ "text": "HTMLElement | null"
8990
8875
  },
8991
- "description": "Prevent outside scrolling when element is shown.\n\nIMPLEMENT THIS IN YOUR COMPONENT.",
8992
- "default": "false",
8993
- "attribute": "prevent-scroll",
8994
- "reflects": true,
8995
- "privacy": "protected",
8876
+ "privacy": "public",
8877
+ "default": "null",
8996
8878
  "inheritedFrom": {
8997
8879
  "name": "Popover",
8998
8880
  "module": "components/popover/popover.component.js"
@@ -9000,33 +8882,35 @@
9000
8882
  },
9001
8883
  {
9002
8884
  "kind": "method",
9003
- "name": "activatePreventScroll",
9004
- "privacy": "protected",
8885
+ "name": "setupTriggerListener",
8886
+ "privacy": "private",
8887
+ "description": "Sets up the trigger event listeners based on the trigger type.",
9005
8888
  "inheritedFrom": {
9006
- "name": "PreventScrollMixin",
9007
- "module": "utils/mixins/PreventScrollMixin.js"
8889
+ "name": "Popover",
8890
+ "module": "components/popover/popover.component.js"
9008
8891
  }
9009
8892
  },
9010
8893
  {
9011
8894
  "kind": "method",
9012
- "name": "deactivatePreventScroll",
9013
- "privacy": "protected",
8895
+ "name": "removeEventListeners",
8896
+ "privacy": "private",
8897
+ "description": "Removes the trigger event listeners.",
9014
8898
  "inheritedFrom": {
9015
- "name": "PreventScrollMixin",
9016
- "module": "utils/mixins/PreventScrollMixin.js"
8899
+ "name": "Popover",
8900
+ "module": "components/popover/popover.component.js"
9017
8901
  }
9018
8902
  },
9019
8903
  {
9020
8904
  "kind": "field",
9021
- "name": "focusTrap",
9022
- "type": {
9023
- "text": "boolean"
9024
- },
9025
- "description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.\n\nIMPLEMENT THIS IN YOUR COMPONENT.",
9026
- "default": "false",
9027
- "attribute": "focus-trap",
9028
- "reflects": true,
8905
+ "name": "onOutsidePopoverClick",
9029
8906
  "privacy": "protected",
8907
+ "description": "Handles the outside click event to close the popover.",
8908
+ "parameters": [
8909
+ {
8910
+ "description": "The mouse event.",
8911
+ "name": "event"
8912
+ }
8913
+ ],
9030
8914
  "inheritedFrom": {
9031
8915
  "name": "Popover",
9032
8916
  "module": "components/popover/popover.component.js"
@@ -9034,784 +8918,768 @@
9034
8918
  },
9035
8919
  {
9036
8920
  "kind": "field",
9037
- "name": "shouldFocusTrapWrap",
9038
- "type": {
9039
- "text": "boolean"
9040
- },
9041
- "default": "true",
9042
- "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.",
9043
- "attribute": "should-focus-trap-wrap",
9044
- "reflects": true,
9045
- "inheritedFrom": {
9046
- "name": "FocusTrapMixin",
9047
- "module": "utils/mixins/FocusTrapMixin.js"
9048
- }
9049
- },
9050
- {
9051
- "kind": "method",
9052
- "name": "setIsFocusTrapActivated",
8921
+ "name": "onEscapeKeydown",
9053
8922
  "privacy": "private",
8923
+ "description": "Handles the escape keydown event to close the popover.\n\nThis method is attached to the document.",
9054
8924
  "parameters": [
9055
8925
  {
9056
- "name": "isActivated",
9057
- "type": {
9058
- "text": "boolean"
9059
- }
8926
+ "description": "The keyboard event.",
8927
+ "name": "event"
9060
8928
  }
9061
8929
  ],
9062
8930
  "inheritedFrom": {
9063
- "name": "FocusTrapMixin",
9064
- "module": "utils/mixins/FocusTrapMixin.js"
8931
+ "name": "Popover",
8932
+ "module": "components/popover/popover.component.js"
9065
8933
  }
9066
8934
  },
9067
8935
  {
9068
- "kind": "method",
9069
- "name": "activateFocusTrap",
9070
- "privacy": "public",
9071
- "description": "Activate the focus trap",
9072
- "inheritedFrom": {
9073
- "name": "FocusTrapMixin",
9074
- "module": "utils/mixins/FocusTrapMixin.js"
9075
- }
9076
- },
9077
- {
9078
- "kind": "method",
9079
- "name": "deactivateFocusTrap",
9080
- "privacy": "public",
9081
- "description": "Deactivate the focus trap.",
9082
- "inheritedFrom": {
9083
- "name": "FocusTrapMixin",
9084
- "module": "utils/mixins/FocusTrapMixin.js"
9085
- }
9086
- },
9087
- {
9088
- "kind": "method",
9089
- "name": "hasNoClientRects",
8936
+ "kind": "field",
8937
+ "name": "onPopoverFocusOut",
9090
8938
  "privacy": "private",
8939
+ "description": "Handles the popover focus out event.",
9091
8940
  "parameters": [
9092
8941
  {
9093
- "name": "element",
9094
- "type": {
9095
- "text": "HTMLElement"
9096
- },
9097
- "description": "The element to check."
8942
+ "description": "The focus event.",
8943
+ "name": "event"
9098
8944
  }
9099
8945
  ],
9100
- "description": "Checks if the element has no client rectangles (not visible in the viewport).",
9101
- "return": {
9102
- "type": {
9103
- "text": ""
9104
- }
9105
- },
9106
8946
  "inheritedFrom": {
9107
- "name": "FocusTrapMixin",
9108
- "module": "utils/mixins/FocusTrapMixin.js"
8947
+ "name": "Popover",
8948
+ "module": "components/popover/popover.component.js"
9109
8949
  }
9110
8950
  },
9111
8951
  {
9112
8952
  "kind": "method",
9113
- "name": "hasZeroDimensions",
9114
- "privacy": "private",
8953
+ "name": "isOpenUpdated",
8954
+ "privacy": "protected",
9115
8955
  "parameters": [
9116
8956
  {
9117
- "name": "element",
8957
+ "name": "oldValue",
9118
8958
  "type": {
9119
- "text": "HTMLElement"
8959
+ "text": "boolean"
9120
8960
  },
9121
- "description": "The element to check."
8961
+ "description": "The old value of the visible property."
8962
+ },
8963
+ {
8964
+ "name": "newValue",
8965
+ "type": {
8966
+ "text": "boolean"
8967
+ },
8968
+ "description": "The new value of the visible property."
9122
8969
  }
9123
8970
  ],
9124
- "description": "Checks if the element has zero dimensions (width and height are both 0).",
9125
- "return": {
9126
- "type": {
9127
- "text": ""
9128
- }
9129
- },
8971
+ "description": "Handles the popover visibility change and position the popover.\nHandles the exit event to close the popover.",
9130
8972
  "inheritedFrom": {
9131
- "name": "FocusTrapMixin",
9132
- "module": "utils/mixins/FocusTrapMixin.js"
8973
+ "name": "Popover",
8974
+ "module": "components/popover/popover.component.js"
9133
8975
  }
9134
8976
  },
9135
8977
  {
9136
- "kind": "method",
9137
- "name": "isNotVisible",
8978
+ "kind": "field",
8979
+ "name": "handleMouseEnter",
9138
8980
  "privacy": "private",
9139
- "parameters": [
9140
- {
9141
- "name": "element",
9142
- "type": {
9143
- "text": "HTMLElement"
9144
- },
9145
- "description": "The element to check."
9146
- }
9147
- ],
9148
- "description": "Determines if the element is not visible in the DOM.",
9149
- "return": {
9150
- "type": {
9151
- "text": ""
9152
- }
9153
- },
8981
+ "description": "Handles mouse enter event on the trigger element.\nThis method sets the `isHovered` flag to true and shows the popover",
9154
8982
  "inheritedFrom": {
9155
- "name": "FocusTrapMixin",
9156
- "module": "utils/mixins/FocusTrapMixin.js"
8983
+ "name": "Popover",
8984
+ "module": "components/popover/popover.component.js"
9157
8985
  }
9158
8986
  },
9159
8987
  {
9160
- "kind": "method",
9161
- "name": "hasHiddenStyle",
8988
+ "kind": "field",
8989
+ "name": "handleMouseLeave",
9162
8990
  "privacy": "private",
9163
- "parameters": [
9164
- {
9165
- "name": "element",
9166
- "type": {
9167
- "text": "HTMLElement"
9168
- },
9169
- "description": "The element to check."
9170
- }
9171
- ],
9172
- "description": "Checks if the element has inline styles that make it hidden.",
9173
- "return": {
9174
- "type": {
9175
- "text": ""
9176
- }
9177
- },
8991
+ "description": "Handles mouse leave event on the trigger element.\nThis method sets the `isHovered` flag to false and starts the close delay\ntimer to hide the popover.",
9178
8992
  "inheritedFrom": {
9179
- "name": "FocusTrapMixin",
9180
- "module": "utils/mixins/FocusTrapMixin.js"
8993
+ "name": "Popover",
8994
+ "module": "components/popover/popover.component.js"
9181
8995
  }
9182
8996
  },
9183
8997
  {
9184
- "kind": "method",
9185
- "name": "hasComputedHidden",
8998
+ "kind": "field",
8999
+ "name": "handleFocusOut",
9186
9000
  "privacy": "private",
9187
- "parameters": [
9188
- {
9189
- "name": "element",
9190
- "type": {
9191
- "text": "HTMLElement"
9192
- },
9193
- "description": "The element to check."
9194
- }
9195
- ],
9196
- "description": "Checks if the element is hidden by a computed style.",
9197
- "return": {
9198
- "type": {
9199
- "text": ""
9200
- }
9201
- },
9001
+ "description": "Handles focus out event on the trigger element.\nThis method checks if the popover is not hovered and hides the popover.\nIf the popover is hovered, it will not hide the popover.",
9202
9002
  "inheritedFrom": {
9203
- "name": "FocusTrapMixin",
9204
- "module": "utils/mixins/FocusTrapMixin.js"
9003
+ "name": "Popover",
9004
+ "module": "components/popover/popover.component.js"
9205
9005
  }
9206
9006
  },
9207
9007
  {
9208
- "kind": "method",
9209
- "name": "isHidden",
9008
+ "kind": "field",
9009
+ "name": "startCloseDelay",
9210
9010
  "privacy": "private",
9211
- "parameters": [
9212
- {
9213
- "name": "element",
9214
- "type": {
9215
- "text": "HTMLElement"
9216
- },
9217
- "description": "The element to check."
9218
- }
9219
- ],
9220
- "description": "Checks if the element is hidden from the user.",
9221
- "return": {
9222
- "type": {
9223
- "text": ""
9224
- }
9225
- },
9011
+ "description": "Starts the close delay timer.\nIf the popover is not interactive, it will close the popover after the delay.",
9226
9012
  "inheritedFrom": {
9227
- "name": "FocusTrapMixin",
9228
- "module": "utils/mixins/FocusTrapMixin.js"
9013
+ "name": "Popover",
9014
+ "module": "components/popover/popover.component.js"
9229
9015
  }
9230
9016
  },
9231
9017
  {
9232
- "kind": "method",
9233
- "name": "isDisabled",
9018
+ "kind": "field",
9019
+ "name": "cancelCloseDelay",
9234
9020
  "privacy": "private",
9235
- "parameters": [
9236
- {
9237
- "name": "element",
9238
- "type": {
9239
- "text": "any"
9240
- },
9241
- "description": "The element to check."
9242
- }
9243
- ],
9244
- "description": "Checks if the element is disabled.",
9245
- "return": {
9246
- "type": {
9247
- "text": ""
9248
- }
9249
- },
9021
+ "description": "Cancels the close delay timer.",
9250
9022
  "inheritedFrom": {
9251
- "name": "FocusTrapMixin",
9252
- "module": "utils/mixins/FocusTrapMixin.js"
9023
+ "name": "Popover",
9024
+ "module": "components/popover/popover.component.js"
9025
+ }
9026
+ },
9027
+ {
9028
+ "kind": "field",
9029
+ "name": "showPopover",
9030
+ "privacy": "public",
9031
+ "description": "Shows the popover.",
9032
+ "inheritedFrom": {
9033
+ "name": "Popover",
9034
+ "module": "components/popover/popover.component.js"
9035
+ }
9036
+ },
9037
+ {
9038
+ "kind": "field",
9039
+ "name": "hidePopover",
9040
+ "privacy": "public",
9041
+ "description": "Hides the popover.",
9042
+ "inheritedFrom": {
9043
+ "name": "Popover",
9044
+ "module": "components/popover/popover.component.js"
9045
+ }
9046
+ },
9047
+ {
9048
+ "kind": "field",
9049
+ "name": "togglePopoverVisible",
9050
+ "privacy": "public",
9051
+ "description": "Toggles the popover visibility.",
9052
+ "inheritedFrom": {
9053
+ "name": "Popover",
9054
+ "module": "components/popover/popover.component.js"
9253
9055
  }
9254
9056
  },
9255
9057
  {
9256
9058
  "kind": "method",
9257
- "name": "isNotTabbable",
9059
+ "name": "positionPopover",
9258
9060
  "privacy": "private",
9259
- "parameters": [
9260
- {
9261
- "name": "element",
9262
- "type": {
9263
- "text": "HTMLElement"
9264
- },
9265
- "description": "The element to check."
9266
- }
9267
- ],
9268
- "description": "Checks if the element is not tabbable.",
9269
- "return": {
9270
- "type": {
9271
- "text": ""
9272
- }
9273
- },
9061
+ "description": "Positions the popover based on the trigger element.\nIt also handles the flip, size and arrow placement.\nIt uses the floating-ui/dom library to calculate the position.",
9274
9062
  "inheritedFrom": {
9275
- "name": "FocusTrapMixin",
9276
- "module": "utils/mixins/FocusTrapMixin.js"
9063
+ "name": "Popover",
9064
+ "module": "components/popover/popover.component.js"
9277
9065
  }
9278
9066
  },
9279
9067
  {
9280
9068
  "kind": "method",
9281
- "name": "isInteractiveElement",
9282
- "privacy": "private",
9069
+ "name": "findClosestPopover",
9070
+ "privacy": "protected",
9283
9071
  "return": {
9284
9072
  "type": {
9285
- "text": ""
9073
+ "text": "Popover | null"
9286
9074
  }
9287
9075
  },
9288
9076
  "parameters": [
9289
9077
  {
9290
9078
  "name": "element",
9291
9079
  "type": {
9292
- "text": "HTMLElement"
9080
+ "text": "Element"
9293
9081
  },
9294
- "description": "The element to check."
9082
+ "description": "The element to start searching from."
9295
9083
  }
9296
9084
  ],
9297
- "description": "Checks if the element is interactive.",
9085
+ "description": "Finds the closest popover to the passed element in the DOM tree.\n\nUseful when need to find the parent popover in a nested popover scenario.",
9298
9086
  "inheritedFrom": {
9299
- "name": "FocusTrapMixin",
9300
- "module": "utils/mixins/FocusTrapMixin.js"
9087
+ "name": "Popover",
9088
+ "module": "components/popover/popover.component.js"
9301
9089
  }
9302
9090
  },
9303
9091
  {
9304
- "kind": "method",
9305
- "name": "isFocusable",
9306
- "privacy": "private",
9307
- "parameters": [
9308
- {
9309
- "name": "element",
9310
- "type": {
9311
- "text": "HTMLElement"
9312
- },
9313
- "description": "The element to check."
9314
- }
9315
- ],
9316
- "description": "Checks if the element is focusable.",
9317
- "return": {
9318
- "type": {
9319
- "text": ""
9320
- }
9321
- },
9092
+ "kind": "field",
9093
+ "name": "utils",
9094
+ "default": "new PopoverUtils(this)",
9322
9095
  "inheritedFrom": {
9323
- "name": "FocusTrapMixin",
9324
- "module": "utils/mixins/FocusTrapMixin.js"
9096
+ "name": "Popover",
9097
+ "module": "components/popover/popover.component.js"
9325
9098
  }
9326
- },
9099
+ }
9100
+ ],
9101
+ "events": [
9327
9102
  {
9328
- "kind": "method",
9329
- "name": "findFocusable",
9330
- "privacy": "private",
9331
- "return": {
9332
- "type": {
9333
- "text": ""
9334
- }
9335
- },
9336
- "parameters": [
9337
- {
9338
- "name": "root",
9339
- "type": {
9340
- "text": "ShadowRoot | HTMLElement"
9341
- },
9342
- "description": "The root element to search for focusable elements."
9343
- },
9344
- {
9345
- "name": "matches",
9346
- "default": "new Set()",
9347
- "type": {
9348
- "text": "Set<HTMLElement>"
9349
- },
9350
- "description": "The set of focusable elements."
9351
- }
9352
- ],
9353
- "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.",
9103
+ "description": "(React: onShown) This event is dispatched when the coachmark is shown",
9104
+ "name": "shown",
9105
+ "reactName": "onShown",
9354
9106
  "inheritedFrom": {
9355
- "name": "FocusTrapMixin",
9356
- "module": "utils/mixins/FocusTrapMixin.js"
9107
+ "name": "Popover",
9108
+ "module": "src/components/popover/popover.component.ts"
9357
9109
  }
9358
9110
  },
9359
9111
  {
9360
- "kind": "method",
9361
- "name": "setFocusableElements",
9362
- "privacy": "private",
9363
- "description": "Updates the list of focusable elements within the component's shadow root.",
9112
+ "description": "(React: onHidden) This event is dispatched when the coachmark is hidden",
9113
+ "name": "hidden",
9114
+ "reactName": "onHidden",
9364
9115
  "inheritedFrom": {
9365
- "name": "FocusTrapMixin",
9366
- "module": "utils/mixins/FocusTrapMixin.js"
9116
+ "name": "Popover",
9117
+ "module": "src/components/popover/popover.component.ts"
9367
9118
  }
9368
9119
  },
9369
9120
  {
9370
- "kind": "method",
9371
- "name": "setInitialFocus",
9372
- "privacy": "public",
9373
- "parameters": [
9374
- {
9375
- "name": "elementIndexToReceiveFocus",
9376
- "default": "0",
9377
- "type": {
9378
- "text": "number"
9379
- },
9380
- "description": "The index of the preferable element to focus."
9381
- }
9382
- ],
9383
- "description": "Sets the initial focus within the container.",
9121
+ "description": "(React: onCreated) This event is dispatched when the coachmark is created (added to the DOM)",
9122
+ "name": "created",
9123
+ "reactName": "onCreated",
9384
9124
  "inheritedFrom": {
9385
- "name": "FocusTrapMixin",
9386
- "module": "utils/mixins/FocusTrapMixin.js"
9125
+ "name": "Popover",
9126
+ "module": "src/components/popover/popover.component.ts"
9387
9127
  }
9388
9128
  },
9389
9129
  {
9390
- "kind": "method",
9391
- "name": "calculateNextIndex",
9392
- "privacy": "private",
9393
- "parameters": [
9394
- {
9395
- "name": "currentIndex",
9396
- "type": {
9397
- "text": "number"
9398
- },
9399
- "description": "The current index."
9400
- },
9401
- {
9402
- "name": "step",
9403
- "type": {
9404
- "text": "number"
9405
- },
9406
- "description": "The step to calculate the next index."
9407
- }
9408
- ],
9409
- "description": "Calculates the next index for the focus trap.",
9410
- "return": {
9411
- "type": {
9412
- "text": ""
9413
- }
9414
- },
9130
+ "description": "(React: onDestroyed) This event is dispatched when the coachmark is destroyed (removed from the DOM)",
9131
+ "name": "destroyed",
9132
+ "reactName": "onDestroyed",
9415
9133
  "inheritedFrom": {
9416
- "name": "FocusTrapMixin",
9417
- "module": "utils/mixins/FocusTrapMixin.js"
9134
+ "name": "Popover",
9135
+ "module": "src/components/popover/popover.component.ts"
9418
9136
  }
9419
- },
9137
+ }
9138
+ ],
9139
+ "attributes": [
9420
9140
  {
9421
- "kind": "method",
9422
- "name": "getDeepActiveElement",
9423
- "privacy": "private",
9424
- "description": "Returns the deepest active element in the shadow DOM.",
9425
- "return": {
9426
- "type": {
9427
- "text": ""
9428
- }
9141
+ "name": "trigger",
9142
+ "type": {
9143
+ "text": "PopoverTrigger"
9429
9144
  },
9145
+ "description": "Determines the events that cause the Coachmark to show.\nMultiple event names should be separated by spaces.\nFor example to allow both click and hover, use 'click mouseenter' as the trigger.\n- **click**\n- **mouseenter**\n- **focusin**\n- **manual**",
9146
+ "default": "manual",
9147
+ "fieldName": "trigger",
9430
9148
  "inheritedFrom": {
9431
- "name": "FocusTrapMixin",
9432
- "module": "utils/mixins/FocusTrapMixin.js"
9149
+ "name": "Popover",
9150
+ "module": "src/components/popover/popover.component.ts"
9433
9151
  }
9434
9152
  },
9435
9153
  {
9436
- "kind": "method",
9437
- "name": "findElement",
9438
- "privacy": "private",
9439
- "parameters": [
9440
- {
9441
- "name": "activeElement",
9442
- "type": {
9443
- "text": "HTMLElement"
9444
- },
9445
- "description": "The active element."
9446
- }
9447
- ],
9448
- "description": "Finds the index of the active element within the focusable elements.",
9449
- "return": {
9450
- "type": {
9451
- "text": ""
9452
- }
9154
+ "name": "show-arrow",
9155
+ "type": {
9156
+ "text": "boolean"
9453
9157
  },
9158
+ "description": "The arrow visibility of the Coachmark.",
9159
+ "default": "true",
9160
+ "fieldName": "showArrow",
9454
9161
  "inheritedFrom": {
9455
- "name": "FocusTrapMixin",
9456
- "module": "utils/mixins/FocusTrapMixin.js"
9162
+ "name": "Popover",
9163
+ "module": "src/components/popover/popover.component.ts"
9457
9164
  }
9458
9165
  },
9459
9166
  {
9460
- "kind": "method",
9461
- "name": "isEqualFocusNode",
9462
- "privacy": "private",
9463
- "parameters": [
9464
- {
9465
- "name": "activeElement",
9466
- "type": {
9467
- "text": "HTMLElement"
9468
- },
9469
- "description": "The active element."
9470
- },
9471
- {
9472
- "name": "element",
9473
- "type": {
9474
- "text": "HTMLElement"
9475
- },
9476
- "description": "The element to compare."
9477
- }
9478
- ],
9479
- "description": "Checks if the active element is equal to the given element.",
9480
- "return": {
9481
- "type": {
9482
- "text": ""
9483
- }
9167
+ "name": "close-button",
9168
+ "type": {
9169
+ "text": "boolean"
9484
9170
  },
9171
+ "description": "The close button visibility of the Coachmark.",
9172
+ "default": "true",
9173
+ "fieldName": "closeButton",
9485
9174
  "inheritedFrom": {
9486
- "name": "FocusTrapMixin",
9487
- "module": "utils/mixins/FocusTrapMixin.js"
9175
+ "name": "Popover",
9176
+ "module": "src/components/popover/popover.component.ts"
9488
9177
  }
9489
9178
  },
9490
9179
  {
9491
- "kind": "method",
9492
- "name": "trapFocus",
9493
- "privacy": "private",
9494
- "parameters": [
9495
- {
9496
- "name": "event",
9497
- "type": {
9498
- "text": "KeyboardEvent"
9499
- }
9500
- },
9501
- {
9502
- "description": "The direction of the focus trap.\nIf true, the focus will be trapped in the previous element.",
9503
- "name": "direction"
9504
- }
9505
- ],
9506
- "description": "Traps focus within the container.",
9180
+ "name": "disable-aria-expanded",
9181
+ "type": {
9182
+ "text": "boolean"
9183
+ },
9184
+ "description": "Disable aria-expanded attribute on trigger element.",
9185
+ "default": "true",
9186
+ "fieldName": "disableAriaExpanded",
9507
9187
  "inheritedFrom": {
9508
- "name": "FocusTrapMixin",
9509
- "module": "utils/mixins/FocusTrapMixin.js"
9188
+ "name": "Popover",
9189
+ "module": "src/components/popover/popover.component.ts"
9510
9190
  }
9511
9191
  },
9512
9192
  {
9513
- "kind": "method",
9514
- "name": "handleTabKeydown",
9515
- "privacy": "private",
9516
- "parameters": [
9517
- {
9518
- "name": "event",
9519
- "type": {
9520
- "text": "KeyboardEvent"
9521
- },
9522
- "description": "The keyboard event."
9523
- }
9524
- ],
9525
- "description": "Traps focus within the container.",
9193
+ "name": "should-focus-trap-wrap",
9194
+ "type": {
9195
+ "text": "boolean"
9196
+ },
9197
+ "default": "true",
9198
+ "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.",
9199
+ "fieldName": "shouldFocusTrapWrap",
9526
9200
  "inheritedFrom": {
9527
9201
  "name": "FocusTrapMixin",
9528
- "module": "utils/mixins/FocusTrapMixin.js"
9202
+ "module": "src/utils/mixins/FocusTrapMixin.ts"
9529
9203
  }
9530
9204
  },
9531
9205
  {
9532
- "kind": "field",
9533
9206
  "name": "id",
9534
9207
  "type": {
9535
9208
  "text": "string"
9536
9209
  },
9537
9210
  "default": "''",
9538
9211
  "description": "The unique ID of the popover.",
9539
- "attribute": "id",
9540
- "reflects": true,
9212
+ "fieldName": "id",
9541
9213
  "inheritedFrom": {
9542
9214
  "name": "Popover",
9543
- "module": "components/popover/popover.component.js"
9215
+ "module": "src/components/popover/popover.component.ts"
9544
9216
  }
9545
9217
  },
9546
9218
  {
9547
- "kind": "field",
9548
9219
  "name": "triggerID",
9549
9220
  "type": {
9550
9221
  "text": "string"
9551
9222
  },
9552
9223
  "default": "''",
9553
9224
  "description": "The ID of the element that triggers the popover.\nThis attribute is required for the popover to work.",
9554
- "attribute": "triggerID",
9555
- "reflects": true,
9225
+ "fieldName": "triggerID",
9556
9226
  "inheritedFrom": {
9557
9227
  "name": "Popover",
9558
- "module": "components/popover/popover.component.js"
9228
+ "module": "src/components/popover/popover.component.ts"
9559
9229
  }
9560
9230
  },
9561
9231
  {
9562
- "kind": "field",
9563
9232
  "name": "placement",
9564
9233
  "type": {
9565
9234
  "text": "PopoverPlacement"
9566
9235
  },
9567
9236
  "description": "The placement of the popover.\n- **top**\n- **top-start**\n- **top-end**\n- **bottom**\n- **bottom-start**\n- **bottom-end**\n- **left**\n- **left-start**\n- **left-end**\n- **right**\n- **right-start**\n- **right-end**",
9568
9237
  "default": "bottom",
9569
- "attribute": "placement",
9570
- "reflects": true,
9238
+ "fieldName": "placement",
9571
9239
  "inheritedFrom": {
9572
9240
  "name": "Popover",
9573
- "module": "components/popover/popover.component.js"
9241
+ "module": "src/components/popover/popover.component.ts"
9574
9242
  }
9575
9243
  },
9576
9244
  {
9577
- "kind": "field",
9578
9245
  "name": "color",
9579
9246
  "type": {
9580
9247
  "text": "PopoverColor"
9581
9248
  },
9582
9249
  "description": "Color of the popover\n- **tonal**\n- **contrast**",
9583
9250
  "default": "tonal",
9584
- "attribute": "color",
9585
- "reflects": true,
9251
+ "fieldName": "color",
9586
9252
  "inheritedFrom": {
9587
9253
  "name": "Popover",
9588
- "module": "components/popover/popover.component.js"
9254
+ "module": "src/components/popover/popover.component.ts"
9589
9255
  }
9590
9256
  },
9591
9257
  {
9592
- "kind": "field",
9593
9258
  "name": "visible",
9594
9259
  "type": {
9595
9260
  "text": "boolean"
9596
9261
  },
9597
9262
  "description": "The visibility of the popover.",
9598
9263
  "default": "false",
9599
- "attribute": "visible",
9600
- "reflects": true,
9264
+ "fieldName": "visible",
9601
9265
  "inheritedFrom": {
9602
9266
  "name": "Popover",
9603
- "module": "components/popover/popover.component.js"
9267
+ "module": "src/components/popover/popover.component.ts"
9604
9268
  }
9605
9269
  },
9606
9270
  {
9607
- "kind": "field",
9608
9271
  "name": "offset",
9609
9272
  "type": {
9610
- "text": "number"
9273
+ "text": "number"
9274
+ },
9275
+ "description": "The offset of the popover.",
9276
+ "default": "4",
9277
+ "fieldName": "offset",
9278
+ "inheritedFrom": {
9279
+ "name": "Popover",
9280
+ "module": "src/components/popover/popover.component.ts"
9281
+ }
9282
+ },
9283
+ {
9284
+ "name": "boundary",
9285
+ "type": {
9286
+ "text": "'clippingAncestors' | string"
9287
+ },
9288
+ "description": "This describes the clipping element(s) or area that overflow will be checked relative to.\nThe default is 'clippingAncestors', which are the overflow ancestors which will cause the\nelement to be clipped.\n\nPossible values:\n - 'clippingAncestors'\n - any css selector",
9289
+ "default": "'clippingAncestors'",
9290
+ "fieldName": "boundary",
9291
+ "inheritedFrom": {
9292
+ "name": "Popover",
9293
+ "module": "src/components/popover/popover.component.ts"
9294
+ }
9295
+ },
9296
+ {
9297
+ "name": "boundary-root",
9298
+ "type": {
9299
+ "text": "'viewport' | 'document'"
9300
+ },
9301
+ "description": "This describes the root boundary that the element will be checked for overflow relative to.\nThe default is 'viewport', which is the area of the page the user can see on the screen.\n\nThe other string option is 'document', which is the entire page outside the viewport.",
9302
+ "default": "'viewport'",
9303
+ "fieldName": "boundaryRoot",
9304
+ "inheritedFrom": {
9305
+ "name": "Popover",
9306
+ "module": "src/components/popover/popover.component.ts"
9307
+ }
9308
+ },
9309
+ {
9310
+ "name": "boundary-padding",
9311
+ "type": {
9312
+ "text": "undefined | number"
9313
+ },
9314
+ "description": "Virtual padding around the boundary to check for overflow.\nSo the popover will not be placed on top of the edge of the boundary.\n\nDefault works well for most cases, but you can set this to customise it when necessary.",
9315
+ "default": "undefined",
9316
+ "fieldName": "boundaryPadding",
9317
+ "inheritedFrom": {
9318
+ "name": "Popover",
9319
+ "module": "src/components/popover/popover.component.ts"
9320
+ }
9321
+ },
9322
+ {
9323
+ "name": "focus-trap",
9324
+ "type": {
9325
+ "text": "boolean"
9326
+ },
9327
+ "description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.",
9328
+ "default": "false",
9329
+ "fieldName": "focusTrap",
9330
+ "inheritedFrom": {
9331
+ "name": "Popover",
9332
+ "module": "src/components/popover/popover.component.ts"
9333
+ }
9334
+ },
9335
+ {
9336
+ "name": "prevent-scroll",
9337
+ "type": {
9338
+ "text": "boolean"
9339
+ },
9340
+ "description": "Prevent outside scrolling when popover is shown.",
9341
+ "default": "false",
9342
+ "fieldName": "preventScroll",
9343
+ "inheritedFrom": {
9344
+ "name": "Popover",
9345
+ "module": "src/components/popover/popover.component.ts"
9346
+ }
9347
+ },
9348
+ {
9349
+ "name": "interactive",
9350
+ "type": {
9351
+ "text": "boolean"
9352
+ },
9353
+ "description": "Determines whether the popover is interactive.\nMake sure to set focusTrap to true to keep the focus inside the popover in case necessary.\nSetting interactive to true will not automatically set focusTrap!",
9354
+ "default": "false",
9355
+ "fieldName": "interactive",
9356
+ "inheritedFrom": {
9357
+ "name": "Popover",
9358
+ "module": "src/components/popover/popover.component.ts"
9359
+ }
9360
+ },
9361
+ {
9362
+ "name": "delay",
9363
+ "type": {
9364
+ "text": "string"
9365
+ },
9366
+ "description": "The delay of the show/hide popover.",
9367
+ "default": "0,0",
9368
+ "fieldName": "delay",
9369
+ "inheritedFrom": {
9370
+ "name": "Popover",
9371
+ "module": "src/components/popover/popover.component.ts"
9372
+ }
9373
+ },
9374
+ {
9375
+ "name": "hide-on-escape",
9376
+ "type": {
9377
+ "text": "boolean"
9378
+ },
9379
+ "description": "Hide popover on escape key press.",
9380
+ "default": "false",
9381
+ "fieldName": "hideOnEscape",
9382
+ "inheritedFrom": {
9383
+ "name": "Popover",
9384
+ "module": "src/components/popover/popover.component.ts"
9385
+ }
9386
+ },
9387
+ {
9388
+ "name": "propagate-event-on-escape",
9389
+ "type": {
9390
+ "text": "boolean"
9391
+ },
9392
+ "description": "Propagates the event, when the escape key is pressed (only when pressed inside the popover)\nIf true, the escape key press close the popover and will propagate the keydown event.\nIf false, the escape key press will close the popover but will not propagate the keydown event.\n(set to false to prevent the event from bubbling up to the document).\n\nThis only works when `hideOnEscape` is true.",
9393
+ "default": "false",
9394
+ "fieldName": "propagateEventOnEscape",
9395
+ "inheritedFrom": {
9396
+ "name": "Popover",
9397
+ "module": "src/components/popover/popover.component.ts"
9398
+ }
9399
+ },
9400
+ {
9401
+ "name": "hide-on-blur",
9402
+ "type": {
9403
+ "text": "boolean"
9404
+ },
9405
+ "description": "Hide popover on blur.",
9406
+ "default": "false",
9407
+ "fieldName": "hideOnBlur",
9408
+ "inheritedFrom": {
9409
+ "name": "Popover",
9410
+ "module": "src/components/popover/popover.component.ts"
9411
+ }
9412
+ },
9413
+ {
9414
+ "name": "hide-on-outside-click",
9415
+ "type": {
9416
+ "text": "boolean"
9611
9417
  },
9612
- "description": "The offset of the popover.",
9613
- "default": "4",
9614
- "attribute": "offset",
9615
- "reflects": true,
9418
+ "description": "Hide on outside click of the popover.",
9419
+ "default": "false",
9420
+ "fieldName": "hideOnOutsideClick",
9616
9421
  "inheritedFrom": {
9617
9422
  "name": "Popover",
9618
- "module": "components/popover/popover.component.js"
9423
+ "module": "src/components/popover/popover.component.ts"
9619
9424
  }
9620
9425
  },
9621
9426
  {
9622
- "kind": "field",
9623
- "name": "boundary",
9427
+ "name": "focus-back-to-trigger",
9624
9428
  "type": {
9625
- "text": "'clippingAncestors' | string"
9429
+ "text": "boolean"
9626
9430
  },
9627
- "description": "This describes the clipping element(s) or area that overflow will be checked relative to.\nThe default is 'clippingAncestors', which are the overflow ancestors which will cause the\nelement to be clipped.\n\nPossible values:\n - 'clippingAncestors'\n - any css selector",
9628
- "default": "'clippingAncestors'",
9629
- "attribute": "boundary",
9630
- "reflects": true,
9431
+ "description": "The focus back to trigger after the popover hide.",
9432
+ "default": "false",
9433
+ "fieldName": "focusBackToTrigger",
9631
9434
  "inheritedFrom": {
9632
9435
  "name": "Popover",
9633
- "module": "components/popover/popover.component.js"
9436
+ "module": "src/components/popover/popover.component.ts"
9634
9437
  }
9635
9438
  },
9636
9439
  {
9637
- "kind": "field",
9638
- "name": "boundaryRoot",
9440
+ "name": "backdrop",
9639
9441
  "type": {
9640
- "text": "'viewport' | 'document'"
9442
+ "text": "boolean"
9641
9443
  },
9642
- "description": "This describes the root boundary that the element will be checked for overflow relative to.\nThe default is 'viewport', which is the area of the page the user can see on the screen.\n\nThe other string option is 'document', which is the entire page outside the viewport.",
9643
- "default": "'viewport'",
9644
- "attribute": "boundary-root",
9645
- "reflects": true,
9444
+ "description": "Determines whether the popover with backdrop.\nOther than popover and trigger element, the rest of the screen will be covered with a backdrop.",
9445
+ "default": "false",
9446
+ "fieldName": "backdrop",
9646
9447
  "inheritedFrom": {
9647
9448
  "name": "Popover",
9648
- "module": "components/popover/popover.component.js"
9449
+ "module": "src/components/popover/popover.component.ts"
9649
9450
  }
9650
9451
  },
9651
9452
  {
9652
- "kind": "field",
9653
- "name": "boundaryPadding",
9453
+ "name": "flip",
9654
9454
  "type": {
9655
- "text": "undefined | number"
9455
+ "text": "boolean"
9656
9456
  },
9657
- "description": "Virtual padding around the boundary to check for overflow.\nSo the popover will not be placed on top of the edge of the boundary.\n\nDefault works well for most cases, but you can set this to customise it when necessary.",
9658
- "default": "undefined",
9659
- "attribute": "boundary-padding",
9660
- "reflects": true,
9457
+ "description": "Changes the placement of popover to keep it in view when scrolling.",
9458
+ "default": "true",
9459
+ "fieldName": "flip",
9661
9460
  "inheritedFrom": {
9662
9461
  "name": "Popover",
9663
- "module": "components/popover/popover.component.js"
9462
+ "module": "src/components/popover/popover.component.ts"
9664
9463
  }
9665
9464
  },
9666
9465
  {
9667
- "kind": "field",
9668
- "name": "interactive",
9466
+ "name": "size",
9669
9467
  "type": {
9670
9468
  "text": "boolean"
9671
9469
  },
9672
- "description": "Determines whether the popover is interactive.\nMake sure to set focusTrap to true to keep the focus inside the popover in case necessary.\nSetting interactive to true will not automatically set focusTrap!",
9470
+ "description": "Changes the size of popover to keep it in view when scrolling.",
9673
9471
  "default": "false",
9674
- "attribute": "interactive",
9675
- "reflects": true,
9472
+ "fieldName": "size",
9676
9473
  "inheritedFrom": {
9677
9474
  "name": "Popover",
9678
- "module": "components/popover/popover.component.js"
9475
+ "module": "src/components/popover/popover.component.ts"
9679
9476
  }
9680
9477
  },
9681
9478
  {
9682
- "kind": "field",
9683
- "name": "delay",
9479
+ "name": "z-index",
9684
9480
  "type": {
9685
- "text": "string"
9481
+ "text": "number"
9686
9482
  },
9687
- "description": "The delay of the show/hide popover.",
9688
- "default": "0,0",
9689
- "attribute": "delay",
9690
- "reflects": true,
9483
+ "description": "The z-index of the popover.",
9484
+ "default": "1000",
9485
+ "fieldName": "zIndex",
9691
9486
  "inheritedFrom": {
9692
9487
  "name": "Popover",
9693
- "module": "components/popover/popover.component.js"
9488
+ "module": "src/components/popover/popover.component.ts"
9694
9489
  }
9695
9490
  },
9696
9491
  {
9697
- "kind": "field",
9698
- "name": "hideOnEscape",
9492
+ "name": "append-to",
9699
9493
  "type": {
9700
- "text": "boolean"
9494
+ "text": "string | undefined"
9701
9495
  },
9702
- "description": "Hide popover on escape key press.",
9703
- "default": "false",
9704
- "attribute": "hide-on-escape",
9705
- "reflects": true,
9496
+ "description": "Element ID that the popover append to.",
9497
+ "default": "''",
9498
+ "fieldName": "appendTo",
9706
9499
  "inheritedFrom": {
9707
9500
  "name": "Popover",
9708
- "module": "components/popover/popover.component.js"
9501
+ "module": "src/components/popover/popover.component.ts"
9709
9502
  }
9710
9503
  },
9711
9504
  {
9712
- "kind": "field",
9713
- "name": "propagateEventOnEscape",
9505
+ "name": "close-button-aria-label",
9714
9506
  "type": {
9715
- "text": "boolean"
9507
+ "text": "string | null"
9716
9508
  },
9717
- "description": "Propagates the event, when the escape key is pressed (only when pressed inside the popover)\nIf true, the escape key press close the popover and will propagate the keydown event.\nIf false, the escape key press will close the popover but will not propagate the keydown event.\n(set to false to prevent the event from bubbling up to the document).\n\nThis only works when `hideOnEscape` is true.",
9718
- "default": "false",
9719
- "attribute": "propagate-event-on-escape",
9720
- "reflects": true,
9509
+ "default": "null",
9510
+ "description": "aria-label attribute to be set for close button accessibility.",
9511
+ "fieldName": "closeButtonAriaLabel",
9721
9512
  "inheritedFrom": {
9722
9513
  "name": "Popover",
9723
- "module": "components/popover/popover.component.js"
9514
+ "module": "src/components/popover/popover.component.ts"
9724
9515
  }
9725
9516
  },
9726
9517
  {
9727
- "kind": "field",
9728
- "name": "hideOnBlur",
9518
+ "name": "role",
9729
9519
  "type": {
9730
- "text": "boolean"
9520
+ "text": "HTMLElement['role']"
9731
9521
  },
9732
- "description": "Hide popover on blur.",
9733
- "default": "false",
9734
- "attribute": "hide-on-blur",
9735
- "reflects": true,
9522
+ "description": "Role of the popover",
9523
+ "default": "dialog",
9524
+ "fieldName": "role",
9736
9525
  "inheritedFrom": {
9737
9526
  "name": "Popover",
9738
- "module": "components/popover/popover.component.js"
9527
+ "module": "src/components/popover/popover.component.ts"
9739
9528
  }
9740
9529
  },
9741
9530
  {
9742
- "kind": "field",
9743
- "name": "hideOnOutsideClick",
9531
+ "name": "aria-labelledby",
9744
9532
  "type": {
9745
- "text": "boolean"
9533
+ "text": "string | null"
9746
9534
  },
9747
- "description": "Hide on outside click of the popover.",
9748
- "default": "false",
9749
- "attribute": "hide-on-outside-click",
9750
- "reflects": true,
9535
+ "default": "null",
9536
+ "description": "aria-labelledby for an interactive popover only, defaults to the trigger component id.\nUsed in nested cases where the triggerComponent isn't the actual button.",
9537
+ "fieldName": "ariaLabelledby",
9751
9538
  "inheritedFrom": {
9752
9539
  "name": "Popover",
9753
- "module": "components/popover/popover.component.js"
9540
+ "module": "src/components/popover/popover.component.ts"
9754
9541
  }
9755
9542
  },
9756
9543
  {
9757
- "kind": "field",
9758
- "name": "focusBackToTrigger",
9544
+ "name": "aria-describedby",
9759
9545
  "type": {
9760
- "text": "boolean"
9546
+ "text": "string | null"
9761
9547
  },
9762
- "description": "The focus back to trigger after the popover hide.",
9763
- "default": "false",
9764
- "attribute": "focus-back-to-trigger",
9765
- "reflects": true,
9548
+ "default": "null",
9549
+ "description": "aria-describedby of the popover.",
9550
+ "fieldName": "ariaDescribedby",
9766
9551
  "inheritedFrom": {
9767
9552
  "name": "Popover",
9768
- "module": "components/popover/popover.component.js"
9553
+ "module": "src/components/popover/popover.component.ts"
9769
9554
  }
9770
9555
  },
9771
9556
  {
9772
- "kind": "field",
9773
- "name": "backdrop",
9557
+ "name": "disable-aria-haspopup",
9774
9558
  "type": {
9775
9559
  "text": "boolean"
9776
9560
  },
9777
- "description": "Determines whether the popover with backdrop.\nOther than popover and trigger element, the rest of the screen will be covered with a backdrop.",
9561
+ "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.",
9778
9562
  "default": "false",
9779
- "attribute": "backdrop",
9780
- "reflects": true,
9563
+ "fieldName": "disableAriaHasPopup",
9781
9564
  "inheritedFrom": {
9782
9565
  "name": "Popover",
9783
- "module": "components/popover/popover.component.js"
9566
+ "module": "src/components/popover/popover.component.ts"
9784
9567
  }
9568
+ }
9569
+ ],
9570
+ "superclass": {
9571
+ "name": "Popover",
9572
+ "module": "/src/components/popover/popover.component"
9573
+ },
9574
+ "tagName": "mdc-coachmark",
9575
+ "jsDoc": "/**\n * Coachmark component based on top of the popover component,\n * with the default value of certain properties changed.\n *\n * @dependency mdc-popover\n *\n * @tagname mdc-coachmark\n *\n * @event shown - (React: onShown) This event is dispatched when the coachmark is shown\n * @event hidden - (React: onHidden) This event is dispatched when the coachmark is hidden\n * @event created - (React: onCreated) This event is dispatched when the coachmark is created (added to the DOM)\n * @event destroyed - (React: onDestroyed) This event is dispatched when the coachmark is\n * destroyed (removed from the DOM)\n *\n * @cssproperty --mdc-popover-arrow-border-radius - radius of the arrow border\n * @cssproperty --mdc-popover-arrow-border - border of the arrow\n * @cssproperty --mdc-popover-primary-background-color - primary background color of the popover\n * @cssproperty --mdc-popover-border-color - border color of the popover\n * @cssproperty --mdc-popover-inverted-background-color - inverted background color of the popover\n * @cssproperty --mdc-popover-inverted-border-color - inverted border color of the popover\n * @cssproperty --mdc-popover-inverted-text-color - inverted text color of the popover\n * @cssproperty --mdc-popover-elevation-3 - elevation of the popover\n *\n * @slot - Default slot for modal container\n *\n */",
9576
+ "customElement": true
9577
+ }
9578
+ ],
9579
+ "exports": [
9580
+ {
9581
+ "kind": "js",
9582
+ "name": "default",
9583
+ "declaration": {
9584
+ "name": "Coachmark",
9585
+ "module": "components/coachmark/coachmark.component.js"
9586
+ }
9587
+ }
9588
+ ]
9589
+ },
9590
+ {
9591
+ "kind": "javascript-module",
9592
+ "path": "components/dialog/dialog.component.js",
9593
+ "declarations": [
9594
+ {
9595
+ "kind": "class",
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
+ "cssProperties": [
9599
+ {
9600
+ "description": "primary background color of the dialog",
9601
+ "name": "--mdc-dialog-primary-background-color"
9785
9602
  },
9603
+ {
9604
+ "description": "border color of the dialog",
9605
+ "name": "--mdc-dialog-border-color"
9606
+ },
9607
+ {
9608
+ "description": "text color of the header/title of the dialog",
9609
+ "name": "--mdc-dialog-header-text-color"
9610
+ },
9611
+ {
9612
+ "description": "text color of the below header description of the dialog",
9613
+ "name": "--mdc-dialog-description-text-color"
9614
+ },
9615
+ {
9616
+ "description": "elevation of the dialog",
9617
+ "name": "--mdc-dialog-elevation-3"
9618
+ },
9619
+ {
9620
+ "description": "width of the dialog",
9621
+ "name": "--mdc-dialog-width"
9622
+ }
9623
+ ],
9624
+ "slots": [
9625
+ {
9626
+ "description": "Slot for the dialog header content. This can be used to pass custom header content.",
9627
+ "name": "header-prefix"
9628
+ },
9629
+ {
9630
+ "description": "Slot for the dialog body content",
9631
+ "name": "dialog-body"
9632
+ },
9633
+ {
9634
+ "description": "This slot is for passing `mdc-link` component within the footer section.",
9635
+ "name": "footer-link"
9636
+ },
9637
+ {
9638
+ "description": "This slot is for passing secondary variant of `mdc-button` component within the footer section.",
9639
+ "name": "footer-button-secondary"
9640
+ },
9641
+ {
9642
+ "description": "This slot is for passing primary variant of `mdc-button` component within the footer section.",
9643
+ "name": "footer-button-primary"
9644
+ },
9645
+ {
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"
9648
+ }
9649
+ ],
9650
+ "members": [
9786
9651
  {
9787
9652
  "kind": "field",
9788
- "name": "flip",
9653
+ "name": "id",
9789
9654
  "type": {
9790
- "text": "boolean"
9655
+ "text": "string"
9791
9656
  },
9792
- "description": "Changes the placement of popover to keep it in view when scrolling.",
9793
- "default": "true",
9794
- "attribute": "flip",
9795
- "reflects": true,
9796
- "inheritedFrom": {
9797
- "name": "Popover",
9798
- "module": "components/popover/popover.component.js"
9799
- }
9657
+ "default": "''",
9658
+ "description": "The unique ID of the dialog",
9659
+ "attribute": "id",
9660
+ "reflects": true
9800
9661
  },
9801
9662
  {
9802
9663
  "kind": "field",
9803
- "name": "size",
9664
+ "name": "triggerId",
9665
+ "type": {
9666
+ "text": "string | undefined"
9667
+ },
9668
+ "description": "The ID of the element that triggers the dialog",
9669
+ "default": "undefined",
9670
+ "attribute": "triggerId",
9671
+ "reflects": true
9672
+ },
9673
+ {
9674
+ "kind": "field",
9675
+ "name": "visible",
9804
9676
  "type": {
9805
9677
  "text": "boolean"
9806
9678
  },
9807
- "description": "Changes the size of popover to keep it in view when scrolling.",
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.",
9808
9680
  "default": "false",
9809
- "attribute": "size",
9810
- "reflects": true,
9811
- "inheritedFrom": {
9812
- "name": "Popover",
9813
- "module": "components/popover/popover.component.js"
9814
- }
9681
+ "attribute": "visible",
9682
+ "reflects": true
9815
9683
  },
9816
9684
  {
9817
9685
  "kind": "field",
@@ -9819,29 +9687,32 @@
9819
9687
  "type": {
9820
9688
  "text": "number"
9821
9689
  },
9822
- "description": "The z-index of the popover.",
9690
+ "description": "The z-index of the dialog\n\nThe backdrop will have z-index of `zIndex - 1`",
9823
9691
  "default": "1000",
9824
9692
  "attribute": "z-index",
9825
- "reflects": true,
9826
- "inheritedFrom": {
9827
- "name": "Popover",
9828
- "module": "components/popover/popover.component.js"
9829
- }
9693
+ "reflects": true
9830
9694
  },
9831
9695
  {
9832
9696
  "kind": "field",
9833
- "name": "appendTo",
9697
+ "name": "size",
9834
9698
  "type": {
9835
- "text": "string | undefined"
9699
+ "text": "DialogSize"
9836
9700
  },
9837
- "description": "Element ID that the popover append to.",
9838
- "default": "''",
9839
- "attribute": "append-to",
9840
- "reflects": true,
9841
- "inheritedFrom": {
9842
- "name": "Popover",
9843
- "module": "components/popover/popover.component.js"
9844
- }
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
9705
+ },
9706
+ {
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
9845
9716
  },
9846
9717
  {
9847
9718
  "kind": "field",
@@ -9850,28 +9721,19 @@
9850
9721
  "text": "string | null"
9851
9722
  },
9852
9723
  "default": "null",
9853
- "description": "aria-label attribute to be set for close button accessibility.",
9854
- "attribute": "close-button-aria-label",
9855
- "reflects": true,
9856
- "inheritedFrom": {
9857
- "name": "Popover",
9858
- "module": "components/popover/popover.component.js"
9859
- }
9724
+ "description": "Defines a string value for the aria-label attribute for close button accessibility",
9725
+ "attribute": "close-button-aria-label"
9860
9726
  },
9861
9727
  {
9862
9728
  "kind": "field",
9863
- "name": "role",
9729
+ "name": "ariaLabel",
9864
9730
  "type": {
9865
- "text": "HTMLElement['role']"
9731
+ "text": "string | null"
9866
9732
  },
9867
- "description": "Role of the popover",
9868
- "default": "dialog",
9869
- "attribute": "role",
9870
- "reflects": true,
9871
- "inheritedFrom": {
9872
- "name": "Popover",
9873
- "module": "components/popover/popover.component.js"
9874
- }
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
9875
9737
  },
9876
9738
  {
9877
9739
  "kind": "field",
@@ -9880,147 +9742,125 @@
9880
9742
  "text": "string | null"
9881
9743
  },
9882
9744
  "default": "null",
9883
- "description": "aria-labelledby for an interactive popover only, defaults to the trigger component id.\nUsed in nested cases where the triggerComponent isn't the actual button.",
9745
+ "description": "Defines a string value for the aria-labelledby attribute that refers to the element\nlabeling the dialog for accessibility",
9884
9746
  "attribute": "aria-labelledby",
9885
- "reflects": true,
9886
- "inheritedFrom": {
9887
- "name": "Popover",
9888
- "module": "components/popover/popover.component.js"
9889
- }
9747
+ "reflects": true
9890
9748
  },
9891
9749
  {
9892
9750
  "kind": "field",
9893
- "name": "ariaDescribedby",
9751
+ "name": "ariaDescribedBy",
9894
9752
  "type": {
9895
9753
  "text": "string | null"
9896
9754
  },
9897
9755
  "default": "null",
9898
- "description": "aria-describedby of the popover.",
9756
+ "description": "Defines a string value for the aria-describedby attribute that refers to the element\ndescribing the dialog for accessibility",
9899
9757
  "attribute": "aria-describedby",
9900
- "reflects": true,
9901
- "inheritedFrom": {
9902
- "name": "Popover",
9903
- "module": "components/popover/popover.component.js"
9904
- }
9758
+ "reflects": true
9905
9759
  },
9906
9760
  {
9907
9761
  "kind": "field",
9908
- "name": "disableAriaHasPopup",
9762
+ "name": "ariaDescription",
9909
9763
  "type": {
9910
- "text": "boolean"
9764
+ "text": "string | null"
9911
9765
  },
9912
- "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.",
9913
- "default": "false",
9914
- "attribute": "disable-aria-haspopup",
9915
- "reflects": true,
9916
- "inheritedFrom": {
9917
- "name": "Popover",
9918
- "module": "components/popover/popover.component.js"
9919
- }
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
9920
9770
  },
9921
9771
  {
9922
9772
  "kind": "field",
9923
- "name": "arrowElement",
9773
+ "name": "headerText",
9924
9774
  "type": {
9925
- "text": "HTMLElement | null"
9775
+ "text": "string | undefined"
9926
9776
  },
9927
- "privacy": "public",
9928
- "default": "null",
9929
- "inheritedFrom": {
9930
- "name": "Popover",
9931
- "module": "components/popover/popover.component.js"
9932
- }
9777
+ "description": "Defines a string value to display as the title of the dialog",
9778
+ "attribute": "header-text",
9779
+ "reflects": true
9933
9780
  },
9934
9781
  {
9935
9782
  "kind": "field",
9936
- "name": "triggerElement",
9783
+ "name": "descriptionText",
9937
9784
  "type": {
9938
- "text": "HTMLElement | null"
9785
+ "text": "string | undefined"
9939
9786
  },
9940
- "privacy": "public",
9941
- "default": "null",
9942
- "inheritedFrom": {
9943
- "name": "Popover",
9944
- "module": "components/popover/popover.component.js"
9945
- }
9787
+ "description": "Defines a string value to display as the under-header description of the dialog",
9788
+ "attribute": "description-text",
9789
+ "reflects": true
9946
9790
  },
9947
9791
  {
9948
- "kind": "method",
9949
- "name": "setupTriggerListener",
9950
- "privacy": "private",
9951
- "description": "Sets up the trigger event listeners based on the trigger type.",
9952
- "inheritedFrom": {
9953
- "name": "Popover",
9954
- "module": "components/popover/popover.component.js"
9955
- }
9792
+ "kind": "field",
9793
+ "name": "headerTagName",
9794
+ "type": {
9795
+ "text": "string"
9796
+ },
9797
+ "description": "The html tag to be used for the header text",
9798
+ "attribute": "header-tag-name",
9799
+ "reflects": true
9956
9800
  },
9957
9801
  {
9958
- "kind": "method",
9959
- "name": "removeEventListeners",
9960
- "privacy": "private",
9961
- "description": "Removes the trigger event listeners.",
9962
- "inheritedFrom": {
9963
- "name": "Popover",
9964
- "module": "components/popover/popover.component.js"
9965
- }
9802
+ "kind": "field",
9803
+ "name": "descriptionTagName",
9804
+ "type": {
9805
+ "text": "string"
9806
+ },
9807
+ "description": "The html tag to be used for the below-header description text",
9808
+ "attribute": "description-tag-name",
9809
+ "reflects": true
9966
9810
  },
9967
9811
  {
9968
9812
  "kind": "field",
9969
- "name": "onOutsidePopoverClick",
9970
- "privacy": "protected",
9971
- "description": "Handles the outside click event to close the popover.",
9972
- "parameters": [
9973
- {
9974
- "description": "The mouse event.",
9975
- "name": "event"
9976
- }
9977
- ],
9978
- "inheritedFrom": {
9979
- "name": "Popover",
9980
- "module": "components/popover/popover.component.js"
9981
- }
9813
+ "name": "role",
9814
+ "type": {
9815
+ "text": "DialogRole"
9816
+ },
9817
+ "description": "Role of the dialog",
9818
+ "default": "dialog",
9819
+ "attribute": "role",
9820
+ "reflects": true
9982
9821
  },
9983
9822
  {
9984
9823
  "kind": "field",
9985
- "name": "onEscapeKeydown",
9986
- "privacy": "private",
9987
- "description": "Handles the escape keydown event to close the popover.\n\nThis method is attached to the document.",
9988
- "parameters": [
9989
- {
9990
- "description": "The keyboard event.",
9991
- "name": "event"
9992
- }
9993
- ],
9994
- "inheritedFrom": {
9995
- "name": "Popover",
9996
- "module": "components/popover/popover.component.js"
9997
- }
9824
+ "name": "disableAriaHasPopup",
9825
+ "type": {
9826
+ "text": "boolean"
9827
+ },
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
9998
9832
  },
9999
9833
  {
10000
9834
  "kind": "field",
10001
- "name": "onPopoverFocusOut",
10002
- "privacy": "private",
10003
- "description": "Handles the popover focus out event.",
10004
- "parameters": [
10005
- {
10006
- "description": "The focus event.",
10007
- "name": "event"
10008
- }
10009
- ],
9835
+ "name": "focusTrap",
9836
+ "type": {
9837
+ "text": "boolean"
9838
+ },
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,
10010
9844
  "inheritedFrom": {
10011
- "name": "Popover",
10012
- "module": "components/popover/popover.component.js"
9845
+ "name": "FocusTrapMixin",
9846
+ "module": "utils/mixins/FocusTrapMixin.js"
10013
9847
  }
10014
9848
  },
9849
+ {
9850
+ "kind": "method",
9851
+ "name": "closeDialog",
9852
+ "privacy": "private",
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
+ },
10015
9855
  {
10016
9856
  "kind": "method",
10017
9857
  "name": "isOpenUpdated",
10018
- "privacy": "protected",
9858
+ "privacy": "private",
10019
9859
  "parameters": [
10020
9860
  {
10021
9861
  "name": "oldValue",
10022
9862
  "type": {
10023
- "text": "boolean"
9863
+ "text": "boolean | undefined"
10024
9864
  },
10025
9865
  "description": "The old value of the visible property."
10026
9866
  },
@@ -10030,613 +9870,773 @@
10030
9870
  "text": "boolean"
10031
9871
  },
10032
9872
  "description": "The new value of the visible property."
10033
- }
10034
- ],
10035
- "description": "Handles the popover visibility change and position the popover.\nHandles the exit event to close the popover.",
10036
- "inheritedFrom": {
10037
- "name": "Popover",
10038
- "module": "components/popover/popover.component.js"
10039
- }
9873
+ }
9874
+ ],
9875
+ "description": "Handles the dialog visibility change.\nHandles the exit event to close the dialog."
10040
9876
  },
10041
9877
  {
10042
9878
  "kind": "field",
10043
- "name": "handleMouseEnter",
10044
- "privacy": "private",
10045
- "description": "Handles mouse enter event on the trigger element.\nThis method sets the `isHovered` flag to true and shows the popover",
9879
+ "name": "preventScroll",
9880
+ "type": {
9881
+ "text": "boolean"
9882
+ },
9883
+ "privacy": "protected",
9884
+ "description": "Prevent outside scrolling when element is shown.\n\nIMPLEMENT THIS IN YOUR COMPONENT.",
10046
9885
  "inheritedFrom": {
10047
- "name": "Popover",
10048
- "module": "components/popover/popover.component.js"
9886
+ "name": "PreventScrollMixin",
9887
+ "module": "utils/mixins/PreventScrollMixin.js"
10049
9888
  }
10050
9889
  },
10051
9890
  {
10052
- "kind": "field",
10053
- "name": "handleMouseLeave",
10054
- "privacy": "private",
10055
- "description": "Handles mouse leave event on the trigger element.\nThis method sets the `isHovered` flag to false and starts the close delay\ntimer to hide the popover.",
9891
+ "kind": "method",
9892
+ "name": "activatePreventScroll",
9893
+ "privacy": "protected",
10056
9894
  "inheritedFrom": {
10057
- "name": "Popover",
10058
- "module": "components/popover/popover.component.js"
9895
+ "name": "PreventScrollMixin",
9896
+ "module": "utils/mixins/PreventScrollMixin.js"
10059
9897
  }
10060
9898
  },
10061
9899
  {
10062
- "kind": "field",
10063
- "name": "handleFocusOut",
10064
- "privacy": "private",
10065
- "description": "Handles focus out event on the trigger element.\nThis method checks if the popover is not hovered and hides the popover.\nIf the popover is hovered, it will not hide the popover.",
9900
+ "kind": "method",
9901
+ "name": "deactivatePreventScroll",
9902
+ "privacy": "protected",
10066
9903
  "inheritedFrom": {
10067
- "name": "Popover",
10068
- "module": "components/popover/popover.component.js"
9904
+ "name": "PreventScrollMixin",
9905
+ "module": "utils/mixins/PreventScrollMixin.js"
10069
9906
  }
10070
9907
  },
10071
9908
  {
10072
9909
  "kind": "field",
10073
- "name": "startCloseDelay",
10074
- "privacy": "private",
10075
- "description": "Starts the close delay timer.\nIf the popover is not interactive, it will close the popover after the delay.",
9910
+ "name": "shouldFocusTrapWrap",
9911
+ "type": {
9912
+ "text": "boolean"
9913
+ },
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",
9917
+ "reflects": true,
10076
9918
  "inheritedFrom": {
10077
- "name": "Popover",
10078
- "module": "components/popover/popover.component.js"
9919
+ "name": "FocusTrapMixin",
9920
+ "module": "utils/mixins/FocusTrapMixin.js"
10079
9921
  }
10080
9922
  },
10081
9923
  {
10082
- "kind": "field",
10083
- "name": "cancelCloseDelay",
9924
+ "kind": "method",
9925
+ "name": "setIsFocusTrapActivated",
10084
9926
  "privacy": "private",
10085
- "description": "Cancels the close delay timer.",
9927
+ "parameters": [
9928
+ {
9929
+ "name": "isActivated",
9930
+ "type": {
9931
+ "text": "boolean"
9932
+ }
9933
+ }
9934
+ ],
10086
9935
  "inheritedFrom": {
10087
- "name": "Popover",
10088
- "module": "components/popover/popover.component.js"
9936
+ "name": "FocusTrapMixin",
9937
+ "module": "utils/mixins/FocusTrapMixin.js"
10089
9938
  }
10090
9939
  },
10091
9940
  {
10092
- "kind": "field",
10093
- "name": "showPopover",
9941
+ "kind": "method",
9942
+ "name": "activateFocusTrap",
10094
9943
  "privacy": "public",
10095
- "description": "Shows the popover.",
9944
+ "description": "Activate the focus trap",
10096
9945
  "inheritedFrom": {
10097
- "name": "Popover",
10098
- "module": "components/popover/popover.component.js"
9946
+ "name": "FocusTrapMixin",
9947
+ "module": "utils/mixins/FocusTrapMixin.js"
10099
9948
  }
10100
9949
  },
10101
9950
  {
10102
- "kind": "field",
10103
- "name": "hidePopover",
9951
+ "kind": "method",
9952
+ "name": "deactivateFocusTrap",
10104
9953
  "privacy": "public",
10105
- "description": "Hides the popover.",
9954
+ "description": "Deactivate the focus trap.",
10106
9955
  "inheritedFrom": {
10107
- "name": "Popover",
10108
- "module": "components/popover/popover.component.js"
9956
+ "name": "FocusTrapMixin",
9957
+ "module": "utils/mixins/FocusTrapMixin.js"
10109
9958
  }
10110
9959
  },
10111
9960
  {
10112
- "kind": "field",
10113
- "name": "togglePopoverVisible",
10114
- "privacy": "public",
10115
- "description": "Toggles the popover visibility.",
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
+ }
9978
+ },
10116
9979
  "inheritedFrom": {
10117
- "name": "Popover",
10118
- "module": "components/popover/popover.component.js"
9980
+ "name": "FocusTrapMixin",
9981
+ "module": "utils/mixins/FocusTrapMixin.js"
10119
9982
  }
10120
9983
  },
10121
9984
  {
10122
9985
  "kind": "method",
10123
- "name": "positionPopover",
9986
+ "name": "hasZeroDimensions",
10124
9987
  "privacy": "private",
10125
- "description": "Positions the popover based on the trigger element.\nIt also handles the flip, size and arrow placement.\nIt uses the floating-ui/dom library to calculate the position.",
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
+ }
10002
+ },
10126
10003
  "inheritedFrom": {
10127
- "name": "Popover",
10128
- "module": "components/popover/popover.component.js"
10004
+ "name": "FocusTrapMixin",
10005
+ "module": "utils/mixins/FocusTrapMixin.js"
10129
10006
  }
10130
10007
  },
10131
10008
  {
10132
10009
  "kind": "method",
10133
- "name": "findClosestPopover",
10134
- "privacy": "protected",
10010
+ "name": "isNotVisible",
10011
+ "privacy": "private",
10012
+ "parameters": [
10013
+ {
10014
+ "name": "element",
10015
+ "type": {
10016
+ "text": "HTMLElement"
10017
+ },
10018
+ "description": "The element to check."
10019
+ }
10020
+ ],
10021
+ "description": "Determines if the element is not visible in the DOM.",
10135
10022
  "return": {
10136
10023
  "type": {
10137
- "text": "Popover | null"
10024
+ "text": ""
10138
10025
  }
10139
10026
  },
10027
+ "inheritedFrom": {
10028
+ "name": "FocusTrapMixin",
10029
+ "module": "utils/mixins/FocusTrapMixin.js"
10030
+ }
10031
+ },
10032
+ {
10033
+ "kind": "method",
10034
+ "name": "hasHiddenStyle",
10035
+ "privacy": "private",
10140
10036
  "parameters": [
10141
10037
  {
10142
10038
  "name": "element",
10143
10039
  "type": {
10144
- "text": "Element"
10040
+ "text": "HTMLElement"
10145
10041
  },
10146
- "description": "The element to start searching from."
10042
+ "description": "The element to check."
10147
10043
  }
10148
10044
  ],
10149
- "description": "Finds the closest popover to the passed element in the DOM tree.\n\nUseful when need to find the parent popover in a nested popover scenario.",
10045
+ "description": "Checks if the element has inline styles that make it hidden.",
10046
+ "return": {
10047
+ "type": {
10048
+ "text": ""
10049
+ }
10050
+ },
10150
10051
  "inheritedFrom": {
10151
- "name": "Popover",
10152
- "module": "components/popover/popover.component.js"
10052
+ "name": "FocusTrapMixin",
10053
+ "module": "utils/mixins/FocusTrapMixin.js"
10153
10054
  }
10154
10055
  },
10155
10056
  {
10156
- "kind": "field",
10157
- "name": "utils",
10158
- "default": "new PopoverUtils(this)",
10057
+ "kind": "method",
10058
+ "name": "hasComputedHidden",
10059
+ "privacy": "private",
10060
+ "parameters": [
10061
+ {
10062
+ "name": "element",
10063
+ "type": {
10064
+ "text": "HTMLElement"
10065
+ },
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
+ },
10159
10075
  "inheritedFrom": {
10160
- "name": "Popover",
10161
- "module": "components/popover/popover.component.js"
10076
+ "name": "FocusTrapMixin",
10077
+ "module": "utils/mixins/FocusTrapMixin.js"
10162
10078
  }
10163
- }
10164
- ],
10165
- "events": [
10079
+ },
10166
10080
  {
10167
- "description": "(React: onShown) This event is dispatched when the coachmark is shown",
10168
- "name": "shown",
10169
- "reactName": "onShown",
10081
+ "kind": "method",
10082
+ "name": "isHidden",
10083
+ "privacy": "private",
10084
+ "parameters": [
10085
+ {
10086
+ "name": "element",
10087
+ "type": {
10088
+ "text": "HTMLElement"
10089
+ },
10090
+ "description": "The element to check."
10091
+ }
10092
+ ],
10093
+ "description": "Checks if the element is hidden from the user.",
10094
+ "return": {
10095
+ "type": {
10096
+ "text": ""
10097
+ }
10098
+ },
10170
10099
  "inheritedFrom": {
10171
- "name": "Popover",
10172
- "module": "src/components/popover/popover.component.ts"
10100
+ "name": "FocusTrapMixin",
10101
+ "module": "utils/mixins/FocusTrapMixin.js"
10173
10102
  }
10174
10103
  },
10175
10104
  {
10176
- "description": "(React: onHidden) This event is dispatched when the coachmark is hidden",
10177
- "name": "hidden",
10178
- "reactName": "onHidden",
10105
+ "kind": "method",
10106
+ "name": "isDisabled",
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
+ },
10179
10123
  "inheritedFrom": {
10180
- "name": "Popover",
10181
- "module": "src/components/popover/popover.component.ts"
10124
+ "name": "FocusTrapMixin",
10125
+ "module": "utils/mixins/FocusTrapMixin.js"
10182
10126
  }
10183
10127
  },
10184
10128
  {
10185
- "description": "(React: onCreated) This event is dispatched when the coachmark is created (added to the DOM)",
10186
- "name": "created",
10187
- "reactName": "onCreated",
10129
+ "kind": "method",
10130
+ "name": "isNotTabbable",
10131
+ "privacy": "private",
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
+ },
10188
10147
  "inheritedFrom": {
10189
- "name": "Popover",
10190
- "module": "src/components/popover/popover.component.ts"
10148
+ "name": "FocusTrapMixin",
10149
+ "module": "utils/mixins/FocusTrapMixin.js"
10191
10150
  }
10192
10151
  },
10193
10152
  {
10194
- "description": "(React: onDestroyed) This event is dispatched when the coachmark is destroyed (removed from the DOM)",
10195
- "name": "destroyed",
10196
- "reactName": "onDestroyed",
10153
+ "kind": "method",
10154
+ "name": "isInteractiveElement",
10155
+ "privacy": "private",
10156
+ "return": {
10157
+ "type": {
10158
+ "text": ""
10159
+ }
10160
+ },
10161
+ "parameters": [
10162
+ {
10163
+ "name": "element",
10164
+ "type": {
10165
+ "text": "HTMLElement"
10166
+ },
10167
+ "description": "The element to check."
10168
+ }
10169
+ ],
10170
+ "description": "Checks if the element is interactive.",
10197
10171
  "inheritedFrom": {
10198
- "name": "Popover",
10199
- "module": "src/components/popover/popover.component.ts"
10172
+ "name": "FocusTrapMixin",
10173
+ "module": "utils/mixins/FocusTrapMixin.js"
10200
10174
  }
10201
- }
10202
- ],
10203
- "attributes": [
10175
+ },
10204
10176
  {
10205
- "name": "trigger",
10206
- "type": {
10207
- "text": "PopoverTrigger"
10177
+ "kind": "method",
10178
+ "name": "isFocusable",
10179
+ "privacy": "private",
10180
+ "parameters": [
10181
+ {
10182
+ "name": "element",
10183
+ "type": {
10184
+ "text": "HTMLElement"
10185
+ },
10186
+ "description": "The element to check."
10187
+ }
10188
+ ],
10189
+ "description": "Checks if the element is focusable.",
10190
+ "return": {
10191
+ "type": {
10192
+ "text": ""
10193
+ }
10208
10194
  },
10209
- "description": "Determines the events that cause the Coachmark to show.\nMultiple event names should be separated by spaces.\nFor example to allow both click and hover, use 'click mouseenter' as the trigger.\n- **click**\n- **mouseenter**\n- **focusin**\n- **manual**",
10210
- "default": "manual",
10211
- "fieldName": "trigger",
10212
10195
  "inheritedFrom": {
10213
- "name": "Popover",
10214
- "module": "src/components/popover/popover.component.ts"
10196
+ "name": "FocusTrapMixin",
10197
+ "module": "utils/mixins/FocusTrapMixin.js"
10215
10198
  }
10216
10199
  },
10217
10200
  {
10218
- "name": "show-arrow",
10219
- "type": {
10220
- "text": "boolean"
10201
+ "kind": "method",
10202
+ "name": "findFocusable",
10203
+ "privacy": "private",
10204
+ "return": {
10205
+ "type": {
10206
+ "text": ""
10207
+ }
10221
10208
  },
10222
- "description": "The arrow visibility of the Coachmark.",
10223
- "default": "true",
10224
- "fieldName": "showArrow",
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.",
10225
10227
  "inheritedFrom": {
10226
- "name": "Popover",
10227
- "module": "src/components/popover/popover.component.ts"
10228
+ "name": "FocusTrapMixin",
10229
+ "module": "utils/mixins/FocusTrapMixin.js"
10228
10230
  }
10229
10231
  },
10230
10232
  {
10231
- "name": "close-button",
10232
- "type": {
10233
- "text": "boolean"
10234
- },
10235
- "description": "The close button visibility of the Coachmark.",
10236
- "default": "true",
10237
- "fieldName": "closeButton",
10233
+ "kind": "method",
10234
+ "name": "setFocusableElements",
10235
+ "privacy": "private",
10236
+ "description": "Updates the list of focusable elements within the component's shadow root.",
10238
10237
  "inheritedFrom": {
10239
- "name": "Popover",
10240
- "module": "src/components/popover/popover.component.ts"
10238
+ "name": "FocusTrapMixin",
10239
+ "module": "utils/mixins/FocusTrapMixin.js"
10241
10240
  }
10242
10241
  },
10243
10242
  {
10244
- "name": "disable-aria-expanded",
10245
- "type": {
10246
- "text": "boolean"
10247
- },
10248
- "description": "Disable aria-expanded attribute on trigger element.",
10249
- "default": "true",
10250
- "fieldName": "disableAriaExpanded",
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.",
10251
10257
  "inheritedFrom": {
10252
- "name": "Popover",
10253
- "module": "src/components/popover/popover.component.ts"
10258
+ "name": "FocusTrapMixin",
10259
+ "module": "utils/mixins/FocusTrapMixin.js"
10254
10260
  }
10255
10261
  },
10256
10262
  {
10257
- "name": "should-focus-trap-wrap",
10258
- "type": {
10259
- "text": "boolean"
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
+ }
10260
10287
  },
10261
- "default": "true",
10262
- "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.",
10263
- "fieldName": "shouldFocusTrapWrap",
10264
10288
  "inheritedFrom": {
10265
10289
  "name": "FocusTrapMixin",
10266
- "module": "src/utils/mixins/FocusTrapMixin.ts"
10290
+ "module": "utils/mixins/FocusTrapMixin.js"
10267
10291
  }
10268
10292
  },
10269
10293
  {
10270
- "name": "id",
10271
- "type": {
10272
- "text": "string"
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
+ }
10273
10302
  },
10274
- "default": "''",
10275
- "description": "The unique ID of the popover.",
10276
- "fieldName": "id",
10277
10303
  "inheritedFrom": {
10278
- "name": "Popover",
10279
- "module": "src/components/popover/popover.component.ts"
10304
+ "name": "FocusTrapMixin",
10305
+ "module": "utils/mixins/FocusTrapMixin.js"
10280
10306
  }
10281
10307
  },
10282
10308
  {
10283
- "name": "triggerID",
10284
- "type": {
10285
- "text": "string"
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
+ }
10286
10326
  },
10287
- "default": "''",
10288
- "description": "The ID of the element that triggers the popover.\nThis attribute is required for the popover to work.",
10289
- "fieldName": "triggerID",
10290
10327
  "inheritedFrom": {
10291
- "name": "Popover",
10292
- "module": "src/components/popover/popover.component.ts"
10328
+ "name": "FocusTrapMixin",
10329
+ "module": "utils/mixins/FocusTrapMixin.js"
10293
10330
  }
10294
10331
  },
10295
10332
  {
10296
- "name": "placement",
10297
- "type": {
10298
- "text": "PopoverPlacement"
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
+ }
10299
10357
  },
10300
- "description": "The placement of the popover.\n- **top**\n- **top-start**\n- **top-end**\n- **bottom**\n- **bottom-start**\n- **bottom-end**\n- **left**\n- **left-start**\n- **left-end**\n- **right**\n- **right-start**\n- **right-end**",
10301
- "default": "bottom",
10302
- "fieldName": "placement",
10303
10358
  "inheritedFrom": {
10304
- "name": "Popover",
10305
- "module": "src/components/popover/popover.component.ts"
10359
+ "name": "FocusTrapMixin",
10360
+ "module": "utils/mixins/FocusTrapMixin.js"
10306
10361
  }
10307
10362
  },
10308
10363
  {
10309
- "name": "color",
10310
- "type": {
10311
- "text": "PopoverColor"
10312
- },
10313
- "description": "Color of the popover\n- **tonal**\n- **contrast**",
10314
- "default": "tonal",
10315
- "fieldName": "color",
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.",
10316
10380
  "inheritedFrom": {
10317
- "name": "Popover",
10318
- "module": "src/components/popover/popover.component.ts"
10381
+ "name": "FocusTrapMixin",
10382
+ "module": "utils/mixins/FocusTrapMixin.js"
10319
10383
  }
10320
10384
  },
10321
10385
  {
10322
- "name": "visible",
10323
- "type": {
10324
- "text": "boolean"
10325
- },
10326
- "description": "The visibility of the popover.",
10327
- "default": "false",
10328
- "fieldName": "visible",
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.",
10329
10399
  "inheritedFrom": {
10330
- "name": "Popover",
10331
- "module": "src/components/popover/popover.component.ts"
10400
+ "name": "FocusTrapMixin",
10401
+ "module": "utils/mixins/FocusTrapMixin.js"
10332
10402
  }
10333
10403
  },
10334
10404
  {
10335
- "name": "offset",
10336
- "type": {
10337
- "text": "number"
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
+ }
10338
10413
  },
10339
- "description": "The offset of the popover.",
10340
- "default": "4",
10341
- "fieldName": "offset",
10342
10414
  "inheritedFrom": {
10343
- "name": "Popover",
10344
- "module": "src/components/popover/popover.component.ts"
10415
+ "name": "CardAndDialogFooterMixin",
10416
+ "module": "utils/mixins/CardAndDialogFooterMixin.js"
10345
10417
  }
10418
+ }
10419
+ ],
10420
+ "events": [
10421
+ {
10422
+ "description": "(React: onShown) Dispatched when the dialog is shown",
10423
+ "name": "shown",
10424
+ "reactName": "onShown"
10346
10425
  },
10347
10426
  {
10348
- "name": "boundary",
10349
- "type": {
10350
- "text": "'clippingAncestors' | string"
10351
- },
10352
- "description": "This describes the clipping element(s) or area that overflow will be checked relative to.\nThe default is 'clippingAncestors', which are the overflow ancestors which will cause the\nelement to be clipped.\n\nPossible values:\n - 'clippingAncestors'\n - any css selector",
10353
- "default": "'clippingAncestors'",
10354
- "fieldName": "boundary",
10355
- "inheritedFrom": {
10356
- "name": "Popover",
10357
- "module": "src/components/popover/popover.component.ts"
10358
- }
10427
+ "description": "(React: onHidden) Dispatched when the dialog is hidden",
10428
+ "name": "hidden",
10429
+ "reactName": "onHidden"
10359
10430
  },
10360
10431
  {
10361
- "name": "boundary-root",
10362
- "type": {
10363
- "text": "'viewport' | 'document'"
10364
- },
10365
- "description": "This describes the root boundary that the element will be checked for overflow relative to.\nThe default is 'viewport', which is the area of the page the user can see on the screen.\n\nThe other string option is 'document', which is the entire page outside the viewport.",
10366
- "default": "'viewport'",
10367
- "fieldName": "boundaryRoot",
10368
- "inheritedFrom": {
10369
- "name": "Popover",
10370
- "module": "src/components/popover/popover.component.ts"
10371
- }
10432
+ "description": "(React: onCreated) Dispatched when the dialog is created (added to the DOM)",
10433
+ "name": "created",
10434
+ "reactName": "onCreated"
10372
10435
  },
10373
10436
  {
10374
- "name": "boundary-padding",
10375
- "type": {
10376
- "text": "undefined | number"
10377
- },
10378
- "description": "Virtual padding around the boundary to check for overflow.\nSo the popover will not be placed on top of the edge of the boundary.\n\nDefault works well for most cases, but you can set this to customise it when necessary.",
10379
- "default": "undefined",
10380
- "fieldName": "boundaryPadding",
10381
- "inheritedFrom": {
10382
- "name": "Popover",
10383
- "module": "src/components/popover/popover.component.ts"
10384
- }
10437
+ "description": "(React: onDestroyed) Dispatched when the dialog is destroyed (removed from the DOM)",
10438
+ "name": "destroyed",
10439
+ "reactName": "onDestroyed"
10385
10440
  },
10386
10441
  {
10387
- "name": "focus-trap",
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"
10445
+ }
10446
+ ],
10447
+ "attributes": [
10448
+ {
10449
+ "name": "id",
10388
10450
  "type": {
10389
- "text": "boolean"
10451
+ "text": "string"
10390
10452
  },
10391
- "description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.",
10392
- "default": "false",
10393
- "fieldName": "focusTrap",
10394
- "inheritedFrom": {
10395
- "name": "Popover",
10396
- "module": "src/components/popover/popover.component.ts"
10397
- }
10453
+ "default": "''",
10454
+ "description": "The unique ID of the dialog",
10455
+ "fieldName": "id"
10398
10456
  },
10399
10457
  {
10400
- "name": "prevent-scroll",
10458
+ "name": "triggerId",
10401
10459
  "type": {
10402
- "text": "boolean"
10460
+ "text": "string | undefined"
10403
10461
  },
10404
- "description": "Prevent outside scrolling when popover is shown.",
10405
- "default": "false",
10406
- "fieldName": "preventScroll",
10407
- "inheritedFrom": {
10408
- "name": "Popover",
10409
- "module": "src/components/popover/popover.component.ts"
10410
- }
10462
+ "description": "The ID of the element that triggers the dialog",
10463
+ "default": "undefined",
10464
+ "fieldName": "triggerId"
10411
10465
  },
10412
10466
  {
10413
- "name": "interactive",
10467
+ "name": "visible",
10414
10468
  "type": {
10415
10469
  "text": "boolean"
10416
10470
  },
10417
- "description": "Determines whether the popover is interactive.\nMake sure to set focusTrap to true to keep the focus inside the popover in case necessary.\nSetting interactive to true will not automatically set focusTrap!",
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.",
10418
10472
  "default": "false",
10419
- "fieldName": "interactive",
10420
- "inheritedFrom": {
10421
- "name": "Popover",
10422
- "module": "src/components/popover/popover.component.ts"
10423
- }
10473
+ "fieldName": "visible"
10424
10474
  },
10425
10475
  {
10426
- "name": "delay",
10476
+ "name": "z-index",
10427
10477
  "type": {
10428
- "text": "string"
10478
+ "text": "number"
10429
10479
  },
10430
- "description": "The delay of the show/hide popover.",
10431
- "default": "0,0",
10432
- "fieldName": "delay",
10433
- "inheritedFrom": {
10434
- "name": "Popover",
10435
- "module": "src/components/popover/popover.component.ts"
10436
- }
10480
+ "description": "The z-index of the dialog\n\nThe backdrop will have z-index of `zIndex - 1`",
10481
+ "default": "1000",
10482
+ "fieldName": "zIndex"
10437
10483
  },
10438
10484
  {
10439
- "name": "hide-on-escape",
10485
+ "name": "size",
10440
10486
  "type": {
10441
- "text": "boolean"
10487
+ "text": "DialogSize"
10442
10488
  },
10443
- "description": "Hide popover on escape key press.",
10444
- "default": "false",
10445
- "fieldName": "hideOnEscape",
10446
- "inheritedFrom": {
10447
- "name": "Popover",
10448
- "module": "src/components/popover/popover.component.ts"
10449
- }
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).",
10490
+ "default": "small",
10491
+ "fieldName": "size"
10450
10492
  },
10451
10493
  {
10452
- "name": "propagate-event-on-escape",
10494
+ "name": "variant",
10453
10495
  "type": {
10454
- "text": "boolean"
10496
+ "text": "DialogVariant"
10455
10497
  },
10456
- "description": "Propagates the event, when the escape key is pressed (only when pressed inside the popover)\nIf true, the escape key press close the popover and will propagate the keydown event.\nIf false, the escape key press will close the popover but will not propagate the keydown event.\n(set to false to prevent the event from bubbling up to the document).\n\nThis only works when `hideOnEscape` is true.",
10457
- "default": "false",
10458
- "fieldName": "propagateEventOnEscape",
10459
- "inheritedFrom": {
10460
- "name": "Popover",
10461
- "module": "src/components/popover/popover.component.ts"
10462
- }
10498
+ "description": "The variant of the dialog, can be 'default' or 'promotional'",
10499
+ "default": "default",
10500
+ "fieldName": "variant"
10463
10501
  },
10464
10502
  {
10465
- "name": "hide-on-blur",
10503
+ "name": "close-button-aria-label",
10466
10504
  "type": {
10467
- "text": "boolean"
10505
+ "text": "string | null"
10468
10506
  },
10469
- "description": "Hide popover on blur.",
10470
- "default": "false",
10471
- "fieldName": "hideOnBlur",
10472
- "inheritedFrom": {
10473
- "name": "Popover",
10474
- "module": "src/components/popover/popover.component.ts"
10475
- }
10507
+ "default": "null",
10508
+ "description": "Defines a string value for the aria-label attribute for close button accessibility",
10509
+ "fieldName": "closeButtonAriaLabel"
10476
10510
  },
10477
10511
  {
10478
- "name": "hide-on-outside-click",
10512
+ "name": "aria-label",
10479
10513
  "type": {
10480
- "text": "boolean"
10514
+ "text": "string | null"
10481
10515
  },
10482
- "description": "Hide on outside click of the popover.",
10483
- "default": "false",
10484
- "fieldName": "hideOnOutsideClick",
10485
- "inheritedFrom": {
10486
- "name": "Popover",
10487
- "module": "src/components/popover/popover.component.ts"
10488
- }
10516
+ "default": "null",
10517
+ "description": "Defines a string value for the aria-label attribute when header is not used",
10518
+ "fieldName": "ariaLabel"
10489
10519
  },
10490
10520
  {
10491
- "name": "focus-back-to-trigger",
10521
+ "name": "aria-labelledby",
10492
10522
  "type": {
10493
- "text": "boolean"
10523
+ "text": "string | null"
10494
10524
  },
10495
- "description": "The focus back to trigger after the popover hide.",
10496
- "default": "false",
10497
- "fieldName": "focusBackToTrigger",
10498
- "inheritedFrom": {
10499
- "name": "Popover",
10500
- "module": "src/components/popover/popover.component.ts"
10501
- }
10525
+ "default": "null",
10526
+ "description": "Defines a string value for the aria-labelledby attribute that refers to the element\nlabeling the dialog for accessibility",
10527
+ "fieldName": "ariaLabelledby"
10502
10528
  },
10503
10529
  {
10504
- "name": "backdrop",
10530
+ "name": "aria-describedby",
10505
10531
  "type": {
10506
- "text": "boolean"
10532
+ "text": "string | null"
10507
10533
  },
10508
- "description": "Determines whether the popover with backdrop.\nOther than popover and trigger element, the rest of the screen will be covered with a backdrop.",
10509
- "default": "false",
10510
- "fieldName": "backdrop",
10511
- "inheritedFrom": {
10512
- "name": "Popover",
10513
- "module": "src/components/popover/popover.component.ts"
10514
- }
10534
+ "default": "null",
10535
+ "description": "Defines a string value for the aria-describedby attribute that refers to the element\ndescribing the dialog for accessibility",
10536
+ "fieldName": "ariaDescribedBy"
10515
10537
  },
10516
10538
  {
10517
- "name": "flip",
10539
+ "name": "aria-description",
10518
10540
  "type": {
10519
- "text": "boolean"
10541
+ "text": "string | null"
10520
10542
  },
10521
- "description": "Changes the placement of popover to keep it in view when scrolling.",
10522
- "default": "true",
10523
- "fieldName": "flip",
10524
- "inheritedFrom": {
10525
- "name": "Popover",
10526
- "module": "src/components/popover/popover.component.ts"
10527
- }
10543
+ "default": "null",
10544
+ "description": "Defines a string value for the aria-description attribute that refers to the element\ndescribing the dialog for accessibility",
10545
+ "fieldName": "ariaDescription"
10528
10546
  },
10529
10547
  {
10530
- "name": "size",
10548
+ "name": "header-text",
10531
10549
  "type": {
10532
- "text": "boolean"
10550
+ "text": "string | undefined"
10533
10551
  },
10534
- "description": "Changes the size of popover to keep it in view when scrolling.",
10535
- "default": "false",
10536
- "fieldName": "size",
10537
- "inheritedFrom": {
10538
- "name": "Popover",
10539
- "module": "src/components/popover/popover.component.ts"
10540
- }
10552
+ "description": "Defines a string value to display as the title of the dialog",
10553
+ "fieldName": "headerText"
10541
10554
  },
10542
10555
  {
10543
- "name": "z-index",
10556
+ "name": "description-text",
10544
10557
  "type": {
10545
- "text": "number"
10558
+ "text": "string | undefined"
10546
10559
  },
10547
- "description": "The z-index of the popover.",
10548
- "default": "1000",
10549
- "fieldName": "zIndex",
10550
- "inheritedFrom": {
10551
- "name": "Popover",
10552
- "module": "src/components/popover/popover.component.ts"
10553
- }
10560
+ "description": "Defines a string value to display as the under-header description of the dialog",
10561
+ "fieldName": "descriptionText"
10554
10562
  },
10555
10563
  {
10556
- "name": "append-to",
10564
+ "name": "header-tag-name",
10557
10565
  "type": {
10558
- "text": "string | undefined"
10566
+ "text": "string"
10559
10567
  },
10560
- "description": "Element ID that the popover append to.",
10561
- "default": "''",
10562
- "fieldName": "appendTo",
10563
- "inheritedFrom": {
10564
- "name": "Popover",
10565
- "module": "src/components/popover/popover.component.ts"
10566
- }
10568
+ "description": "The html tag to be used for the header text",
10569
+ "fieldName": "headerTagName"
10567
10570
  },
10568
10571
  {
10569
- "name": "close-button-aria-label",
10572
+ "name": "description-tag-name",
10570
10573
  "type": {
10571
- "text": "string | null"
10574
+ "text": "string"
10572
10575
  },
10573
- "default": "null",
10574
- "description": "aria-label attribute to be set for close button accessibility.",
10575
- "fieldName": "closeButtonAriaLabel",
10576
- "inheritedFrom": {
10577
- "name": "Popover",
10578
- "module": "src/components/popover/popover.component.ts"
10579
- }
10576
+ "description": "The html tag to be used for the below-header description text",
10577
+ "fieldName": "descriptionTagName"
10580
10578
  },
10581
10579
  {
10582
10580
  "name": "role",
10583
10581
  "type": {
10584
- "text": "HTMLElement['role']"
10582
+ "text": "DialogRole"
10585
10583
  },
10586
- "description": "Role of the popover",
10584
+ "description": "Role of the dialog",
10587
10585
  "default": "dialog",
10588
- "fieldName": "role",
10589
- "inheritedFrom": {
10590
- "name": "Popover",
10591
- "module": "src/components/popover/popover.component.ts"
10592
- }
10586
+ "fieldName": "role"
10593
10587
  },
10594
10588
  {
10595
- "name": "aria-labelledby",
10589
+ "name": "disable-aria-haspopup",
10596
10590
  "type": {
10597
- "text": "string | null"
10591
+ "text": "boolean"
10598
10592
  },
10599
- "default": "null",
10600
- "description": "aria-labelledby for an interactive popover only, defaults to the trigger component id.\nUsed in nested cases where the triggerComponent isn't the actual button.",
10601
- "fieldName": "ariaLabelledby",
10602
- "inheritedFrom": {
10603
- "name": "Popover",
10604
- "module": "src/components/popover/popover.component.ts"
10605
- }
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.",
10594
+ "default": "false",
10595
+ "fieldName": "disableAriaHasPopup"
10606
10596
  },
10607
10597
  {
10608
- "name": "aria-describedby",
10598
+ "name": "focus-trap",
10609
10599
  "type": {
10610
- "text": "string | null"
10600
+ "text": "boolean"
10611
10601
  },
10612
- "default": "null",
10613
- "description": "aria-describedby of the popover.",
10614
- "fieldName": "ariaDescribedby",
10615
- "inheritedFrom": {
10616
- "name": "Popover",
10617
- "module": "src/components/popover/popover.component.ts"
10618
- }
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.",
10603
+ "default": "true",
10604
+ "fieldName": "focusTrap"
10619
10605
  },
10620
10606
  {
10621
- "name": "disable-aria-haspopup",
10607
+ "name": "should-focus-trap-wrap",
10622
10608
  "type": {
10623
10609
  "text": "boolean"
10624
10610
  },
10625
- "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.",
10626
- "default": "false",
10627
- "fieldName": "disableAriaHasPopup",
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",
10628
10614
  "inheritedFrom": {
10629
- "name": "Popover",
10630
- "module": "src/components/popover/popover.component.ts"
10615
+ "name": "FocusTrapMixin",
10616
+ "module": "src/utils/mixins/FocusTrapMixin.ts"
10631
10617
  }
10632
10618
  }
10633
10619
  ],
10620
+ "mixins": [
10621
+ {
10622
+ "name": "PreventScrollMixin",
10623
+ "module": "/src/utils/mixins/PreventScrollMixin"
10624
+ },
10625
+ {
10626
+ "name": "FocusTrapMixin",
10627
+ "module": "/src/utils/mixins/FocusTrapMixin"
10628
+ },
10629
+ {
10630
+ "name": "CardAndDialogFooterMixin",
10631
+ "module": "/src/utils/mixins/CardAndDialogFooterMixin"
10632
+ }
10633
+ ],
10634
10634
  "superclass": {
10635
- "name": "Popover",
10636
- "module": "/src/components/popover/popover.component"
10635
+ "name": "Component",
10636
+ "module": "/src/models"
10637
10637
  },
10638
- "tagName": "mdc-coachmark",
10639
- "jsDoc": "/**\n * Coachmark component based on top of the popover component,\n * with the default value of certain properties changed.\n *\n * @dependency mdc-popover\n *\n * @tagname mdc-coachmark\n *\n * @event shown - (React: onShown) This event is dispatched when the coachmark is shown\n * @event hidden - (React: onHidden) This event is dispatched when the coachmark is hidden\n * @event created - (React: onCreated) This event is dispatched when the coachmark is created (added to the DOM)\n * @event destroyed - (React: onDestroyed) This event is dispatched when the coachmark is\n * destroyed (removed from the DOM)\n *\n * @cssproperty --mdc-popover-arrow-border-radius - radius of the arrow border\n * @cssproperty --mdc-popover-arrow-border - border of the arrow\n * @cssproperty --mdc-popover-primary-background-color - primary background color of the popover\n * @cssproperty --mdc-popover-border-color - border color of the popover\n * @cssproperty --mdc-popover-inverted-background-color - inverted background color of the popover\n * @cssproperty --mdc-popover-inverted-border-color - inverted border color of the popover\n * @cssproperty --mdc-popover-inverted-text-color - inverted text color of the popover\n * @cssproperty --mdc-popover-elevation-3 - elevation of the popover\n *\n * @slot - Default slot for modal container\n *\n */",
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
10640
  "customElement": true
10641
10641
  }
10642
10642
  ],
@@ -10645,8 +10645,8 @@
10645
10645
  "kind": "js",
10646
10646
  "name": "default",
10647
10647
  "declaration": {
10648
- "name": "Coachmark",
10649
- "module": "components/coachmark/coachmark.component.js"
10648
+ "name": "Dialog",
10649
+ "module": "components/dialog/dialog.component.js"
10650
10650
  }
10651
10651
  }
10652
10652
  ]
@@ -21936,123 +21936,61 @@
21936
21936
  "fieldName": "dataAriaLabel",
21937
21937
  "inheritedFrom": {
21938
21938
  "name": "DataAriaLabelMixin",
21939
- "module": "src/utils/mixins/DataAriaLabelMixin.ts"
21940
- }
21941
- },
21942
- {
21943
- "name": "disabled",
21944
- "type": {
21945
- "text": "boolean | undefined"
21946
- },
21947
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
21948
- "default": "undefined",
21949
- "fieldName": "disabled",
21950
- "inheritedFrom": {
21951
- "name": "DisabledMixin",
21952
- "module": "src/utils/mixins/DisabledMixin.ts"
21953
- }
21954
- }
21955
- ],
21956
- "mixins": [
21957
- {
21958
- "name": "DataAriaLabelMixin",
21959
- "module": "/src/utils/mixins/DataAriaLabelMixin"
21960
- },
21961
- {
21962
- "name": "DisabledMixin",
21963
- "module": "/src/utils/mixins/DisabledMixin"
21964
- }
21965
- ],
21966
- "superclass": {
21967
- "name": "Component",
21968
- "module": "/src/models"
21969
- },
21970
- "tagName": "mdc-optgroup",
21971
- "jsDoc": "/**\n * optgroup component, which creates a grouping of mdc-option within a listbox element.\n *\n * @dependency mdc-text\n *\n * @tagname mdc-optgroup\n *\n * @slot default - This is a default slot for mdc-option elements.\n *\n * @cssproperty --mdc-optgroup-disabled-color - Allows customization of the disabled option color.\n */",
21972
- "customElement": true
21973
- }
21974
- ],
21975
- "exports": [
21976
- {
21977
- "kind": "js",
21978
- "name": "default",
21979
- "declaration": {
21980
- "name": "OptGroup",
21981
- "module": "components/optgroup/optgroup.component.js"
21982
- }
21983
- }
21984
- ]
21985
- },
21986
- {
21987
- "kind": "javascript-module",
21988
- "path": "components/option/option.component.js",
21989
- "declarations": [
21990
- {
21991
- "kind": "class",
21992
- "description": "option component, which is used as a list item in a select component.<br/>\nWe can pass an icon which will be displayed in leading position of the option label text.\nWe can pass a tooltip which will be displayed on hover of the option label text.\nThe tooltip will be helpful for a long label text which is truncated with ellipsis.",
21993
- "name": "Option",
21994
- "slots": [
21995
- {
21996
- "description": "This is a default/unnamed slot",
21997
- "name": "default"
21998
- },
21999
- {
22000
- "description": "slot for list item controls to appear of leading end.",
22001
- "name": "leading-controls",
22002
- "inheritedFrom": {
22003
- "name": "ListItem",
22004
- "module": "src/components/listitem/listitem.component.ts"
22005
- }
22006
- },
22007
- {
22008
- "description": "slot for list item primary label.",
22009
- "name": "leading-text-primary-label",
22010
- "inheritedFrom": {
22011
- "name": "ListItem",
22012
- "module": "src/components/listitem/listitem.component.ts"
22013
- }
22014
- },
22015
- {
22016
- "description": "slot for list item secondary label.",
22017
- "name": "leading-text-secondary-label",
22018
- "inheritedFrom": {
22019
- "name": "ListItem",
22020
- "module": "src/components/listitem/listitem.component.ts"
22021
- }
22022
- },
22023
- {
22024
- "description": "slot for list item tertiary label.",
22025
- "name": "leading-text-tertiary-label",
22026
- "inheritedFrom": {
22027
- "name": "ListItem",
22028
- "module": "src/components/listitem/listitem.component.ts"
22029
- }
22030
- },
22031
- {
22032
- "description": "slot for list item side header text.",
22033
- "name": "trailing-text-side-header",
22034
- "inheritedFrom": {
22035
- "name": "ListItem",
22036
- "module": "src/components/listitem/listitem.component.ts"
21939
+ "module": "src/utils/mixins/DataAriaLabelMixin.ts"
22037
21940
  }
22038
21941
  },
22039
21942
  {
22040
- "description": "slot for list item subline text.",
22041
- "name": "trailing-text-subline",
21943
+ "name": "disabled",
21944
+ "type": {
21945
+ "text": "boolean | undefined"
21946
+ },
21947
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
21948
+ "default": "undefined",
21949
+ "fieldName": "disabled",
22042
21950
  "inheritedFrom": {
22043
- "name": "ListItem",
22044
- "module": "src/components/listitem/listitem.component.ts"
21951
+ "name": "DisabledMixin",
21952
+ "module": "src/utils/mixins/DisabledMixin.ts"
22045
21953
  }
21954
+ }
21955
+ ],
21956
+ "mixins": [
21957
+ {
21958
+ "name": "DataAriaLabelMixin",
21959
+ "module": "/src/utils/mixins/DataAriaLabelMixin"
22046
21960
  },
22047
21961
  {
22048
- "description": "slot for list item controls to appear of trailing end.",
22049
- "name": "trailing-controls",
22050
- "inheritedFrom": {
22051
- "name": "ListItem",
22052
- "module": "src/components/listitem/listitem.component.ts"
22053
- }
21962
+ "name": "DisabledMixin",
21963
+ "module": "/src/utils/mixins/DisabledMixin"
22054
21964
  }
22055
21965
  ],
21966
+ "superclass": {
21967
+ "name": "Component",
21968
+ "module": "/src/models"
21969
+ },
21970
+ "tagName": "mdc-optgroup",
21971
+ "jsDoc": "/**\n * optgroup component, which creates a grouping of mdc-option within a listbox element.\n *\n * @dependency mdc-text\n *\n * @tagname mdc-optgroup\n *\n * @slot default - This is a default slot for mdc-option elements.\n *\n * @cssproperty --mdc-optgroup-disabled-color - Allows customization of the disabled option color.\n */",
21972
+ "customElement": true
21973
+ }
21974
+ ],
21975
+ "exports": [
21976
+ {
21977
+ "kind": "js",
21978
+ "name": "default",
21979
+ "declaration": {
21980
+ "name": "OptGroup",
21981
+ "module": "components/optgroup/optgroup.component.js"
21982
+ }
21983
+ }
21984
+ ]
21985
+ },
21986
+ {
21987
+ "kind": "javascript-module",
21988
+ "path": "components/option/option.component.js",
21989
+ "declarations": [
21990
+ {
21991
+ "kind": "class",
21992
+ "description": "Option component, which is used within Selectlistbox within Select component.\n\nThe label and secondary label of the option can be set using the `label` and `secondaryLabel` properties respectively.\nThe `label` is the primary text displayed in the option, while the `secondaryLabel` is the secondary text displayed below the primary label.\n\nThe `selected` property is used to indicate whether the option is selected or not.\nWhen the `selected` property is set to true, a checkmark icon will be displayed\non the right side of the option to indicate that it is selected.\n\nThe `prefixIcon` property can be used to display an icon on the left side of the option label.\nWe can show a tooltip by setting `tooltip-text` attribute. This will be displayed on hover or focus of the option.\nThe tooltip will be helpful for a long label text which is truncated with ellipsis.",
21993
+ "name": "Option",
22056
21994
  "members": [
22057
21995
  {
22058
21996
  "kind": "field",
@@ -22086,12 +22024,6 @@
22086
22024
  "attribute": "aria-label",
22087
22025
  "reflects": true
22088
22026
  },
22089
- {
22090
- "kind": "method",
22091
- "name": "handleDefaultSlotChange",
22092
- "privacy": "private",
22093
- "description": "Listens to changes in the default slot and updates the label of the option accordingly.\nThis is used to set the label of the option when it is not explicitly set.\nIt is called internally when the slot is changed."
22094
- },
22095
22027
  {
22096
22028
  "kind": "field",
22097
22029
  "name": "name",
@@ -22837,8 +22769,66 @@
22837
22769
  "module": "/src/components/listitem/listitem.component"
22838
22770
  },
22839
22771
  "tagName": "mdc-option",
22840
- "jsDoc": "/**\n * option component, which is used as a list item in a select component.<br/>\n * We can pass an icon which will be displayed in leading position of the option label text.\n * We can pass a tooltip which will be displayed on hover of the option label text.\n * The tooltip will be helpful for a long label text which is truncated with ellipsis.\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n * @dependency mdc-tooltip\n *\n * @tagname mdc-option\n *\n * @slot default - This is a default/unnamed slot\n *\n * @event click - (React: onClick) This event is dispatched when the option is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the option.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the option.\n * @event focus - (React: onFocus) This event is dispatched when the option receives focus.\n */",
22772
+ "jsDoc": "/**\n * Option component, which is used within Selectlistbox within Select component.\n *\n * The label and secondary label of the option can be set using the `label` and `secondaryLabel` properties respectively.\n * The `label` is the primary text displayed in the option, while the `secondaryLabel` is the secondary text displayed below the primary label.\n *\n * The `selected` property is used to indicate whether the option is selected or not.\n * When the `selected` property is set to true, a checkmark icon will be displayed\n * on the right side of the option to indicate that it is selected.\n *\n * The `prefixIcon` property can be used to display an icon on the left side of the option label.\n * We can show a tooltip by setting `tooltip-text` attribute. This will be displayed on hover or focus of the option.\n * The tooltip will be helpful for a long label text which is truncated with ellipsis.\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n * @dependency mdc-tooltip\n *\n * @tagname mdc-option\n *\n * @event click - (React: onClick) This event is dispatched when the option is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the option.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the option.\n * @event focus - (React: onFocus) This event is dispatched when the option receives focus.\n */",
22841
22773
  "customElement": true,
22774
+ "slots": [
22775
+ {
22776
+ "description": "slot for list item controls to appear of leading end.",
22777
+ "name": "leading-controls",
22778
+ "inheritedFrom": {
22779
+ "name": "ListItem",
22780
+ "module": "src/components/listitem/listitem.component.ts"
22781
+ }
22782
+ },
22783
+ {
22784
+ "description": "slot for list item primary label.",
22785
+ "name": "leading-text-primary-label",
22786
+ "inheritedFrom": {
22787
+ "name": "ListItem",
22788
+ "module": "src/components/listitem/listitem.component.ts"
22789
+ }
22790
+ },
22791
+ {
22792
+ "description": "slot for list item secondary label.",
22793
+ "name": "leading-text-secondary-label",
22794
+ "inheritedFrom": {
22795
+ "name": "ListItem",
22796
+ "module": "src/components/listitem/listitem.component.ts"
22797
+ }
22798
+ },
22799
+ {
22800
+ "description": "slot for list item tertiary label.",
22801
+ "name": "leading-text-tertiary-label",
22802
+ "inheritedFrom": {
22803
+ "name": "ListItem",
22804
+ "module": "src/components/listitem/listitem.component.ts"
22805
+ }
22806
+ },
22807
+ {
22808
+ "description": "slot for list item side header text.",
22809
+ "name": "trailing-text-side-header",
22810
+ "inheritedFrom": {
22811
+ "name": "ListItem",
22812
+ "module": "src/components/listitem/listitem.component.ts"
22813
+ }
22814
+ },
22815
+ {
22816
+ "description": "slot for list item subline text.",
22817
+ "name": "trailing-text-subline",
22818
+ "inheritedFrom": {
22819
+ "name": "ListItem",
22820
+ "module": "src/components/listitem/listitem.component.ts"
22821
+ }
22822
+ },
22823
+ {
22824
+ "description": "slot for list item controls to appear of trailing end.",
22825
+ "name": "trailing-controls",
22826
+ "inheritedFrom": {
22827
+ "name": "ListItem",
22828
+ "module": "src/components/listitem/listitem.component.ts"
22829
+ }
22830
+ }
22831
+ ],
22842
22832
  "cssProperties": [
22843
22833
  {
22844
22834
  "description": "Allows customization of the default background color.",
@@ -29555,11 +29545,11 @@
29555
29545
  "declarations": [
29556
29546
  {
29557
29547
  "kind": "class",
29558
- "description": "The mdc-select component is a dropdown selection control that allows users to pick an option from a predefined list.\nIt is designed to work with `mdc-option` for individual options and `mdc-optgroup` for grouping related options.\nThe component ensures accessibility and usability while handling various use cases,\nincluding long text truncation with tooltip support.\n\nTo set a default option, use the `selected` attribute on the `mdc-option` element.\n\n**Note:** Make sure to add `mdc-selectlistbox` as a child of `mdc-select` and wrap options/optgroup in it to ensure proper accessibility functionality. Read more about it in SelectListBox documentation.",
29548
+ "description": "The mdc-select component is a dropdown selection control that allows users to pick an option from a predefined list.\nIt is designed to work with `mdc-option` for individual options and `mdc-optgroup` for grouping related options.\nThe component ensures accessibility and usability while handling various use cases,\nincluding long text truncation with tooltip support.\n\nEvery mdc-option should have a `value` attribute set to ensure proper form submission.\n\nTo set a default option, use the `selected` attribute on the `mdc-option` element.\n\n**Note:** Make sure to add `mdc-selectlistbox` as a child of `mdc-select` and wrap options/optgroup in it to ensure proper accessibility functionality. Read more about it in SelectListBox documentation.",
29559
29549
  "name": "Select",
29560
29550
  "slots": [
29561
29551
  {
29562
- "description": "This is a default/unnamed slot for options and/or option group.",
29552
+ "description": "This is a default/unnamed slot for Selectlistbox including options and/or option group.",
29563
29553
  "name": "default"
29564
29554
  }
29565
29555
  ],
@@ -29615,36 +29605,49 @@
29615
29605
  },
29616
29606
  {
29617
29607
  "kind": "method",
29618
- "name": "modifyListBoxWrapper",
29608
+ "name": "getAllValidOptions",
29619
29609
  "privacy": "private",
29620
- "description": "Modifies the listbox wrapper to ensure it has the correct attributes\nand IDs for accessibility.\n\nOnce [ariaOwnsElements](https://developer.mozilla.org/en-US/docs/Web/API/ElementInternals/ariaOwnsElements) is supported in browsers,\nthis an be removed and mdc-option can be used directly in the select component with a listbox in a different\nshadow root and aria-owns attribute to connect them."
29610
+ "return": {
29611
+ "type": {
29612
+ "text": "Array<Option>"
29613
+ }
29614
+ }
29621
29615
  },
29622
29616
  {
29623
29617
  "kind": "method",
29624
- "name": "getAllValidOptions",
29618
+ "name": "getFirstValidOption",
29625
29619
  "privacy": "private",
29626
- "description": "A helper function which returns a flattened array of all valid options from within the slotted listbox.\nIt takes care of the edge cases where the option is either a direct child or a\nchild of an option group."
29620
+ "return": {
29621
+ "type": {
29622
+ "text": "Option | null"
29623
+ }
29624
+ }
29627
29625
  },
29628
29626
  {
29629
29627
  "kind": "method",
29630
- "name": "updateTabIndexForAllOptions",
29628
+ "name": "getLastValidOption",
29631
29629
  "privacy": "private",
29632
29630
  "return": {
29633
29631
  "type": {
29634
- "text": "void"
29632
+ "text": "Option | null"
29635
29633
  }
29636
- },
29637
- "parameters": [
29638
- {
29639
- "name": "selectedOption",
29640
- "optional": true,
29641
- "type": {
29642
- "text": "EventTarget | null"
29643
- },
29644
- "description": "The option which should be selected."
29634
+ }
29635
+ },
29636
+ {
29637
+ "kind": "method",
29638
+ "name": "getFirstSelectedOption",
29639
+ "privacy": "private",
29640
+ "return": {
29641
+ "type": {
29642
+ "text": "Option | null"
29645
29643
  }
29646
- ],
29647
- "description": "Updates the tabindex and selected attribute of the options.\nIf selectedOption is provided, it will be set as the selected option.\nOtherwise, it will set the first option as the selected option."
29644
+ }
29645
+ },
29646
+ {
29647
+ "kind": "method",
29648
+ "name": "modifyListBoxWrapper",
29649
+ "privacy": "private",
29650
+ "description": "Modifies the listbox wrapper to ensure it has the correct attributes\nand IDs for accessibility.\n\nOnce [ariaOwnsElements](https://developer.mozilla.org/en-US/docs/Web/API/ElementInternals/ariaOwnsElements) is supported in browsers,\nthis an be removed and mdc-option can be used directly in the select component with a listbox in a different\nshadow root and aria-owns attribute to connect them."
29648
29651
  },
29649
29652
  {
29650
29653
  "kind": "method",
@@ -29664,11 +29667,11 @@
29664
29667
  "description": "The event which triggered this function."
29665
29668
  }
29666
29669
  ],
29667
- "description": "A private method which is called when an option is clicked.\nIt is used to update the tabindex and selected attribute of the options."
29670
+ "description": "A private method which is called when an option is clicked.\nIt sets the selected option, removes selected from other options, updates the tabindex for all options,\ncloses the popover, and fires the change and input events."
29668
29671
  },
29669
29672
  {
29670
29673
  "kind": "method",
29671
- "name": "setSelectedValue",
29674
+ "name": "setSelectedOption",
29672
29675
  "privacy": "private",
29673
29676
  "return": {
29674
29677
  "type": {
@@ -29679,16 +29682,16 @@
29679
29682
  {
29680
29683
  "name": "option",
29681
29684
  "type": {
29682
- "text": "Element"
29685
+ "text": "Option | null"
29683
29686
  },
29684
- "description": "The option element from which to set the selected value."
29687
+ "description": "The option element in DOM which gets selected."
29685
29688
  }
29686
29689
  ],
29687
- "description": "Sets the selected value based on the provided option element.\nIt retrieves the 'label' attribute of the option, if present,\notherwise it falls back to the option's text content."
29690
+ "description": "Sets the selected option in the component state and updates the input element's value.\nThis method ensures that only the selected option is marked as selected in the DOM,\nand updates the tabindex for all options accordingly.\nIt also updates the validity of the input element based on the selected option.\nThis method is called when an option is selected."
29688
29691
  },
29689
29692
  {
29690
29693
  "kind": "method",
29691
- "name": "dispatchChange",
29694
+ "name": "updateTabIndexForAllOptions",
29692
29695
  "privacy": "private",
29693
29696
  "return": {
29694
29697
  "type": {
@@ -29697,16 +29700,19 @@
29697
29700
  },
29698
29701
  "parameters": [
29699
29702
  {
29700
- "name": "value",
29703
+ "name": "option",
29704
+ "optional": true,
29701
29705
  "type": {
29702
- "text": "string"
29703
- }
29706
+ "text": "Option | null"
29707
+ },
29708
+ "description": "The option which tabIndex should be set to 0."
29704
29709
  }
29705
- ]
29710
+ ],
29711
+ "description": "Updates the tabindex of all options.\nSets the tabindex of the selected option to '0' and others to '-1'."
29706
29712
  },
29707
29713
  {
29708
29714
  "kind": "method",
29709
- "name": "dispatchInput",
29715
+ "name": "updateSelectedInChildOptions",
29710
29716
  "privacy": "private",
29711
29717
  "return": {
29712
29718
  "type": {
@@ -29715,36 +29721,29 @@
29715
29721
  },
29716
29722
  "parameters": [
29717
29723
  {
29718
- "name": "value",
29724
+ "name": "selectedOption",
29719
29725
  "type": {
29720
- "text": "string"
29721
- }
29726
+ "text": "Option | null"
29727
+ },
29728
+ "description": "The option which gets selected"
29722
29729
  }
29723
- ]
29730
+ ],
29731
+ "description": "Sets selected attribute on the selected option and removes it from all options"
29724
29732
  },
29725
29733
  {
29726
29734
  "kind": "method",
29727
- "name": "handlePopoverOnOpen",
29735
+ "name": "fireEvents",
29728
29736
  "privacy": "private",
29729
29737
  "return": {
29730
29738
  "type": {
29731
29739
  "text": "void"
29732
29740
  }
29733
29741
  },
29734
- "parameters": [
29735
- {
29736
- "name": "event",
29737
- "type": {
29738
- "text": "KeyboardEvent"
29739
- },
29740
- "description": "The keyboard event."
29741
- }
29742
- ],
29743
- "description": "Handles the keydown event on the select element when the popover is open.\nThe options are as follows:\n- SPACE or ENTER: Selects the currently active option and closes the popover.\n- HOME: Sets focus and tabindex on the first option.\n- END: Sets focus and tabindex on the last option.\n- ARROW_DOWN, ARROW_UP, PAGE_DOWN, PAGE_UP: Handles navigation between options."
29742
+ "description": "A private method which is called to fire the change and input events.\nIt dispatches the input and change events with the selected option's value and label."
29744
29743
  },
29745
29744
  {
29746
29745
  "kind": "method",
29747
- "name": "handleClickCombobox",
29746
+ "name": "dispatchChange",
29748
29747
  "privacy": "private",
29749
29748
  "return": {
29750
29749
  "type": {
@@ -29753,16 +29752,16 @@
29753
29752
  },
29754
29753
  "parameters": [
29755
29754
  {
29756
- "name": "event",
29755
+ "name": "option",
29757
29756
  "type": {
29758
- "text": "MouseEvent"
29757
+ "text": "Option"
29759
29758
  }
29760
29759
  }
29761
29760
  ]
29762
29761
  },
29763
29762
  {
29764
29763
  "kind": "method",
29765
- "name": "handleKeydownCombobox",
29764
+ "name": "dispatchInput",
29766
29765
  "privacy": "private",
29767
29766
  "return": {
29768
29767
  "type": {
@@ -29771,18 +29770,16 @@
29771
29770
  },
29772
29771
  "parameters": [
29773
29772
  {
29774
- "name": "event",
29773
+ "name": "option",
29775
29774
  "type": {
29776
- "text": "KeyboardEvent"
29777
- },
29778
- "description": "The keyboard event."
29775
+ "text": "Option"
29776
+ }
29779
29777
  }
29780
- ],
29781
- "description": "Handles the keydown event on the select element when the popover is closed.\nThe options are as follows:\n- ARROW_DOWN, ARROW_UP, SPACE: Opens the popover and prevents the default scrolling behavior.\n- ENTER: Opens the popover, prevents default scrolling, and submits the form if the popover is closed.\n- HOME: Opens the popover and sets focus and tabindex on the first option.\n- END: Opens the popover and sets focus and tabindex on the last option."
29778
+ ]
29782
29779
  },
29783
29780
  {
29784
29781
  "kind": "method",
29785
- "name": "handleOptionsNavigation",
29782
+ "name": "handleClickCombobox",
29786
29783
  "privacy": "private",
29787
29784
  "return": {
29788
29785
  "type": {
@@ -29793,50 +29790,36 @@
29793
29790
  {
29794
29791
  "name": "event",
29795
29792
  "type": {
29796
- "text": "KeyboardEvent"
29793
+ "text": "MouseEvent"
29797
29794
  },
29798
- "description": "The keyboard event that triggered the navigation."
29795
+ "description": "The mouse event which triggered this function."
29799
29796
  }
29800
29797
  ],
29801
- "description": "Handles the navigation of options when the user presses\nArrowUp, ArrowDown, PageUp, or PageDown keys."
29798
+ "description": "Handles the click event on the visual combobox.\nIf the select is disabled, soft-disabled or readonly, it does nothing.\nIf the popover is already open, it closes it.\nIf it is closed, it opens it."
29802
29799
  },
29803
29800
  {
29804
29801
  "kind": "method",
29805
- "name": "getNewIndexBasedOnKey",
29802
+ "name": "handleKeydownCombobox",
29806
29803
  "privacy": "private",
29807
29804
  "return": {
29808
29805
  "type": {
29809
- "text": ""
29806
+ "text": "void"
29810
29807
  }
29811
29808
  },
29812
29809
  "parameters": [
29813
29810
  {
29814
- "name": "key",
29815
- "type": {
29816
- "text": "string"
29817
- },
29818
- "description": "The navigation key that was pressed."
29819
- },
29820
- {
29821
- "name": "currentIndex",
29822
- "type": {
29823
- "text": "number"
29824
- },
29825
- "description": "The current index of the focused option."
29826
- },
29827
- {
29828
- "name": "optionsLength",
29811
+ "name": "event",
29829
29812
  "type": {
29830
- "text": "number"
29813
+ "text": "KeyboardEvent"
29831
29814
  },
29832
- "description": "The total number of options."
29815
+ "description": "The keyboard event."
29833
29816
  }
29834
29817
  ],
29835
- "description": "Calculates the new index based on the pressed navigation key.\nSupports ArrowUp, ArrowDown, PageUp, and PageDown keys for navigating options.\n- ArrowDown: Moves focus to the next option, if available.\n- ArrowUp: Moves focus to the previous option, if available.\n- PageDown: Moves focus 10 options down or to the last option.\n- PageUp: Moves focus 10 options up or to the first option."
29818
+ "description": "Handles the keydown event on the select element when the popover is closed.\nThe options are as follows:\n- ARROW_DOWN, ARROW_UP, SPACE: Opens the popover and prevents the default scrolling behavior.\n- ENTER: Opens the popover, prevents default scrolling, and submits the form if the popover is closed.\n- HOME: Opens the popover and sets focus and tabindex on the first option.\n- END: Opens the popover and sets focus and tabindex on the last option."
29836
29819
  },
29837
29820
  {
29838
29821
  "kind": "method",
29839
- "name": "setFocusAndTabIndex",
29822
+ "name": "handlePopoverKeydown",
29840
29823
  "privacy": "private",
29841
29824
  "return": {
29842
29825
  "type": {
@@ -29845,42 +29828,14 @@
29845
29828
  },
29846
29829
  "parameters": [
29847
29830
  {
29848
- "name": "newIndex",
29831
+ "name": "event",
29849
29832
  "type": {
29850
- "text": "number"
29851
- }
29852
- }
29853
- ]
29854
- },
29855
- {
29856
- "kind": "method",
29857
- "name": "openPopover",
29858
- "privacy": "private",
29859
- "return": {
29860
- "type": {
29861
- "text": "void"
29862
- }
29863
- }
29864
- },
29865
- {
29866
- "kind": "method",
29867
- "name": "closePopover",
29868
- "privacy": "private",
29869
- "return": {
29870
- "type": {
29871
- "text": "void"
29872
- }
29873
- }
29874
- },
29875
- {
29876
- "kind": "method",
29877
- "name": "handleOnChange",
29878
- "privacy": "private",
29879
- "return": {
29880
- "type": {
29881
- "text": "void"
29833
+ "text": "KeyboardEvent"
29834
+ },
29835
+ "description": "The keyboard event."
29882
29836
  }
29883
- }
29837
+ ],
29838
+ "description": "Handles the keydown event on the select element when the popover is open.\nThe options are as follows:\n- HOME: Sets focus and tabindex on the first option.\n- END: Sets focus and tabindex on the last option.\n- ARROW_DOWN, ARROW_UP, PAGE_DOWN, PAGE_UP: Handles navigation between options."
29884
29839
  },
29885
29840
  {
29886
29841
  "kind": "field",
@@ -30458,7 +30413,7 @@
30458
30413
  "module": "/src/components/formfieldwrapper/formfieldwrapper.component"
30459
30414
  },
30460
30415
  "tagName": "mdc-select",
30461
- "jsDoc": "/**\n * The mdc-select component is a dropdown selection control that allows users to pick an option from a predefined list.\n * It is designed to work with `mdc-option` for individual options and `mdc-optgroup` for grouping related options.\n * The component ensures accessibility and usability while handling various use cases,\n * including long text truncation with tooltip support.\n *\n * To set a default option, use the `selected` attribute on the `mdc-option` element.\n *\n * **Note:** Make sure to add `mdc-selectlistbox` as a child of `mdc-select` and wrap options/optgroup in it to ensure proper accessibility functionality. Read more about it in SelectListBox documentation.\n *\n * @dependency mdc-button\n * @dependency mdc-icon\n * @dependency mdc-popover\n * @dependency mdc-text\n * @dependency mdc-toggletip\n *\n * @tagname mdc-select\n *\n * @slot default - This is a default/unnamed slot for options and/or option group.\n *\n * @event click - (React: onClick) This event is dispatched when the select is clicked.\n * @event change - (React: onChange) This event is dispatched when the select is changed.\n * @event input - (React: onInput) This event is dispatched when the select is changed.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the select.\n * @event focus - (React: onFocus) This event is dispatched when the select receives focus.\n */",
30416
+ "jsDoc": "/**\n * The mdc-select component is a dropdown selection control that allows users to pick an option from a predefined list.\n * It is designed to work with `mdc-option` for individual options and `mdc-optgroup` for grouping related options.\n * The component ensures accessibility and usability while handling various use cases,\n * including long text truncation with tooltip support.\n *\n * Every mdc-option should have a `value` attribute set to ensure proper form submission.\n *\n * To set a default option, use the `selected` attribute on the `mdc-option` element.\n *\n * **Note:** Make sure to add `mdc-selectlistbox` as a child of `mdc-select` and wrap options/optgroup in it to ensure proper accessibility functionality. Read more about it in SelectListBox documentation.\n *\n * @dependency mdc-button\n * @dependency mdc-icon\n * @dependency mdc-popover\n * @dependency mdc-text\n * @dependency mdc-toggletip\n *\n * @tagname mdc-select\n *\n * @slot default - This is a default/unnamed slot for Selectlistbox including options and/or option group.\n *\n * @event click - (React: onClick) This event is dispatched when the select is clicked.\n * @event change - (React: onChange) This event is dispatched when the select is changed.\n * @event input - (React: onInput) This event is dispatched when the select is changed.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the select.\n * @event focus - (React: onFocus) This event is dispatched when the select receives focus.\n */",
30462
30417
  "customElement": true
30463
30418
  }
30464
30419
  ],