@momentum-design/components 0.96.0 → 0.96.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,1208 +8465,1189 @@
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": "FooterMixin",
8586
- "module": "utils/mixins/FooterMixin.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": "FooterMixin",
8801
- "module": "/src/utils/mixins/FooterMixin"
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/divider/divider.component.js",
8827
- "declarations": [
8828
- {
8829
- "kind": "class",
8830
- "description": "`mdc-divider` is a component that provides a line to separate and organize content.\nIt can also include a button or text positioned centrally, allowing users to interact with the layout.\n\n**Divider Orientation:**\n- **Horizontal**: A thin, horizontal line.\n- **Vertical**: A thin, vertical line.\n\n**Divider Variants:**\n- **solid**: Solid line.\n- **gradient**: Gradient Line.\n\n**Divider Types:**\n- The type of divider is inferred based on the kind of slot present.\n - **Primary**: A simple horizontal or vertical divider.\n - **Text**: A horizontal divider with a text label in the center.\n - **Grabber Button**: A horizontal or vertical divider with a styled button in the center.\n\n**Accessibility:**\n- When the slot is replaced by an `mdc-button`:\n - `aria-label` should be passed to the `mdc-button`.\n - `aria-expanded` should be passed to the `mdc-button`.\n\n**Notes:**\n- If the slot is replaced by an invalid tag name or contains multiple elements,\n the divider defaults to the **Primary** type.\n- To override the styles of the divider, use the provided CSS custom properties.",
8831
- "name": "Divider",
8832
- "cssProperties": [
8833
- {
8834
- "description": "background color of the divider",
8835
- "name": "--mdc-divider-background-color"
8836
- },
8837
- {
8838
- "description": "width of the divider",
8839
- "name": "--mdc-divider-width"
8840
- },
8841
- {
8842
- "description": "gradient of the horizontal divider",
8843
- "name": "--mdc-divider-horizontal-gradient"
8844
- },
8845
- {
8846
- "description": "gradient of the vertical divider",
8847
- "name": "--mdc-divider-vertical-gradient"
8848
- },
8849
- {
8850
- "description": "font size of label in the text divider",
8851
- "name": "--mdc-divider-text-size"
8852
- },
8853
- {
8854
- "description": "font color of label in the text divider",
8855
- "name": "--mdc-divider-text-color"
8856
- },
8857
- {
8858
- "description": "left and right margin of label in the text divider",
8859
- "name": "--mdc-divider-text-margin"
8860
- },
8861
- {
8862
- "description": "line height of label in the text divider",
8863
- "name": "--mdc-divider-text-line-height"
8864
- },
8865
- {
8866
- "description": "background color of the grabber button in rest state",
8867
- "name": "--mdc-divider-grabber-button-background-color-normal"
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,
8777
+ "inheritedFrom": {
8778
+ "name": "Popover",
8779
+ "module": "components/popover/popover.component.js"
8780
+ }
8868
8781
  },
8869
8782
  {
8870
- "description": "background color of the grabber button in hover state",
8871
- "name": "--mdc-divider-grabber-button-background-color-hover"
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,
8792
+ "inheritedFrom": {
8793
+ "name": "Popover",
8794
+ "module": "components/popover/popover.component.js"
8795
+ }
8872
8796
  },
8873
8797
  {
8874
- "description": "background color of the grabber button in pressed state",
8875
- "name": "--mdc-divider-grabber-button-background-color-pressed"
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,
8807
+ "inheritedFrom": {
8808
+ "name": "Popover",
8809
+ "module": "components/popover/popover.component.js"
8810
+ }
8876
8811
  },
8877
8812
  {
8878
- "description": "border color of the grabber button",
8879
- "name": "--mdc-divider-grabber-button-border-color"
8813
+ "kind": "field",
8814
+ "name": "ariaLabelledby",
8815
+ "type": {
8816
+ "text": "string | null"
8817
+ },
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",
8821
+ "reflects": true,
8822
+ "inheritedFrom": {
8823
+ "name": "Popover",
8824
+ "module": "components/popover/popover.component.js"
8825
+ }
8880
8826
  },
8881
- {
8882
- "description": "border radius of the grabber button",
8883
- "name": "--mdc-divider-grabber-button-border-radius"
8884
- }
8885
- ],
8886
- "members": [
8887
8827
  {
8888
8828
  "kind": "field",
8889
- "name": "orientation",
8829
+ "name": "ariaDescribedby",
8890
8830
  "type": {
8891
- "text": "DividerOrientation"
8831
+ "text": "string | null"
8892
8832
  },
8893
- "description": "Two orientations of divider\n- **horizontal**: A thin, horizontal line with 0.0625rem width.\n- **vertical**: A thin, vertical line with 0.0625rem width.\n\nNote: We do not support \"Vertical Text Divider\" as of now.",
8894
- "default": "horizontal",
8895
- "attribute": "orientation",
8896
- "reflects": true
8833
+ "default": "null",
8834
+ "description": "aria-describedby of the popover.",
8835
+ "attribute": "aria-describedby",
8836
+ "reflects": true,
8837
+ "inheritedFrom": {
8838
+ "name": "Popover",
8839
+ "module": "components/popover/popover.component.js"
8840
+ }
8897
8841
  },
8898
8842
  {
8899
8843
  "kind": "field",
8900
- "name": "variant",
8844
+ "name": "disableAriaHasPopup",
8901
8845
  "type": {
8902
- "text": "DividerVariant"
8846
+ "text": "boolean"
8903
8847
  },
8904
- "description": "Two variants of divider\n- **solid**: Solid line.\n- **gradient**: Gradient Line that fades on either sides of the divider.",
8905
- "default": "solid",
8906
- "attribute": "variant",
8907
- "reflects": true
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",
8851
+ "reflects": true,
8852
+ "inheritedFrom": {
8853
+ "name": "Popover",
8854
+ "module": "components/popover/popover.component.js"
8855
+ }
8908
8856
  },
8909
8857
  {
8910
8858
  "kind": "field",
8911
- "name": "arrowDirection",
8859
+ "name": "arrowElement",
8912
8860
  "type": {
8913
- "text": "Directions"
8861
+ "text": "HTMLElement | null"
8914
8862
  },
8915
- "description": "Direction of the arrow icon, if applicable.\n- **positive**\n- **negative**\n\nNote: Positive and Negative directions are defined based on Cartesian plane.",
8916
- "default": "'negative'",
8917
- "attribute": "arrow-direction",
8918
- "reflects": true
8863
+ "privacy": "public",
8864
+ "default": "null",
8865
+ "inheritedFrom": {
8866
+ "name": "Popover",
8867
+ "module": "components/popover/popover.component.js"
8868
+ }
8919
8869
  },
8920
8870
  {
8921
8871
  "kind": "field",
8922
- "name": "buttonPosition",
8872
+ "name": "triggerElement",
8923
8873
  "type": {
8924
- "text": "Directions"
8874
+ "text": "HTMLElement | null"
8925
8875
  },
8926
- "description": "Position of the button, if applicable.\n- **positive**\n- **negative**\n\nNote: Positive and Negative directions are defined based on Cartesian plane.",
8927
- "default": "'negative'",
8928
- "attribute": "button-position",
8929
- "reflects": true
8876
+ "privacy": "public",
8877
+ "default": "null",
8878
+ "inheritedFrom": {
8879
+ "name": "Popover",
8880
+ "module": "components/popover/popover.component.js"
8881
+ }
8930
8882
  },
8931
8883
  {
8932
8884
  "kind": "method",
8933
- "name": "setVariant",
8885
+ "name": "setupTriggerListener",
8886
+ "privacy": "private",
8887
+ "description": "Sets up the trigger event listeners based on the trigger type.",
8888
+ "inheritedFrom": {
8889
+ "name": "Popover",
8890
+ "module": "components/popover/popover.component.js"
8891
+ }
8892
+ },
8893
+ {
8894
+ "kind": "method",
8895
+ "name": "removeEventListeners",
8934
8896
  "privacy": "private",
8897
+ "description": "Removes the trigger event listeners.",
8898
+ "inheritedFrom": {
8899
+ "name": "Popover",
8900
+ "module": "components/popover/popover.component.js"
8901
+ }
8902
+ },
8903
+ {
8904
+ "kind": "field",
8905
+ "name": "onOutsidePopoverClick",
8906
+ "privacy": "protected",
8907
+ "description": "Handles the outside click event to close the popover.",
8935
8908
  "parameters": [
8936
8909
  {
8937
- "name": "variant",
8938
- "type": {
8939
- "text": "DividerVariant"
8940
- },
8941
- "description": "The variant to set."
8910
+ "description": "The mouse event.",
8911
+ "name": "event"
8942
8912
  }
8943
8913
  ],
8944
- "description": "Sets the variant attribute for the divider component.\nIf the provided variant is not included in the DIVIDER_VARIANT,\nit defaults to the value specified in DEFAULTS.VARIANT."
8914
+ "inheritedFrom": {
8915
+ "name": "Popover",
8916
+ "module": "components/popover/popover.component.js"
8917
+ }
8945
8918
  },
8946
8919
  {
8947
- "kind": "method",
8948
- "name": "setOrientation",
8920
+ "kind": "field",
8921
+ "name": "onEscapeKeydown",
8949
8922
  "privacy": "private",
8923
+ "description": "Handles the escape keydown event to close the popover.\n\nThis method is attached to the document.",
8950
8924
  "parameters": [
8951
8925
  {
8952
- "name": "orientation",
8953
- "type": {
8954
- "text": "DividerOrientation"
8955
- },
8956
- "description": "The orientation to set."
8926
+ "description": "The keyboard event.",
8927
+ "name": "event"
8957
8928
  }
8958
8929
  ],
8959
- "description": "Sets the orientation attribute for the divider component.\nIf the provided orientation is not included in the DIVIDER_ORIENTATION,\nit defaults to the value specified in DEFAULTS.ORIENTATION."
8930
+ "inheritedFrom": {
8931
+ "name": "Popover",
8932
+ "module": "components/popover/popover.component.js"
8933
+ }
8960
8934
  },
8961
8935
  {
8962
- "kind": "method",
8963
- "name": "ensureValidDirections",
8936
+ "kind": "field",
8937
+ "name": "onPopoverFocusOut",
8964
8938
  "privacy": "private",
8965
- "description": "Sets the buttonPosition and arrowDirection attribute for the divider component.\nIf the provided buttonPosition and arrowDirection are not included in the DIRECTIONS,\nit defaults to the value specified in DIRECTIONS based on the ORIENTATION.",
8939
+ "description": "Handles the popover focus out event.",
8966
8940
  "parameters": [
8967
8941
  {
8968
- "description": "The buttonPosition to set.",
8969
- "name": "buttonPosition"
8970
- },
8971
- {
8972
- "description": "The arrowDirection to set.",
8973
- "name": "arrowDirection"
8942
+ "description": "The focus event.",
8943
+ "name": "event"
8974
8944
  }
8975
- ]
8945
+ ],
8946
+ "inheritedFrom": {
8947
+ "name": "Popover",
8948
+ "module": "components/popover/popover.component.js"
8949
+ }
8976
8950
  },
8977
8951
  {
8978
8952
  "kind": "method",
8979
- "name": "setGrabberButton",
8980
- "privacy": "private",
8981
- "return": {
8982
- "type": {
8983
- "text": "void"
8953
+ "name": "isOpenUpdated",
8954
+ "privacy": "protected",
8955
+ "parameters": [
8956
+ {
8957
+ "name": "oldValue",
8958
+ "type": {
8959
+ "text": "boolean"
8960
+ },
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."
8984
8969
  }
8985
- },
8986
- "description": "Configures the grabber button within the divider.\n\n- Sets the `prefix-icon` attribute for the grabber button based\non the `arrow-direction` and `orientation` properties.\n\nThis method updates the DOM element dynamically if a grabber button is present."
8970
+ ],
8971
+ "description": "Handles the popover visibility change and position the popover.\nHandles the exit event to close the popover.",
8972
+ "inheritedFrom": {
8973
+ "name": "Popover",
8974
+ "module": "components/popover/popover.component.js"
8975
+ }
8987
8976
  },
8988
8977
  {
8989
- "kind": "method",
8990
- "name": "getArrowIcon",
8978
+ "kind": "field",
8979
+ "name": "handleMouseEnter",
8991
8980
  "privacy": "private",
8992
- "return": {
8993
- "type": {
8994
- "text": ""
8995
- }
8996
- },
8997
- "description": "Determines the arrow icon based on the consumer-defined `arrowDirection`."
8981
+ "description": "Handles mouse enter event on the trigger element.\nThis method sets the `isHovered` flag to true and shows the popover",
8982
+ "inheritedFrom": {
8983
+ "name": "Popover",
8984
+ "module": "components/popover/popover.component.js"
8985
+ }
8998
8986
  },
8999
8987
  {
9000
- "kind": "method",
9001
- "name": "inferDividerType",
8988
+ "kind": "field",
8989
+ "name": "handleMouseLeave",
9002
8990
  "privacy": "private",
9003
- "description": "Infers the type of divider based on the kind of slot present.",
9004
- "parameters": [
9005
- {
9006
- "description": "default slot of divider",
9007
- "name": "slot"
9008
- }
9009
- ]
9010
- }
9011
- ],
9012
- "attributes": [
9013
- {
9014
- "name": "orientation",
9015
- "type": {
9016
- "text": "DividerOrientation"
9017
- },
9018
- "description": "Two orientations of divider\n- **horizontal**: A thin, horizontal line with 0.0625rem width.\n- **vertical**: A thin, vertical line with 0.0625rem width.\n\nNote: We do not support \"Vertical Text Divider\" as of now.",
9019
- "default": "horizontal",
9020
- "fieldName": "orientation"
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.",
8992
+ "inheritedFrom": {
8993
+ "name": "Popover",
8994
+ "module": "components/popover/popover.component.js"
8995
+ }
9021
8996
  },
9022
8997
  {
9023
- "name": "variant",
9024
- "type": {
9025
- "text": "DividerVariant"
9026
- },
9027
- "description": "Two variants of divider\n- **solid**: Solid line.\n- **gradient**: Gradient Line that fades on either sides of the divider.",
9028
- "default": "solid",
9029
- "fieldName": "variant"
8998
+ "kind": "field",
8999
+ "name": "handleFocusOut",
9000
+ "privacy": "private",
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.",
9002
+ "inheritedFrom": {
9003
+ "name": "Popover",
9004
+ "module": "components/popover/popover.component.js"
9005
+ }
9030
9006
  },
9031
9007
  {
9032
- "name": "arrow-direction",
9033
- "type": {
9034
- "text": "Directions"
9035
- },
9036
- "description": "Direction of the arrow icon, if applicable.\n- **positive**\n- **negative**\n\nNote: Positive and Negative directions are defined based on Cartesian plane.",
9037
- "default": "'negative'",
9038
- "fieldName": "arrowDirection"
9008
+ "kind": "field",
9009
+ "name": "startCloseDelay",
9010
+ "privacy": "private",
9011
+ "description": "Starts the close delay timer.\nIf the popover is not interactive, it will close the popover after the delay.",
9012
+ "inheritedFrom": {
9013
+ "name": "Popover",
9014
+ "module": "components/popover/popover.component.js"
9015
+ }
9039
9016
  },
9040
9017
  {
9041
- "name": "button-position",
9042
- "type": {
9043
- "text": "Directions"
9044
- },
9045
- "description": "Position of the button, if applicable.\n- **positive**\n- **negative**\n\nNote: Positive and Negative directions are defined based on Cartesian plane.",
9046
- "default": "'negative'",
9047
- "fieldName": "buttonPosition"
9048
- }
9049
- ],
9050
- "superclass": {
9051
- "name": "Component",
9052
- "module": "/src/models"
9053
- },
9054
- "tagName": "mdc-divider",
9055
- "jsDoc": "/**\n * `mdc-divider` is a component that provides a line to separate and organize content.\n * It can also include a button or text positioned centrally, allowing users to interact with the layout.\n *\n * **Divider Orientation:**\n * - **Horizontal**: A thin, horizontal line.\n * - **Vertical**: A thin, vertical line.\n *\n * **Divider Variants:**\n * - **solid**: Solid line.\n * - **gradient**: Gradient Line.\n *\n * **Divider Types:**\n * - The type of divider is inferred based on the kind of slot present.\n * - **Primary**: A simple horizontal or vertical divider.\n * - **Text**: A horizontal divider with a text label in the center.\n * - **Grabber Button**: A horizontal or vertical divider with a styled button in the center.\n *\n * **Accessibility:**\n * - When the slot is replaced by an `mdc-button`:\n * - `aria-label` should be passed to the `mdc-button`.\n * - `aria-expanded` should be passed to the `mdc-button`.\n *\n * **Notes:**\n * - If the slot is replaced by an invalid tag name or contains multiple elements,\n * the divider defaults to the **Primary** type.\n * - To override the styles of the divider, use the provided CSS custom properties.\n *\n * @tagname mdc-divider\n *\n * @cssproperty --mdc-divider-background-color - background color of the divider\n * @cssproperty --mdc-divider-width - width of the divider\n * @cssproperty --mdc-divider-horizontal-gradient - gradient of the horizontal divider\n * @cssproperty --mdc-divider-vertical-gradient - gradient of the vertical divider\n * @cssproperty --mdc-divider-text-size - font size of label in the text divider\n * @cssproperty --mdc-divider-text-color - font color of label in the text divider\n * @cssproperty --mdc-divider-text-margin - left and right margin of label in the text divider\n * @cssproperty --mdc-divider-text-line-height - line height of label in the text divider\n * @cssproperty --mdc-divider-grabber-button-background-color-normal - background color of the grabber button\n * in rest state\n * @cssproperty --mdc-divider-grabber-button-background-color-hover - background color of the grabber button\n * in hover state\n * @cssproperty --mdc-divider-grabber-button-background-color-pressed - background color of the grabber button\n * in pressed state\n * @cssproperty --mdc-divider-grabber-button-border-color - border color of the grabber button\n * @cssproperty --mdc-divider-grabber-button-border-radius - border radius of the grabber button\n */",
9056
- "customElement": true
9057
- }
9058
- ],
9059
- "exports": [
9060
- {
9061
- "kind": "js",
9062
- "name": "default",
9063
- "declaration": {
9064
- "name": "Divider",
9065
- "module": "components/divider/divider.component.js"
9066
- }
9067
- }
9068
- ]
9069
- },
9070
- {
9071
- "kind": "javascript-module",
9072
- "path": "components/coachmark/coachmark.component.js",
9073
- "declarations": [
9074
- {
9075
- "kind": "class",
9076
- "description": "Coachmark component based on top of the popover component,\nwith the default value of certain properties changed.",
9077
- "name": "Coachmark",
9078
- "cssProperties": [
9079
- {
9080
- "description": "radius of the arrow border",
9081
- "name": "--mdc-popover-arrow-border-radius",
9018
+ "kind": "field",
9019
+ "name": "cancelCloseDelay",
9020
+ "privacy": "private",
9021
+ "description": "Cancels the close delay timer.",
9082
9022
  "inheritedFrom": {
9083
9023
  "name": "Popover",
9084
- "module": "src/components/popover/popover.component.ts"
9024
+ "module": "components/popover/popover.component.js"
9085
9025
  }
9086
9026
  },
9087
9027
  {
9088
- "description": "border of the arrow",
9089
- "name": "--mdc-popover-arrow-border",
9028
+ "kind": "field",
9029
+ "name": "showPopover",
9030
+ "privacy": "public",
9031
+ "description": "Shows the popover.",
9090
9032
  "inheritedFrom": {
9091
9033
  "name": "Popover",
9092
- "module": "src/components/popover/popover.component.ts"
9034
+ "module": "components/popover/popover.component.js"
9093
9035
  }
9094
9036
  },
9095
9037
  {
9096
- "description": "primary background color of the popover",
9097
- "name": "--mdc-popover-primary-background-color",
9038
+ "kind": "field",
9039
+ "name": "hidePopover",
9040
+ "privacy": "public",
9041
+ "description": "Hides the popover.",
9098
9042
  "inheritedFrom": {
9099
9043
  "name": "Popover",
9100
- "module": "src/components/popover/popover.component.ts"
9044
+ "module": "components/popover/popover.component.js"
9101
9045
  }
9102
9046
  },
9103
9047
  {
9104
- "description": "border color of the popover",
9105
- "name": "--mdc-popover-border-color",
9048
+ "kind": "field",
9049
+ "name": "togglePopoverVisible",
9050
+ "privacy": "public",
9051
+ "description": "Toggles the popover visibility.",
9106
9052
  "inheritedFrom": {
9107
9053
  "name": "Popover",
9108
- "module": "src/components/popover/popover.component.ts"
9054
+ "module": "components/popover/popover.component.js"
9109
9055
  }
9110
9056
  },
9111
9057
  {
9112
- "description": "inverted background color of the popover",
9113
- "name": "--mdc-popover-inverted-background-color",
9058
+ "kind": "method",
9059
+ "name": "positionPopover",
9060
+ "privacy": "private",
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.",
9114
9062
  "inheritedFrom": {
9115
9063
  "name": "Popover",
9116
- "module": "src/components/popover/popover.component.ts"
9064
+ "module": "components/popover/popover.component.js"
9117
9065
  }
9118
9066
  },
9119
9067
  {
9120
- "description": "inverted border color of the popover",
9121
- "name": "--mdc-popover-inverted-border-color",
9068
+ "kind": "method",
9069
+ "name": "findClosestPopover",
9070
+ "privacy": "protected",
9071
+ "return": {
9072
+ "type": {
9073
+ "text": "Popover | null"
9074
+ }
9075
+ },
9076
+ "parameters": [
9077
+ {
9078
+ "name": "element",
9079
+ "type": {
9080
+ "text": "Element"
9081
+ },
9082
+ "description": "The element to start searching from."
9083
+ }
9084
+ ],
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.",
9122
9086
  "inheritedFrom": {
9123
9087
  "name": "Popover",
9124
- "module": "src/components/popover/popover.component.ts"
9088
+ "module": "components/popover/popover.component.js"
9125
9089
  }
9126
9090
  },
9127
9091
  {
9128
- "description": "inverted text color of the popover",
9129
- "name": "--mdc-popover-inverted-text-color",
9092
+ "kind": "field",
9093
+ "name": "utils",
9094
+ "default": "new PopoverUtils(this)",
9130
9095
  "inheritedFrom": {
9131
9096
  "name": "Popover",
9132
- "module": "src/components/popover/popover.component.ts"
9097
+ "module": "components/popover/popover.component.js"
9133
9098
  }
9134
- },
9099
+ }
9100
+ ],
9101
+ "events": [
9135
9102
  {
9136
- "description": "elevation of the popover",
9137
- "name": "--mdc-popover-elevation-3",
9103
+ "description": "(React: onShown) This event is dispatched when the coachmark is shown",
9104
+ "name": "shown",
9105
+ "reactName": "onShown",
9138
9106
  "inheritedFrom": {
9139
9107
  "name": "Popover",
9140
9108
  "module": "src/components/popover/popover.component.ts"
9141
9109
  }
9142
9110
  },
9143
9111
  {
9144
- "description": "max width of the popover",
9145
- "name": "--mdc-popover-max-width",
9112
+ "description": "(React: onHidden) This event is dispatched when the coachmark is hidden",
9113
+ "name": "hidden",
9114
+ "reactName": "onHidden",
9146
9115
  "inheritedFrom": {
9147
9116
  "name": "Popover",
9148
9117
  "module": "src/components/popover/popover.component.ts"
9149
9118
  }
9150
9119
  },
9151
9120
  {
9152
- "description": "max height of the popover",
9153
- "name": "--mdc-popover-max-height",
9121
+ "description": "(React: onCreated) This event is dispatched when the coachmark is created (added to the DOM)",
9122
+ "name": "created",
9123
+ "reactName": "onCreated",
9154
9124
  "inheritedFrom": {
9155
9125
  "name": "Popover",
9156
9126
  "module": "src/components/popover/popover.component.ts"
9157
9127
  }
9158
- }
9159
- ],
9160
- "slots": [
9128
+ },
9161
9129
  {
9162
- "description": "Default slot for modal container",
9163
- "name": "",
9130
+ "description": "(React: onDestroyed) This event is dispatched when the coachmark is destroyed (removed from the DOM)",
9131
+ "name": "destroyed",
9132
+ "reactName": "onDestroyed",
9164
9133
  "inheritedFrom": {
9165
9134
  "name": "Popover",
9166
9135
  "module": "src/components/popover/popover.component.ts"
9167
9136
  }
9168
9137
  }
9169
9138
  ],
9170
- "members": [
9139
+ "attributes": [
9171
9140
  {
9172
- "kind": "field",
9173
9141
  "name": "trigger",
9174
9142
  "type": {
9175
9143
  "text": "PopoverTrigger"
9176
9144
  },
9177
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**",
9178
9146
  "default": "manual",
9179
- "attribute": "trigger",
9180
- "reflects": true,
9147
+ "fieldName": "trigger",
9181
9148
  "inheritedFrom": {
9182
9149
  "name": "Popover",
9183
- "module": "components/popover/popover.component.js"
9150
+ "module": "src/components/popover/popover.component.ts"
9184
9151
  }
9185
9152
  },
9186
9153
  {
9187
- "kind": "field",
9188
- "name": "showArrow",
9154
+ "name": "show-arrow",
9189
9155
  "type": {
9190
9156
  "text": "boolean"
9191
9157
  },
9192
9158
  "description": "The arrow visibility of the Coachmark.",
9193
9159
  "default": "true",
9194
- "attribute": "show-arrow",
9195
- "reflects": true,
9160
+ "fieldName": "showArrow",
9196
9161
  "inheritedFrom": {
9197
9162
  "name": "Popover",
9198
- "module": "components/popover/popover.component.js"
9163
+ "module": "src/components/popover/popover.component.ts"
9199
9164
  }
9200
9165
  },
9201
9166
  {
9202
- "kind": "field",
9203
- "name": "closeButton",
9167
+ "name": "close-button",
9204
9168
  "type": {
9205
9169
  "text": "boolean"
9206
9170
  },
9207
9171
  "description": "The close button visibility of the Coachmark.",
9208
9172
  "default": "true",
9209
- "attribute": "close-button",
9210
- "reflects": true,
9173
+ "fieldName": "closeButton",
9211
9174
  "inheritedFrom": {
9212
9175
  "name": "Popover",
9213
- "module": "components/popover/popover.component.js"
9176
+ "module": "src/components/popover/popover.component.ts"
9214
9177
  }
9215
9178
  },
9216
9179
  {
9217
- "kind": "field",
9218
- "name": "disableAriaExpanded",
9180
+ "name": "disable-aria-expanded",
9219
9181
  "type": {
9220
9182
  "text": "boolean"
9221
9183
  },
9222
9184
  "description": "Disable aria-expanded attribute on trigger element.",
9223
9185
  "default": "true",
9224
- "attribute": "disable-aria-expanded",
9225
- "reflects": true,
9186
+ "fieldName": "disableAriaExpanded",
9226
9187
  "inheritedFrom": {
9227
9188
  "name": "Popover",
9228
- "module": "components/popover/popover.component.js"
9189
+ "module": "src/components/popover/popover.component.ts"
9229
9190
  }
9230
9191
  },
9231
9192
  {
9232
- "kind": "field",
9233
- "name": "preventScroll",
9193
+ "name": "should-focus-trap-wrap",
9234
9194
  "type": {
9235
9195
  "text": "boolean"
9236
9196
  },
9237
- "description": "Prevent outside scrolling when element is shown.\n\nIMPLEMENT THIS IN YOUR COMPONENT.",
9238
- "default": "false",
9239
- "attribute": "prevent-scroll",
9240
- "reflects": true,
9241
- "privacy": "protected",
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",
9200
+ "inheritedFrom": {
9201
+ "name": "FocusTrapMixin",
9202
+ "module": "src/utils/mixins/FocusTrapMixin.ts"
9203
+ }
9204
+ },
9205
+ {
9206
+ "name": "id",
9207
+ "type": {
9208
+ "text": "string"
9209
+ },
9210
+ "default": "''",
9211
+ "description": "The unique ID of the popover.",
9212
+ "fieldName": "id",
9242
9213
  "inheritedFrom": {
9243
9214
  "name": "Popover",
9244
- "module": "components/popover/popover.component.js"
9215
+ "module": "src/components/popover/popover.component.ts"
9245
9216
  }
9246
9217
  },
9247
9218
  {
9248
- "kind": "method",
9249
- "name": "activatePreventScroll",
9250
- "privacy": "protected",
9219
+ "name": "triggerID",
9220
+ "type": {
9221
+ "text": "string"
9222
+ },
9223
+ "default": "''",
9224
+ "description": "The ID of the element that triggers the popover.\nThis attribute is required for the popover to work.",
9225
+ "fieldName": "triggerID",
9251
9226
  "inheritedFrom": {
9252
- "name": "PreventScrollMixin",
9253
- "module": "utils/mixins/PreventScrollMixin.js"
9227
+ "name": "Popover",
9228
+ "module": "src/components/popover/popover.component.ts"
9254
9229
  }
9255
9230
  },
9256
9231
  {
9257
- "kind": "method",
9258
- "name": "deactivatePreventScroll",
9259
- "privacy": "protected",
9232
+ "name": "placement",
9233
+ "type": {
9234
+ "text": "PopoverPlacement"
9235
+ },
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**",
9237
+ "default": "bottom",
9238
+ "fieldName": "placement",
9260
9239
  "inheritedFrom": {
9261
- "name": "PreventScrollMixin",
9262
- "module": "utils/mixins/PreventScrollMixin.js"
9240
+ "name": "Popover",
9241
+ "module": "src/components/popover/popover.component.ts"
9263
9242
  }
9264
9243
  },
9265
9244
  {
9266
- "kind": "field",
9267
- "name": "focusTrap",
9245
+ "name": "color",
9246
+ "type": {
9247
+ "text": "PopoverColor"
9248
+ },
9249
+ "description": "Color of the popover\n- **tonal**\n- **contrast**",
9250
+ "default": "tonal",
9251
+ "fieldName": "color",
9252
+ "inheritedFrom": {
9253
+ "name": "Popover",
9254
+ "module": "src/components/popover/popover.component.ts"
9255
+ }
9256
+ },
9257
+ {
9258
+ "name": "visible",
9268
9259
  "type": {
9269
9260
  "text": "boolean"
9270
9261
  },
9271
- "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.",
9262
+ "description": "The visibility of the popover.",
9272
9263
  "default": "false",
9273
- "attribute": "focus-trap",
9274
- "reflects": true,
9275
- "privacy": "protected",
9264
+ "fieldName": "visible",
9276
9265
  "inheritedFrom": {
9277
9266
  "name": "Popover",
9278
- "module": "components/popover/popover.component.js"
9267
+ "module": "src/components/popover/popover.component.ts"
9279
9268
  }
9280
9269
  },
9281
9270
  {
9282
- "kind": "field",
9283
- "name": "shouldFocusTrapWrap",
9271
+ "name": "offset",
9284
9272
  "type": {
9285
- "text": "boolean"
9273
+ "text": "number"
9286
9274
  },
9287
- "default": "true",
9288
- "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.",
9289
- "attribute": "should-focus-trap-wrap",
9290
- "reflects": true,
9275
+ "description": "The offset of the popover.",
9276
+ "default": "4",
9277
+ "fieldName": "offset",
9291
9278
  "inheritedFrom": {
9292
- "name": "FocusTrapMixin",
9293
- "module": "utils/mixins/FocusTrapMixin.js"
9279
+ "name": "Popover",
9280
+ "module": "src/components/popover/popover.component.ts"
9294
9281
  }
9295
9282
  },
9296
9283
  {
9297
- "kind": "method",
9298
- "name": "setIsFocusTrapActivated",
9299
- "privacy": "private",
9300
- "parameters": [
9301
- {
9302
- "name": "isActivated",
9303
- "type": {
9304
- "text": "boolean"
9305
- }
9306
- }
9307
- ],
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",
9308
9291
  "inheritedFrom": {
9309
- "name": "FocusTrapMixin",
9310
- "module": "utils/mixins/FocusTrapMixin.js"
9292
+ "name": "Popover",
9293
+ "module": "src/components/popover/popover.component.ts"
9311
9294
  }
9312
9295
  },
9313
9296
  {
9314
- "kind": "method",
9315
- "name": "activateFocusTrap",
9316
- "privacy": "public",
9317
- "description": "Activate the focus trap",
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",
9318
9304
  "inheritedFrom": {
9319
- "name": "FocusTrapMixin",
9320
- "module": "utils/mixins/FocusTrapMixin.js"
9305
+ "name": "Popover",
9306
+ "module": "src/components/popover/popover.component.ts"
9321
9307
  }
9322
9308
  },
9323
9309
  {
9324
- "kind": "method",
9325
- "name": "deactivateFocusTrap",
9326
- "privacy": "public",
9327
- "description": "Deactivate the focus trap.",
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",
9328
9317
  "inheritedFrom": {
9329
- "name": "FocusTrapMixin",
9330
- "module": "utils/mixins/FocusTrapMixin.js"
9318
+ "name": "Popover",
9319
+ "module": "src/components/popover/popover.component.ts"
9331
9320
  }
9332
9321
  },
9333
9322
  {
9334
- "kind": "method",
9335
- "name": "hasNoClientRects",
9336
- "privacy": "private",
9337
- "parameters": [
9338
- {
9339
- "name": "element",
9340
- "type": {
9341
- "text": "HTMLElement"
9342
- },
9343
- "description": "The element to check."
9344
- }
9345
- ],
9346
- "description": "Checks if the element has no client rectangles (not visible in the viewport).",
9347
- "return": {
9348
- "type": {
9349
- "text": ""
9350
- }
9323
+ "name": "focus-trap",
9324
+ "type": {
9325
+ "text": "boolean"
9351
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",
9352
9330
  "inheritedFrom": {
9353
- "name": "FocusTrapMixin",
9354
- "module": "utils/mixins/FocusTrapMixin.js"
9331
+ "name": "Popover",
9332
+ "module": "src/components/popover/popover.component.ts"
9355
9333
  }
9356
9334
  },
9357
9335
  {
9358
- "kind": "method",
9359
- "name": "hasZeroDimensions",
9360
- "privacy": "private",
9361
- "parameters": [
9362
- {
9363
- "name": "element",
9364
- "type": {
9365
- "text": "HTMLElement"
9366
- },
9367
- "description": "The element to check."
9368
- }
9369
- ],
9370
- "description": "Checks if the element has zero dimensions (width and height are both 0).",
9371
- "return": {
9372
- "type": {
9373
- "text": ""
9374
- }
9336
+ "name": "prevent-scroll",
9337
+ "type": {
9338
+ "text": "boolean"
9375
9339
  },
9340
+ "description": "Prevent outside scrolling when popover is shown.",
9341
+ "default": "false",
9342
+ "fieldName": "preventScroll",
9376
9343
  "inheritedFrom": {
9377
- "name": "FocusTrapMixin",
9378
- "module": "utils/mixins/FocusTrapMixin.js"
9344
+ "name": "Popover",
9345
+ "module": "src/components/popover/popover.component.ts"
9379
9346
  }
9380
9347
  },
9381
9348
  {
9382
- "kind": "method",
9383
- "name": "isNotVisible",
9384
- "privacy": "private",
9385
- "parameters": [
9386
- {
9387
- "name": "element",
9388
- "type": {
9389
- "text": "HTMLElement"
9390
- },
9391
- "description": "The element to check."
9392
- }
9393
- ],
9394
- "description": "Determines if the element is not visible in the DOM.",
9395
- "return": {
9396
- "type": {
9397
- "text": ""
9398
- }
9349
+ "name": "interactive",
9350
+ "type": {
9351
+ "text": "boolean"
9399
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",
9400
9356
  "inheritedFrom": {
9401
- "name": "FocusTrapMixin",
9402
- "module": "utils/mixins/FocusTrapMixin.js"
9357
+ "name": "Popover",
9358
+ "module": "src/components/popover/popover.component.ts"
9403
9359
  }
9404
9360
  },
9405
9361
  {
9406
- "kind": "method",
9407
- "name": "hasHiddenStyle",
9408
- "privacy": "private",
9409
- "parameters": [
9410
- {
9411
- "name": "element",
9412
- "type": {
9413
- "text": "HTMLElement"
9414
- },
9415
- "description": "The element to check."
9416
- }
9417
- ],
9418
- "description": "Checks if the element has inline styles that make it hidden.",
9419
- "return": {
9420
- "type": {
9421
- "text": ""
9422
- }
9362
+ "name": "delay",
9363
+ "type": {
9364
+ "text": "string"
9423
9365
  },
9366
+ "description": "The delay of the show/hide popover.",
9367
+ "default": "0,0",
9368
+ "fieldName": "delay",
9424
9369
  "inheritedFrom": {
9425
- "name": "FocusTrapMixin",
9426
- "module": "utils/mixins/FocusTrapMixin.js"
9370
+ "name": "Popover",
9371
+ "module": "src/components/popover/popover.component.ts"
9427
9372
  }
9428
9373
  },
9429
9374
  {
9430
- "kind": "method",
9431
- "name": "hasComputedHidden",
9432
- "privacy": "private",
9433
- "parameters": [
9434
- {
9435
- "name": "element",
9436
- "type": {
9437
- "text": "HTMLElement"
9438
- },
9439
- "description": "The element to check."
9440
- }
9441
- ],
9442
- "description": "Checks if the element is hidden by a computed style.",
9443
- "return": {
9444
- "type": {
9445
- "text": ""
9446
- }
9375
+ "name": "hide-on-escape",
9376
+ "type": {
9377
+ "text": "boolean"
9447
9378
  },
9379
+ "description": "Hide popover on escape key press.",
9380
+ "default": "false",
9381
+ "fieldName": "hideOnEscape",
9448
9382
  "inheritedFrom": {
9449
- "name": "FocusTrapMixin",
9450
- "module": "utils/mixins/FocusTrapMixin.js"
9383
+ "name": "Popover",
9384
+ "module": "src/components/popover/popover.component.ts"
9451
9385
  }
9452
9386
  },
9453
9387
  {
9454
- "kind": "method",
9455
- "name": "isHidden",
9456
- "privacy": "private",
9457
- "parameters": [
9458
- {
9459
- "name": "element",
9460
- "type": {
9461
- "text": "HTMLElement"
9462
- },
9463
- "description": "The element to check."
9464
- }
9465
- ],
9466
- "description": "Checks if the element is hidden from the user.",
9467
- "return": {
9468
- "type": {
9469
- "text": ""
9470
- }
9388
+ "name": "propagate-event-on-escape",
9389
+ "type": {
9390
+ "text": "boolean"
9471
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",
9472
9395
  "inheritedFrom": {
9473
- "name": "FocusTrapMixin",
9474
- "module": "utils/mixins/FocusTrapMixin.js"
9396
+ "name": "Popover",
9397
+ "module": "src/components/popover/popover.component.ts"
9475
9398
  }
9476
9399
  },
9477
9400
  {
9478
- "kind": "method",
9479
- "name": "isDisabled",
9480
- "privacy": "private",
9481
- "parameters": [
9482
- {
9483
- "name": "element",
9484
- "type": {
9485
- "text": "any"
9486
- },
9487
- "description": "The element to check."
9488
- }
9489
- ],
9490
- "description": "Checks if the element is disabled.",
9491
- "return": {
9492
- "type": {
9493
- "text": ""
9494
- }
9401
+ "name": "hide-on-blur",
9402
+ "type": {
9403
+ "text": "boolean"
9495
9404
  },
9405
+ "description": "Hide popover on blur.",
9406
+ "default": "false",
9407
+ "fieldName": "hideOnBlur",
9496
9408
  "inheritedFrom": {
9497
- "name": "FocusTrapMixin",
9498
- "module": "utils/mixins/FocusTrapMixin.js"
9409
+ "name": "Popover",
9410
+ "module": "src/components/popover/popover.component.ts"
9499
9411
  }
9500
9412
  },
9501
9413
  {
9502
- "kind": "method",
9503
- "name": "isNotTabbable",
9504
- "privacy": "private",
9505
- "parameters": [
9506
- {
9507
- "name": "element",
9508
- "type": {
9509
- "text": "HTMLElement"
9510
- },
9511
- "description": "The element to check."
9512
- }
9513
- ],
9514
- "description": "Checks if the element is not tabbable.",
9515
- "return": {
9516
- "type": {
9517
- "text": ""
9518
- }
9414
+ "name": "hide-on-outside-click",
9415
+ "type": {
9416
+ "text": "boolean"
9519
9417
  },
9418
+ "description": "Hide on outside click of the popover.",
9419
+ "default": "false",
9420
+ "fieldName": "hideOnOutsideClick",
9520
9421
  "inheritedFrom": {
9521
- "name": "FocusTrapMixin",
9522
- "module": "utils/mixins/FocusTrapMixin.js"
9422
+ "name": "Popover",
9423
+ "module": "src/components/popover/popover.component.ts"
9523
9424
  }
9524
9425
  },
9525
9426
  {
9526
- "kind": "method",
9527
- "name": "isInteractiveElement",
9528
- "privacy": "private",
9529
- "return": {
9530
- "type": {
9531
- "text": ""
9532
- }
9427
+ "name": "focus-back-to-trigger",
9428
+ "type": {
9429
+ "text": "boolean"
9533
9430
  },
9534
- "parameters": [
9535
- {
9536
- "name": "element",
9537
- "type": {
9538
- "text": "HTMLElement"
9539
- },
9540
- "description": "The element to check."
9541
- }
9542
- ],
9543
- "description": "Checks if the element is interactive.",
9431
+ "description": "The focus back to trigger after the popover hide.",
9432
+ "default": "false",
9433
+ "fieldName": "focusBackToTrigger",
9544
9434
  "inheritedFrom": {
9545
- "name": "FocusTrapMixin",
9546
- "module": "utils/mixins/FocusTrapMixin.js"
9435
+ "name": "Popover",
9436
+ "module": "src/components/popover/popover.component.ts"
9547
9437
  }
9548
9438
  },
9549
9439
  {
9550
- "kind": "method",
9551
- "name": "isFocusable",
9552
- "privacy": "private",
9553
- "parameters": [
9554
- {
9555
- "name": "element",
9556
- "type": {
9557
- "text": "HTMLElement"
9558
- },
9559
- "description": "The element to check."
9560
- }
9561
- ],
9562
- "description": "Checks if the element is focusable.",
9563
- "return": {
9564
- "type": {
9565
- "text": ""
9566
- }
9440
+ "name": "backdrop",
9441
+ "type": {
9442
+ "text": "boolean"
9567
9443
  },
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",
9568
9447
  "inheritedFrom": {
9569
- "name": "FocusTrapMixin",
9570
- "module": "utils/mixins/FocusTrapMixin.js"
9448
+ "name": "Popover",
9449
+ "module": "src/components/popover/popover.component.ts"
9571
9450
  }
9572
9451
  },
9573
9452
  {
9574
- "kind": "method",
9575
- "name": "findFocusable",
9576
- "privacy": "private",
9577
- "return": {
9578
- "type": {
9579
- "text": ""
9580
- }
9453
+ "name": "flip",
9454
+ "type": {
9455
+ "text": "boolean"
9581
9456
  },
9582
- "parameters": [
9583
- {
9584
- "name": "root",
9585
- "type": {
9586
- "text": "ShadowRoot | HTMLElement"
9587
- },
9588
- "description": "The root element to search for focusable elements."
9589
- },
9590
- {
9591
- "name": "matches",
9592
- "default": "new Set()",
9593
- "type": {
9594
- "text": "Set<HTMLElement>"
9595
- },
9596
- "description": "The set of focusable elements."
9597
- }
9598
- ],
9599
- "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.",
9457
+ "description": "Changes the placement of popover to keep it in view when scrolling.",
9458
+ "default": "true",
9459
+ "fieldName": "flip",
9600
9460
  "inheritedFrom": {
9601
- "name": "FocusTrapMixin",
9602
- "module": "utils/mixins/FocusTrapMixin.js"
9461
+ "name": "Popover",
9462
+ "module": "src/components/popover/popover.component.ts"
9603
9463
  }
9604
9464
  },
9605
9465
  {
9606
- "kind": "method",
9607
- "name": "setFocusableElements",
9608
- "privacy": "private",
9609
- "description": "Updates the list of focusable elements within the component's shadow root.",
9466
+ "name": "size",
9467
+ "type": {
9468
+ "text": "boolean"
9469
+ },
9470
+ "description": "Changes the size of popover to keep it in view when scrolling.",
9471
+ "default": "false",
9472
+ "fieldName": "size",
9610
9473
  "inheritedFrom": {
9611
- "name": "FocusTrapMixin",
9612
- "module": "utils/mixins/FocusTrapMixin.js"
9474
+ "name": "Popover",
9475
+ "module": "src/components/popover/popover.component.ts"
9613
9476
  }
9614
9477
  },
9615
9478
  {
9616
- "kind": "method",
9617
- "name": "setInitialFocus",
9618
- "privacy": "public",
9619
- "parameters": [
9620
- {
9621
- "name": "elementIndexToReceiveFocus",
9622
- "default": "0",
9623
- "type": {
9624
- "text": "number"
9625
- },
9626
- "description": "The index of the preferable element to focus."
9627
- }
9628
- ],
9629
- "description": "Sets the initial focus within the container.",
9479
+ "name": "z-index",
9480
+ "type": {
9481
+ "text": "number"
9482
+ },
9483
+ "description": "The z-index of the popover.",
9484
+ "default": "1000",
9485
+ "fieldName": "zIndex",
9630
9486
  "inheritedFrom": {
9631
- "name": "FocusTrapMixin",
9632
- "module": "utils/mixins/FocusTrapMixin.js"
9487
+ "name": "Popover",
9488
+ "module": "src/components/popover/popover.component.ts"
9633
9489
  }
9634
9490
  },
9635
9491
  {
9636
- "kind": "method",
9637
- "name": "calculateNextIndex",
9638
- "privacy": "private",
9639
- "parameters": [
9640
- {
9641
- "name": "currentIndex",
9642
- "type": {
9643
- "text": "number"
9644
- },
9645
- "description": "The current index."
9646
- },
9647
- {
9648
- "name": "step",
9649
- "type": {
9650
- "text": "number"
9651
- },
9652
- "description": "The step to calculate the next index."
9653
- }
9654
- ],
9655
- "description": "Calculates the next index for the focus trap.",
9656
- "return": {
9657
- "type": {
9658
- "text": ""
9659
- }
9492
+ "name": "append-to",
9493
+ "type": {
9494
+ "text": "string | undefined"
9660
9495
  },
9496
+ "description": "Element ID that the popover append to.",
9497
+ "default": "''",
9498
+ "fieldName": "appendTo",
9661
9499
  "inheritedFrom": {
9662
- "name": "FocusTrapMixin",
9663
- "module": "utils/mixins/FocusTrapMixin.js"
9500
+ "name": "Popover",
9501
+ "module": "src/components/popover/popover.component.ts"
9664
9502
  }
9665
9503
  },
9666
9504
  {
9667
- "kind": "method",
9668
- "name": "getDeepActiveElement",
9669
- "privacy": "private",
9670
- "description": "Returns the deepest active element in the shadow DOM.",
9671
- "return": {
9672
- "type": {
9673
- "text": ""
9674
- }
9505
+ "name": "close-button-aria-label",
9506
+ "type": {
9507
+ "text": "string | null"
9675
9508
  },
9509
+ "default": "null",
9510
+ "description": "aria-label attribute to be set for close button accessibility.",
9511
+ "fieldName": "closeButtonAriaLabel",
9676
9512
  "inheritedFrom": {
9677
- "name": "FocusTrapMixin",
9678
- "module": "utils/mixins/FocusTrapMixin.js"
9513
+ "name": "Popover",
9514
+ "module": "src/components/popover/popover.component.ts"
9679
9515
  }
9680
9516
  },
9681
9517
  {
9682
- "kind": "method",
9683
- "name": "findElement",
9684
- "privacy": "private",
9685
- "parameters": [
9686
- {
9687
- "name": "activeElement",
9688
- "type": {
9689
- "text": "HTMLElement"
9690
- },
9691
- "description": "The active element."
9692
- }
9693
- ],
9694
- "description": "Finds the index of the active element within the focusable elements.",
9695
- "return": {
9696
- "type": {
9697
- "text": ""
9698
- }
9518
+ "name": "role",
9519
+ "type": {
9520
+ "text": "HTMLElement['role']"
9699
9521
  },
9522
+ "description": "Role of the popover",
9523
+ "default": "dialog",
9524
+ "fieldName": "role",
9700
9525
  "inheritedFrom": {
9701
- "name": "FocusTrapMixin",
9702
- "module": "utils/mixins/FocusTrapMixin.js"
9526
+ "name": "Popover",
9527
+ "module": "src/components/popover/popover.component.ts"
9703
9528
  }
9704
9529
  },
9705
9530
  {
9706
- "kind": "method",
9707
- "name": "isEqualFocusNode",
9708
- "privacy": "private",
9709
- "parameters": [
9710
- {
9711
- "name": "activeElement",
9712
- "type": {
9713
- "text": "HTMLElement"
9714
- },
9715
- "description": "The active element."
9716
- },
9717
- {
9718
- "name": "element",
9719
- "type": {
9720
- "text": "HTMLElement"
9721
- },
9722
- "description": "The element to compare."
9723
- }
9724
- ],
9725
- "description": "Checks if the active element is equal to the given element.",
9726
- "return": {
9727
- "type": {
9728
- "text": ""
9729
- }
9531
+ "name": "aria-labelledby",
9532
+ "type": {
9533
+ "text": "string | null"
9730
9534
  },
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",
9731
9538
  "inheritedFrom": {
9732
- "name": "FocusTrapMixin",
9733
- "module": "utils/mixins/FocusTrapMixin.js"
9539
+ "name": "Popover",
9540
+ "module": "src/components/popover/popover.component.ts"
9734
9541
  }
9735
9542
  },
9736
9543
  {
9737
- "kind": "method",
9738
- "name": "trapFocus",
9739
- "privacy": "private",
9740
- "parameters": [
9741
- {
9742
- "name": "event",
9743
- "type": {
9744
- "text": "KeyboardEvent"
9745
- }
9746
- },
9747
- {
9748
- "description": "The direction of the focus trap.\nIf true, the focus will be trapped in the previous element.",
9749
- "name": "direction"
9750
- }
9751
- ],
9752
- "description": "Traps focus within the container.",
9544
+ "name": "aria-describedby",
9545
+ "type": {
9546
+ "text": "string | null"
9547
+ },
9548
+ "default": "null",
9549
+ "description": "aria-describedby of the popover.",
9550
+ "fieldName": "ariaDescribedby",
9753
9551
  "inheritedFrom": {
9754
- "name": "FocusTrapMixin",
9755
- "module": "utils/mixins/FocusTrapMixin.js"
9552
+ "name": "Popover",
9553
+ "module": "src/components/popover/popover.component.ts"
9756
9554
  }
9757
9555
  },
9758
9556
  {
9759
- "kind": "method",
9760
- "name": "handleTabKeydown",
9761
- "privacy": "private",
9762
- "parameters": [
9763
- {
9764
- "name": "event",
9765
- "type": {
9766
- "text": "KeyboardEvent"
9767
- },
9768
- "description": "The keyboard event."
9769
- }
9770
- ],
9771
- "description": "Traps focus within the container.",
9557
+ "name": "disable-aria-haspopup",
9558
+ "type": {
9559
+ "text": "boolean"
9560
+ },
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.",
9562
+ "default": "false",
9563
+ "fieldName": "disableAriaHasPopup",
9772
9564
  "inheritedFrom": {
9773
- "name": "FocusTrapMixin",
9774
- "module": "utils/mixins/FocusTrapMixin.js"
9565
+ "name": "Popover",
9566
+ "module": "src/components/popover/popover.component.ts"
9775
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"
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"
9776
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": [
9777
9651
  {
9778
9652
  "kind": "field",
9779
9653
  "name": "id",
@@ -9781,1108 +9655,1234 @@
9781
9655
  "text": "string"
9782
9656
  },
9783
9657
  "default": "''",
9784
- "description": "The unique ID of the popover.",
9658
+ "description": "The unique ID of the dialog",
9785
9659
  "attribute": "id",
9786
- "reflects": true,
9787
- "inheritedFrom": {
9788
- "name": "Popover",
9789
- "module": "components/popover/popover.component.js"
9790
- }
9660
+ "reflects": true
9661
+ },
9662
+ {
9663
+ "kind": "field",
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",
9676
+ "type": {
9677
+ "text": "boolean"
9678
+ },
9679
+ "description": "The visibility of the dialog\n\nDialog is a controlled component, visible is the only property that controls the visibility of the dialog.",
9680
+ "default": "false",
9681
+ "attribute": "visible",
9682
+ "reflects": true
9791
9683
  },
9792
9684
  {
9793
9685
  "kind": "field",
9794
- "name": "triggerID",
9686
+ "name": "zIndex",
9795
9687
  "type": {
9796
- "text": "string"
9688
+ "text": "number"
9797
9689
  },
9798
- "default": "''",
9799
- "description": "The ID of the element that triggers the popover.\nThis attribute is required for the popover to work.",
9800
- "attribute": "triggerID",
9801
- "reflects": true,
9802
- "inheritedFrom": {
9803
- "name": "Popover",
9804
- "module": "components/popover/popover.component.js"
9805
- }
9690
+ "description": "The z-index of the dialog\n\nThe backdrop will have z-index of `zIndex - 1`",
9691
+ "default": "1000",
9692
+ "attribute": "z-index",
9693
+ "reflects": true
9806
9694
  },
9807
9695
  {
9808
9696
  "kind": "field",
9809
- "name": "placement",
9697
+ "name": "size",
9810
9698
  "type": {
9811
- "text": "PopoverPlacement"
9699
+ "text": "DialogSize"
9812
9700
  },
9813
- "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**",
9814
- "default": "bottom",
9815
- "attribute": "placement",
9816
- "reflects": true,
9817
- "inheritedFrom": {
9818
- "name": "Popover",
9819
- "module": "components/popover/popover.component.js"
9820
- }
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
9821
9705
  },
9822
9706
  {
9823
9707
  "kind": "field",
9824
- "name": "color",
9708
+ "name": "variant",
9825
9709
  "type": {
9826
- "text": "PopoverColor"
9710
+ "text": "DialogVariant"
9827
9711
  },
9828
- "description": "Color of the popover\n- **tonal**\n- **contrast**",
9829
- "default": "tonal",
9830
- "attribute": "color",
9831
- "reflects": true,
9832
- "inheritedFrom": {
9833
- "name": "Popover",
9834
- "module": "components/popover/popover.component.js"
9835
- }
9712
+ "description": "The variant of the dialog, can be 'default' or 'promotional'",
9713
+ "default": "default",
9714
+ "attribute": "variant",
9715
+ "reflects": true
9836
9716
  },
9837
9717
  {
9838
9718
  "kind": "field",
9839
- "name": "visible",
9719
+ "name": "closeButtonAriaLabel",
9840
9720
  "type": {
9841
- "text": "boolean"
9721
+ "text": "string | null"
9842
9722
  },
9843
- "description": "The visibility of the popover.",
9844
- "default": "false",
9845
- "attribute": "visible",
9846
- "reflects": true,
9847
- "inheritedFrom": {
9848
- "name": "Popover",
9849
- "module": "components/popover/popover.component.js"
9850
- }
9723
+ "default": "null",
9724
+ "description": "Defines a string value for the aria-label attribute for close button accessibility",
9725
+ "attribute": "close-button-aria-label"
9851
9726
  },
9852
9727
  {
9853
9728
  "kind": "field",
9854
- "name": "offset",
9729
+ "name": "ariaLabel",
9855
9730
  "type": {
9856
- "text": "number"
9731
+ "text": "string | null"
9857
9732
  },
9858
- "description": "The offset of the popover.",
9859
- "default": "4",
9860
- "attribute": "offset",
9861
- "reflects": true,
9862
- "inheritedFrom": {
9863
- "name": "Popover",
9864
- "module": "components/popover/popover.component.js"
9865
- }
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
9866
9737
  },
9867
9738
  {
9868
9739
  "kind": "field",
9869
- "name": "boundary",
9740
+ "name": "ariaLabelledby",
9870
9741
  "type": {
9871
- "text": "'clippingAncestors' | string"
9742
+ "text": "string | null"
9872
9743
  },
9873
- "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",
9874
- "default": "'clippingAncestors'",
9875
- "attribute": "boundary",
9876
- "reflects": true,
9877
- "inheritedFrom": {
9878
- "name": "Popover",
9879
- "module": "components/popover/popover.component.js"
9880
- }
9744
+ "default": "null",
9745
+ "description": "Defines a string value for the aria-labelledby attribute that refers to the element\nlabeling the dialog for accessibility",
9746
+ "attribute": "aria-labelledby",
9747
+ "reflects": true
9881
9748
  },
9882
9749
  {
9883
9750
  "kind": "field",
9884
- "name": "boundaryRoot",
9751
+ "name": "ariaDescribedBy",
9885
9752
  "type": {
9886
- "text": "'viewport' | 'document'"
9753
+ "text": "string | null"
9887
9754
  },
9888
- "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.",
9889
- "default": "'viewport'",
9890
- "attribute": "boundary-root",
9891
- "reflects": true,
9892
- "inheritedFrom": {
9893
- "name": "Popover",
9894
- "module": "components/popover/popover.component.js"
9895
- }
9755
+ "default": "null",
9756
+ "description": "Defines a string value for the aria-describedby attribute that refers to the element\ndescribing the dialog for accessibility",
9757
+ "attribute": "aria-describedby",
9758
+ "reflects": true
9896
9759
  },
9897
9760
  {
9898
9761
  "kind": "field",
9899
- "name": "boundaryPadding",
9762
+ "name": "ariaDescription",
9900
9763
  "type": {
9901
- "text": "undefined | number"
9764
+ "text": "string | null"
9902
9765
  },
9903
- "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.",
9904
- "default": "undefined",
9905
- "attribute": "boundary-padding",
9906
- "reflects": true,
9907
- "inheritedFrom": {
9908
- "name": "Popover",
9909
- "module": "components/popover/popover.component.js"
9910
- }
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
9911
9770
  },
9912
9771
  {
9913
9772
  "kind": "field",
9914
- "name": "interactive",
9773
+ "name": "headerText",
9915
9774
  "type": {
9916
- "text": "boolean"
9775
+ "text": "string | undefined"
9917
9776
  },
9918
- "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!",
9919
- "default": "false",
9920
- "attribute": "interactive",
9921
- "reflects": true,
9922
- "inheritedFrom": {
9923
- "name": "Popover",
9924
- "module": "components/popover/popover.component.js"
9925
- }
9777
+ "description": "Defines a string value to display as the title of the dialog",
9778
+ "attribute": "header-text",
9779
+ "reflects": true
9926
9780
  },
9927
9781
  {
9928
9782
  "kind": "field",
9929
- "name": "delay",
9783
+ "name": "descriptionText",
9930
9784
  "type": {
9931
- "text": "string"
9785
+ "text": "string | undefined"
9932
9786
  },
9933
- "description": "The delay of the show/hide popover.",
9934
- "default": "0,0",
9935
- "attribute": "delay",
9936
- "reflects": true,
9937
- "inheritedFrom": {
9938
- "name": "Popover",
9939
- "module": "components/popover/popover.component.js"
9940
- }
9787
+ "description": "Defines a string value to display as the under-header description of the dialog",
9788
+ "attribute": "description-text",
9789
+ "reflects": true
9941
9790
  },
9942
9791
  {
9943
9792
  "kind": "field",
9944
- "name": "hideOnEscape",
9793
+ "name": "headerTagName",
9945
9794
  "type": {
9946
- "text": "boolean"
9795
+ "text": "string"
9947
9796
  },
9948
- "description": "Hide popover on escape key press.",
9949
- "default": "false",
9950
- "attribute": "hide-on-escape",
9951
- "reflects": true,
9952
- "inheritedFrom": {
9953
- "name": "Popover",
9954
- "module": "components/popover/popover.component.js"
9955
- }
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
9802
  "kind": "field",
9959
- "name": "propagateEventOnEscape",
9803
+ "name": "descriptionTagName",
9960
9804
  "type": {
9961
- "text": "boolean"
9805
+ "text": "string"
9962
9806
  },
9963
- "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.",
9964
- "default": "false",
9965
- "attribute": "propagate-event-on-escape",
9966
- "reflects": true,
9967
- "inheritedFrom": {
9968
- "name": "Popover",
9969
- "module": "components/popover/popover.component.js"
9970
- }
9807
+ "description": "The html tag to be used for the below-header description text",
9808
+ "attribute": "description-tag-name",
9809
+ "reflects": true
9971
9810
  },
9972
9811
  {
9973
9812
  "kind": "field",
9974
- "name": "hideOnBlur",
9813
+ "name": "role",
9975
9814
  "type": {
9976
- "text": "boolean"
9815
+ "text": "DialogRole"
9977
9816
  },
9978
- "description": "Hide popover on blur.",
9979
- "default": "false",
9980
- "attribute": "hide-on-blur",
9981
- "reflects": true,
9982
- "inheritedFrom": {
9983
- "name": "Popover",
9984
- "module": "components/popover/popover.component.js"
9985
- }
9817
+ "description": "Role of the dialog",
9818
+ "default": "dialog",
9819
+ "attribute": "role",
9820
+ "reflects": true
9986
9821
  },
9987
9822
  {
9988
9823
  "kind": "field",
9989
- "name": "hideOnOutsideClick",
9824
+ "name": "disableAriaHasPopup",
9990
9825
  "type": {
9991
9826
  "text": "boolean"
9992
9827
  },
9993
- "description": "Hide on outside click of the popover.",
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.",
9994
9829
  "default": "false",
9995
- "attribute": "hide-on-outside-click",
9996
- "reflects": true,
9997
- "inheritedFrom": {
9998
- "name": "Popover",
9999
- "module": "components/popover/popover.component.js"
10000
- }
9830
+ "attribute": "disable-aria-haspopup",
9831
+ "reflects": true
10001
9832
  },
10002
9833
  {
10003
9834
  "kind": "field",
10004
- "name": "focusBackToTrigger",
9835
+ "name": "focusTrap",
10005
9836
  "type": {
10006
9837
  "text": "boolean"
10007
9838
  },
10008
- "description": "The focus back to trigger after the popover hide.",
10009
- "default": "false",
10010
- "attribute": "focus-back-to-trigger",
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",
10011
9843
  "reflects": true,
10012
9844
  "inheritedFrom": {
10013
- "name": "Popover",
10014
- "module": "components/popover/popover.component.js"
9845
+ "name": "FocusTrapMixin",
9846
+ "module": "utils/mixins/FocusTrapMixin.js"
10015
9847
  }
10016
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
+ },
9855
+ {
9856
+ "kind": "method",
9857
+ "name": "isOpenUpdated",
9858
+ "privacy": "private",
9859
+ "parameters": [
9860
+ {
9861
+ "name": "oldValue",
9862
+ "type": {
9863
+ "text": "boolean | undefined"
9864
+ },
9865
+ "description": "The old value of the visible property."
9866
+ },
9867
+ {
9868
+ "name": "newValue",
9869
+ "type": {
9870
+ "text": "boolean"
9871
+ },
9872
+ "description": "The new value of the visible property."
9873
+ }
9874
+ ],
9875
+ "description": "Handles the dialog visibility change.\nHandles the exit event to close the dialog."
9876
+ },
10017
9877
  {
10018
9878
  "kind": "field",
10019
- "name": "backdrop",
9879
+ "name": "preventScroll",
10020
9880
  "type": {
10021
9881
  "text": "boolean"
10022
9882
  },
10023
- "description": "Determines whether the popover with backdrop.\nOther than popover and trigger element, the rest of the screen will be covered with a backdrop.",
10024
- "default": "false",
10025
- "attribute": "backdrop",
10026
- "reflects": true,
9883
+ "privacy": "protected",
9884
+ "description": "Prevent outside scrolling when element is shown.\n\nIMPLEMENT THIS IN YOUR COMPONENT.",
10027
9885
  "inheritedFrom": {
10028
- "name": "Popover",
10029
- "module": "components/popover/popover.component.js"
9886
+ "name": "PreventScrollMixin",
9887
+ "module": "utils/mixins/PreventScrollMixin.js"
10030
9888
  }
10031
9889
  },
10032
9890
  {
10033
- "kind": "field",
10034
- "name": "flip",
10035
- "type": {
10036
- "text": "boolean"
10037
- },
10038
- "description": "Changes the placement of popover to keep it in view when scrolling.",
10039
- "default": "true",
10040
- "attribute": "flip",
10041
- "reflects": true,
9891
+ "kind": "method",
9892
+ "name": "activatePreventScroll",
9893
+ "privacy": "protected",
10042
9894
  "inheritedFrom": {
10043
- "name": "Popover",
10044
- "module": "components/popover/popover.component.js"
9895
+ "name": "PreventScrollMixin",
9896
+ "module": "utils/mixins/PreventScrollMixin.js"
10045
9897
  }
10046
9898
  },
10047
9899
  {
10048
- "kind": "field",
10049
- "name": "size",
10050
- "type": {
10051
- "text": "boolean"
10052
- },
10053
- "description": "Changes the size of popover to keep it in view when scrolling.",
10054
- "default": "false",
10055
- "attribute": "size",
10056
- "reflects": true,
9900
+ "kind": "method",
9901
+ "name": "deactivatePreventScroll",
9902
+ "privacy": "protected",
10057
9903
  "inheritedFrom": {
10058
- "name": "Popover",
10059
- "module": "components/popover/popover.component.js"
9904
+ "name": "PreventScrollMixin",
9905
+ "module": "utils/mixins/PreventScrollMixin.js"
10060
9906
  }
10061
9907
  },
10062
9908
  {
10063
9909
  "kind": "field",
10064
- "name": "zIndex",
9910
+ "name": "shouldFocusTrapWrap",
10065
9911
  "type": {
10066
- "text": "number"
9912
+ "text": "boolean"
10067
9913
  },
10068
- "description": "The z-index of the popover.",
10069
- "default": "1000",
10070
- "attribute": "z-index",
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",
10071
9917
  "reflects": true,
10072
9918
  "inheritedFrom": {
10073
- "name": "Popover",
10074
- "module": "components/popover/popover.component.js"
9919
+ "name": "FocusTrapMixin",
9920
+ "module": "utils/mixins/FocusTrapMixin.js"
10075
9921
  }
10076
9922
  },
10077
9923
  {
10078
- "kind": "field",
10079
- "name": "appendTo",
10080
- "type": {
10081
- "text": "string | undefined"
10082
- },
10083
- "description": "Element ID that the popover append to.",
10084
- "default": "''",
10085
- "attribute": "append-to",
10086
- "reflects": true,
9924
+ "kind": "method",
9925
+ "name": "setIsFocusTrapActivated",
9926
+ "privacy": "private",
9927
+ "parameters": [
9928
+ {
9929
+ "name": "isActivated",
9930
+ "type": {
9931
+ "text": "boolean"
9932
+ }
9933
+ }
9934
+ ],
10087
9935
  "inheritedFrom": {
10088
- "name": "Popover",
10089
- "module": "components/popover/popover.component.js"
9936
+ "name": "FocusTrapMixin",
9937
+ "module": "utils/mixins/FocusTrapMixin.js"
10090
9938
  }
10091
9939
  },
10092
9940
  {
10093
- "kind": "field",
10094
- "name": "closeButtonAriaLabel",
10095
- "type": {
10096
- "text": "string | null"
10097
- },
10098
- "default": "null",
10099
- "description": "aria-label attribute to be set for close button accessibility.",
10100
- "attribute": "close-button-aria-label",
10101
- "reflects": true,
9941
+ "kind": "method",
9942
+ "name": "activateFocusTrap",
9943
+ "privacy": "public",
9944
+ "description": "Activate the focus trap",
10102
9945
  "inheritedFrom": {
10103
- "name": "Popover",
10104
- "module": "components/popover/popover.component.js"
9946
+ "name": "FocusTrapMixin",
9947
+ "module": "utils/mixins/FocusTrapMixin.js"
10105
9948
  }
10106
9949
  },
10107
9950
  {
10108
- "kind": "field",
10109
- "name": "role",
10110
- "type": {
10111
- "text": "HTMLElement['role']"
10112
- },
10113
- "description": "Role of the popover",
10114
- "default": "dialog",
10115
- "attribute": "role",
10116
- "reflects": true,
9951
+ "kind": "method",
9952
+ "name": "deactivateFocusTrap",
9953
+ "privacy": "public",
9954
+ "description": "Deactivate the focus trap.",
10117
9955
  "inheritedFrom": {
10118
- "name": "Popover",
10119
- "module": "components/popover/popover.component.js"
9956
+ "name": "FocusTrapMixin",
9957
+ "module": "utils/mixins/FocusTrapMixin.js"
10120
9958
  }
10121
9959
  },
10122
9960
  {
10123
- "kind": "field",
10124
- "name": "ariaLabelledby",
10125
- "type": {
10126
- "text": "string | null"
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
+ }
10127
9978
  },
10128
- "default": "null",
10129
- "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.",
10130
- "attribute": "aria-labelledby",
10131
- "reflects": true,
10132
9979
  "inheritedFrom": {
10133
- "name": "Popover",
10134
- "module": "components/popover/popover.component.js"
9980
+ "name": "FocusTrapMixin",
9981
+ "module": "utils/mixins/FocusTrapMixin.js"
10135
9982
  }
10136
9983
  },
10137
9984
  {
10138
- "kind": "field",
10139
- "name": "ariaDescribedby",
10140
- "type": {
10141
- "text": "string | null"
9985
+ "kind": "method",
9986
+ "name": "hasZeroDimensions",
9987
+ "privacy": "private",
9988
+ "parameters": [
9989
+ {
9990
+ "name": "element",
9991
+ "type": {
9992
+ "text": "HTMLElement"
9993
+ },
9994
+ "description": "The element to check."
9995
+ }
9996
+ ],
9997
+ "description": "Checks if the element has zero dimensions (width and height are both 0).",
9998
+ "return": {
9999
+ "type": {
10000
+ "text": ""
10001
+ }
10142
10002
  },
10143
- "default": "null",
10144
- "description": "aria-describedby of the popover.",
10145
- "attribute": "aria-describedby",
10146
- "reflects": true,
10147
10003
  "inheritedFrom": {
10148
- "name": "Popover",
10149
- "module": "components/popover/popover.component.js"
10004
+ "name": "FocusTrapMixin",
10005
+ "module": "utils/mixins/FocusTrapMixin.js"
10150
10006
  }
10151
10007
  },
10152
10008
  {
10153
- "kind": "field",
10154
- "name": "disableAriaHasPopup",
10155
- "type": {
10156
- "text": "boolean"
10009
+ "kind": "method",
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.",
10022
+ "return": {
10023
+ "type": {
10024
+ "text": ""
10025
+ }
10157
10026
  },
10158
- "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.",
10159
- "default": "false",
10160
- "attribute": "disable-aria-haspopup",
10161
- "reflects": true,
10162
10027
  "inheritedFrom": {
10163
- "name": "Popover",
10164
- "module": "components/popover/popover.component.js"
10028
+ "name": "FocusTrapMixin",
10029
+ "module": "utils/mixins/FocusTrapMixin.js"
10165
10030
  }
10166
10031
  },
10167
10032
  {
10168
- "kind": "field",
10169
- "name": "arrowElement",
10170
- "type": {
10171
- "text": "HTMLElement | null"
10033
+ "kind": "method",
10034
+ "name": "hasHiddenStyle",
10035
+ "privacy": "private",
10036
+ "parameters": [
10037
+ {
10038
+ "name": "element",
10039
+ "type": {
10040
+ "text": "HTMLElement"
10041
+ },
10042
+ "description": "The element to check."
10043
+ }
10044
+ ],
10045
+ "description": "Checks if the element has inline styles that make it hidden.",
10046
+ "return": {
10047
+ "type": {
10048
+ "text": ""
10049
+ }
10172
10050
  },
10173
- "privacy": "public",
10174
- "default": "null",
10175
10051
  "inheritedFrom": {
10176
- "name": "Popover",
10177
- "module": "components/popover/popover.component.js"
10052
+ "name": "FocusTrapMixin",
10053
+ "module": "utils/mixins/FocusTrapMixin.js"
10178
10054
  }
10179
10055
  },
10180
10056
  {
10181
- "kind": "field",
10182
- "name": "triggerElement",
10183
- "type": {
10184
- "text": "HTMLElement | null"
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
+ }
10185
10074
  },
10186
- "privacy": "public",
10187
- "default": "null",
10188
- "inheritedFrom": {
10189
- "name": "Popover",
10190
- "module": "components/popover/popover.component.js"
10075
+ "inheritedFrom": {
10076
+ "name": "FocusTrapMixin",
10077
+ "module": "utils/mixins/FocusTrapMixin.js"
10191
10078
  }
10192
10079
  },
10193
10080
  {
10194
10081
  "kind": "method",
10195
- "name": "setupTriggerListener",
10082
+ "name": "isHidden",
10196
10083
  "privacy": "private",
10197
- "description": "Sets up the trigger event listeners based on the trigger type.",
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
+ },
10198
10099
  "inheritedFrom": {
10199
- "name": "Popover",
10200
- "module": "components/popover/popover.component.js"
10100
+ "name": "FocusTrapMixin",
10101
+ "module": "utils/mixins/FocusTrapMixin.js"
10201
10102
  }
10202
10103
  },
10203
10104
  {
10204
10105
  "kind": "method",
10205
- "name": "removeEventListeners",
10106
+ "name": "isDisabled",
10206
10107
  "privacy": "private",
10207
- "description": "Removes the trigger event listeners.",
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
+ },
10208
10123
  "inheritedFrom": {
10209
- "name": "Popover",
10210
- "module": "components/popover/popover.component.js"
10124
+ "name": "FocusTrapMixin",
10125
+ "module": "utils/mixins/FocusTrapMixin.js"
10211
10126
  }
10212
10127
  },
10213
10128
  {
10214
- "kind": "field",
10215
- "name": "onOutsidePopoverClick",
10216
- "privacy": "protected",
10217
- "description": "Handles the outside click event to close the popover.",
10129
+ "kind": "method",
10130
+ "name": "isNotTabbable",
10131
+ "privacy": "private",
10218
10132
  "parameters": [
10219
10133
  {
10220
- "description": "The mouse event.",
10221
- "name": "event"
10134
+ "name": "element",
10135
+ "type": {
10136
+ "text": "HTMLElement"
10137
+ },
10138
+ "description": "The element to check."
10222
10139
  }
10223
10140
  ],
10141
+ "description": "Checks if the element is not tabbable.",
10142
+ "return": {
10143
+ "type": {
10144
+ "text": ""
10145
+ }
10146
+ },
10224
10147
  "inheritedFrom": {
10225
- "name": "Popover",
10226
- "module": "components/popover/popover.component.js"
10148
+ "name": "FocusTrapMixin",
10149
+ "module": "utils/mixins/FocusTrapMixin.js"
10227
10150
  }
10228
10151
  },
10229
10152
  {
10230
- "kind": "field",
10231
- "name": "onEscapeKeydown",
10153
+ "kind": "method",
10154
+ "name": "isInteractiveElement",
10232
10155
  "privacy": "private",
10233
- "description": "Handles the escape keydown event to close the popover.\n\nThis method is attached to the document.",
10156
+ "return": {
10157
+ "type": {
10158
+ "text": ""
10159
+ }
10160
+ },
10234
10161
  "parameters": [
10235
10162
  {
10236
- "description": "The keyboard event.",
10237
- "name": "event"
10163
+ "name": "element",
10164
+ "type": {
10165
+ "text": "HTMLElement"
10166
+ },
10167
+ "description": "The element to check."
10238
10168
  }
10239
10169
  ],
10170
+ "description": "Checks if the element is interactive.",
10240
10171
  "inheritedFrom": {
10241
- "name": "Popover",
10242
- "module": "components/popover/popover.component.js"
10172
+ "name": "FocusTrapMixin",
10173
+ "module": "utils/mixins/FocusTrapMixin.js"
10243
10174
  }
10244
10175
  },
10245
10176
  {
10246
- "kind": "field",
10247
- "name": "onPopoverFocusOut",
10177
+ "kind": "method",
10178
+ "name": "isFocusable",
10248
10179
  "privacy": "private",
10249
- "description": "Handles the popover focus out event.",
10250
10180
  "parameters": [
10251
10181
  {
10252
- "description": "The focus event.",
10253
- "name": "event"
10182
+ "name": "element",
10183
+ "type": {
10184
+ "text": "HTMLElement"
10185
+ },
10186
+ "description": "The element to check."
10254
10187
  }
10255
10188
  ],
10189
+ "description": "Checks if the element is focusable.",
10190
+ "return": {
10191
+ "type": {
10192
+ "text": ""
10193
+ }
10194
+ },
10256
10195
  "inheritedFrom": {
10257
- "name": "Popover",
10258
- "module": "components/popover/popover.component.js"
10196
+ "name": "FocusTrapMixin",
10197
+ "module": "utils/mixins/FocusTrapMixin.js"
10259
10198
  }
10260
10199
  },
10261
10200
  {
10262
10201
  "kind": "method",
10263
- "name": "isOpenUpdated",
10264
- "privacy": "protected",
10202
+ "name": "findFocusable",
10203
+ "privacy": "private",
10204
+ "return": {
10205
+ "type": {
10206
+ "text": ""
10207
+ }
10208
+ },
10265
10209
  "parameters": [
10266
10210
  {
10267
- "name": "oldValue",
10211
+ "name": "root",
10268
10212
  "type": {
10269
- "text": "boolean"
10213
+ "text": "ShadowRoot | HTMLElement"
10270
10214
  },
10271
- "description": "The old value of the visible property."
10215
+ "description": "The root element to search for focusable elements."
10272
10216
  },
10273
10217
  {
10274
- "name": "newValue",
10218
+ "name": "matches",
10219
+ "default": "new Set()",
10275
10220
  "type": {
10276
- "text": "boolean"
10221
+ "text": "Set<HTMLElement>"
10277
10222
  },
10278
- "description": "The new value of the visible property."
10223
+ "description": "The set of focusable elements."
10279
10224
  }
10280
10225
  ],
10281
- "description": "Handles the popover visibility change and position the popover.\nHandles the exit event to close the popover.",
10282
- "inheritedFrom": {
10283
- "name": "Popover",
10284
- "module": "components/popover/popover.component.js"
10285
- }
10286
- },
10287
- {
10288
- "kind": "field",
10289
- "name": "handleMouseEnter",
10290
- "privacy": "private",
10291
- "description": "Handles mouse enter event on the trigger element.\nThis method sets the `isHovered` flag to true and shows the popover",
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.",
10292
10227
  "inheritedFrom": {
10293
- "name": "Popover",
10294
- "module": "components/popover/popover.component.js"
10228
+ "name": "FocusTrapMixin",
10229
+ "module": "utils/mixins/FocusTrapMixin.js"
10295
10230
  }
10296
10231
  },
10297
10232
  {
10298
- "kind": "field",
10299
- "name": "handleMouseLeave",
10233
+ "kind": "method",
10234
+ "name": "setFocusableElements",
10300
10235
  "privacy": "private",
10301
- "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.",
10236
+ "description": "Updates the list of focusable elements within the component's shadow root.",
10302
10237
  "inheritedFrom": {
10303
- "name": "Popover",
10304
- "module": "components/popover/popover.component.js"
10238
+ "name": "FocusTrapMixin",
10239
+ "module": "utils/mixins/FocusTrapMixin.js"
10305
10240
  }
10306
10241
  },
10307
10242
  {
10308
- "kind": "field",
10309
- "name": "handleFocusOut",
10310
- "privacy": "private",
10311
- "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.",
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.",
10312
10257
  "inheritedFrom": {
10313
- "name": "Popover",
10314
- "module": "components/popover/popover.component.js"
10258
+ "name": "FocusTrapMixin",
10259
+ "module": "utils/mixins/FocusTrapMixin.js"
10315
10260
  }
10316
10261
  },
10317
10262
  {
10318
- "kind": "field",
10319
- "name": "startCloseDelay",
10263
+ "kind": "method",
10264
+ "name": "calculateNextIndex",
10320
10265
  "privacy": "private",
10321
- "description": "Starts the close delay timer.\nIf the popover is not interactive, it will close the popover after the delay.",
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
+ }
10287
+ },
10322
10288
  "inheritedFrom": {
10323
- "name": "Popover",
10324
- "module": "components/popover/popover.component.js"
10289
+ "name": "FocusTrapMixin",
10290
+ "module": "utils/mixins/FocusTrapMixin.js"
10325
10291
  }
10326
10292
  },
10327
10293
  {
10328
- "kind": "field",
10329
- "name": "cancelCloseDelay",
10294
+ "kind": "method",
10295
+ "name": "getDeepActiveElement",
10330
10296
  "privacy": "private",
10331
- "description": "Cancels the close delay timer.",
10332
- "inheritedFrom": {
10333
- "name": "Popover",
10334
- "module": "components/popover/popover.component.js"
10335
- }
10336
- },
10337
- {
10338
- "kind": "field",
10339
- "name": "showPopover",
10340
- "privacy": "public",
10341
- "description": "Shows the popover.",
10342
- "inheritedFrom": {
10343
- "name": "Popover",
10344
- "module": "components/popover/popover.component.js"
10345
- }
10346
- },
10347
- {
10348
- "kind": "field",
10349
- "name": "hidePopover",
10350
- "privacy": "public",
10351
- "description": "Hides the popover.",
10352
- "inheritedFrom": {
10353
- "name": "Popover",
10354
- "module": "components/popover/popover.component.js"
10355
- }
10356
- },
10357
- {
10358
- "kind": "field",
10359
- "name": "togglePopoverVisible",
10360
- "privacy": "public",
10361
- "description": "Toggles the popover visibility.",
10297
+ "description": "Returns the deepest active element in the shadow DOM.",
10298
+ "return": {
10299
+ "type": {
10300
+ "text": ""
10301
+ }
10302
+ },
10362
10303
  "inheritedFrom": {
10363
- "name": "Popover",
10364
- "module": "components/popover/popover.component.js"
10304
+ "name": "FocusTrapMixin",
10305
+ "module": "utils/mixins/FocusTrapMixin.js"
10365
10306
  }
10366
10307
  },
10367
10308
  {
10368
10309
  "kind": "method",
10369
- "name": "positionPopover",
10310
+ "name": "findElement",
10370
10311
  "privacy": "private",
10371
- "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.",
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
+ }
10326
+ },
10372
10327
  "inheritedFrom": {
10373
- "name": "Popover",
10374
- "module": "components/popover/popover.component.js"
10328
+ "name": "FocusTrapMixin",
10329
+ "module": "utils/mixins/FocusTrapMixin.js"
10375
10330
  }
10376
10331
  },
10377
10332
  {
10378
10333
  "kind": "method",
10379
- "name": "findClosestPopover",
10380
- "privacy": "protected",
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.",
10381
10353
  "return": {
10382
10354
  "type": {
10383
- "text": "Popover | null"
10355
+ "text": ""
10384
10356
  }
10385
10357
  },
10358
+ "inheritedFrom": {
10359
+ "name": "FocusTrapMixin",
10360
+ "module": "utils/mixins/FocusTrapMixin.js"
10361
+ }
10362
+ },
10363
+ {
10364
+ "kind": "method",
10365
+ "name": "trapFocus",
10366
+ "privacy": "private",
10386
10367
  "parameters": [
10387
10368
  {
10388
- "name": "element",
10369
+ "name": "event",
10389
10370
  "type": {
10390
- "text": "Element"
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.",
10380
+ "inheritedFrom": {
10381
+ "name": "FocusTrapMixin",
10382
+ "module": "utils/mixins/FocusTrapMixin.js"
10383
+ }
10384
+ },
10385
+ {
10386
+ "kind": "method",
10387
+ "name": "handleTabKeydown",
10388
+ "privacy": "private",
10389
+ "parameters": [
10390
+ {
10391
+ "name": "event",
10392
+ "type": {
10393
+ "text": "KeyboardEvent"
10391
10394
  },
10392
- "description": "The element to start searching from."
10395
+ "description": "The keyboard event."
10393
10396
  }
10394
10397
  ],
10395
- "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.",
10398
+ "description": "Traps focus within the container.",
10396
10399
  "inheritedFrom": {
10397
- "name": "Popover",
10398
- "module": "components/popover/popover.component.js"
10400
+ "name": "FocusTrapMixin",
10401
+ "module": "utils/mixins/FocusTrapMixin.js"
10399
10402
  }
10400
10403
  },
10401
10404
  {
10402
- "kind": "field",
10403
- "name": "utils",
10404
- "default": "new PopoverUtils(this)",
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
+ }
10413
+ },
10405
10414
  "inheritedFrom": {
10406
- "name": "Popover",
10407
- "module": "components/popover/popover.component.js"
10415
+ "name": "FooterMixin",
10416
+ "module": "utils/mixins/FooterMixin.js"
10408
10417
  }
10409
10418
  }
10410
10419
  ],
10411
10420
  "events": [
10412
10421
  {
10413
- "description": "(React: onShown) This event is dispatched when the coachmark is shown",
10422
+ "description": "(React: onShown) Dispatched when the dialog is shown",
10414
10423
  "name": "shown",
10415
- "reactName": "onShown",
10416
- "inheritedFrom": {
10417
- "name": "Popover",
10418
- "module": "src/components/popover/popover.component.ts"
10419
- }
10424
+ "reactName": "onShown"
10420
10425
  },
10421
10426
  {
10422
- "description": "(React: onHidden) This event is dispatched when the coachmark is hidden",
10427
+ "description": "(React: onHidden) Dispatched when the dialog is hidden",
10423
10428
  "name": "hidden",
10424
- "reactName": "onHidden",
10425
- "inheritedFrom": {
10426
- "name": "Popover",
10427
- "module": "src/components/popover/popover.component.ts"
10428
- }
10429
+ "reactName": "onHidden"
10429
10430
  },
10430
10431
  {
10431
- "description": "(React: onCreated) This event is dispatched when the coachmark is created (added to the DOM)",
10432
+ "description": "(React: onCreated) Dispatched when the dialog is created (added to the DOM)",
10432
10433
  "name": "created",
10433
- "reactName": "onCreated",
10434
- "inheritedFrom": {
10435
- "name": "Popover",
10436
- "module": "src/components/popover/popover.component.ts"
10437
- }
10434
+ "reactName": "onCreated"
10438
10435
  },
10439
10436
  {
10440
- "description": "(React: onDestroyed) This event is dispatched when the coachmark is destroyed (removed from the DOM)",
10437
+ "description": "(React: onDestroyed) Dispatched when the dialog is destroyed (removed from the DOM)",
10441
10438
  "name": "destroyed",
10442
- "reactName": "onDestroyed",
10443
- "inheritedFrom": {
10444
- "name": "Popover",
10445
- "module": "src/components/popover/popover.component.ts"
10446
- }
10439
+ "reactName": "onDestroyed"
10440
+ },
10441
+ {
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"
10447
10445
  }
10448
10446
  ],
10449
10447
  "attributes": [
10450
10448
  {
10451
- "name": "trigger",
10449
+ "name": "id",
10452
10450
  "type": {
10453
- "text": "PopoverTrigger"
10451
+ "text": "string"
10454
10452
  },
10455
- "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**",
10456
- "default": "manual",
10457
- "fieldName": "trigger",
10458
- "inheritedFrom": {
10459
- "name": "Popover",
10460
- "module": "src/components/popover/popover.component.ts"
10461
- }
10453
+ "default": "''",
10454
+ "description": "The unique ID of the dialog",
10455
+ "fieldName": "id"
10462
10456
  },
10463
10457
  {
10464
- "name": "show-arrow",
10458
+ "name": "triggerId",
10465
10459
  "type": {
10466
- "text": "boolean"
10460
+ "text": "string | undefined"
10467
10461
  },
10468
- "description": "The arrow visibility of the Coachmark.",
10469
- "default": "true",
10470
- "fieldName": "showArrow",
10471
- "inheritedFrom": {
10472
- "name": "Popover",
10473
- "module": "src/components/popover/popover.component.ts"
10474
- }
10462
+ "description": "The ID of the element that triggers the dialog",
10463
+ "default": "undefined",
10464
+ "fieldName": "triggerId"
10475
10465
  },
10476
10466
  {
10477
- "name": "close-button",
10467
+ "name": "visible",
10478
10468
  "type": {
10479
10469
  "text": "boolean"
10480
10470
  },
10481
- "description": "The close button visibility of the Coachmark.",
10482
- "default": "true",
10483
- "fieldName": "closeButton",
10484
- "inheritedFrom": {
10485
- "name": "Popover",
10486
- "module": "src/components/popover/popover.component.ts"
10487
- }
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.",
10472
+ "default": "false",
10473
+ "fieldName": "visible"
10488
10474
  },
10489
10475
  {
10490
- "name": "disable-aria-expanded",
10476
+ "name": "z-index",
10491
10477
  "type": {
10492
- "text": "boolean"
10478
+ "text": "number"
10493
10479
  },
10494
- "description": "Disable aria-expanded attribute on trigger element.",
10495
- "default": "true",
10496
- "fieldName": "disableAriaExpanded",
10497
- "inheritedFrom": {
10498
- "name": "Popover",
10499
- "module": "src/components/popover/popover.component.ts"
10500
- }
10480
+ "description": "The z-index of the dialog\n\nThe backdrop will have z-index of `zIndex - 1`",
10481
+ "default": "1000",
10482
+ "fieldName": "zIndex"
10501
10483
  },
10502
10484
  {
10503
- "name": "should-focus-trap-wrap",
10485
+ "name": "size",
10504
10486
  "type": {
10505
- "text": "boolean"
10487
+ "text": "DialogSize"
10506
10488
  },
10507
- "default": "true",
10508
- "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.",
10509
- "fieldName": "shouldFocusTrapWrap",
10510
- "inheritedFrom": {
10511
- "name": "FocusTrapMixin",
10512
- "module": "src/utils/mixins/FocusTrapMixin.ts"
10513
- }
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"
10514
10492
  },
10515
10493
  {
10516
- "name": "id",
10494
+ "name": "variant",
10517
10495
  "type": {
10518
- "text": "string"
10496
+ "text": "DialogVariant"
10519
10497
  },
10520
- "default": "''",
10521
- "description": "The unique ID of the popover.",
10522
- "fieldName": "id",
10523
- "inheritedFrom": {
10524
- "name": "Popover",
10525
- "module": "src/components/popover/popover.component.ts"
10526
- }
10498
+ "description": "The variant of the dialog, can be 'default' or 'promotional'",
10499
+ "default": "default",
10500
+ "fieldName": "variant"
10527
10501
  },
10528
10502
  {
10529
- "name": "triggerID",
10503
+ "name": "close-button-aria-label",
10530
10504
  "type": {
10531
- "text": "string"
10505
+ "text": "string | null"
10532
10506
  },
10533
- "default": "''",
10534
- "description": "The ID of the element that triggers the popover.\nThis attribute is required for the popover to work.",
10535
- "fieldName": "triggerID",
10536
- "inheritedFrom": {
10537
- "name": "Popover",
10538
- "module": "src/components/popover/popover.component.ts"
10539
- }
10507
+ "default": "null",
10508
+ "description": "Defines a string value for the aria-label attribute for close button accessibility",
10509
+ "fieldName": "closeButtonAriaLabel"
10510
+ },
10511
+ {
10512
+ "name": "aria-label",
10513
+ "type": {
10514
+ "text": "string | null"
10515
+ },
10516
+ "default": "null",
10517
+ "description": "Defines a string value for the aria-label attribute when header is not used",
10518
+ "fieldName": "ariaLabel"
10519
+ },
10520
+ {
10521
+ "name": "aria-labelledby",
10522
+ "type": {
10523
+ "text": "string | null"
10524
+ },
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"
10540
10528
  },
10541
10529
  {
10542
- "name": "placement",
10530
+ "name": "aria-describedby",
10543
10531
  "type": {
10544
- "text": "PopoverPlacement"
10532
+ "text": "string | null"
10545
10533
  },
10546
- "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**",
10547
- "default": "bottom",
10548
- "fieldName": "placement",
10549
- "inheritedFrom": {
10550
- "name": "Popover",
10551
- "module": "src/components/popover/popover.component.ts"
10552
- }
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"
10553
10537
  },
10554
10538
  {
10555
- "name": "color",
10539
+ "name": "aria-description",
10556
10540
  "type": {
10557
- "text": "PopoverColor"
10541
+ "text": "string | null"
10558
10542
  },
10559
- "description": "Color of the popover\n- **tonal**\n- **contrast**",
10560
- "default": "tonal",
10561
- "fieldName": "color",
10562
- "inheritedFrom": {
10563
- "name": "Popover",
10564
- "module": "src/components/popover/popover.component.ts"
10565
- }
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"
10566
10546
  },
10567
10547
  {
10568
- "name": "visible",
10548
+ "name": "header-text",
10569
10549
  "type": {
10570
- "text": "boolean"
10550
+ "text": "string | undefined"
10571
10551
  },
10572
- "description": "The visibility of the popover.",
10573
- "default": "false",
10574
- "fieldName": "visible",
10575
- "inheritedFrom": {
10576
- "name": "Popover",
10577
- "module": "src/components/popover/popover.component.ts"
10578
- }
10552
+ "description": "Defines a string value to display as the title of the dialog",
10553
+ "fieldName": "headerText"
10579
10554
  },
10580
10555
  {
10581
- "name": "offset",
10556
+ "name": "description-text",
10582
10557
  "type": {
10583
- "text": "number"
10558
+ "text": "string | undefined"
10584
10559
  },
10585
- "description": "The offset of the popover.",
10586
- "default": "4",
10587
- "fieldName": "offset",
10588
- "inheritedFrom": {
10589
- "name": "Popover",
10590
- "module": "src/components/popover/popover.component.ts"
10591
- }
10560
+ "description": "Defines a string value to display as the under-header description of the dialog",
10561
+ "fieldName": "descriptionText"
10592
10562
  },
10593
10563
  {
10594
- "name": "boundary",
10564
+ "name": "header-tag-name",
10595
10565
  "type": {
10596
- "text": "'clippingAncestors' | string"
10566
+ "text": "string"
10597
10567
  },
10598
- "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",
10599
- "default": "'clippingAncestors'",
10600
- "fieldName": "boundary",
10601
- "inheritedFrom": {
10602
- "name": "Popover",
10603
- "module": "src/components/popover/popover.component.ts"
10604
- }
10568
+ "description": "The html tag to be used for the header text",
10569
+ "fieldName": "headerTagName"
10605
10570
  },
10606
10571
  {
10607
- "name": "boundary-root",
10572
+ "name": "description-tag-name",
10608
10573
  "type": {
10609
- "text": "'viewport' | 'document'"
10574
+ "text": "string"
10610
10575
  },
10611
- "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.",
10612
- "default": "'viewport'",
10613
- "fieldName": "boundaryRoot",
10614
- "inheritedFrom": {
10615
- "name": "Popover",
10616
- "module": "src/components/popover/popover.component.ts"
10617
- }
10576
+ "description": "The html tag to be used for the below-header description text",
10577
+ "fieldName": "descriptionTagName"
10618
10578
  },
10619
10579
  {
10620
- "name": "boundary-padding",
10580
+ "name": "role",
10621
10581
  "type": {
10622
- "text": "undefined | number"
10582
+ "text": "DialogRole"
10623
10583
  },
10624
- "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.",
10625
- "default": "undefined",
10626
- "fieldName": "boundaryPadding",
10627
- "inheritedFrom": {
10628
- "name": "Popover",
10629
- "module": "src/components/popover/popover.component.ts"
10630
- }
10584
+ "description": "Role of the dialog",
10585
+ "default": "dialog",
10586
+ "fieldName": "role"
10631
10587
  },
10632
10588
  {
10633
- "name": "focus-trap",
10589
+ "name": "disable-aria-haspopup",
10634
10590
  "type": {
10635
10591
  "text": "boolean"
10636
10592
  },
10637
- "description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.",
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.",
10638
10594
  "default": "false",
10639
- "fieldName": "focusTrap",
10640
- "inheritedFrom": {
10641
- "name": "Popover",
10642
- "module": "src/components/popover/popover.component.ts"
10643
- }
10595
+ "fieldName": "disableAriaHasPopup"
10644
10596
  },
10645
10597
  {
10646
- "name": "prevent-scroll",
10598
+ "name": "focus-trap",
10647
10599
  "type": {
10648
10600
  "text": "boolean"
10649
10601
  },
10650
- "description": "Prevent outside scrolling when popover is shown.",
10651
- "default": "false",
10652
- "fieldName": "preventScroll",
10653
- "inheritedFrom": {
10654
- "name": "Popover",
10655
- "module": "src/components/popover/popover.component.ts"
10656
- }
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"
10657
10605
  },
10658
10606
  {
10659
- "name": "interactive",
10607
+ "name": "should-focus-trap-wrap",
10660
10608
  "type": {
10661
10609
  "text": "boolean"
10662
10610
  },
10663
- "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!",
10664
- "default": "false",
10665
- "fieldName": "interactive",
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",
10666
10614
  "inheritedFrom": {
10667
- "name": "Popover",
10668
- "module": "src/components/popover/popover.component.ts"
10615
+ "name": "FocusTrapMixin",
10616
+ "module": "src/utils/mixins/FocusTrapMixin.ts"
10669
10617
  }
10618
+ }
10619
+ ],
10620
+ "mixins": [
10621
+ {
10622
+ "name": "PreventScrollMixin",
10623
+ "module": "/src/utils/mixins/PreventScrollMixin"
10670
10624
  },
10671
10625
  {
10672
- "name": "delay",
10673
- "type": {
10674
- "text": "string"
10675
- },
10676
- "description": "The delay of the show/hide popover.",
10677
- "default": "0,0",
10678
- "fieldName": "delay",
10679
- "inheritedFrom": {
10680
- "name": "Popover",
10681
- "module": "src/components/popover/popover.component.ts"
10682
- }
10626
+ "name": "FocusTrapMixin",
10627
+ "module": "/src/utils/mixins/FocusTrapMixin"
10683
10628
  },
10684
10629
  {
10685
- "name": "hide-on-escape",
10686
- "type": {
10687
- "text": "boolean"
10688
- },
10689
- "description": "Hide popover on escape key press.",
10690
- "default": "false",
10691
- "fieldName": "hideOnEscape",
10692
- "inheritedFrom": {
10693
- "name": "Popover",
10694
- "module": "src/components/popover/popover.component.ts"
10695
- }
10630
+ "name": "FooterMixin",
10631
+ "module": "/src/utils/mixins/FooterMixin"
10632
+ }
10633
+ ],
10634
+ "superclass": {
10635
+ "name": "Component",
10636
+ "module": "/src/models"
10637
+ },
10638
+ "tagName": "mdc-dialog",
10639
+ "jsDoc": "/**\n * Dialog component is a modal dialog that can be used to display information or prompt the user for input.\n * It can be used to create custom dialogs where content for the body and footer actions is provided by the consumer.\n * The dialog is available in 5 sizes: small, medium, large, xlarge and fullscreen. It may also receive custom styling/sizing.\n * The dialog interrupts the user and will block interaction with the rest of the application until it is closed.\n *\n * The dialog can be controlled solely through the `visible` property, no trigger element is required.\n * If a `triggerId` is provided, the dialog will manage focus with that element, otherwise it will\n * remember the previously focused element before the dialog was opened.\n *\n * The dialog is a controlled component, meaning it does not have its own state management for visibility.\n * Use the `visible` property to control the visibility of the dialog.\n * Use the `onClose` event to handle the close action of the dialog (fired when Close button is clicked\n * or Escape is pressed).\n *\n * Dialog component have 2 variants: default and promotional.\n *\n * **Accessibility notes for consuming (have to be explicitly set when you consume the component)**\n *\n * - The dialog should have an aria-label or aria-labelledby attribute to provide a label for screen readers.\n * - Use aria-labelledby to reference the ID of the element that labels the dialog when there is no visible title.\n *\n * **Note: Programmatic show/hide requires the ? prefix on the visible attribute**\n * - Use `?visible=true/false` as an attribute instead of `visible=true/false`\n * - Reference docs for more info: https://lit.dev/docs/templates/expressions/#boolean-attribute-expressions\n *\n * @dependency mdc-button\n * @dependency mdc-text\n *\n * @tagname mdc-dialog\n *\n * @event shown - (React: onShown) Dispatched when the dialog is shown\n * @event hidden - (React: onHidden) Dispatched when the dialog is hidden\n * @event created - (React: onCreated) Dispatched when the dialog is created (added to the DOM)\n * @event destroyed - (React: onDestroyed) Dispatched when the dialog is destroyed (removed from the DOM)\n * @event close - (React: onClose) Dispatched when the Close Button is clicked or Escape key is pressed\n * (this does not hide the dialog)\n *\n * @cssproperty --mdc-dialog-primary-background-color - primary background color of the dialog\n * @cssproperty --mdc-dialog-border-color - border color of the dialog\n * @cssproperty --mdc-dialog-header-text-color - text color of the header/title of the dialog\n * @cssproperty --mdc-dialog-description-text-color - text color of the below header description of the dialog\n * @cssproperty --mdc-dialog-elevation-3 - elevation of the dialog\n * @cssproperty --mdc-dialog-width - width of the dialog\n *\n * @slot header-prefix - Slot for the dialog header content. This can be used to pass custom header content.\n * @slot dialog-body - Slot for the dialog body content\n * @slot footer-link - This slot is for passing `mdc-link` component within the footer section.\n * @slot footer-button-secondary - This slot is for passing secondary variant of `mdc-button` component\n * within the footer section.\n * @slot footer-button-primary - This slot is for passing primary variant of\n * `mdc-button` component within the footer section.\n * @slot footer - This slot is for passing custom footer content. Only use this if really needed,\n * using the footer-link and footer-button slots is preferred\n */",
10640
+ "customElement": true
10641
+ }
10642
+ ],
10643
+ "exports": [
10644
+ {
10645
+ "kind": "js",
10646
+ "name": "default",
10647
+ "declaration": {
10648
+ "name": "Dialog",
10649
+ "module": "components/dialog/dialog.component.js"
10650
+ }
10651
+ }
10652
+ ]
10653
+ },
10654
+ {
10655
+ "kind": "javascript-module",
10656
+ "path": "components/divider/divider.component.js",
10657
+ "declarations": [
10658
+ {
10659
+ "kind": "class",
10660
+ "description": "`mdc-divider` is a component that provides a line to separate and organize content.\nIt can also include a button or text positioned centrally, allowing users to interact with the layout.\n\n**Divider Orientation:**\n- **Horizontal**: A thin, horizontal line.\n- **Vertical**: A thin, vertical line.\n\n**Divider Variants:**\n- **solid**: Solid line.\n- **gradient**: Gradient Line.\n\n**Divider Types:**\n- The type of divider is inferred based on the kind of slot present.\n - **Primary**: A simple horizontal or vertical divider.\n - **Text**: A horizontal divider with a text label in the center.\n - **Grabber Button**: A horizontal or vertical divider with a styled button in the center.\n\n**Accessibility:**\n- When the slot is replaced by an `mdc-button`:\n - `aria-label` should be passed to the `mdc-button`.\n - `aria-expanded` should be passed to the `mdc-button`.\n\n**Notes:**\n- If the slot is replaced by an invalid tag name or contains multiple elements,\n the divider defaults to the **Primary** type.\n- To override the styles of the divider, use the provided CSS custom properties.",
10661
+ "name": "Divider",
10662
+ "cssProperties": [
10663
+ {
10664
+ "description": "background color of the divider",
10665
+ "name": "--mdc-divider-background-color"
10696
10666
  },
10697
10667
  {
10698
- "name": "propagate-event-on-escape",
10699
- "type": {
10700
- "text": "boolean"
10701
- },
10702
- "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.",
10703
- "default": "false",
10704
- "fieldName": "propagateEventOnEscape",
10705
- "inheritedFrom": {
10706
- "name": "Popover",
10707
- "module": "src/components/popover/popover.component.ts"
10708
- }
10668
+ "description": "width of the divider",
10669
+ "name": "--mdc-divider-width"
10670
+ },
10671
+ {
10672
+ "description": "gradient of the horizontal divider",
10673
+ "name": "--mdc-divider-horizontal-gradient"
10674
+ },
10675
+ {
10676
+ "description": "gradient of the vertical divider",
10677
+ "name": "--mdc-divider-vertical-gradient"
10678
+ },
10679
+ {
10680
+ "description": "font size of label in the text divider",
10681
+ "name": "--mdc-divider-text-size"
10682
+ },
10683
+ {
10684
+ "description": "font color of label in the text divider",
10685
+ "name": "--mdc-divider-text-color"
10686
+ },
10687
+ {
10688
+ "description": "left and right margin of label in the text divider",
10689
+ "name": "--mdc-divider-text-margin"
10690
+ },
10691
+ {
10692
+ "description": "line height of label in the text divider",
10693
+ "name": "--mdc-divider-text-line-height"
10694
+ },
10695
+ {
10696
+ "description": "background color of the grabber button in rest state",
10697
+ "name": "--mdc-divider-grabber-button-background-color-normal"
10698
+ },
10699
+ {
10700
+ "description": "background color of the grabber button in hover state",
10701
+ "name": "--mdc-divider-grabber-button-background-color-hover"
10702
+ },
10703
+ {
10704
+ "description": "background color of the grabber button in pressed state",
10705
+ "name": "--mdc-divider-grabber-button-background-color-pressed"
10706
+ },
10707
+ {
10708
+ "description": "border color of the grabber button",
10709
+ "name": "--mdc-divider-grabber-button-border-color"
10709
10710
  },
10710
10711
  {
10711
- "name": "hide-on-blur",
10712
+ "description": "border radius of the grabber button",
10713
+ "name": "--mdc-divider-grabber-button-border-radius"
10714
+ }
10715
+ ],
10716
+ "members": [
10717
+ {
10718
+ "kind": "field",
10719
+ "name": "orientation",
10712
10720
  "type": {
10713
- "text": "boolean"
10721
+ "text": "DividerOrientation"
10714
10722
  },
10715
- "description": "Hide popover on blur.",
10716
- "default": "false",
10717
- "fieldName": "hideOnBlur",
10718
- "inheritedFrom": {
10719
- "name": "Popover",
10720
- "module": "src/components/popover/popover.component.ts"
10721
- }
10723
+ "description": "Two orientations of divider\n- **horizontal**: A thin, horizontal line with 0.0625rem width.\n- **vertical**: A thin, vertical line with 0.0625rem width.\n\nNote: We do not support \"Vertical Text Divider\" as of now.",
10724
+ "default": "horizontal",
10725
+ "attribute": "orientation",
10726
+ "reflects": true
10722
10727
  },
10723
10728
  {
10724
- "name": "hide-on-outside-click",
10729
+ "kind": "field",
10730
+ "name": "variant",
10725
10731
  "type": {
10726
- "text": "boolean"
10732
+ "text": "DividerVariant"
10727
10733
  },
10728
- "description": "Hide on outside click of the popover.",
10729
- "default": "false",
10730
- "fieldName": "hideOnOutsideClick",
10731
- "inheritedFrom": {
10732
- "name": "Popover",
10733
- "module": "src/components/popover/popover.component.ts"
10734
- }
10734
+ "description": "Two variants of divider\n- **solid**: Solid line.\n- **gradient**: Gradient Line that fades on either sides of the divider.",
10735
+ "default": "solid",
10736
+ "attribute": "variant",
10737
+ "reflects": true
10735
10738
  },
10736
10739
  {
10737
- "name": "focus-back-to-trigger",
10740
+ "kind": "field",
10741
+ "name": "arrowDirection",
10738
10742
  "type": {
10739
- "text": "boolean"
10743
+ "text": "Directions"
10740
10744
  },
10741
- "description": "The focus back to trigger after the popover hide.",
10742
- "default": "false",
10743
- "fieldName": "focusBackToTrigger",
10744
- "inheritedFrom": {
10745
- "name": "Popover",
10746
- "module": "src/components/popover/popover.component.ts"
10747
- }
10745
+ "description": "Direction of the arrow icon, if applicable.\n- **positive**\n- **negative**\n\nNote: Positive and Negative directions are defined based on Cartesian plane.",
10746
+ "default": "'negative'",
10747
+ "attribute": "arrow-direction",
10748
+ "reflects": true
10748
10749
  },
10749
10750
  {
10750
- "name": "backdrop",
10751
+ "kind": "field",
10752
+ "name": "buttonPosition",
10751
10753
  "type": {
10752
- "text": "boolean"
10754
+ "text": "Directions"
10753
10755
  },
10754
- "description": "Determines whether the popover with backdrop.\nOther than popover and trigger element, the rest of the screen will be covered with a backdrop.",
10755
- "default": "false",
10756
- "fieldName": "backdrop",
10757
- "inheritedFrom": {
10758
- "name": "Popover",
10759
- "module": "src/components/popover/popover.component.ts"
10760
- }
10756
+ "description": "Position of the button, if applicable.\n- **positive**\n- **negative**\n\nNote: Positive and Negative directions are defined based on Cartesian plane.",
10757
+ "default": "'negative'",
10758
+ "attribute": "button-position",
10759
+ "reflects": true
10761
10760
  },
10762
10761
  {
10763
- "name": "flip",
10764
- "type": {
10765
- "text": "boolean"
10766
- },
10767
- "description": "Changes the placement of popover to keep it in view when scrolling.",
10768
- "default": "true",
10769
- "fieldName": "flip",
10770
- "inheritedFrom": {
10771
- "name": "Popover",
10772
- "module": "src/components/popover/popover.component.ts"
10773
- }
10762
+ "kind": "method",
10763
+ "name": "setVariant",
10764
+ "privacy": "private",
10765
+ "parameters": [
10766
+ {
10767
+ "name": "variant",
10768
+ "type": {
10769
+ "text": "DividerVariant"
10770
+ },
10771
+ "description": "The variant to set."
10772
+ }
10773
+ ],
10774
+ "description": "Sets the variant attribute for the divider component.\nIf the provided variant is not included in the DIVIDER_VARIANT,\nit defaults to the value specified in DEFAULTS.VARIANT."
10774
10775
  },
10775
10776
  {
10776
- "name": "size",
10777
- "type": {
10778
- "text": "boolean"
10779
- },
10780
- "description": "Changes the size of popover to keep it in view when scrolling.",
10781
- "default": "false",
10782
- "fieldName": "size",
10783
- "inheritedFrom": {
10784
- "name": "Popover",
10785
- "module": "src/components/popover/popover.component.ts"
10786
- }
10777
+ "kind": "method",
10778
+ "name": "setOrientation",
10779
+ "privacy": "private",
10780
+ "parameters": [
10781
+ {
10782
+ "name": "orientation",
10783
+ "type": {
10784
+ "text": "DividerOrientation"
10785
+ },
10786
+ "description": "The orientation to set."
10787
+ }
10788
+ ],
10789
+ "description": "Sets the orientation attribute for the divider component.\nIf the provided orientation is not included in the DIVIDER_ORIENTATION,\nit defaults to the value specified in DEFAULTS.ORIENTATION."
10787
10790
  },
10788
10791
  {
10789
- "name": "z-index",
10790
- "type": {
10791
- "text": "number"
10792
- },
10793
- "description": "The z-index of the popover.",
10794
- "default": "1000",
10795
- "fieldName": "zIndex",
10796
- "inheritedFrom": {
10797
- "name": "Popover",
10798
- "module": "src/components/popover/popover.component.ts"
10799
- }
10792
+ "kind": "method",
10793
+ "name": "ensureValidDirections",
10794
+ "privacy": "private",
10795
+ "description": "Sets the buttonPosition and arrowDirection attribute for the divider component.\nIf the provided buttonPosition and arrowDirection are not included in the DIRECTIONS,\nit defaults to the value specified in DIRECTIONS based on the ORIENTATION.",
10796
+ "parameters": [
10797
+ {
10798
+ "description": "The buttonPosition to set.",
10799
+ "name": "buttonPosition"
10800
+ },
10801
+ {
10802
+ "description": "The arrowDirection to set.",
10803
+ "name": "arrowDirection"
10804
+ }
10805
+ ]
10800
10806
  },
10801
10807
  {
10802
- "name": "append-to",
10803
- "type": {
10804
- "text": "string | undefined"
10808
+ "kind": "method",
10809
+ "name": "setGrabberButton",
10810
+ "privacy": "private",
10811
+ "return": {
10812
+ "type": {
10813
+ "text": "void"
10814
+ }
10805
10815
  },
10806
- "description": "Element ID that the popover append to.",
10807
- "default": "''",
10808
- "fieldName": "appendTo",
10809
- "inheritedFrom": {
10810
- "name": "Popover",
10811
- "module": "src/components/popover/popover.component.ts"
10812
- }
10816
+ "description": "Configures the grabber button within the divider.\n\n- Sets the `prefix-icon` attribute for the grabber button based\non the `arrow-direction` and `orientation` properties.\n\nThis method updates the DOM element dynamically if a grabber button is present."
10813
10817
  },
10814
10818
  {
10815
- "name": "close-button-aria-label",
10816
- "type": {
10817
- "text": "string | null"
10819
+ "kind": "method",
10820
+ "name": "getArrowIcon",
10821
+ "privacy": "private",
10822
+ "return": {
10823
+ "type": {
10824
+ "text": ""
10825
+ }
10818
10826
  },
10819
- "default": "null",
10820
- "description": "aria-label attribute to be set for close button accessibility.",
10821
- "fieldName": "closeButtonAriaLabel",
10822
- "inheritedFrom": {
10823
- "name": "Popover",
10824
- "module": "src/components/popover/popover.component.ts"
10825
- }
10827
+ "description": "Determines the arrow icon based on the consumer-defined `arrowDirection`."
10826
10828
  },
10827
10829
  {
10828
- "name": "role",
10830
+ "kind": "method",
10831
+ "name": "inferDividerType",
10832
+ "privacy": "private",
10833
+ "description": "Infers the type of divider based on the kind of slot present.",
10834
+ "parameters": [
10835
+ {
10836
+ "description": "default slot of divider",
10837
+ "name": "slot"
10838
+ }
10839
+ ]
10840
+ }
10841
+ ],
10842
+ "attributes": [
10843
+ {
10844
+ "name": "orientation",
10829
10845
  "type": {
10830
- "text": "HTMLElement['role']"
10846
+ "text": "DividerOrientation"
10831
10847
  },
10832
- "description": "Role of the popover",
10833
- "default": "dialog",
10834
- "fieldName": "role",
10835
- "inheritedFrom": {
10836
- "name": "Popover",
10837
- "module": "src/components/popover/popover.component.ts"
10838
- }
10848
+ "description": "Two orientations of divider\n- **horizontal**: A thin, horizontal line with 0.0625rem width.\n- **vertical**: A thin, vertical line with 0.0625rem width.\n\nNote: We do not support \"Vertical Text Divider\" as of now.",
10849
+ "default": "horizontal",
10850
+ "fieldName": "orientation"
10839
10851
  },
10840
10852
  {
10841
- "name": "aria-labelledby",
10853
+ "name": "variant",
10842
10854
  "type": {
10843
- "text": "string | null"
10855
+ "text": "DividerVariant"
10844
10856
  },
10845
- "default": "null",
10846
- "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.",
10847
- "fieldName": "ariaLabelledby",
10848
- "inheritedFrom": {
10849
- "name": "Popover",
10850
- "module": "src/components/popover/popover.component.ts"
10851
- }
10857
+ "description": "Two variants of divider\n- **solid**: Solid line.\n- **gradient**: Gradient Line that fades on either sides of the divider.",
10858
+ "default": "solid",
10859
+ "fieldName": "variant"
10852
10860
  },
10853
10861
  {
10854
- "name": "aria-describedby",
10862
+ "name": "arrow-direction",
10855
10863
  "type": {
10856
- "text": "string | null"
10864
+ "text": "Directions"
10857
10865
  },
10858
- "default": "null",
10859
- "description": "aria-describedby of the popover.",
10860
- "fieldName": "ariaDescribedby",
10861
- "inheritedFrom": {
10862
- "name": "Popover",
10863
- "module": "src/components/popover/popover.component.ts"
10864
- }
10866
+ "description": "Direction of the arrow icon, if applicable.\n- **positive**\n- **negative**\n\nNote: Positive and Negative directions are defined based on Cartesian plane.",
10867
+ "default": "'negative'",
10868
+ "fieldName": "arrowDirection"
10865
10869
  },
10866
10870
  {
10867
- "name": "disable-aria-haspopup",
10871
+ "name": "button-position",
10868
10872
  "type": {
10869
- "text": "boolean"
10873
+ "text": "Directions"
10870
10874
  },
10871
- "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.",
10872
- "default": "false",
10873
- "fieldName": "disableAriaHasPopup",
10874
- "inheritedFrom": {
10875
- "name": "Popover",
10876
- "module": "src/components/popover/popover.component.ts"
10877
- }
10875
+ "description": "Position of the button, if applicable.\n- **positive**\n- **negative**\n\nNote: Positive and Negative directions are defined based on Cartesian plane.",
10876
+ "default": "'negative'",
10877
+ "fieldName": "buttonPosition"
10878
10878
  }
10879
10879
  ],
10880
10880
  "superclass": {
10881
- "name": "Popover",
10882
- "module": "/src/components/popover/popover.component"
10881
+ "name": "Component",
10882
+ "module": "/src/models"
10883
10883
  },
10884
- "tagName": "mdc-coachmark",
10885
- "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 */",
10884
+ "tagName": "mdc-divider",
10885
+ "jsDoc": "/**\n * `mdc-divider` is a component that provides a line to separate and organize content.\n * It can also include a button or text positioned centrally, allowing users to interact with the layout.\n *\n * **Divider Orientation:**\n * - **Horizontal**: A thin, horizontal line.\n * - **Vertical**: A thin, vertical line.\n *\n * **Divider Variants:**\n * - **solid**: Solid line.\n * - **gradient**: Gradient Line.\n *\n * **Divider Types:**\n * - The type of divider is inferred based on the kind of slot present.\n * - **Primary**: A simple horizontal or vertical divider.\n * - **Text**: A horizontal divider with a text label in the center.\n * - **Grabber Button**: A horizontal or vertical divider with a styled button in the center.\n *\n * **Accessibility:**\n * - When the slot is replaced by an `mdc-button`:\n * - `aria-label` should be passed to the `mdc-button`.\n * - `aria-expanded` should be passed to the `mdc-button`.\n *\n * **Notes:**\n * - If the slot is replaced by an invalid tag name or contains multiple elements,\n * the divider defaults to the **Primary** type.\n * - To override the styles of the divider, use the provided CSS custom properties.\n *\n * @tagname mdc-divider\n *\n * @cssproperty --mdc-divider-background-color - background color of the divider\n * @cssproperty --mdc-divider-width - width of the divider\n * @cssproperty --mdc-divider-horizontal-gradient - gradient of the horizontal divider\n * @cssproperty --mdc-divider-vertical-gradient - gradient of the vertical divider\n * @cssproperty --mdc-divider-text-size - font size of label in the text divider\n * @cssproperty --mdc-divider-text-color - font color of label in the text divider\n * @cssproperty --mdc-divider-text-margin - left and right margin of label in the text divider\n * @cssproperty --mdc-divider-text-line-height - line height of label in the text divider\n * @cssproperty --mdc-divider-grabber-button-background-color-normal - background color of the grabber button\n * in rest state\n * @cssproperty --mdc-divider-grabber-button-background-color-hover - background color of the grabber button\n * in hover state\n * @cssproperty --mdc-divider-grabber-button-background-color-pressed - background color of the grabber button\n * in pressed state\n * @cssproperty --mdc-divider-grabber-button-border-color - border color of the grabber button\n * @cssproperty --mdc-divider-grabber-button-border-radius - border radius of the grabber button\n */",
10886
10886
  "customElement": true
10887
10887
  }
10888
10888
  ],
@@ -10891,8 +10891,8 @@
10891
10891
  "kind": "js",
10892
10892
  "name": "default",
10893
10893
  "declaration": {
10894
- "name": "Coachmark",
10895
- "module": "components/coachmark/coachmark.component.js"
10894
+ "name": "Divider",
10895
+ "module": "components/divider/divider.component.js"
10896
10896
  }
10897
10897
  }
10898
10898
  ]