@momentum-design/components 0.92.5 → 0.94.0
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.
- package/dist/custom-elements.json +1894 -1894
- package/dist/react/index.d.ts +3 -3
- package/dist/react/index.js +3 -3
- package/package.json +1 -1
@@ -7759,240 +7759,347 @@
|
|
7759
7759
|
},
|
7760
7760
|
{
|
7761
7761
|
"kind": "javascript-module",
|
7762
|
-
"path": "components/
|
7762
|
+
"path": "components/dialog/dialog.component.js",
|
7763
7763
|
"declarations": [
|
7764
7764
|
{
|
7765
7765
|
"kind": "class",
|
7766
|
-
"description": "
|
7767
|
-
"name": "
|
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",
|
7768
7768
|
"cssProperties": [
|
7769
7769
|
{
|
7770
|
-
"description": "
|
7771
|
-
"name": "--mdc-
|
7772
|
-
"inheritedFrom": {
|
7773
|
-
"name": "Popover",
|
7774
|
-
"module": "src/components/popover/popover.component.ts"
|
7775
|
-
}
|
7770
|
+
"description": "primary background color of the dialog",
|
7771
|
+
"name": "--mdc-dialog-primary-background-color"
|
7776
7772
|
},
|
7777
7773
|
{
|
7778
|
-
"description": "border of the
|
7779
|
-
"name": "--mdc-
|
7780
|
-
"inheritedFrom": {
|
7781
|
-
"name": "Popover",
|
7782
|
-
"module": "src/components/popover/popover.component.ts"
|
7783
|
-
}
|
7774
|
+
"description": "border color of the dialog",
|
7775
|
+
"name": "--mdc-dialog-border-color"
|
7784
7776
|
},
|
7785
7777
|
{
|
7786
|
-
"description": "
|
7787
|
-
"name": "--mdc-
|
7788
|
-
"inheritedFrom": {
|
7789
|
-
"name": "Popover",
|
7790
|
-
"module": "src/components/popover/popover.component.ts"
|
7791
|
-
}
|
7778
|
+
"description": "text color of the header/title of the dialog",
|
7779
|
+
"name": "--mdc-dialog-header-text-color"
|
7792
7780
|
},
|
7793
7781
|
{
|
7794
|
-
"description": "
|
7795
|
-
"name": "--mdc-
|
7796
|
-
"inheritedFrom": {
|
7797
|
-
"name": "Popover",
|
7798
|
-
"module": "src/components/popover/popover.component.ts"
|
7799
|
-
}
|
7782
|
+
"description": "text color of the below header description of the dialog",
|
7783
|
+
"name": "--mdc-dialog-description-text-color"
|
7800
7784
|
},
|
7801
7785
|
{
|
7802
|
-
"description": "
|
7803
|
-
"name": "--mdc-
|
7804
|
-
"inheritedFrom": {
|
7805
|
-
"name": "Popover",
|
7806
|
-
"module": "src/components/popover/popover.component.ts"
|
7807
|
-
}
|
7786
|
+
"description": "elevation of the dialog",
|
7787
|
+
"name": "--mdc-dialog-elevation-3"
|
7808
7788
|
},
|
7809
7789
|
{
|
7810
|
-
"description": "
|
7811
|
-
"name": "--mdc-
|
7812
|
-
|
7813
|
-
|
7814
|
-
|
7815
|
-
|
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"
|
7816
7798
|
},
|
7817
7799
|
{
|
7818
|
-
"description": "
|
7819
|
-
"name": "
|
7820
|
-
"inheritedFrom": {
|
7821
|
-
"name": "Popover",
|
7822
|
-
"module": "src/components/popover/popover.component.ts"
|
7823
|
-
}
|
7800
|
+
"description": "Slot for the dialog body content",
|
7801
|
+
"name": "dialog-body"
|
7824
7802
|
},
|
7825
7803
|
{
|
7826
|
-
"description": "
|
7827
|
-
"name": "
|
7828
|
-
"inheritedFrom": {
|
7829
|
-
"name": "Popover",
|
7830
|
-
"module": "src/components/popover/popover.component.ts"
|
7831
|
-
}
|
7804
|
+
"description": "This slot is for passing `mdc-link` component within the footer section.",
|
7805
|
+
"name": "footer-link"
|
7832
7806
|
},
|
7833
7807
|
{
|
7834
|
-
"description": "
|
7835
|
-
"name": "
|
7836
|
-
"inheritedFrom": {
|
7837
|
-
"name": "Popover",
|
7838
|
-
"module": "src/components/popover/popover.component.ts"
|
7839
|
-
}
|
7808
|
+
"description": "This slot is for passing secondary variant of `mdc-button` component within the footer section.",
|
7809
|
+
"name": "footer-button-secondary"
|
7840
7810
|
},
|
7841
7811
|
{
|
7842
|
-
"description": "
|
7843
|
-
"name": "
|
7844
|
-
|
7845
|
-
"name": "Popover",
|
7846
|
-
"module": "src/components/popover/popover.component.ts"
|
7847
|
-
}
|
7848
|
-
}
|
7849
|
-
],
|
7850
|
-
"slots": [
|
7812
|
+
"description": "This slot is for passing primary variant of `mdc-button` component within the footer section.",
|
7813
|
+
"name": "footer-button-primary"
|
7814
|
+
},
|
7851
7815
|
{
|
7852
|
-
"description": "
|
7853
|
-
"name": ""
|
7854
|
-
"inheritedFrom": {
|
7855
|
-
"name": "Popover",
|
7856
|
-
"module": "src/components/popover/popover.component.ts"
|
7857
|
-
}
|
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"
|
7858
7818
|
}
|
7859
7819
|
],
|
7860
7820
|
"members": [
|
7861
7821
|
{
|
7862
7822
|
"kind": "field",
|
7863
|
-
"name": "
|
7823
|
+
"name": "id",
|
7864
7824
|
"type": {
|
7865
|
-
"text": "
|
7825
|
+
"text": "string"
|
7866
7826
|
},
|
7867
|
-
"
|
7868
|
-
"
|
7869
|
-
"attribute": "
|
7870
|
-
"reflects": true
|
7871
|
-
"inheritedFrom": {
|
7872
|
-
"name": "Popover",
|
7873
|
-
"module": "components/popover/popover.component.js"
|
7874
|
-
}
|
7827
|
+
"default": "''",
|
7828
|
+
"description": "The unique ID of the dialog",
|
7829
|
+
"attribute": "id",
|
7830
|
+
"reflects": true
|
7875
7831
|
},
|
7876
7832
|
{
|
7877
7833
|
"kind": "field",
|
7878
|
-
"name": "
|
7834
|
+
"name": "triggerId",
|
7879
7835
|
"type": {
|
7880
|
-
"text": "
|
7836
|
+
"text": "string | undefined"
|
7881
7837
|
},
|
7882
|
-
"description": "The
|
7883
|
-
"default": "
|
7884
|
-
"attribute": "
|
7885
|
-
"reflects": true
|
7886
|
-
"inheritedFrom": {
|
7887
|
-
"name": "Popover",
|
7888
|
-
"module": "components/popover/popover.component.js"
|
7889
|
-
}
|
7838
|
+
"description": "The ID of the element that triggers the dialog",
|
7839
|
+
"default": "undefined",
|
7840
|
+
"attribute": "triggerId",
|
7841
|
+
"reflects": true
|
7890
7842
|
},
|
7891
7843
|
{
|
7892
7844
|
"kind": "field",
|
7893
|
-
"name": "
|
7845
|
+
"name": "visible",
|
7894
7846
|
"type": {
|
7895
7847
|
"text": "boolean"
|
7896
7848
|
},
|
7897
|
-
"description": "The
|
7898
|
-
"default": "
|
7899
|
-
"attribute": "
|
7900
|
-
"reflects": true
|
7901
|
-
"inheritedFrom": {
|
7902
|
-
"name": "Popover",
|
7903
|
-
"module": "components/popover/popover.component.js"
|
7904
|
-
}
|
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
|
7905
7853
|
},
|
7906
7854
|
{
|
7907
7855
|
"kind": "field",
|
7908
|
-
"name": "
|
7856
|
+
"name": "zIndex",
|
7909
7857
|
"type": {
|
7910
|
-
"text": "
|
7858
|
+
"text": "number"
|
7911
7859
|
},
|
7912
|
-
"description": "
|
7913
|
-
"default": "
|
7914
|
-
"attribute": "
|
7915
|
-
"reflects": true
|
7916
|
-
"inheritedFrom": {
|
7917
|
-
"name": "Popover",
|
7918
|
-
"module": "components/popover/popover.component.js"
|
7919
|
-
}
|
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
|
7920
7864
|
},
|
7921
7865
|
{
|
7922
7866
|
"kind": "field",
|
7923
|
-
"name": "
|
7867
|
+
"name": "size",
|
7924
7868
|
"type": {
|
7925
|
-
"text": "
|
7869
|
+
"text": "DialogSize"
|
7926
7870
|
},
|
7927
|
-
"description": "
|
7928
|
-
"default": "
|
7929
|
-
"attribute": "
|
7930
|
-
"reflects": true
|
7931
|
-
"privacy": "protected",
|
7932
|
-
"inheritedFrom": {
|
7933
|
-
"name": "Popover",
|
7934
|
-
"module": "components/popover/popover.component.js"
|
7935
|
-
}
|
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
|
7936
7875
|
},
|
7937
7876
|
{
|
7938
|
-
"kind": "
|
7939
|
-
"name": "
|
7940
|
-
"
|
7941
|
-
|
7942
|
-
|
7943
|
-
|
7944
|
-
|
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
|
7945
7886
|
},
|
7946
7887
|
{
|
7947
|
-
"kind": "
|
7948
|
-
"name": "
|
7949
|
-
"
|
7950
|
-
|
7951
|
-
|
7952
|
-
|
7953
|
-
|
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"
|
7954
7896
|
},
|
7955
7897
|
{
|
7956
7898
|
"kind": "field",
|
7957
|
-
"name": "
|
7899
|
+
"name": "ariaLabel",
|
7958
7900
|
"type": {
|
7959
|
-
"text": "
|
7901
|
+
"text": "string | null"
|
7960
7902
|
},
|
7961
|
-
"
|
7962
|
-
"
|
7963
|
-
"attribute": "
|
7964
|
-
"reflects": true
|
7965
|
-
"privacy": "protected",
|
7966
|
-
"inheritedFrom": {
|
7967
|
-
"name": "Popover",
|
7968
|
-
"module": "components/popover/popover.component.js"
|
7969
|
-
}
|
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
|
7970
7907
|
},
|
7971
7908
|
{
|
7972
7909
|
"kind": "field",
|
7973
|
-
"name": "
|
7910
|
+
"name": "ariaLabelledby",
|
7974
7911
|
"type": {
|
7975
|
-
"text": "
|
7912
|
+
"text": "string | null"
|
7976
7913
|
},
|
7977
|
-
"default": "
|
7978
|
-
"description": "
|
7979
|
-
"attribute": "
|
7980
|
-
"reflects": true
|
7981
|
-
"inheritedFrom": {
|
7982
|
-
"name": "FocusTrapMixin",
|
7983
|
-
"module": "utils/mixins/FocusTrapMixin.js"
|
7984
|
-
}
|
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
|
7985
7918
|
},
|
7986
7919
|
{
|
7987
|
-
"kind": "
|
7988
|
-
"name": "
|
7989
|
-
"
|
7990
|
-
|
7991
|
-
|
7992
|
-
|
7993
|
-
|
7994
|
-
|
7995
|
-
|
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
|
+
}
|
8092
|
+
},
|
8093
|
+
{
|
8094
|
+
"kind": "method",
|
8095
|
+
"name": "setIsFocusTrapActivated",
|
8096
|
+
"privacy": "private",
|
8097
|
+
"parameters": [
|
8098
|
+
{
|
8099
|
+
"name": "isActivated",
|
8100
|
+
"type": {
|
8101
|
+
"text": "boolean"
|
8102
|
+
}
|
7996
8103
|
}
|
7997
8104
|
],
|
7998
8105
|
"inheritedFrom": {
|
@@ -8465,374 +8572,365 @@
|
|
8465
8572
|
}
|
8466
8573
|
},
|
8467
8574
|
{
|
8468
|
-
"kind": "
|
8469
|
-
"name": "
|
8470
|
-
"
|
8471
|
-
|
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
|
+
}
|
8472
8583
|
},
|
8473
|
-
"default": "''",
|
8474
|
-
"description": "The unique ID of the popover.",
|
8475
|
-
"attribute": "id",
|
8476
|
-
"reflects": true,
|
8477
8584
|
"inheritedFrom": {
|
8478
|
-
"name": "
|
8479
|
-
"module": "
|
8585
|
+
"name": "CardAndDialogFooterMixin",
|
8586
|
+
"module": "utils/mixins/CardAndDialogFooterMixin.js"
|
8480
8587
|
}
|
8588
|
+
}
|
8589
|
+
],
|
8590
|
+
"events": [
|
8591
|
+
{
|
8592
|
+
"description": "(React: onShown) Dispatched when the dialog is shown",
|
8593
|
+
"name": "shown",
|
8594
|
+
"reactName": "onShown"
|
8481
8595
|
},
|
8482
8596
|
{
|
8483
|
-
"
|
8484
|
-
"name": "
|
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
|
+
{
|
8619
|
+
"name": "id",
|
8485
8620
|
"type": {
|
8486
8621
|
"text": "string"
|
8487
8622
|
},
|
8488
8623
|
"default": "''",
|
8489
|
-
"description": "The ID of the
|
8490
|
-
"
|
8491
|
-
"reflects": true,
|
8492
|
-
"inheritedFrom": {
|
8493
|
-
"name": "Popover",
|
8494
|
-
"module": "components/popover/popover.component.js"
|
8495
|
-
}
|
8624
|
+
"description": "The unique ID of the dialog",
|
8625
|
+
"fieldName": "id"
|
8496
8626
|
},
|
8497
8627
|
{
|
8498
|
-
"
|
8499
|
-
"name": "placement",
|
8628
|
+
"name": "triggerId",
|
8500
8629
|
"type": {
|
8501
|
-
"text": "
|
8630
|
+
"text": "string | undefined"
|
8502
8631
|
},
|
8503
|
-
"description": "The
|
8504
|
-
"default": "
|
8505
|
-
"
|
8506
|
-
"reflects": true,
|
8507
|
-
"inheritedFrom": {
|
8508
|
-
"name": "Popover",
|
8509
|
-
"module": "components/popover/popover.component.js"
|
8510
|
-
}
|
8511
|
-
},
|
8512
|
-
{
|
8513
|
-
"kind": "field",
|
8514
|
-
"name": "color",
|
8515
|
-
"type": {
|
8516
|
-
"text": "PopoverColor"
|
8517
|
-
},
|
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
|
-
}
|
8632
|
+
"description": "The ID of the element that triggers the dialog",
|
8633
|
+
"default": "undefined",
|
8634
|
+
"fieldName": "triggerId"
|
8526
8635
|
},
|
8527
8636
|
{
|
8528
|
-
"kind": "field",
|
8529
8637
|
"name": "visible",
|
8530
8638
|
"type": {
|
8531
8639
|
"text": "boolean"
|
8532
8640
|
},
|
8533
|
-
"description": "The visibility of the
|
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.",
|
8534
8642
|
"default": "false",
|
8535
|
-
"
|
8536
|
-
"reflects": true,
|
8537
|
-
"inheritedFrom": {
|
8538
|
-
"name": "Popover",
|
8539
|
-
"module": "components/popover/popover.component.js"
|
8540
|
-
}
|
8643
|
+
"fieldName": "visible"
|
8541
8644
|
},
|
8542
8645
|
{
|
8543
|
-
"
|
8544
|
-
"name": "offset",
|
8646
|
+
"name": "z-index",
|
8545
8647
|
"type": {
|
8546
8648
|
"text": "number"
|
8547
8649
|
},
|
8548
|
-
"description": "The
|
8549
|
-
"default": "
|
8550
|
-
"
|
8551
|
-
"reflects": true,
|
8552
|
-
"inheritedFrom": {
|
8553
|
-
"name": "Popover",
|
8554
|
-
"module": "components/popover/popover.component.js"
|
8555
|
-
}
|
8650
|
+
"description": "The z-index of the dialog\n\nThe backdrop will have z-index of `zIndex - 1`",
|
8651
|
+
"default": "1000",
|
8652
|
+
"fieldName": "zIndex"
|
8556
8653
|
},
|
8557
8654
|
{
|
8558
|
-
"
|
8559
|
-
"name": "boundary",
|
8655
|
+
"name": "size",
|
8560
8656
|
"type": {
|
8561
|
-
"text": "
|
8657
|
+
"text": "DialogSize"
|
8562
8658
|
},
|
8563
|
-
"description": "
|
8564
|
-
"default": "
|
8565
|
-
"
|
8566
|
-
"reflects": true,
|
8567
|
-
"inheritedFrom": {
|
8568
|
-
"name": "Popover",
|
8569
|
-
"module": "components/popover/popover.component.js"
|
8570
|
-
}
|
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"
|
8571
8662
|
},
|
8572
8663
|
{
|
8573
|
-
"
|
8574
|
-
"name": "boundaryRoot",
|
8664
|
+
"name": "variant",
|
8575
8665
|
"type": {
|
8576
|
-
"text": "
|
8666
|
+
"text": "DialogVariant"
|
8577
8667
|
},
|
8578
|
-
"description": "
|
8579
|
-
"default": "
|
8580
|
-
"
|
8581
|
-
"reflects": true,
|
8582
|
-
"inheritedFrom": {
|
8583
|
-
"name": "Popover",
|
8584
|
-
"module": "components/popover/popover.component.js"
|
8585
|
-
}
|
8668
|
+
"description": "The variant of the dialog, can be 'default' or 'promotional'",
|
8669
|
+
"default": "default",
|
8670
|
+
"fieldName": "variant"
|
8586
8671
|
},
|
8587
8672
|
{
|
8588
|
-
"
|
8589
|
-
"name": "boundaryPadding",
|
8673
|
+
"name": "close-button-aria-label",
|
8590
8674
|
"type": {
|
8591
|
-
"text": "
|
8675
|
+
"text": "string | null"
|
8592
8676
|
},
|
8593
|
-
"
|
8594
|
-
"
|
8595
|
-
"
|
8596
|
-
"reflects": true,
|
8597
|
-
"inheritedFrom": {
|
8598
|
-
"name": "Popover",
|
8599
|
-
"module": "components/popover/popover.component.js"
|
8600
|
-
}
|
8677
|
+
"default": "null",
|
8678
|
+
"description": "Defines a string value for the aria-label attribute for close button accessibility",
|
8679
|
+
"fieldName": "closeButtonAriaLabel"
|
8601
8680
|
},
|
8602
8681
|
{
|
8603
|
-
"
|
8604
|
-
"name": "interactive",
|
8682
|
+
"name": "aria-label",
|
8605
8683
|
"type": {
|
8606
|
-
"text": "
|
8684
|
+
"text": "string | null"
|
8607
8685
|
},
|
8608
|
-
"
|
8609
|
-
"
|
8610
|
-
"
|
8611
|
-
"reflects": true,
|
8612
|
-
"inheritedFrom": {
|
8613
|
-
"name": "Popover",
|
8614
|
-
"module": "components/popover/popover.component.js"
|
8615
|
-
}
|
8686
|
+
"default": "null",
|
8687
|
+
"description": "Defines a string value for the aria-label attribute when header is not used",
|
8688
|
+
"fieldName": "ariaLabel"
|
8616
8689
|
},
|
8617
8690
|
{
|
8618
|
-
"
|
8619
|
-
"name": "delay",
|
8691
|
+
"name": "aria-labelledby",
|
8620
8692
|
"type": {
|
8621
|
-
"text": "string"
|
8693
|
+
"text": "string | null"
|
8622
8694
|
},
|
8623
|
-
"
|
8624
|
-
"
|
8625
|
-
"
|
8626
|
-
"reflects": true,
|
8627
|
-
"inheritedFrom": {
|
8628
|
-
"name": "Popover",
|
8629
|
-
"module": "components/popover/popover.component.js"
|
8630
|
-
}
|
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"
|
8631
8698
|
},
|
8632
8699
|
{
|
8633
|
-
"
|
8634
|
-
"name": "hideOnEscape",
|
8700
|
+
"name": "aria-describedby",
|
8635
8701
|
"type": {
|
8636
|
-
"text": "
|
8702
|
+
"text": "string | null"
|
8637
8703
|
},
|
8638
|
-
"
|
8639
|
-
"
|
8640
|
-
"
|
8641
|
-
"reflects": true,
|
8642
|
-
"inheritedFrom": {
|
8643
|
-
"name": "Popover",
|
8644
|
-
"module": "components/popover/popover.component.js"
|
8645
|
-
}
|
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"
|
8646
8707
|
},
|
8647
8708
|
{
|
8648
|
-
"
|
8649
|
-
"name": "propagateEventOnEscape",
|
8709
|
+
"name": "aria-description",
|
8650
8710
|
"type": {
|
8651
|
-
"text": "
|
8711
|
+
"text": "string | null"
|
8652
8712
|
},
|
8653
|
-
"
|
8654
|
-
"
|
8655
|
-
"
|
8656
|
-
"reflects": true,
|
8657
|
-
"inheritedFrom": {
|
8658
|
-
"name": "Popover",
|
8659
|
-
"module": "components/popover/popover.component.js"
|
8660
|
-
}
|
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"
|
8661
8716
|
},
|
8662
8717
|
{
|
8663
|
-
"
|
8664
|
-
"name": "hideOnBlur",
|
8718
|
+
"name": "header-text",
|
8665
8719
|
"type": {
|
8666
|
-
"text": "
|
8720
|
+
"text": "string | undefined"
|
8667
8721
|
},
|
8668
|
-
"description": "
|
8669
|
-
"
|
8670
|
-
"attribute": "hide-on-blur",
|
8671
|
-
"reflects": true,
|
8672
|
-
"inheritedFrom": {
|
8673
|
-
"name": "Popover",
|
8674
|
-
"module": "components/popover/popover.component.js"
|
8675
|
-
}
|
8722
|
+
"description": "Defines a string value to display as the title of the dialog",
|
8723
|
+
"fieldName": "headerText"
|
8676
8724
|
},
|
8677
8725
|
{
|
8678
|
-
"
|
8679
|
-
"name": "hideOnOutsideClick",
|
8726
|
+
"name": "description-text",
|
8680
8727
|
"type": {
|
8681
|
-
"text": "
|
8728
|
+
"text": "string | undefined"
|
8682
8729
|
},
|
8683
|
-
"description": "
|
8684
|
-
"
|
8685
|
-
"attribute": "hide-on-outside-click",
|
8686
|
-
"reflects": true,
|
8687
|
-
"inheritedFrom": {
|
8688
|
-
"name": "Popover",
|
8689
|
-
"module": "components/popover/popover.component.js"
|
8690
|
-
}
|
8730
|
+
"description": "Defines a string value to display as the under-header description of the dialog",
|
8731
|
+
"fieldName": "descriptionText"
|
8691
8732
|
},
|
8692
8733
|
{
|
8693
|
-
"
|
8694
|
-
"name": "focusBackToTrigger",
|
8734
|
+
"name": "header-tag-name",
|
8695
8735
|
"type": {
|
8696
|
-
"text": "
|
8736
|
+
"text": "string"
|
8697
8737
|
},
|
8698
|
-
"description": "The
|
8699
|
-
"
|
8700
|
-
"attribute": "focus-back-to-trigger",
|
8701
|
-
"reflects": true,
|
8702
|
-
"inheritedFrom": {
|
8703
|
-
"name": "Popover",
|
8704
|
-
"module": "components/popover/popover.component.js"
|
8705
|
-
}
|
8738
|
+
"description": "The html tag to be used for the header text",
|
8739
|
+
"fieldName": "headerTagName"
|
8706
8740
|
},
|
8707
8741
|
{
|
8708
|
-
"
|
8709
|
-
"
|
8742
|
+
"name": "description-tag-name",
|
8743
|
+
"type": {
|
8744
|
+
"text": "string"
|
8745
|
+
},
|
8746
|
+
"description": "The html tag to be used for the below-header description text",
|
8747
|
+
"fieldName": "descriptionTagName"
|
8748
|
+
},
|
8749
|
+
{
|
8750
|
+
"name": "role",
|
8751
|
+
"type": {
|
8752
|
+
"text": "DialogRole"
|
8753
|
+
},
|
8754
|
+
"description": "Role of the dialog",
|
8755
|
+
"default": "dialog",
|
8756
|
+
"fieldName": "role"
|
8757
|
+
},
|
8758
|
+
{
|
8759
|
+
"name": "disable-aria-haspopup",
|
8710
8760
|
"type": {
|
8711
8761
|
"text": "boolean"
|
8712
8762
|
},
|
8713
|
-
"description": "
|
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.",
|
8714
8764
|
"default": "false",
|
8715
|
-
"
|
8716
|
-
"reflects": true,
|
8717
|
-
"inheritedFrom": {
|
8718
|
-
"name": "Popover",
|
8719
|
-
"module": "components/popover/popover.component.js"
|
8720
|
-
}
|
8765
|
+
"fieldName": "disableAriaHasPopup"
|
8721
8766
|
},
|
8722
8767
|
{
|
8723
|
-
"
|
8724
|
-
"name": "flip",
|
8768
|
+
"name": "focus-trap",
|
8725
8769
|
"type": {
|
8726
8770
|
"text": "boolean"
|
8727
8771
|
},
|
8728
|
-
"description": "
|
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.",
|
8729
8773
|
"default": "true",
|
8730
|
-
"
|
8731
|
-
"reflects": true,
|
8732
|
-
"inheritedFrom": {
|
8733
|
-
"name": "Popover",
|
8734
|
-
"module": "components/popover/popover.component.js"
|
8735
|
-
}
|
8774
|
+
"fieldName": "focusTrap"
|
8736
8775
|
},
|
8737
8776
|
{
|
8738
|
-
"
|
8739
|
-
"name": "size",
|
8777
|
+
"name": "should-focus-trap-wrap",
|
8740
8778
|
"type": {
|
8741
8779
|
"text": "boolean"
|
8742
8780
|
},
|
8743
|
-
"
|
8744
|
-
"
|
8745
|
-
"
|
8746
|
-
"reflects": true,
|
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",
|
8747
8784
|
"inheritedFrom": {
|
8748
|
-
"name": "
|
8749
|
-
"module": "
|
8785
|
+
"name": "FocusTrapMixin",
|
8786
|
+
"module": "src/utils/mixins/FocusTrapMixin.ts"
|
8750
8787
|
}
|
8751
|
-
}
|
8788
|
+
}
|
8789
|
+
],
|
8790
|
+
"mixins": [
|
8752
8791
|
{
|
8753
|
-
"
|
8754
|
-
"
|
8755
|
-
|
8756
|
-
|
8757
|
-
|
8758
|
-
"
|
8759
|
-
|
8760
|
-
|
8761
|
-
"
|
8792
|
+
"name": "PreventScrollMixin",
|
8793
|
+
"module": "/src/utils/mixins/PreventScrollMixin"
|
8794
|
+
},
|
8795
|
+
{
|
8796
|
+
"name": "FocusTrapMixin",
|
8797
|
+
"module": "/src/utils/mixins/FocusTrapMixin"
|
8798
|
+
},
|
8799
|
+
{
|
8800
|
+
"name": "CardAndDialogFooterMixin",
|
8801
|
+
"module": "/src/utils/mixins/CardAndDialogFooterMixin"
|
8802
|
+
}
|
8803
|
+
],
|
8804
|
+
"superclass": {
|
8805
|
+
"name": "Component",
|
8806
|
+
"module": "/src/models"
|
8807
|
+
},
|
8808
|
+
"tagName": "mdc-dialog",
|
8809
|
+
"jsDoc": "/**\n * Dialog component is a modal dialog that can be used to display information or prompt the user for input.\n * It can be used to create custom dialogs where content for the body and footer actions is provided by the consumer.\n * The dialog is available in 5 sizes: small, medium, large, xlarge and fullscreen. It may also receive custom styling/sizing.\n * The dialog interrupts the user and will block interaction with the rest of the application until it is closed.\n *\n * The dialog can be controlled solely through the `visible` property, no trigger element is required.\n * If a `triggerId` is provided, the dialog will manage focus with that element, otherwise it will\n * remember the previously focused element before the dialog was opened.\n *\n * The dialog is a controlled component, meaning it does not have its own state management for visibility.\n * Use the `visible` property to control the visibility of the dialog.\n * Use the `onClose` event to handle the close action of the dialog (fired when Close button is clicked\n * or Escape is pressed).\n *\n * Dialog component have 2 variants: default and promotional.\n *\n * **Accessibility notes for consuming (have to be explicitly set when you consume the component)**\n *\n * - The dialog should have an aria-label or aria-labelledby attribute to provide a label for screen readers.\n * - Use aria-labelledby to reference the ID of the element that labels the dialog when there is no visible title.\n *\n * **Note: Programmatic show/hide requires the ? prefix on the visible attribute**\n * - Use `?visible=true/false` as an attribute instead of `visible=true/false`\n * - Reference docs for more info: https://lit.dev/docs/templates/expressions/#boolean-attribute-expressions\n *\n * @dependency mdc-button\n * @dependency mdc-text\n *\n * @tagname mdc-dialog\n *\n * @event shown - (React: onShown) Dispatched when the dialog is shown\n * @event hidden - (React: onHidden) Dispatched when the dialog is hidden\n * @event created - (React: onCreated) Dispatched when the dialog is created (added to the DOM)\n * @event destroyed - (React: onDestroyed) Dispatched when the dialog is destroyed (removed from the DOM)\n * @event close - (React: onClose) Dispatched when the Close Button is clicked or Escape key is pressed\n * (this does not hide the dialog)\n *\n * @cssproperty --mdc-dialog-primary-background-color - primary background color of the dialog\n * @cssproperty --mdc-dialog-border-color - border color of the dialog\n * @cssproperty --mdc-dialog-header-text-color - text color of the header/title of the dialog\n * @cssproperty --mdc-dialog-description-text-color - text color of the below header description of the dialog\n * @cssproperty --mdc-dialog-elevation-3 - elevation of the dialog\n * @cssproperty --mdc-dialog-width - width of the dialog\n *\n * @slot header-prefix - Slot for the dialog header content. This can be used to pass custom header content.\n * @slot dialog-body - Slot for the dialog body content\n * @slot footer-link - This slot is for passing `mdc-link` component within the footer section.\n * @slot footer-button-secondary - This slot is for passing secondary variant of `mdc-button` component\n * within the footer section.\n * @slot footer-button-primary - This slot is for passing primary variant of\n * `mdc-button` component within the footer section.\n * @slot footer - This slot is for passing custom footer content. Only use this if really needed,\n * using the footer-link and footer-button slots is preferred\n */",
|
8810
|
+
"customElement": true
|
8811
|
+
}
|
8812
|
+
],
|
8813
|
+
"exports": [
|
8814
|
+
{
|
8815
|
+
"kind": "js",
|
8816
|
+
"name": "default",
|
8817
|
+
"declaration": {
|
8818
|
+
"name": "Dialog",
|
8819
|
+
"module": "components/dialog/dialog.component.js"
|
8820
|
+
}
|
8821
|
+
}
|
8822
|
+
]
|
8823
|
+
},
|
8824
|
+
{
|
8825
|
+
"kind": "javascript-module",
|
8826
|
+
"path": "components/coachmark/coachmark.component.js",
|
8827
|
+
"declarations": [
|
8828
|
+
{
|
8829
|
+
"kind": "class",
|
8830
|
+
"description": "Coachmark component based on top of the popover component,\nwith the default value of certain properties changed.",
|
8831
|
+
"name": "Coachmark",
|
8832
|
+
"cssProperties": [
|
8833
|
+
{
|
8834
|
+
"description": "radius of the arrow border",
|
8835
|
+
"name": "--mdc-popover-arrow-border-radius",
|
8762
8836
|
"inheritedFrom": {
|
8763
8837
|
"name": "Popover",
|
8764
|
-
"module": "components/popover/popover.component.
|
8838
|
+
"module": "src/components/popover/popover.component.ts"
|
8765
8839
|
}
|
8766
8840
|
},
|
8767
8841
|
{
|
8768
|
-
"
|
8769
|
-
"name": "
|
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,
|
8842
|
+
"description": "border of the arrow",
|
8843
|
+
"name": "--mdc-popover-arrow-border",
|
8777
8844
|
"inheritedFrom": {
|
8778
8845
|
"name": "Popover",
|
8779
|
-
"module": "components/popover/popover.component.
|
8846
|
+
"module": "src/components/popover/popover.component.ts"
|
8780
8847
|
}
|
8781
8848
|
},
|
8782
8849
|
{
|
8783
|
-
"
|
8784
|
-
"name": "
|
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,
|
8850
|
+
"description": "primary background color of the popover",
|
8851
|
+
"name": "--mdc-popover-primary-background-color",
|
8792
8852
|
"inheritedFrom": {
|
8793
8853
|
"name": "Popover",
|
8794
|
-
"module": "components/popover/popover.component.
|
8854
|
+
"module": "src/components/popover/popover.component.ts"
|
8795
8855
|
}
|
8796
8856
|
},
|
8797
8857
|
{
|
8798
|
-
"
|
8799
|
-
"name": "
|
8800
|
-
"type": {
|
8801
|
-
"text": "HTMLElement['role']"
|
8802
|
-
},
|
8803
|
-
"description": "Role of the popover",
|
8804
|
-
"default": "dialog",
|
8805
|
-
"attribute": "role",
|
8806
|
-
"reflects": true,
|
8858
|
+
"description": "border color of the popover",
|
8859
|
+
"name": "--mdc-popover-border-color",
|
8807
8860
|
"inheritedFrom": {
|
8808
8861
|
"name": "Popover",
|
8809
|
-
"module": "components/popover/popover.component.
|
8862
|
+
"module": "src/components/popover/popover.component.ts"
|
8810
8863
|
}
|
8811
8864
|
},
|
8812
8865
|
{
|
8813
|
-
"
|
8814
|
-
"name": "
|
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,
|
8866
|
+
"description": "inverted background color of the popover",
|
8867
|
+
"name": "--mdc-popover-inverted-background-color",
|
8822
8868
|
"inheritedFrom": {
|
8823
8869
|
"name": "Popover",
|
8824
|
-
"module": "components/popover/popover.component.
|
8870
|
+
"module": "src/components/popover/popover.component.ts"
|
8871
|
+
}
|
8872
|
+
},
|
8873
|
+
{
|
8874
|
+
"description": "inverted border color of the popover",
|
8875
|
+
"name": "--mdc-popover-inverted-border-color",
|
8876
|
+
"inheritedFrom": {
|
8877
|
+
"name": "Popover",
|
8878
|
+
"module": "src/components/popover/popover.component.ts"
|
8879
|
+
}
|
8880
|
+
},
|
8881
|
+
{
|
8882
|
+
"description": "inverted text color of the popover",
|
8883
|
+
"name": "--mdc-popover-inverted-text-color",
|
8884
|
+
"inheritedFrom": {
|
8885
|
+
"name": "Popover",
|
8886
|
+
"module": "src/components/popover/popover.component.ts"
|
8887
|
+
}
|
8888
|
+
},
|
8889
|
+
{
|
8890
|
+
"description": "elevation of the popover",
|
8891
|
+
"name": "--mdc-popover-elevation-3",
|
8892
|
+
"inheritedFrom": {
|
8893
|
+
"name": "Popover",
|
8894
|
+
"module": "src/components/popover/popover.component.ts"
|
8895
|
+
}
|
8896
|
+
},
|
8897
|
+
{
|
8898
|
+
"description": "max width of the popover",
|
8899
|
+
"name": "--mdc-popover-max-width",
|
8900
|
+
"inheritedFrom": {
|
8901
|
+
"name": "Popover",
|
8902
|
+
"module": "src/components/popover/popover.component.ts"
|
8825
8903
|
}
|
8826
8904
|
},
|
8905
|
+
{
|
8906
|
+
"description": "max height of the popover",
|
8907
|
+
"name": "--mdc-popover-max-height",
|
8908
|
+
"inheritedFrom": {
|
8909
|
+
"name": "Popover",
|
8910
|
+
"module": "src/components/popover/popover.component.ts"
|
8911
|
+
}
|
8912
|
+
}
|
8913
|
+
],
|
8914
|
+
"slots": [
|
8915
|
+
{
|
8916
|
+
"description": "Default slot for modal container",
|
8917
|
+
"name": "",
|
8918
|
+
"inheritedFrom": {
|
8919
|
+
"name": "Popover",
|
8920
|
+
"module": "src/components/popover/popover.component.ts"
|
8921
|
+
}
|
8922
|
+
}
|
8923
|
+
],
|
8924
|
+
"members": [
|
8827
8925
|
{
|
8828
8926
|
"kind": "field",
|
8829
|
-
"name": "
|
8927
|
+
"name": "trigger",
|
8830
8928
|
"type": {
|
8831
|
-
"text": "
|
8929
|
+
"text": "PopoverTrigger"
|
8832
8930
|
},
|
8833
|
-
"
|
8834
|
-
"
|
8835
|
-
"attribute": "
|
8931
|
+
"description": "Determines the events that cause the Coachmark to show.\nMultiple event names should be separated by spaces.\nFor example to allow both click and hover, use 'click mouseenter' as the trigger.\n- **click**\n- **mouseenter**\n- **focusin**\n- **manual**",
|
8932
|
+
"default": "manual",
|
8933
|
+
"attribute": "trigger",
|
8836
8934
|
"reflects": true,
|
8837
8935
|
"inheritedFrom": {
|
8838
8936
|
"name": "Popover",
|
@@ -8841,13 +8939,13 @@
|
|
8841
8939
|
},
|
8842
8940
|
{
|
8843
8941
|
"kind": "field",
|
8844
|
-
"name": "
|
8942
|
+
"name": "showArrow",
|
8845
8943
|
"type": {
|
8846
8944
|
"text": "boolean"
|
8847
8945
|
},
|
8848
|
-
"description": "
|
8849
|
-
"default": "
|
8850
|
-
"attribute": "
|
8946
|
+
"description": "The arrow visibility of the Coachmark.",
|
8947
|
+
"default": "true",
|
8948
|
+
"attribute": "show-arrow",
|
8851
8949
|
"reflects": true,
|
8852
8950
|
"inheritedFrom": {
|
8853
8951
|
"name": "Popover",
|
@@ -8856,12 +8954,14 @@
|
|
8856
8954
|
},
|
8857
8955
|
{
|
8858
8956
|
"kind": "field",
|
8859
|
-
"name": "
|
8957
|
+
"name": "closeButton",
|
8860
8958
|
"type": {
|
8861
|
-
"text": "
|
8959
|
+
"text": "boolean"
|
8862
8960
|
},
|
8863
|
-
"
|
8864
|
-
"default": "
|
8961
|
+
"description": "The close button visibility of the Coachmark.",
|
8962
|
+
"default": "true",
|
8963
|
+
"attribute": "close-button",
|
8964
|
+
"reflects": true,
|
8865
8965
|
"inheritedFrom": {
|
8866
8966
|
"name": "Popover",
|
8867
8967
|
"module": "components/popover/popover.component.js"
|
@@ -8869,22 +8969,30 @@
|
|
8869
8969
|
},
|
8870
8970
|
{
|
8871
8971
|
"kind": "field",
|
8872
|
-
"name": "
|
8972
|
+
"name": "disableAriaExpanded",
|
8873
8973
|
"type": {
|
8874
|
-
"text": "
|
8974
|
+
"text": "boolean"
|
8875
8975
|
},
|
8876
|
-
"
|
8877
|
-
"default": "
|
8976
|
+
"description": "Disable aria-expanded attribute on trigger element.",
|
8977
|
+
"default": "true",
|
8978
|
+
"attribute": "disable-aria-expanded",
|
8979
|
+
"reflects": true,
|
8878
8980
|
"inheritedFrom": {
|
8879
8981
|
"name": "Popover",
|
8880
8982
|
"module": "components/popover/popover.component.js"
|
8881
8983
|
}
|
8882
8984
|
},
|
8883
8985
|
{
|
8884
|
-
"kind": "
|
8885
|
-
"name": "
|
8886
|
-
"
|
8887
|
-
|
8986
|
+
"kind": "field",
|
8987
|
+
"name": "preventScroll",
|
8988
|
+
"type": {
|
8989
|
+
"text": "boolean"
|
8990
|
+
},
|
8991
|
+
"description": "Prevent outside scrolling when element is shown.\n\nIMPLEMENT THIS IN YOUR COMPONENT.",
|
8992
|
+
"default": "false",
|
8993
|
+
"attribute": "prevent-scroll",
|
8994
|
+
"reflects": true,
|
8995
|
+
"privacy": "protected",
|
8888
8996
|
"inheritedFrom": {
|
8889
8997
|
"name": "Popover",
|
8890
8998
|
"module": "components/popover/popover.component.js"
|
@@ -8892,41 +9000,33 @@
|
|
8892
9000
|
},
|
8893
9001
|
{
|
8894
9002
|
"kind": "method",
|
8895
|
-
"name": "
|
8896
|
-
"privacy": "
|
8897
|
-
"description": "Removes the trigger event listeners.",
|
9003
|
+
"name": "activatePreventScroll",
|
9004
|
+
"privacy": "protected",
|
8898
9005
|
"inheritedFrom": {
|
8899
|
-
"name": "
|
8900
|
-
"module": "
|
9006
|
+
"name": "PreventScrollMixin",
|
9007
|
+
"module": "utils/mixins/PreventScrollMixin.js"
|
8901
9008
|
}
|
8902
9009
|
},
|
8903
9010
|
{
|
8904
|
-
"kind": "
|
8905
|
-
"name": "
|
9011
|
+
"kind": "method",
|
9012
|
+
"name": "deactivatePreventScroll",
|
8906
9013
|
"privacy": "protected",
|
8907
|
-
"description": "Handles the outside click event to close the popover.",
|
8908
|
-
"parameters": [
|
8909
|
-
{
|
8910
|
-
"description": "The mouse event.",
|
8911
|
-
"name": "event"
|
8912
|
-
}
|
8913
|
-
],
|
8914
9014
|
"inheritedFrom": {
|
8915
|
-
"name": "
|
8916
|
-
"module": "
|
9015
|
+
"name": "PreventScrollMixin",
|
9016
|
+
"module": "utils/mixins/PreventScrollMixin.js"
|
8917
9017
|
}
|
8918
9018
|
},
|
8919
9019
|
{
|
8920
9020
|
"kind": "field",
|
8921
|
-
"name": "
|
8922
|
-
"
|
8923
|
-
|
8924
|
-
|
8925
|
-
|
8926
|
-
|
8927
|
-
|
8928
|
-
|
8929
|
-
|
9021
|
+
"name": "focusTrap",
|
9022
|
+
"type": {
|
9023
|
+
"text": "boolean"
|
9024
|
+
},
|
9025
|
+
"description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.\n\nIMPLEMENT THIS IN YOUR COMPONENT.",
|
9026
|
+
"default": "false",
|
9027
|
+
"attribute": "focus-trap",
|
9028
|
+
"reflects": true,
|
9029
|
+
"privacy": "protected",
|
8930
9030
|
"inheritedFrom": {
|
8931
9031
|
"name": "Popover",
|
8932
9032
|
"module": "components/popover/popover.component.js"
|
@@ -8934,720 +9034,500 @@
|
|
8934
9034
|
},
|
8935
9035
|
{
|
8936
9036
|
"kind": "field",
|
8937
|
-
"name": "
|
8938
|
-
"
|
8939
|
-
|
8940
|
-
|
8941
|
-
|
8942
|
-
|
8943
|
-
|
8944
|
-
|
8945
|
-
],
|
9037
|
+
"name": "shouldFocusTrapWrap",
|
9038
|
+
"type": {
|
9039
|
+
"text": "boolean"
|
9040
|
+
},
|
9041
|
+
"default": "true",
|
9042
|
+
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `focusTrap` is true.",
|
9043
|
+
"attribute": "should-focus-trap-wrap",
|
9044
|
+
"reflects": true,
|
8946
9045
|
"inheritedFrom": {
|
8947
|
-
"name": "
|
8948
|
-
"module": "
|
9046
|
+
"name": "FocusTrapMixin",
|
9047
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
8949
9048
|
}
|
8950
9049
|
},
|
8951
9050
|
{
|
8952
9051
|
"kind": "method",
|
8953
|
-
"name": "
|
8954
|
-
"privacy": "
|
9052
|
+
"name": "setIsFocusTrapActivated",
|
9053
|
+
"privacy": "private",
|
8955
9054
|
"parameters": [
|
8956
9055
|
{
|
8957
|
-
"name": "
|
8958
|
-
"type": {
|
8959
|
-
"text": "boolean"
|
8960
|
-
},
|
8961
|
-
"description": "The old value of the visible property."
|
8962
|
-
},
|
8963
|
-
{
|
8964
|
-
"name": "newValue",
|
9056
|
+
"name": "isActivated",
|
8965
9057
|
"type": {
|
8966
9058
|
"text": "boolean"
|
8967
|
-
}
|
8968
|
-
"description": "The new value of the visible property."
|
9059
|
+
}
|
8969
9060
|
}
|
8970
9061
|
],
|
8971
|
-
"description": "Handles the popover visibility change and position the popover.\nHandles the exit event to close the popover.",
|
8972
9062
|
"inheritedFrom": {
|
8973
|
-
"name": "
|
8974
|
-
"module": "
|
9063
|
+
"name": "FocusTrapMixin",
|
9064
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
8975
9065
|
}
|
8976
9066
|
},
|
8977
9067
|
{
|
8978
|
-
"kind": "
|
8979
|
-
"name": "
|
8980
|
-
"privacy": "
|
8981
|
-
"description": "
|
9068
|
+
"kind": "method",
|
9069
|
+
"name": "activateFocusTrap",
|
9070
|
+
"privacy": "public",
|
9071
|
+
"description": "Activate the focus trap",
|
8982
9072
|
"inheritedFrom": {
|
8983
|
-
"name": "
|
8984
|
-
"module": "
|
9073
|
+
"name": "FocusTrapMixin",
|
9074
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
8985
9075
|
}
|
8986
9076
|
},
|
8987
9077
|
{
|
8988
|
-
"kind": "
|
8989
|
-
"name": "
|
8990
|
-
"privacy": "
|
8991
|
-
"description": "
|
9078
|
+
"kind": "method",
|
9079
|
+
"name": "deactivateFocusTrap",
|
9080
|
+
"privacy": "public",
|
9081
|
+
"description": "Deactivate the focus trap.",
|
8992
9082
|
"inheritedFrom": {
|
8993
|
-
"name": "
|
8994
|
-
"module": "
|
9083
|
+
"name": "FocusTrapMixin",
|
9084
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
8995
9085
|
}
|
8996
9086
|
},
|
8997
9087
|
{
|
8998
|
-
"kind": "
|
8999
|
-
"name": "
|
9088
|
+
"kind": "method",
|
9089
|
+
"name": "hasNoClientRects",
|
9000
9090
|
"privacy": "private",
|
9001
|
-
"
|
9091
|
+
"parameters": [
|
9092
|
+
{
|
9093
|
+
"name": "element",
|
9094
|
+
"type": {
|
9095
|
+
"text": "HTMLElement"
|
9096
|
+
},
|
9097
|
+
"description": "The element to check."
|
9098
|
+
}
|
9099
|
+
],
|
9100
|
+
"description": "Checks if the element has no client rectangles (not visible in the viewport).",
|
9101
|
+
"return": {
|
9102
|
+
"type": {
|
9103
|
+
"text": ""
|
9104
|
+
}
|
9105
|
+
},
|
9002
9106
|
"inheritedFrom": {
|
9003
|
-
"name": "
|
9004
|
-
"module": "
|
9107
|
+
"name": "FocusTrapMixin",
|
9108
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
9005
9109
|
}
|
9006
9110
|
},
|
9007
9111
|
{
|
9008
|
-
"kind": "
|
9009
|
-
"name": "
|
9112
|
+
"kind": "method",
|
9113
|
+
"name": "hasZeroDimensions",
|
9010
9114
|
"privacy": "private",
|
9011
|
-
"
|
9115
|
+
"parameters": [
|
9116
|
+
{
|
9117
|
+
"name": "element",
|
9118
|
+
"type": {
|
9119
|
+
"text": "HTMLElement"
|
9120
|
+
},
|
9121
|
+
"description": "The element to check."
|
9122
|
+
}
|
9123
|
+
],
|
9124
|
+
"description": "Checks if the element has zero dimensions (width and height are both 0).",
|
9125
|
+
"return": {
|
9126
|
+
"type": {
|
9127
|
+
"text": ""
|
9128
|
+
}
|
9129
|
+
},
|
9012
9130
|
"inheritedFrom": {
|
9013
|
-
"name": "
|
9014
|
-
"module": "
|
9131
|
+
"name": "FocusTrapMixin",
|
9132
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
9015
9133
|
}
|
9016
9134
|
},
|
9017
9135
|
{
|
9018
|
-
"kind": "
|
9019
|
-
"name": "
|
9136
|
+
"kind": "method",
|
9137
|
+
"name": "isNotVisible",
|
9020
9138
|
"privacy": "private",
|
9021
|
-
"
|
9022
|
-
|
9023
|
-
|
9024
|
-
|
9025
|
-
|
9026
|
-
|
9027
|
-
|
9028
|
-
|
9029
|
-
|
9030
|
-
"
|
9031
|
-
"
|
9032
|
-
|
9033
|
-
|
9034
|
-
|
9035
|
-
}
|
9036
|
-
},
|
9037
|
-
{
|
9038
|
-
"kind": "field",
|
9039
|
-
"name": "hidePopover",
|
9040
|
-
"privacy": "public",
|
9041
|
-
"description": "Hides the popover.",
|
9139
|
+
"parameters": [
|
9140
|
+
{
|
9141
|
+
"name": "element",
|
9142
|
+
"type": {
|
9143
|
+
"text": "HTMLElement"
|
9144
|
+
},
|
9145
|
+
"description": "The element to check."
|
9146
|
+
}
|
9147
|
+
],
|
9148
|
+
"description": "Determines if the element is not visible in the DOM.",
|
9149
|
+
"return": {
|
9150
|
+
"type": {
|
9151
|
+
"text": ""
|
9152
|
+
}
|
9153
|
+
},
|
9042
9154
|
"inheritedFrom": {
|
9043
|
-
"name": "
|
9044
|
-
"module": "
|
9155
|
+
"name": "FocusTrapMixin",
|
9156
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
9045
9157
|
}
|
9046
9158
|
},
|
9047
9159
|
{
|
9048
|
-
"kind": "
|
9049
|
-
"name": "
|
9050
|
-
"privacy": "
|
9051
|
-
"
|
9160
|
+
"kind": "method",
|
9161
|
+
"name": "hasHiddenStyle",
|
9162
|
+
"privacy": "private",
|
9163
|
+
"parameters": [
|
9164
|
+
{
|
9165
|
+
"name": "element",
|
9166
|
+
"type": {
|
9167
|
+
"text": "HTMLElement"
|
9168
|
+
},
|
9169
|
+
"description": "The element to check."
|
9170
|
+
}
|
9171
|
+
],
|
9172
|
+
"description": "Checks if the element has inline styles that make it hidden.",
|
9173
|
+
"return": {
|
9174
|
+
"type": {
|
9175
|
+
"text": ""
|
9176
|
+
}
|
9177
|
+
},
|
9052
9178
|
"inheritedFrom": {
|
9053
|
-
"name": "
|
9054
|
-
"module": "
|
9179
|
+
"name": "FocusTrapMixin",
|
9180
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
9055
9181
|
}
|
9056
9182
|
},
|
9057
9183
|
{
|
9058
9184
|
"kind": "method",
|
9059
|
-
"name": "
|
9185
|
+
"name": "hasComputedHidden",
|
9060
9186
|
"privacy": "private",
|
9061
|
-
"
|
9187
|
+
"parameters": [
|
9188
|
+
{
|
9189
|
+
"name": "element",
|
9190
|
+
"type": {
|
9191
|
+
"text": "HTMLElement"
|
9192
|
+
},
|
9193
|
+
"description": "The element to check."
|
9194
|
+
}
|
9195
|
+
],
|
9196
|
+
"description": "Checks if the element is hidden by a computed style.",
|
9197
|
+
"return": {
|
9198
|
+
"type": {
|
9199
|
+
"text": ""
|
9200
|
+
}
|
9201
|
+
},
|
9062
9202
|
"inheritedFrom": {
|
9063
|
-
"name": "
|
9064
|
-
"module": "
|
9203
|
+
"name": "FocusTrapMixin",
|
9204
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
9065
9205
|
}
|
9066
9206
|
},
|
9067
9207
|
{
|
9068
9208
|
"kind": "method",
|
9069
|
-
"name": "
|
9070
|
-
"privacy": "
|
9209
|
+
"name": "isHidden",
|
9210
|
+
"privacy": "private",
|
9211
|
+
"parameters": [
|
9212
|
+
{
|
9213
|
+
"name": "element",
|
9214
|
+
"type": {
|
9215
|
+
"text": "HTMLElement"
|
9216
|
+
},
|
9217
|
+
"description": "The element to check."
|
9218
|
+
}
|
9219
|
+
],
|
9220
|
+
"description": "Checks if the element is hidden from the user.",
|
9071
9221
|
"return": {
|
9072
9222
|
"type": {
|
9073
|
-
"text": "
|
9223
|
+
"text": ""
|
9074
9224
|
}
|
9075
9225
|
},
|
9226
|
+
"inheritedFrom": {
|
9227
|
+
"name": "FocusTrapMixin",
|
9228
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
9229
|
+
}
|
9230
|
+
},
|
9231
|
+
{
|
9232
|
+
"kind": "method",
|
9233
|
+
"name": "isDisabled",
|
9234
|
+
"privacy": "private",
|
9076
9235
|
"parameters": [
|
9077
9236
|
{
|
9078
9237
|
"name": "element",
|
9079
9238
|
"type": {
|
9080
|
-
"text": "
|
9239
|
+
"text": "any"
|
9081
9240
|
},
|
9082
|
-
"description": "The element to
|
9241
|
+
"description": "The element to check."
|
9083
9242
|
}
|
9084
9243
|
],
|
9085
|
-
"description": "
|
9244
|
+
"description": "Checks if the element is disabled.",
|
9245
|
+
"return": {
|
9246
|
+
"type": {
|
9247
|
+
"text": ""
|
9248
|
+
}
|
9249
|
+
},
|
9086
9250
|
"inheritedFrom": {
|
9087
|
-
"name": "
|
9088
|
-
"module": "
|
9251
|
+
"name": "FocusTrapMixin",
|
9252
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
9089
9253
|
}
|
9090
9254
|
},
|
9091
9255
|
{
|
9092
|
-
"kind": "
|
9093
|
-
"name": "
|
9094
|
-
"
|
9095
|
-
"
|
9096
|
-
|
9097
|
-
|
9098
|
-
|
9099
|
-
|
9100
|
-
|
9101
|
-
|
9102
|
-
|
9103
|
-
|
9104
|
-
"
|
9105
|
-
"
|
9106
|
-
|
9107
|
-
|
9108
|
-
|
9109
|
-
}
|
9110
|
-
},
|
9111
|
-
{
|
9112
|
-
"description": "(React: onHidden) This event is dispatched when the coachmark is hidden",
|
9113
|
-
"name": "hidden",
|
9114
|
-
"reactName": "onHidden",
|
9256
|
+
"kind": "method",
|
9257
|
+
"name": "isNotTabbable",
|
9258
|
+
"privacy": "private",
|
9259
|
+
"parameters": [
|
9260
|
+
{
|
9261
|
+
"name": "element",
|
9262
|
+
"type": {
|
9263
|
+
"text": "HTMLElement"
|
9264
|
+
},
|
9265
|
+
"description": "The element to check."
|
9266
|
+
}
|
9267
|
+
],
|
9268
|
+
"description": "Checks if the element is not tabbable.",
|
9269
|
+
"return": {
|
9270
|
+
"type": {
|
9271
|
+
"text": ""
|
9272
|
+
}
|
9273
|
+
},
|
9115
9274
|
"inheritedFrom": {
|
9116
|
-
"name": "
|
9117
|
-
"module": "
|
9275
|
+
"name": "FocusTrapMixin",
|
9276
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
9118
9277
|
}
|
9119
9278
|
},
|
9120
9279
|
{
|
9121
|
-
"
|
9122
|
-
"name": "
|
9123
|
-
"
|
9280
|
+
"kind": "method",
|
9281
|
+
"name": "isInteractiveElement",
|
9282
|
+
"privacy": "private",
|
9283
|
+
"return": {
|
9284
|
+
"type": {
|
9285
|
+
"text": ""
|
9286
|
+
}
|
9287
|
+
},
|
9288
|
+
"parameters": [
|
9289
|
+
{
|
9290
|
+
"name": "element",
|
9291
|
+
"type": {
|
9292
|
+
"text": "HTMLElement"
|
9293
|
+
},
|
9294
|
+
"description": "The element to check."
|
9295
|
+
}
|
9296
|
+
],
|
9297
|
+
"description": "Checks if the element is interactive.",
|
9124
9298
|
"inheritedFrom": {
|
9125
|
-
"name": "
|
9126
|
-
"module": "
|
9299
|
+
"name": "FocusTrapMixin",
|
9300
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
9127
9301
|
}
|
9128
9302
|
},
|
9129
9303
|
{
|
9130
|
-
"
|
9131
|
-
"name": "
|
9132
|
-
"
|
9133
|
-
"
|
9134
|
-
|
9135
|
-
|
9136
|
-
|
9137
|
-
|
9138
|
-
|
9139
|
-
|
9140
|
-
|
9141
|
-
|
9142
|
-
"
|
9143
|
-
|
9304
|
+
"kind": "method",
|
9305
|
+
"name": "isFocusable",
|
9306
|
+
"privacy": "private",
|
9307
|
+
"parameters": [
|
9308
|
+
{
|
9309
|
+
"name": "element",
|
9310
|
+
"type": {
|
9311
|
+
"text": "HTMLElement"
|
9312
|
+
},
|
9313
|
+
"description": "The element to check."
|
9314
|
+
}
|
9315
|
+
],
|
9316
|
+
"description": "Checks if the element is focusable.",
|
9317
|
+
"return": {
|
9318
|
+
"type": {
|
9319
|
+
"text": ""
|
9320
|
+
}
|
9144
9321
|
},
|
9145
|
-
"description": "Determines the events that cause the Coachmark to show.\nMultiple event names should be separated by spaces.\nFor example to allow both click and hover, use 'click mouseenter' as the trigger.\n- **click**\n- **mouseenter**\n- **focusin**\n- **manual**",
|
9146
|
-
"default": "manual",
|
9147
|
-
"fieldName": "trigger",
|
9148
9322
|
"inheritedFrom": {
|
9149
|
-
"name": "
|
9150
|
-
"module": "
|
9323
|
+
"name": "FocusTrapMixin",
|
9324
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
9151
9325
|
}
|
9152
9326
|
},
|
9153
9327
|
{
|
9154
|
-
"
|
9155
|
-
"
|
9156
|
-
|
9328
|
+
"kind": "method",
|
9329
|
+
"name": "findFocusable",
|
9330
|
+
"privacy": "private",
|
9331
|
+
"return": {
|
9332
|
+
"type": {
|
9333
|
+
"text": ""
|
9334
|
+
}
|
9157
9335
|
},
|
9158
|
-
"
|
9159
|
-
|
9160
|
-
|
9336
|
+
"parameters": [
|
9337
|
+
{
|
9338
|
+
"name": "root",
|
9339
|
+
"type": {
|
9340
|
+
"text": "ShadowRoot | HTMLElement"
|
9341
|
+
},
|
9342
|
+
"description": "The root element to search for focusable elements."
|
9343
|
+
},
|
9344
|
+
{
|
9345
|
+
"name": "matches",
|
9346
|
+
"default": "new Set()",
|
9347
|
+
"type": {
|
9348
|
+
"text": "Set<HTMLElement>"
|
9349
|
+
},
|
9350
|
+
"description": "The set of focusable elements."
|
9351
|
+
}
|
9352
|
+
],
|
9353
|
+
"description": "Recursively finds all focusable elements within the given root and its descendants.\n\nMake sure this is performant, as it will be called multiple times.",
|
9161
9354
|
"inheritedFrom": {
|
9162
|
-
"name": "
|
9163
|
-
"module": "
|
9355
|
+
"name": "FocusTrapMixin",
|
9356
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
9164
9357
|
}
|
9165
9358
|
},
|
9166
9359
|
{
|
9167
|
-
"
|
9168
|
-
"
|
9169
|
-
|
9170
|
-
|
9171
|
-
"description": "The close button visibility of the Coachmark.",
|
9172
|
-
"default": "true",
|
9173
|
-
"fieldName": "closeButton",
|
9360
|
+
"kind": "method",
|
9361
|
+
"name": "setFocusableElements",
|
9362
|
+
"privacy": "private",
|
9363
|
+
"description": "Updates the list of focusable elements within the component's shadow root.",
|
9174
9364
|
"inheritedFrom": {
|
9175
|
-
"name": "
|
9176
|
-
"module": "
|
9365
|
+
"name": "FocusTrapMixin",
|
9366
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
9177
9367
|
}
|
9178
9368
|
},
|
9179
9369
|
{
|
9180
|
-
"
|
9181
|
-
"
|
9182
|
-
|
9183
|
-
|
9184
|
-
|
9185
|
-
|
9186
|
-
|
9370
|
+
"kind": "method",
|
9371
|
+
"name": "setInitialFocus",
|
9372
|
+
"privacy": "public",
|
9373
|
+
"parameters": [
|
9374
|
+
{
|
9375
|
+
"name": "elementIndexToReceiveFocus",
|
9376
|
+
"default": "0",
|
9377
|
+
"type": {
|
9378
|
+
"text": "number"
|
9379
|
+
},
|
9380
|
+
"description": "The index of the preferable element to focus."
|
9381
|
+
}
|
9382
|
+
],
|
9383
|
+
"description": "Sets the initial focus within the container.",
|
9187
9384
|
"inheritedFrom": {
|
9188
|
-
"name": "
|
9189
|
-
"module": "
|
9385
|
+
"name": "FocusTrapMixin",
|
9386
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
9190
9387
|
}
|
9191
9388
|
},
|
9192
9389
|
{
|
9193
|
-
"
|
9194
|
-
"
|
9195
|
-
|
9390
|
+
"kind": "method",
|
9391
|
+
"name": "calculateNextIndex",
|
9392
|
+
"privacy": "private",
|
9393
|
+
"parameters": [
|
9394
|
+
{
|
9395
|
+
"name": "currentIndex",
|
9396
|
+
"type": {
|
9397
|
+
"text": "number"
|
9398
|
+
},
|
9399
|
+
"description": "The current index."
|
9400
|
+
},
|
9401
|
+
{
|
9402
|
+
"name": "step",
|
9403
|
+
"type": {
|
9404
|
+
"text": "number"
|
9405
|
+
},
|
9406
|
+
"description": "The step to calculate the next index."
|
9407
|
+
}
|
9408
|
+
],
|
9409
|
+
"description": "Calculates the next index for the focus trap.",
|
9410
|
+
"return": {
|
9411
|
+
"type": {
|
9412
|
+
"text": ""
|
9413
|
+
}
|
9196
9414
|
},
|
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
9415
|
"inheritedFrom": {
|
9201
9416
|
"name": "FocusTrapMixin",
|
9202
|
-
"module": "
|
9417
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
9203
9418
|
}
|
9204
9419
|
},
|
9205
9420
|
{
|
9206
|
-
"
|
9207
|
-
"
|
9208
|
-
|
9421
|
+
"kind": "method",
|
9422
|
+
"name": "getDeepActiveElement",
|
9423
|
+
"privacy": "private",
|
9424
|
+
"description": "Returns the deepest active element in the shadow DOM.",
|
9425
|
+
"return": {
|
9426
|
+
"type": {
|
9427
|
+
"text": ""
|
9428
|
+
}
|
9209
9429
|
},
|
9210
|
-
"default": "''",
|
9211
|
-
"description": "The unique ID of the popover.",
|
9212
|
-
"fieldName": "id",
|
9213
9430
|
"inheritedFrom": {
|
9214
|
-
"name": "
|
9215
|
-
"module": "
|
9431
|
+
"name": "FocusTrapMixin",
|
9432
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
9216
9433
|
}
|
9217
9434
|
},
|
9218
9435
|
{
|
9219
|
-
"
|
9220
|
-
"
|
9221
|
-
|
9436
|
+
"kind": "method",
|
9437
|
+
"name": "findElement",
|
9438
|
+
"privacy": "private",
|
9439
|
+
"parameters": [
|
9440
|
+
{
|
9441
|
+
"name": "activeElement",
|
9442
|
+
"type": {
|
9443
|
+
"text": "HTMLElement"
|
9444
|
+
},
|
9445
|
+
"description": "The active element."
|
9446
|
+
}
|
9447
|
+
],
|
9448
|
+
"description": "Finds the index of the active element within the focusable elements.",
|
9449
|
+
"return": {
|
9450
|
+
"type": {
|
9451
|
+
"text": ""
|
9452
|
+
}
|
9222
9453
|
},
|
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",
|
9226
9454
|
"inheritedFrom": {
|
9227
|
-
"name": "
|
9228
|
-
"module": "
|
9455
|
+
"name": "FocusTrapMixin",
|
9456
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
9229
9457
|
}
|
9230
9458
|
},
|
9231
9459
|
{
|
9232
|
-
"
|
9233
|
-
"
|
9234
|
-
|
9235
|
-
|
9236
|
-
|
9237
|
-
|
9238
|
-
|
9239
|
-
|
9240
|
-
|
9241
|
-
|
9242
|
-
|
9243
|
-
|
9244
|
-
|
9245
|
-
|
9246
|
-
|
9247
|
-
|
9248
|
-
|
9249
|
-
|
9250
|
-
|
9251
|
-
"
|
9252
|
-
"
|
9253
|
-
"
|
9254
|
-
|
9255
|
-
|
9256
|
-
},
|
9257
|
-
{
|
9258
|
-
"name": "visible",
|
9259
|
-
"type": {
|
9260
|
-
"text": "boolean"
|
9261
|
-
},
|
9262
|
-
"description": "The visibility of the popover.",
|
9263
|
-
"default": "false",
|
9264
|
-
"fieldName": "visible",
|
9265
|
-
"inheritedFrom": {
|
9266
|
-
"name": "Popover",
|
9267
|
-
"module": "src/components/popover/popover.component.ts"
|
9268
|
-
}
|
9269
|
-
},
|
9270
|
-
{
|
9271
|
-
"name": "offset",
|
9272
|
-
"type": {
|
9273
|
-
"text": "number"
|
9274
|
-
},
|
9275
|
-
"description": "The offset of the popover.",
|
9276
|
-
"default": "4",
|
9277
|
-
"fieldName": "offset",
|
9278
|
-
"inheritedFrom": {
|
9279
|
-
"name": "Popover",
|
9280
|
-
"module": "src/components/popover/popover.component.ts"
|
9281
|
-
}
|
9282
|
-
},
|
9283
|
-
{
|
9284
|
-
"name": "boundary",
|
9285
|
-
"type": {
|
9286
|
-
"text": "'clippingAncestors' | string"
|
9287
|
-
},
|
9288
|
-
"description": "This describes the clipping element(s) or area that overflow will be checked relative to.\nThe default is 'clippingAncestors', which are the overflow ancestors which will cause the\nelement to be clipped.\n\nPossible values:\n - 'clippingAncestors'\n - any css selector",
|
9289
|
-
"default": "'clippingAncestors'",
|
9290
|
-
"fieldName": "boundary",
|
9291
|
-
"inheritedFrom": {
|
9292
|
-
"name": "Popover",
|
9293
|
-
"module": "src/components/popover/popover.component.ts"
|
9294
|
-
}
|
9295
|
-
},
|
9296
|
-
{
|
9297
|
-
"name": "boundary-root",
|
9298
|
-
"type": {
|
9299
|
-
"text": "'viewport' | 'document'"
|
9300
|
-
},
|
9301
|
-
"description": "This describes the root boundary that the element will be checked for overflow relative to.\nThe default is 'viewport', which is the area of the page the user can see on the screen.\n\nThe other string option is 'document', which is the entire page outside the viewport.",
|
9302
|
-
"default": "'viewport'",
|
9303
|
-
"fieldName": "boundaryRoot",
|
9304
|
-
"inheritedFrom": {
|
9305
|
-
"name": "Popover",
|
9306
|
-
"module": "src/components/popover/popover.component.ts"
|
9307
|
-
}
|
9308
|
-
},
|
9309
|
-
{
|
9310
|
-
"name": "boundary-padding",
|
9311
|
-
"type": {
|
9312
|
-
"text": "undefined | number"
|
9313
|
-
},
|
9314
|
-
"description": "Virtual padding around the boundary to check for overflow.\nSo the popover will not be placed on top of the edge of the boundary.\n\nDefault works well for most cases, but you can set this to customise it when necessary.",
|
9315
|
-
"default": "undefined",
|
9316
|
-
"fieldName": "boundaryPadding",
|
9317
|
-
"inheritedFrom": {
|
9318
|
-
"name": "Popover",
|
9319
|
-
"module": "src/components/popover/popover.component.ts"
|
9320
|
-
}
|
9321
|
-
},
|
9322
|
-
{
|
9323
|
-
"name": "focus-trap",
|
9324
|
-
"type": {
|
9325
|
-
"text": "boolean"
|
9326
|
-
},
|
9327
|
-
"description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.",
|
9328
|
-
"default": "false",
|
9329
|
-
"fieldName": "focusTrap",
|
9330
|
-
"inheritedFrom": {
|
9331
|
-
"name": "Popover",
|
9332
|
-
"module": "src/components/popover/popover.component.ts"
|
9333
|
-
}
|
9334
|
-
},
|
9335
|
-
{
|
9336
|
-
"name": "prevent-scroll",
|
9337
|
-
"type": {
|
9338
|
-
"text": "boolean"
|
9339
|
-
},
|
9340
|
-
"description": "Prevent outside scrolling when popover is shown.",
|
9341
|
-
"default": "false",
|
9342
|
-
"fieldName": "preventScroll",
|
9343
|
-
"inheritedFrom": {
|
9344
|
-
"name": "Popover",
|
9345
|
-
"module": "src/components/popover/popover.component.ts"
|
9346
|
-
}
|
9347
|
-
},
|
9348
|
-
{
|
9349
|
-
"name": "interactive",
|
9350
|
-
"type": {
|
9351
|
-
"text": "boolean"
|
9352
|
-
},
|
9353
|
-
"description": "Determines whether the popover is interactive.\nMake sure to set focusTrap to true to keep the focus inside the popover in case necessary.\nSetting interactive to true will not automatically set focusTrap!",
|
9354
|
-
"default": "false",
|
9355
|
-
"fieldName": "interactive",
|
9356
|
-
"inheritedFrom": {
|
9357
|
-
"name": "Popover",
|
9358
|
-
"module": "src/components/popover/popover.component.ts"
|
9359
|
-
}
|
9360
|
-
},
|
9361
|
-
{
|
9362
|
-
"name": "delay",
|
9363
|
-
"type": {
|
9364
|
-
"text": "string"
|
9365
|
-
},
|
9366
|
-
"description": "The delay of the show/hide popover.",
|
9367
|
-
"default": "0,0",
|
9368
|
-
"fieldName": "delay",
|
9369
|
-
"inheritedFrom": {
|
9370
|
-
"name": "Popover",
|
9371
|
-
"module": "src/components/popover/popover.component.ts"
|
9372
|
-
}
|
9373
|
-
},
|
9374
|
-
{
|
9375
|
-
"name": "hide-on-escape",
|
9376
|
-
"type": {
|
9377
|
-
"text": "boolean"
|
9378
|
-
},
|
9379
|
-
"description": "Hide popover on escape key press.",
|
9380
|
-
"default": "false",
|
9381
|
-
"fieldName": "hideOnEscape",
|
9382
|
-
"inheritedFrom": {
|
9383
|
-
"name": "Popover",
|
9384
|
-
"module": "src/components/popover/popover.component.ts"
|
9385
|
-
}
|
9386
|
-
},
|
9387
|
-
{
|
9388
|
-
"name": "propagate-event-on-escape",
|
9389
|
-
"type": {
|
9390
|
-
"text": "boolean"
|
9391
|
-
},
|
9392
|
-
"description": "Propagates the event, when the escape key is pressed (only when pressed inside the popover)\nIf true, the escape key press close the popover and will propagate the keydown event.\nIf false, the escape key press will close the popover but will not propagate the keydown event.\n(set to false to prevent the event from bubbling up to the document).\n\nThis only works when `hideOnEscape` is true.",
|
9393
|
-
"default": "false",
|
9394
|
-
"fieldName": "propagateEventOnEscape",
|
9395
|
-
"inheritedFrom": {
|
9396
|
-
"name": "Popover",
|
9397
|
-
"module": "src/components/popover/popover.component.ts"
|
9398
|
-
}
|
9399
|
-
},
|
9400
|
-
{
|
9401
|
-
"name": "hide-on-blur",
|
9402
|
-
"type": {
|
9403
|
-
"text": "boolean"
|
9404
|
-
},
|
9405
|
-
"description": "Hide popover on blur.",
|
9406
|
-
"default": "false",
|
9407
|
-
"fieldName": "hideOnBlur",
|
9408
|
-
"inheritedFrom": {
|
9409
|
-
"name": "Popover",
|
9410
|
-
"module": "src/components/popover/popover.component.ts"
|
9411
|
-
}
|
9412
|
-
},
|
9413
|
-
{
|
9414
|
-
"name": "hide-on-outside-click",
|
9415
|
-
"type": {
|
9416
|
-
"text": "boolean"
|
9417
|
-
},
|
9418
|
-
"description": "Hide on outside click of the popover.",
|
9419
|
-
"default": "false",
|
9420
|
-
"fieldName": "hideOnOutsideClick",
|
9421
|
-
"inheritedFrom": {
|
9422
|
-
"name": "Popover",
|
9423
|
-
"module": "src/components/popover/popover.component.ts"
|
9424
|
-
}
|
9425
|
-
},
|
9426
|
-
{
|
9427
|
-
"name": "focus-back-to-trigger",
|
9428
|
-
"type": {
|
9429
|
-
"text": "boolean"
|
9430
|
-
},
|
9431
|
-
"description": "The focus back to trigger after the popover hide.",
|
9432
|
-
"default": "false",
|
9433
|
-
"fieldName": "focusBackToTrigger",
|
9434
|
-
"inheritedFrom": {
|
9435
|
-
"name": "Popover",
|
9436
|
-
"module": "src/components/popover/popover.component.ts"
|
9437
|
-
}
|
9438
|
-
},
|
9439
|
-
{
|
9440
|
-
"name": "backdrop",
|
9441
|
-
"type": {
|
9442
|
-
"text": "boolean"
|
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",
|
9447
|
-
"inheritedFrom": {
|
9448
|
-
"name": "Popover",
|
9449
|
-
"module": "src/components/popover/popover.component.ts"
|
9450
|
-
}
|
9451
|
-
},
|
9452
|
-
{
|
9453
|
-
"name": "flip",
|
9454
|
-
"type": {
|
9455
|
-
"text": "boolean"
|
9456
|
-
},
|
9457
|
-
"description": "Changes the placement of popover to keep it in view when scrolling.",
|
9458
|
-
"default": "true",
|
9459
|
-
"fieldName": "flip",
|
9460
|
-
"inheritedFrom": {
|
9461
|
-
"name": "Popover",
|
9462
|
-
"module": "src/components/popover/popover.component.ts"
|
9463
|
-
}
|
9464
|
-
},
|
9465
|
-
{
|
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",
|
9473
|
-
"inheritedFrom": {
|
9474
|
-
"name": "Popover",
|
9475
|
-
"module": "src/components/popover/popover.component.ts"
|
9476
|
-
}
|
9477
|
-
},
|
9478
|
-
{
|
9479
|
-
"name": "z-index",
|
9480
|
-
"type": {
|
9481
|
-
"text": "number"
|
9482
|
-
},
|
9483
|
-
"description": "The z-index of the popover.",
|
9484
|
-
"default": "1000",
|
9485
|
-
"fieldName": "zIndex",
|
9486
|
-
"inheritedFrom": {
|
9487
|
-
"name": "Popover",
|
9488
|
-
"module": "src/components/popover/popover.component.ts"
|
9489
|
-
}
|
9490
|
-
},
|
9491
|
-
{
|
9492
|
-
"name": "append-to",
|
9493
|
-
"type": {
|
9494
|
-
"text": "string | undefined"
|
9495
|
-
},
|
9496
|
-
"description": "Element ID that the popover append to.",
|
9497
|
-
"default": "''",
|
9498
|
-
"fieldName": "appendTo",
|
9499
|
-
"inheritedFrom": {
|
9500
|
-
"name": "Popover",
|
9501
|
-
"module": "src/components/popover/popover.component.ts"
|
9502
|
-
}
|
9503
|
-
},
|
9504
|
-
{
|
9505
|
-
"name": "close-button-aria-label",
|
9506
|
-
"type": {
|
9507
|
-
"text": "string | null"
|
9508
|
-
},
|
9509
|
-
"default": "null",
|
9510
|
-
"description": "aria-label attribute to be set for close button accessibility.",
|
9511
|
-
"fieldName": "closeButtonAriaLabel",
|
9512
|
-
"inheritedFrom": {
|
9513
|
-
"name": "Popover",
|
9514
|
-
"module": "src/components/popover/popover.component.ts"
|
9515
|
-
}
|
9516
|
-
},
|
9517
|
-
{
|
9518
|
-
"name": "role",
|
9519
|
-
"type": {
|
9520
|
-
"text": "HTMLElement['role']"
|
9521
|
-
},
|
9522
|
-
"description": "Role of the popover",
|
9523
|
-
"default": "dialog",
|
9524
|
-
"fieldName": "role",
|
9525
|
-
"inheritedFrom": {
|
9526
|
-
"name": "Popover",
|
9527
|
-
"module": "src/components/popover/popover.component.ts"
|
9528
|
-
}
|
9529
|
-
},
|
9530
|
-
{
|
9531
|
-
"name": "aria-labelledby",
|
9532
|
-
"type": {
|
9533
|
-
"text": "string | null"
|
9460
|
+
"kind": "method",
|
9461
|
+
"name": "isEqualFocusNode",
|
9462
|
+
"privacy": "private",
|
9463
|
+
"parameters": [
|
9464
|
+
{
|
9465
|
+
"name": "activeElement",
|
9466
|
+
"type": {
|
9467
|
+
"text": "HTMLElement"
|
9468
|
+
},
|
9469
|
+
"description": "The active element."
|
9470
|
+
},
|
9471
|
+
{
|
9472
|
+
"name": "element",
|
9473
|
+
"type": {
|
9474
|
+
"text": "HTMLElement"
|
9475
|
+
},
|
9476
|
+
"description": "The element to compare."
|
9477
|
+
}
|
9478
|
+
],
|
9479
|
+
"description": "Checks if the active element is equal to the given element.",
|
9480
|
+
"return": {
|
9481
|
+
"type": {
|
9482
|
+
"text": ""
|
9483
|
+
}
|
9534
9484
|
},
|
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",
|
9538
9485
|
"inheritedFrom": {
|
9539
|
-
"name": "
|
9540
|
-
"module": "
|
9486
|
+
"name": "FocusTrapMixin",
|
9487
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
9541
9488
|
}
|
9542
9489
|
},
|
9543
9490
|
{
|
9544
|
-
"
|
9545
|
-
"
|
9546
|
-
|
9547
|
-
|
9548
|
-
|
9549
|
-
|
9550
|
-
|
9491
|
+
"kind": "method",
|
9492
|
+
"name": "trapFocus",
|
9493
|
+
"privacy": "private",
|
9494
|
+
"parameters": [
|
9495
|
+
{
|
9496
|
+
"name": "event",
|
9497
|
+
"type": {
|
9498
|
+
"text": "KeyboardEvent"
|
9499
|
+
}
|
9500
|
+
},
|
9501
|
+
{
|
9502
|
+
"description": "The direction of the focus trap.\nIf true, the focus will be trapped in the previous element.",
|
9503
|
+
"name": "direction"
|
9504
|
+
}
|
9505
|
+
],
|
9506
|
+
"description": "Traps focus within the container.",
|
9551
9507
|
"inheritedFrom": {
|
9552
|
-
"name": "
|
9553
|
-
"module": "
|
9508
|
+
"name": "FocusTrapMixin",
|
9509
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
9554
9510
|
}
|
9555
9511
|
},
|
9556
9512
|
{
|
9557
|
-
"
|
9558
|
-
"
|
9559
|
-
|
9560
|
-
|
9561
|
-
|
9562
|
-
|
9563
|
-
|
9513
|
+
"kind": "method",
|
9514
|
+
"name": "handleTabKeydown",
|
9515
|
+
"privacy": "private",
|
9516
|
+
"parameters": [
|
9517
|
+
{
|
9518
|
+
"name": "event",
|
9519
|
+
"type": {
|
9520
|
+
"text": "KeyboardEvent"
|
9521
|
+
},
|
9522
|
+
"description": "The keyboard event."
|
9523
|
+
}
|
9524
|
+
],
|
9525
|
+
"description": "Traps focus within the container.",
|
9564
9526
|
"inheritedFrom": {
|
9565
|
-
"name": "
|
9566
|
-
"module": "
|
9527
|
+
"name": "FocusTrapMixin",
|
9528
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
9567
9529
|
}
|
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
9530
|
},
|
9603
|
-
{
|
9604
|
-
"description": "border color of the dialog",
|
9605
|
-
"name": "--mdc-dialog-border-color"
|
9606
|
-
},
|
9607
|
-
{
|
9608
|
-
"description": "text color of the header/title of the dialog",
|
9609
|
-
"name": "--mdc-dialog-header-text-color"
|
9610
|
-
},
|
9611
|
-
{
|
9612
|
-
"description": "text color of the below header description of the dialog",
|
9613
|
-
"name": "--mdc-dialog-description-text-color"
|
9614
|
-
},
|
9615
|
-
{
|
9616
|
-
"description": "elevation of the dialog",
|
9617
|
-
"name": "--mdc-dialog-elevation-3"
|
9618
|
-
},
|
9619
|
-
{
|
9620
|
-
"description": "width of the dialog",
|
9621
|
-
"name": "--mdc-dialog-width"
|
9622
|
-
}
|
9623
|
-
],
|
9624
|
-
"slots": [
|
9625
|
-
{
|
9626
|
-
"description": "Slot for the dialog header content. This can be used to pass custom header content.",
|
9627
|
-
"name": "header-prefix"
|
9628
|
-
},
|
9629
|
-
{
|
9630
|
-
"description": "Slot for the dialog body content",
|
9631
|
-
"name": "dialog-body"
|
9632
|
-
},
|
9633
|
-
{
|
9634
|
-
"description": "This slot is for passing `mdc-link` component within the footer section.",
|
9635
|
-
"name": "footer-link"
|
9636
|
-
},
|
9637
|
-
{
|
9638
|
-
"description": "This slot is for passing secondary variant of `mdc-button` component within the footer section.",
|
9639
|
-
"name": "footer-button-secondary"
|
9640
|
-
},
|
9641
|
-
{
|
9642
|
-
"description": "This slot is for passing primary variant of `mdc-button` component within the footer section.",
|
9643
|
-
"name": "footer-button-primary"
|
9644
|
-
},
|
9645
|
-
{
|
9646
|
-
"description": " This slot is for passing custom footer content. Only use this if really needed, using the footer-link and footer-button slots is preferred",
|
9647
|
-
"name": "footer"
|
9648
|
-
}
|
9649
|
-
],
|
9650
|
-
"members": [
|
9651
9531
|
{
|
9652
9532
|
"kind": "field",
|
9653
9533
|
"name": "id",
|
@@ -9655,988 +9535,1108 @@
|
|
9655
9535
|
"text": "string"
|
9656
9536
|
},
|
9657
9537
|
"default": "''",
|
9658
|
-
"description": "The unique ID of the
|
9538
|
+
"description": "The unique ID of the popover.",
|
9659
9539
|
"attribute": "id",
|
9660
|
-
"reflects": true
|
9540
|
+
"reflects": true,
|
9541
|
+
"inheritedFrom": {
|
9542
|
+
"name": "Popover",
|
9543
|
+
"module": "components/popover/popover.component.js"
|
9544
|
+
}
|
9661
9545
|
},
|
9662
9546
|
{
|
9663
9547
|
"kind": "field",
|
9664
|
-
"name": "
|
9548
|
+
"name": "triggerID",
|
9665
9549
|
"type": {
|
9666
|
-
"text": "string
|
9550
|
+
"text": "string"
|
9667
9551
|
},
|
9668
|
-
"
|
9669
|
-
"
|
9670
|
-
"attribute": "
|
9671
|
-
"reflects": true
|
9552
|
+
"default": "''",
|
9553
|
+
"description": "The ID of the element that triggers the popover.\nThis attribute is required for the popover to work.",
|
9554
|
+
"attribute": "triggerID",
|
9555
|
+
"reflects": true,
|
9556
|
+
"inheritedFrom": {
|
9557
|
+
"name": "Popover",
|
9558
|
+
"module": "components/popover/popover.component.js"
|
9559
|
+
}
|
9672
9560
|
},
|
9673
9561
|
{
|
9674
9562
|
"kind": "field",
|
9675
|
-
"name": "
|
9563
|
+
"name": "placement",
|
9676
9564
|
"type": {
|
9677
|
-
"text": "
|
9565
|
+
"text": "PopoverPlacement"
|
9678
9566
|
},
|
9679
|
-
"description": "The
|
9680
|
-
"default": "
|
9681
|
-
"attribute": "
|
9682
|
-
"reflects": true
|
9567
|
+
"description": "The placement of the popover.\n- **top**\n- **top-start**\n- **top-end**\n- **bottom**\n- **bottom-start**\n- **bottom-end**\n- **left**\n- **left-start**\n- **left-end**\n- **right**\n- **right-start**\n- **right-end**",
|
9568
|
+
"default": "bottom",
|
9569
|
+
"attribute": "placement",
|
9570
|
+
"reflects": true,
|
9571
|
+
"inheritedFrom": {
|
9572
|
+
"name": "Popover",
|
9573
|
+
"module": "components/popover/popover.component.js"
|
9574
|
+
}
|
9683
9575
|
},
|
9684
9576
|
{
|
9685
9577
|
"kind": "field",
|
9686
|
-
"name": "
|
9578
|
+
"name": "color",
|
9687
9579
|
"type": {
|
9688
|
-
"text": "
|
9580
|
+
"text": "PopoverColor"
|
9689
9581
|
},
|
9690
|
-
"description": "
|
9691
|
-
"default": "
|
9692
|
-
"attribute": "
|
9693
|
-
"reflects": true
|
9582
|
+
"description": "Color of the popover\n- **tonal**\n- **contrast**",
|
9583
|
+
"default": "tonal",
|
9584
|
+
"attribute": "color",
|
9585
|
+
"reflects": true,
|
9586
|
+
"inheritedFrom": {
|
9587
|
+
"name": "Popover",
|
9588
|
+
"module": "components/popover/popover.component.js"
|
9589
|
+
}
|
9694
9590
|
},
|
9695
9591
|
{
|
9696
9592
|
"kind": "field",
|
9697
|
-
"name": "
|
9593
|
+
"name": "visible",
|
9698
9594
|
"type": {
|
9699
|
-
"text": "
|
9595
|
+
"text": "boolean"
|
9700
9596
|
},
|
9701
|
-
"description": "The
|
9702
|
-
"default": "
|
9703
|
-
"attribute": "
|
9704
|
-
"reflects": true
|
9597
|
+
"description": "The visibility of the popover.",
|
9598
|
+
"default": "false",
|
9599
|
+
"attribute": "visible",
|
9600
|
+
"reflects": true,
|
9601
|
+
"inheritedFrom": {
|
9602
|
+
"name": "Popover",
|
9603
|
+
"module": "components/popover/popover.component.js"
|
9604
|
+
}
|
9705
9605
|
},
|
9706
9606
|
{
|
9707
9607
|
"kind": "field",
|
9708
|
-
"name": "
|
9608
|
+
"name": "offset",
|
9709
9609
|
"type": {
|
9710
|
-
"text": "
|
9610
|
+
"text": "number"
|
9711
9611
|
},
|
9712
|
-
"description": "The
|
9713
|
-
"default": "
|
9714
|
-
"attribute": "
|
9715
|
-
"reflects": true
|
9612
|
+
"description": "The offset of the popover.",
|
9613
|
+
"default": "4",
|
9614
|
+
"attribute": "offset",
|
9615
|
+
"reflects": true,
|
9616
|
+
"inheritedFrom": {
|
9617
|
+
"name": "Popover",
|
9618
|
+
"module": "components/popover/popover.component.js"
|
9619
|
+
}
|
9716
9620
|
},
|
9717
9621
|
{
|
9718
9622
|
"kind": "field",
|
9719
|
-
"name": "
|
9623
|
+
"name": "boundary",
|
9720
9624
|
"type": {
|
9721
|
-
"text": "
|
9625
|
+
"text": "'clippingAncestors' | string"
|
9722
9626
|
},
|
9723
|
-
"
|
9724
|
-
"
|
9725
|
-
"attribute": "
|
9627
|
+
"description": "This describes the clipping element(s) or area that overflow will be checked relative to.\nThe default is 'clippingAncestors', which are the overflow ancestors which will cause the\nelement to be clipped.\n\nPossible values:\n - 'clippingAncestors'\n - any css selector",
|
9628
|
+
"default": "'clippingAncestors'",
|
9629
|
+
"attribute": "boundary",
|
9630
|
+
"reflects": true,
|
9631
|
+
"inheritedFrom": {
|
9632
|
+
"name": "Popover",
|
9633
|
+
"module": "components/popover/popover.component.js"
|
9634
|
+
}
|
9726
9635
|
},
|
9727
9636
|
{
|
9728
9637
|
"kind": "field",
|
9729
|
-
"name": "
|
9638
|
+
"name": "boundaryRoot",
|
9730
9639
|
"type": {
|
9731
|
-
"text": "
|
9640
|
+
"text": "'viewport' | 'document'"
|
9732
9641
|
},
|
9733
|
-
"
|
9734
|
-
"
|
9735
|
-
"attribute": "
|
9736
|
-
"reflects": true
|
9642
|
+
"description": "This describes the root boundary that the element will be checked for overflow relative to.\nThe default is 'viewport', which is the area of the page the user can see on the screen.\n\nThe other string option is 'document', which is the entire page outside the viewport.",
|
9643
|
+
"default": "'viewport'",
|
9644
|
+
"attribute": "boundary-root",
|
9645
|
+
"reflects": true,
|
9646
|
+
"inheritedFrom": {
|
9647
|
+
"name": "Popover",
|
9648
|
+
"module": "components/popover/popover.component.js"
|
9649
|
+
}
|
9737
9650
|
},
|
9738
9651
|
{
|
9739
9652
|
"kind": "field",
|
9740
|
-
"name": "
|
9653
|
+
"name": "boundaryPadding",
|
9741
9654
|
"type": {
|
9742
|
-
"text": "
|
9655
|
+
"text": "undefined | number"
|
9743
9656
|
},
|
9744
|
-
"
|
9745
|
-
"
|
9746
|
-
"attribute": "
|
9747
|
-
"reflects": true
|
9657
|
+
"description": "Virtual padding around the boundary to check for overflow.\nSo the popover will not be placed on top of the edge of the boundary.\n\nDefault works well for most cases, but you can set this to customise it when necessary.",
|
9658
|
+
"default": "undefined",
|
9659
|
+
"attribute": "boundary-padding",
|
9660
|
+
"reflects": true,
|
9661
|
+
"inheritedFrom": {
|
9662
|
+
"name": "Popover",
|
9663
|
+
"module": "components/popover/popover.component.js"
|
9664
|
+
}
|
9748
9665
|
},
|
9749
9666
|
{
|
9750
9667
|
"kind": "field",
|
9751
|
-
"name": "
|
9668
|
+
"name": "interactive",
|
9752
9669
|
"type": {
|
9753
|
-
"text": "
|
9670
|
+
"text": "boolean"
|
9754
9671
|
},
|
9755
|
-
"
|
9756
|
-
"
|
9757
|
-
"attribute": "
|
9758
|
-
"reflects": true
|
9672
|
+
"description": "Determines whether the popover is interactive.\nMake sure to set focusTrap to true to keep the focus inside the popover in case necessary.\nSetting interactive to true will not automatically set focusTrap!",
|
9673
|
+
"default": "false",
|
9674
|
+
"attribute": "interactive",
|
9675
|
+
"reflects": true,
|
9676
|
+
"inheritedFrom": {
|
9677
|
+
"name": "Popover",
|
9678
|
+
"module": "components/popover/popover.component.js"
|
9679
|
+
}
|
9759
9680
|
},
|
9760
9681
|
{
|
9761
9682
|
"kind": "field",
|
9762
|
-
"name": "
|
9683
|
+
"name": "delay",
|
9763
9684
|
"type": {
|
9764
|
-
"text": "string
|
9685
|
+
"text": "string"
|
9765
9686
|
},
|
9766
|
-
"
|
9767
|
-
"
|
9768
|
-
"attribute": "
|
9769
|
-
"reflects": true
|
9687
|
+
"description": "The delay of the show/hide popover.",
|
9688
|
+
"default": "0,0",
|
9689
|
+
"attribute": "delay",
|
9690
|
+
"reflects": true,
|
9691
|
+
"inheritedFrom": {
|
9692
|
+
"name": "Popover",
|
9693
|
+
"module": "components/popover/popover.component.js"
|
9694
|
+
}
|
9770
9695
|
},
|
9771
9696
|
{
|
9772
9697
|
"kind": "field",
|
9773
|
-
"name": "
|
9698
|
+
"name": "hideOnEscape",
|
9774
9699
|
"type": {
|
9775
|
-
"text": "
|
9700
|
+
"text": "boolean"
|
9776
9701
|
},
|
9777
|
-
"description": "
|
9778
|
-
"
|
9779
|
-
"
|
9702
|
+
"description": "Hide popover on escape key press.",
|
9703
|
+
"default": "false",
|
9704
|
+
"attribute": "hide-on-escape",
|
9705
|
+
"reflects": true,
|
9706
|
+
"inheritedFrom": {
|
9707
|
+
"name": "Popover",
|
9708
|
+
"module": "components/popover/popover.component.js"
|
9709
|
+
}
|
9780
9710
|
},
|
9781
9711
|
{
|
9782
9712
|
"kind": "field",
|
9783
|
-
"name": "
|
9713
|
+
"name": "propagateEventOnEscape",
|
9784
9714
|
"type": {
|
9785
|
-
"text": "
|
9715
|
+
"text": "boolean"
|
9786
9716
|
},
|
9787
|
-
"description": "
|
9788
|
-
"
|
9789
|
-
"
|
9717
|
+
"description": "Propagates the event, when the escape key is pressed (only when pressed inside the popover)\nIf true, the escape key press close the popover and will propagate the keydown event.\nIf false, the escape key press will close the popover but will not propagate the keydown event.\n(set to false to prevent the event from bubbling up to the document).\n\nThis only works when `hideOnEscape` is true.",
|
9718
|
+
"default": "false",
|
9719
|
+
"attribute": "propagate-event-on-escape",
|
9720
|
+
"reflects": true,
|
9721
|
+
"inheritedFrom": {
|
9722
|
+
"name": "Popover",
|
9723
|
+
"module": "components/popover/popover.component.js"
|
9724
|
+
}
|
9790
9725
|
},
|
9791
9726
|
{
|
9792
9727
|
"kind": "field",
|
9793
|
-
"name": "
|
9728
|
+
"name": "hideOnBlur",
|
9794
9729
|
"type": {
|
9795
|
-
"text": "
|
9730
|
+
"text": "boolean"
|
9796
9731
|
},
|
9797
|
-
"description": "
|
9798
|
-
"
|
9799
|
-
"
|
9732
|
+
"description": "Hide popover on blur.",
|
9733
|
+
"default": "false",
|
9734
|
+
"attribute": "hide-on-blur",
|
9735
|
+
"reflects": true,
|
9736
|
+
"inheritedFrom": {
|
9737
|
+
"name": "Popover",
|
9738
|
+
"module": "components/popover/popover.component.js"
|
9739
|
+
}
|
9800
9740
|
},
|
9801
9741
|
{
|
9802
9742
|
"kind": "field",
|
9803
|
-
"name": "
|
9743
|
+
"name": "hideOnOutsideClick",
|
9804
9744
|
"type": {
|
9805
|
-
"text": "
|
9745
|
+
"text": "boolean"
|
9806
9746
|
},
|
9807
|
-
"description": "
|
9808
|
-
"
|
9809
|
-
"
|
9747
|
+
"description": "Hide on outside click of the popover.",
|
9748
|
+
"default": "false",
|
9749
|
+
"attribute": "hide-on-outside-click",
|
9750
|
+
"reflects": true,
|
9751
|
+
"inheritedFrom": {
|
9752
|
+
"name": "Popover",
|
9753
|
+
"module": "components/popover/popover.component.js"
|
9754
|
+
}
|
9810
9755
|
},
|
9811
9756
|
{
|
9812
9757
|
"kind": "field",
|
9813
|
-
"name": "
|
9758
|
+
"name": "focusBackToTrigger",
|
9814
9759
|
"type": {
|
9815
|
-
"text": "
|
9760
|
+
"text": "boolean"
|
9816
9761
|
},
|
9817
|
-
"description": "
|
9818
|
-
"default": "
|
9819
|
-
"attribute": "
|
9820
|
-
"reflects": true
|
9762
|
+
"description": "The focus back to trigger after the popover hide.",
|
9763
|
+
"default": "false",
|
9764
|
+
"attribute": "focus-back-to-trigger",
|
9765
|
+
"reflects": true,
|
9766
|
+
"inheritedFrom": {
|
9767
|
+
"name": "Popover",
|
9768
|
+
"module": "components/popover/popover.component.js"
|
9769
|
+
}
|
9770
|
+
},
|
9771
|
+
{
|
9772
|
+
"kind": "field",
|
9773
|
+
"name": "backdrop",
|
9774
|
+
"type": {
|
9775
|
+
"text": "boolean"
|
9776
|
+
},
|
9777
|
+
"description": "Determines whether the popover with backdrop.\nOther than popover and trigger element, the rest of the screen will be covered with a backdrop.",
|
9778
|
+
"default": "false",
|
9779
|
+
"attribute": "backdrop",
|
9780
|
+
"reflects": true,
|
9781
|
+
"inheritedFrom": {
|
9782
|
+
"name": "Popover",
|
9783
|
+
"module": "components/popover/popover.component.js"
|
9784
|
+
}
|
9821
9785
|
},
|
9822
9786
|
{
|
9823
9787
|
"kind": "field",
|
9824
|
-
"name": "
|
9788
|
+
"name": "flip",
|
9825
9789
|
"type": {
|
9826
9790
|
"text": "boolean"
|
9827
9791
|
},
|
9828
|
-
"description": "
|
9829
|
-
"default": "
|
9830
|
-
"attribute": "
|
9831
|
-
"reflects": true
|
9792
|
+
"description": "Changes the placement of popover to keep it in view when scrolling.",
|
9793
|
+
"default": "true",
|
9794
|
+
"attribute": "flip",
|
9795
|
+
"reflects": true,
|
9796
|
+
"inheritedFrom": {
|
9797
|
+
"name": "Popover",
|
9798
|
+
"module": "components/popover/popover.component.js"
|
9799
|
+
}
|
9832
9800
|
},
|
9833
9801
|
{
|
9834
9802
|
"kind": "field",
|
9835
|
-
"name": "
|
9803
|
+
"name": "size",
|
9836
9804
|
"type": {
|
9837
9805
|
"text": "boolean"
|
9838
9806
|
},
|
9839
|
-
"
|
9840
|
-
"
|
9841
|
-
"
|
9842
|
-
"attribute": "focus-trap",
|
9807
|
+
"description": "Changes the size of popover to keep it in view when scrolling.",
|
9808
|
+
"default": "false",
|
9809
|
+
"attribute": "size",
|
9843
9810
|
"reflects": true,
|
9844
9811
|
"inheritedFrom": {
|
9845
|
-
"name": "
|
9846
|
-
"module": "
|
9812
|
+
"name": "Popover",
|
9813
|
+
"module": "components/popover/popover.component.js"
|
9847
9814
|
}
|
9848
9815
|
},
|
9849
9816
|
{
|
9850
|
-
"kind": "
|
9851
|
-
"name": "
|
9852
|
-
"
|
9853
|
-
|
9817
|
+
"kind": "field",
|
9818
|
+
"name": "zIndex",
|
9819
|
+
"type": {
|
9820
|
+
"text": "number"
|
9821
|
+
},
|
9822
|
+
"description": "The z-index of the popover.",
|
9823
|
+
"default": "1000",
|
9824
|
+
"attribute": "z-index",
|
9825
|
+
"reflects": true,
|
9826
|
+
"inheritedFrom": {
|
9827
|
+
"name": "Popover",
|
9828
|
+
"module": "components/popover/popover.component.js"
|
9829
|
+
}
|
9854
9830
|
},
|
9855
9831
|
{
|
9856
|
-
"kind": "
|
9857
|
-
"name": "
|
9858
|
-
"
|
9859
|
-
|
9860
|
-
|
9861
|
-
|
9862
|
-
|
9863
|
-
|
9864
|
-
|
9865
|
-
|
9866
|
-
|
9867
|
-
|
9868
|
-
|
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."
|
9832
|
+
"kind": "field",
|
9833
|
+
"name": "appendTo",
|
9834
|
+
"type": {
|
9835
|
+
"text": "string | undefined"
|
9836
|
+
},
|
9837
|
+
"description": "Element ID that the popover append to.",
|
9838
|
+
"default": "''",
|
9839
|
+
"attribute": "append-to",
|
9840
|
+
"reflects": true,
|
9841
|
+
"inheritedFrom": {
|
9842
|
+
"name": "Popover",
|
9843
|
+
"module": "components/popover/popover.component.js"
|
9844
|
+
}
|
9876
9845
|
},
|
9877
9846
|
{
|
9878
9847
|
"kind": "field",
|
9879
|
-
"name": "
|
9848
|
+
"name": "closeButtonAriaLabel",
|
9880
9849
|
"type": {
|
9881
|
-
"text": "
|
9850
|
+
"text": "string | null"
|
9882
9851
|
},
|
9883
|
-
"
|
9884
|
-
"description": "
|
9852
|
+
"default": "null",
|
9853
|
+
"description": "aria-label attribute to be set for close button accessibility.",
|
9854
|
+
"attribute": "close-button-aria-label",
|
9855
|
+
"reflects": true,
|
9885
9856
|
"inheritedFrom": {
|
9886
|
-
"name": "
|
9887
|
-
"module": "
|
9857
|
+
"name": "Popover",
|
9858
|
+
"module": "components/popover/popover.component.js"
|
9888
9859
|
}
|
9889
9860
|
},
|
9890
9861
|
{
|
9891
|
-
"kind": "
|
9892
|
-
"name": "
|
9893
|
-
"
|
9862
|
+
"kind": "field",
|
9863
|
+
"name": "role",
|
9864
|
+
"type": {
|
9865
|
+
"text": "HTMLElement['role']"
|
9866
|
+
},
|
9867
|
+
"description": "Role of the popover",
|
9868
|
+
"default": "dialog",
|
9869
|
+
"attribute": "role",
|
9870
|
+
"reflects": true,
|
9894
9871
|
"inheritedFrom": {
|
9895
|
-
"name": "
|
9896
|
-
"module": "
|
9872
|
+
"name": "Popover",
|
9873
|
+
"module": "components/popover/popover.component.js"
|
9897
9874
|
}
|
9898
9875
|
},
|
9899
9876
|
{
|
9900
|
-
"kind": "
|
9901
|
-
"name": "
|
9902
|
-
"
|
9877
|
+
"kind": "field",
|
9878
|
+
"name": "ariaLabelledby",
|
9879
|
+
"type": {
|
9880
|
+
"text": "string | null"
|
9881
|
+
},
|
9882
|
+
"default": "null",
|
9883
|
+
"description": "aria-labelledby for an interactive popover only, defaults to the trigger component id.\nUsed in nested cases where the triggerComponent isn't the actual button.",
|
9884
|
+
"attribute": "aria-labelledby",
|
9885
|
+
"reflects": true,
|
9903
9886
|
"inheritedFrom": {
|
9904
|
-
"name": "
|
9905
|
-
"module": "
|
9887
|
+
"name": "Popover",
|
9888
|
+
"module": "components/popover/popover.component.js"
|
9906
9889
|
}
|
9907
9890
|
},
|
9908
9891
|
{
|
9909
9892
|
"kind": "field",
|
9910
|
-
"name": "
|
9893
|
+
"name": "ariaDescribedby",
|
9911
9894
|
"type": {
|
9912
|
-
"text": "
|
9895
|
+
"text": "string | null"
|
9913
9896
|
},
|
9914
|
-
"default": "
|
9915
|
-
"description": "
|
9916
|
-
"attribute": "
|
9897
|
+
"default": "null",
|
9898
|
+
"description": "aria-describedby of the popover.",
|
9899
|
+
"attribute": "aria-describedby",
|
9917
9900
|
"reflects": true,
|
9918
9901
|
"inheritedFrom": {
|
9919
|
-
"name": "
|
9920
|
-
"module": "
|
9902
|
+
"name": "Popover",
|
9903
|
+
"module": "components/popover/popover.component.js"
|
9921
9904
|
}
|
9922
9905
|
},
|
9923
9906
|
{
|
9924
|
-
"kind": "
|
9925
|
-
"name": "
|
9926
|
-
"
|
9927
|
-
|
9928
|
-
|
9929
|
-
|
9930
|
-
|
9931
|
-
|
9932
|
-
|
9933
|
-
}
|
9934
|
-
],
|
9907
|
+
"kind": "field",
|
9908
|
+
"name": "disableAriaHasPopup",
|
9909
|
+
"type": {
|
9910
|
+
"text": "boolean"
|
9911
|
+
},
|
9912
|
+
"description": "Disable setting the aria-haspopup attribute on trigger element.\nMake sure to set this to true when the popover is extended and its role\nis not 'dialog' or 'alertdialog' i.e. listbox, menu, etc.",
|
9913
|
+
"default": "false",
|
9914
|
+
"attribute": "disable-aria-haspopup",
|
9915
|
+
"reflects": true,
|
9935
9916
|
"inheritedFrom": {
|
9936
|
-
"name": "
|
9937
|
-
"module": "
|
9917
|
+
"name": "Popover",
|
9918
|
+
"module": "components/popover/popover.component.js"
|
9938
9919
|
}
|
9939
9920
|
},
|
9940
9921
|
{
|
9941
|
-
"kind": "
|
9942
|
-
"name": "
|
9922
|
+
"kind": "field",
|
9923
|
+
"name": "arrowElement",
|
9924
|
+
"type": {
|
9925
|
+
"text": "HTMLElement | null"
|
9926
|
+
},
|
9943
9927
|
"privacy": "public",
|
9944
|
-
"
|
9928
|
+
"default": "null",
|
9945
9929
|
"inheritedFrom": {
|
9946
|
-
"name": "
|
9947
|
-
"module": "
|
9930
|
+
"name": "Popover",
|
9931
|
+
"module": "components/popover/popover.component.js"
|
9948
9932
|
}
|
9949
9933
|
},
|
9950
9934
|
{
|
9951
|
-
"kind": "
|
9952
|
-
"name": "
|
9935
|
+
"kind": "field",
|
9936
|
+
"name": "triggerElement",
|
9937
|
+
"type": {
|
9938
|
+
"text": "HTMLElement | null"
|
9939
|
+
},
|
9953
9940
|
"privacy": "public",
|
9954
|
-
"
|
9941
|
+
"default": "null",
|
9955
9942
|
"inheritedFrom": {
|
9956
|
-
"name": "
|
9957
|
-
"module": "
|
9943
|
+
"name": "Popover",
|
9944
|
+
"module": "components/popover/popover.component.js"
|
9958
9945
|
}
|
9959
9946
|
},
|
9960
9947
|
{
|
9961
9948
|
"kind": "method",
|
9962
|
-
"name": "
|
9949
|
+
"name": "setupTriggerListener",
|
9963
9950
|
"privacy": "private",
|
9964
|
-
"
|
9965
|
-
{
|
9966
|
-
"name": "element",
|
9967
|
-
"type": {
|
9968
|
-
"text": "HTMLElement"
|
9969
|
-
},
|
9970
|
-
"description": "The element to check."
|
9971
|
-
}
|
9972
|
-
],
|
9973
|
-
"description": "Checks if the element has no client rectangles (not visible in the viewport).",
|
9974
|
-
"return": {
|
9975
|
-
"type": {
|
9976
|
-
"text": ""
|
9977
|
-
}
|
9978
|
-
},
|
9951
|
+
"description": "Sets up the trigger event listeners based on the trigger type.",
|
9979
9952
|
"inheritedFrom": {
|
9980
|
-
"name": "
|
9981
|
-
"module": "
|
9953
|
+
"name": "Popover",
|
9954
|
+
"module": "components/popover/popover.component.js"
|
9982
9955
|
}
|
9983
9956
|
},
|
9984
9957
|
{
|
9985
9958
|
"kind": "method",
|
9986
|
-
"name": "
|
9959
|
+
"name": "removeEventListeners",
|
9987
9960
|
"privacy": "private",
|
9988
|
-
"
|
9989
|
-
{
|
9990
|
-
"name": "element",
|
9991
|
-
"type": {
|
9992
|
-
"text": "HTMLElement"
|
9993
|
-
},
|
9994
|
-
"description": "The element to check."
|
9995
|
-
}
|
9996
|
-
],
|
9997
|
-
"description": "Checks if the element has zero dimensions (width and height are both 0).",
|
9998
|
-
"return": {
|
9999
|
-
"type": {
|
10000
|
-
"text": ""
|
10001
|
-
}
|
10002
|
-
},
|
9961
|
+
"description": "Removes the trigger event listeners.",
|
10003
9962
|
"inheritedFrom": {
|
10004
|
-
"name": "
|
10005
|
-
"module": "
|
9963
|
+
"name": "Popover",
|
9964
|
+
"module": "components/popover/popover.component.js"
|
10006
9965
|
}
|
10007
9966
|
},
|
10008
9967
|
{
|
10009
|
-
"kind": "
|
10010
|
-
"name": "
|
10011
|
-
"privacy": "
|
9968
|
+
"kind": "field",
|
9969
|
+
"name": "onOutsidePopoverClick",
|
9970
|
+
"privacy": "protected",
|
9971
|
+
"description": "Handles the outside click event to close the popover.",
|
10012
9972
|
"parameters": [
|
10013
9973
|
{
|
10014
|
-
"
|
10015
|
-
"
|
10016
|
-
"text": "HTMLElement"
|
10017
|
-
},
|
10018
|
-
"description": "The element to check."
|
9974
|
+
"description": "The mouse event.",
|
9975
|
+
"name": "event"
|
10019
9976
|
}
|
10020
9977
|
],
|
10021
|
-
"description": "Determines if the element is not visible in the DOM.",
|
10022
|
-
"return": {
|
10023
|
-
"type": {
|
10024
|
-
"text": ""
|
10025
|
-
}
|
10026
|
-
},
|
10027
9978
|
"inheritedFrom": {
|
10028
|
-
"name": "
|
10029
|
-
"module": "
|
9979
|
+
"name": "Popover",
|
9980
|
+
"module": "components/popover/popover.component.js"
|
10030
9981
|
}
|
10031
9982
|
},
|
10032
9983
|
{
|
10033
|
-
"kind": "
|
10034
|
-
"name": "
|
9984
|
+
"kind": "field",
|
9985
|
+
"name": "onEscapeKeydown",
|
10035
9986
|
"privacy": "private",
|
9987
|
+
"description": "Handles the escape keydown event to close the popover.\n\nThis method is attached to the document.",
|
10036
9988
|
"parameters": [
|
10037
9989
|
{
|
10038
|
-
"
|
10039
|
-
"
|
10040
|
-
"text": "HTMLElement"
|
10041
|
-
},
|
10042
|
-
"description": "The element to check."
|
9990
|
+
"description": "The keyboard event.",
|
9991
|
+
"name": "event"
|
10043
9992
|
}
|
10044
9993
|
],
|
10045
|
-
"description": "Checks if the element has inline styles that make it hidden.",
|
10046
|
-
"return": {
|
10047
|
-
"type": {
|
10048
|
-
"text": ""
|
10049
|
-
}
|
10050
|
-
},
|
10051
9994
|
"inheritedFrom": {
|
10052
|
-
"name": "
|
10053
|
-
"module": "
|
9995
|
+
"name": "Popover",
|
9996
|
+
"module": "components/popover/popover.component.js"
|
10054
9997
|
}
|
10055
9998
|
},
|
10056
9999
|
{
|
10057
|
-
"kind": "
|
10058
|
-
"name": "
|
10000
|
+
"kind": "field",
|
10001
|
+
"name": "onPopoverFocusOut",
|
10059
10002
|
"privacy": "private",
|
10003
|
+
"description": "Handles the popover focus out event.",
|
10060
10004
|
"parameters": [
|
10061
10005
|
{
|
10062
|
-
"
|
10063
|
-
"
|
10064
|
-
"text": "HTMLElement"
|
10065
|
-
},
|
10066
|
-
"description": "The element to check."
|
10006
|
+
"description": "The focus event.",
|
10007
|
+
"name": "event"
|
10067
10008
|
}
|
10068
10009
|
],
|
10069
|
-
"description": "Checks if the element is hidden by a computed style.",
|
10070
|
-
"return": {
|
10071
|
-
"type": {
|
10072
|
-
"text": ""
|
10073
|
-
}
|
10074
|
-
},
|
10075
10010
|
"inheritedFrom": {
|
10076
|
-
"name": "
|
10077
|
-
"module": "
|
10011
|
+
"name": "Popover",
|
10012
|
+
"module": "components/popover/popover.component.js"
|
10078
10013
|
}
|
10079
10014
|
},
|
10080
10015
|
{
|
10081
10016
|
"kind": "method",
|
10082
|
-
"name": "
|
10083
|
-
"privacy": "
|
10017
|
+
"name": "isOpenUpdated",
|
10018
|
+
"privacy": "protected",
|
10084
10019
|
"parameters": [
|
10085
10020
|
{
|
10086
|
-
"name": "
|
10021
|
+
"name": "oldValue",
|
10087
10022
|
"type": {
|
10088
|
-
"text": "
|
10023
|
+
"text": "boolean"
|
10089
10024
|
},
|
10090
|
-
"description": "The
|
10025
|
+
"description": "The old value of the visible property."
|
10026
|
+
},
|
10027
|
+
{
|
10028
|
+
"name": "newValue",
|
10029
|
+
"type": {
|
10030
|
+
"text": "boolean"
|
10031
|
+
},
|
10032
|
+
"description": "The new value of the visible property."
|
10091
10033
|
}
|
10092
10034
|
],
|
10093
|
-
"description": "
|
10094
|
-
"return": {
|
10095
|
-
"type": {
|
10096
|
-
"text": ""
|
10097
|
-
}
|
10098
|
-
},
|
10035
|
+
"description": "Handles the popover visibility change and position the popover.\nHandles the exit event to close the popover.",
|
10099
10036
|
"inheritedFrom": {
|
10100
|
-
"name": "
|
10101
|
-
"module": "
|
10037
|
+
"name": "Popover",
|
10038
|
+
"module": "components/popover/popover.component.js"
|
10102
10039
|
}
|
10103
10040
|
},
|
10104
10041
|
{
|
10105
|
-
"kind": "
|
10106
|
-
"name": "
|
10042
|
+
"kind": "field",
|
10043
|
+
"name": "handleMouseEnter",
|
10107
10044
|
"privacy": "private",
|
10108
|
-
"
|
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
|
-
},
|
10045
|
+
"description": "Handles mouse enter event on the trigger element.\nThis method sets the `isHovered` flag to true and shows the popover",
|
10123
10046
|
"inheritedFrom": {
|
10124
|
-
"name": "
|
10125
|
-
"module": "
|
10047
|
+
"name": "Popover",
|
10048
|
+
"module": "components/popover/popover.component.js"
|
10126
10049
|
}
|
10127
10050
|
},
|
10128
10051
|
{
|
10129
|
-
"kind": "
|
10130
|
-
"name": "
|
10052
|
+
"kind": "field",
|
10053
|
+
"name": "handleMouseLeave",
|
10131
10054
|
"privacy": "private",
|
10132
|
-
"
|
10133
|
-
{
|
10134
|
-
"name": "element",
|
10135
|
-
"type": {
|
10136
|
-
"text": "HTMLElement"
|
10137
|
-
},
|
10138
|
-
"description": "The element to check."
|
10139
|
-
}
|
10140
|
-
],
|
10141
|
-
"description": "Checks if the element is not tabbable.",
|
10142
|
-
"return": {
|
10143
|
-
"type": {
|
10144
|
-
"text": ""
|
10145
|
-
}
|
10146
|
-
},
|
10055
|
+
"description": "Handles mouse leave event on the trigger element.\nThis method sets the `isHovered` flag to false and starts the close delay\ntimer to hide the popover.",
|
10147
10056
|
"inheritedFrom": {
|
10148
|
-
"name": "
|
10149
|
-
"module": "
|
10057
|
+
"name": "Popover",
|
10058
|
+
"module": "components/popover/popover.component.js"
|
10059
|
+
}
|
10060
|
+
},
|
10061
|
+
{
|
10062
|
+
"kind": "field",
|
10063
|
+
"name": "handleFocusOut",
|
10064
|
+
"privacy": "private",
|
10065
|
+
"description": "Handles focus out event on the trigger element.\nThis method checks if the popover is not hovered and hides the popover.\nIf the popover is hovered, it will not hide the popover.",
|
10066
|
+
"inheritedFrom": {
|
10067
|
+
"name": "Popover",
|
10068
|
+
"module": "components/popover/popover.component.js"
|
10069
|
+
}
|
10070
|
+
},
|
10071
|
+
{
|
10072
|
+
"kind": "field",
|
10073
|
+
"name": "startCloseDelay",
|
10074
|
+
"privacy": "private",
|
10075
|
+
"description": "Starts the close delay timer.\nIf the popover is not interactive, it will close the popover after the delay.",
|
10076
|
+
"inheritedFrom": {
|
10077
|
+
"name": "Popover",
|
10078
|
+
"module": "components/popover/popover.component.js"
|
10079
|
+
}
|
10080
|
+
},
|
10081
|
+
{
|
10082
|
+
"kind": "field",
|
10083
|
+
"name": "cancelCloseDelay",
|
10084
|
+
"privacy": "private",
|
10085
|
+
"description": "Cancels the close delay timer.",
|
10086
|
+
"inheritedFrom": {
|
10087
|
+
"name": "Popover",
|
10088
|
+
"module": "components/popover/popover.component.js"
|
10089
|
+
}
|
10090
|
+
},
|
10091
|
+
{
|
10092
|
+
"kind": "field",
|
10093
|
+
"name": "showPopover",
|
10094
|
+
"privacy": "public",
|
10095
|
+
"description": "Shows the popover.",
|
10096
|
+
"inheritedFrom": {
|
10097
|
+
"name": "Popover",
|
10098
|
+
"module": "components/popover/popover.component.js"
|
10099
|
+
}
|
10100
|
+
},
|
10101
|
+
{
|
10102
|
+
"kind": "field",
|
10103
|
+
"name": "hidePopover",
|
10104
|
+
"privacy": "public",
|
10105
|
+
"description": "Hides the popover.",
|
10106
|
+
"inheritedFrom": {
|
10107
|
+
"name": "Popover",
|
10108
|
+
"module": "components/popover/popover.component.js"
|
10109
|
+
}
|
10110
|
+
},
|
10111
|
+
{
|
10112
|
+
"kind": "field",
|
10113
|
+
"name": "togglePopoverVisible",
|
10114
|
+
"privacy": "public",
|
10115
|
+
"description": "Toggles the popover visibility.",
|
10116
|
+
"inheritedFrom": {
|
10117
|
+
"name": "Popover",
|
10118
|
+
"module": "components/popover/popover.component.js"
|
10150
10119
|
}
|
10151
10120
|
},
|
10152
10121
|
{
|
10153
10122
|
"kind": "method",
|
10154
|
-
"name": "
|
10123
|
+
"name": "positionPopover",
|
10155
10124
|
"privacy": "private",
|
10125
|
+
"description": "Positions the popover based on the trigger element.\nIt also handles the flip, size and arrow placement.\nIt uses the floating-ui/dom library to calculate the position.",
|
10126
|
+
"inheritedFrom": {
|
10127
|
+
"name": "Popover",
|
10128
|
+
"module": "components/popover/popover.component.js"
|
10129
|
+
}
|
10130
|
+
},
|
10131
|
+
{
|
10132
|
+
"kind": "method",
|
10133
|
+
"name": "findClosestPopover",
|
10134
|
+
"privacy": "protected",
|
10156
10135
|
"return": {
|
10157
10136
|
"type": {
|
10158
|
-
"text": ""
|
10137
|
+
"text": "Popover | null"
|
10159
10138
|
}
|
10160
10139
|
},
|
10161
10140
|
"parameters": [
|
10162
10141
|
{
|
10163
10142
|
"name": "element",
|
10164
10143
|
"type": {
|
10165
|
-
"text": "
|
10144
|
+
"text": "Element"
|
10166
10145
|
},
|
10167
|
-
"description": "The element to
|
10146
|
+
"description": "The element to start searching from."
|
10168
10147
|
}
|
10169
10148
|
],
|
10170
|
-
"description": "
|
10149
|
+
"description": "Finds the closest popover to the passed element in the DOM tree.\n\nUseful when need to find the parent popover in a nested popover scenario.",
|
10171
10150
|
"inheritedFrom": {
|
10172
|
-
"name": "
|
10173
|
-
"module": "
|
10151
|
+
"name": "Popover",
|
10152
|
+
"module": "components/popover/popover.component.js"
|
10174
10153
|
}
|
10175
10154
|
},
|
10176
10155
|
{
|
10177
|
-
"kind": "
|
10178
|
-
"name": "
|
10179
|
-
"
|
10180
|
-
"
|
10181
|
-
|
10182
|
-
|
10183
|
-
|
10184
|
-
|
10185
|
-
|
10186
|
-
|
10187
|
-
|
10188
|
-
|
10189
|
-
"
|
10190
|
-
"
|
10191
|
-
|
10192
|
-
|
10193
|
-
|
10156
|
+
"kind": "field",
|
10157
|
+
"name": "utils",
|
10158
|
+
"default": "new PopoverUtils(this)",
|
10159
|
+
"inheritedFrom": {
|
10160
|
+
"name": "Popover",
|
10161
|
+
"module": "components/popover/popover.component.js"
|
10162
|
+
}
|
10163
|
+
}
|
10164
|
+
],
|
10165
|
+
"events": [
|
10166
|
+
{
|
10167
|
+
"description": "(React: onShown) This event is dispatched when the coachmark is shown",
|
10168
|
+
"name": "shown",
|
10169
|
+
"reactName": "onShown",
|
10170
|
+
"inheritedFrom": {
|
10171
|
+
"name": "Popover",
|
10172
|
+
"module": "src/components/popover/popover.component.ts"
|
10173
|
+
}
|
10174
|
+
},
|
10175
|
+
{
|
10176
|
+
"description": "(React: onHidden) This event is dispatched when the coachmark is hidden",
|
10177
|
+
"name": "hidden",
|
10178
|
+
"reactName": "onHidden",
|
10179
|
+
"inheritedFrom": {
|
10180
|
+
"name": "Popover",
|
10181
|
+
"module": "src/components/popover/popover.component.ts"
|
10182
|
+
}
|
10183
|
+
},
|
10184
|
+
{
|
10185
|
+
"description": "(React: onCreated) This event is dispatched when the coachmark is created (added to the DOM)",
|
10186
|
+
"name": "created",
|
10187
|
+
"reactName": "onCreated",
|
10188
|
+
"inheritedFrom": {
|
10189
|
+
"name": "Popover",
|
10190
|
+
"module": "src/components/popover/popover.component.ts"
|
10191
|
+
}
|
10192
|
+
},
|
10193
|
+
{
|
10194
|
+
"description": "(React: onDestroyed) This event is dispatched when the coachmark is destroyed (removed from the DOM)",
|
10195
|
+
"name": "destroyed",
|
10196
|
+
"reactName": "onDestroyed",
|
10197
|
+
"inheritedFrom": {
|
10198
|
+
"name": "Popover",
|
10199
|
+
"module": "src/components/popover/popover.component.ts"
|
10200
|
+
}
|
10201
|
+
}
|
10202
|
+
],
|
10203
|
+
"attributes": [
|
10204
|
+
{
|
10205
|
+
"name": "trigger",
|
10206
|
+
"type": {
|
10207
|
+
"text": "PopoverTrigger"
|
10194
10208
|
},
|
10209
|
+
"description": "Determines the events that cause the Coachmark to show.\nMultiple event names should be separated by spaces.\nFor example to allow both click and hover, use 'click mouseenter' as the trigger.\n- **click**\n- **mouseenter**\n- **focusin**\n- **manual**",
|
10210
|
+
"default": "manual",
|
10211
|
+
"fieldName": "trigger",
|
10195
10212
|
"inheritedFrom": {
|
10196
|
-
"name": "
|
10197
|
-
"module": "
|
10213
|
+
"name": "Popover",
|
10214
|
+
"module": "src/components/popover/popover.component.ts"
|
10198
10215
|
}
|
10199
10216
|
},
|
10200
10217
|
{
|
10201
|
-
"
|
10202
|
-
"
|
10203
|
-
|
10204
|
-
"return": {
|
10205
|
-
"type": {
|
10206
|
-
"text": ""
|
10207
|
-
}
|
10218
|
+
"name": "show-arrow",
|
10219
|
+
"type": {
|
10220
|
+
"text": "boolean"
|
10208
10221
|
},
|
10209
|
-
"
|
10210
|
-
|
10211
|
-
|
10212
|
-
"type": {
|
10213
|
-
"text": "ShadowRoot | HTMLElement"
|
10214
|
-
},
|
10215
|
-
"description": "The root element to search for focusable elements."
|
10216
|
-
},
|
10217
|
-
{
|
10218
|
-
"name": "matches",
|
10219
|
-
"default": "new Set()",
|
10220
|
-
"type": {
|
10221
|
-
"text": "Set<HTMLElement>"
|
10222
|
-
},
|
10223
|
-
"description": "The set of focusable elements."
|
10224
|
-
}
|
10225
|
-
],
|
10226
|
-
"description": "Recursively finds all focusable elements within the given root and its descendants.\n\nMake sure this is performant, as it will be called multiple times.",
|
10222
|
+
"description": "The arrow visibility of the Coachmark.",
|
10223
|
+
"default": "true",
|
10224
|
+
"fieldName": "showArrow",
|
10227
10225
|
"inheritedFrom": {
|
10228
|
-
"name": "
|
10229
|
-
"module": "
|
10226
|
+
"name": "Popover",
|
10227
|
+
"module": "src/components/popover/popover.component.ts"
|
10230
10228
|
}
|
10231
10229
|
},
|
10232
10230
|
{
|
10233
|
-
"
|
10234
|
-
"
|
10235
|
-
|
10236
|
-
|
10231
|
+
"name": "close-button",
|
10232
|
+
"type": {
|
10233
|
+
"text": "boolean"
|
10234
|
+
},
|
10235
|
+
"description": "The close button visibility of the Coachmark.",
|
10236
|
+
"default": "true",
|
10237
|
+
"fieldName": "closeButton",
|
10237
10238
|
"inheritedFrom": {
|
10238
|
-
"name": "
|
10239
|
-
"module": "
|
10239
|
+
"name": "Popover",
|
10240
|
+
"module": "src/components/popover/popover.component.ts"
|
10240
10241
|
}
|
10241
10242
|
},
|
10242
10243
|
{
|
10243
|
-
"
|
10244
|
-
"
|
10245
|
-
|
10246
|
-
|
10247
|
-
|
10248
|
-
|
10249
|
-
|
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.",
|
10244
|
+
"name": "disable-aria-expanded",
|
10245
|
+
"type": {
|
10246
|
+
"text": "boolean"
|
10247
|
+
},
|
10248
|
+
"description": "Disable aria-expanded attribute on trigger element.",
|
10249
|
+
"default": "true",
|
10250
|
+
"fieldName": "disableAriaExpanded",
|
10257
10251
|
"inheritedFrom": {
|
10258
|
-
"name": "
|
10259
|
-
"module": "
|
10252
|
+
"name": "Popover",
|
10253
|
+
"module": "src/components/popover/popover.component.ts"
|
10260
10254
|
}
|
10261
10255
|
},
|
10262
10256
|
{
|
10263
|
-
"
|
10264
|
-
"
|
10265
|
-
|
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
|
-
}
|
10257
|
+
"name": "should-focus-trap-wrap",
|
10258
|
+
"type": {
|
10259
|
+
"text": "boolean"
|
10287
10260
|
},
|
10261
|
+
"default": "true",
|
10262
|
+
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `focusTrap` is true.",
|
10263
|
+
"fieldName": "shouldFocusTrapWrap",
|
10288
10264
|
"inheritedFrom": {
|
10289
10265
|
"name": "FocusTrapMixin",
|
10290
|
-
"module": "utils/mixins/FocusTrapMixin.
|
10266
|
+
"module": "src/utils/mixins/FocusTrapMixin.ts"
|
10291
10267
|
}
|
10292
10268
|
},
|
10293
10269
|
{
|
10294
|
-
"
|
10295
|
-
"
|
10296
|
-
|
10297
|
-
"description": "Returns the deepest active element in the shadow DOM.",
|
10298
|
-
"return": {
|
10299
|
-
"type": {
|
10300
|
-
"text": ""
|
10301
|
-
}
|
10270
|
+
"name": "id",
|
10271
|
+
"type": {
|
10272
|
+
"text": "string"
|
10302
10273
|
},
|
10274
|
+
"default": "''",
|
10275
|
+
"description": "The unique ID of the popover.",
|
10276
|
+
"fieldName": "id",
|
10303
10277
|
"inheritedFrom": {
|
10304
|
-
"name": "
|
10305
|
-
"module": "
|
10278
|
+
"name": "Popover",
|
10279
|
+
"module": "src/components/popover/popover.component.ts"
|
10306
10280
|
}
|
10307
10281
|
},
|
10308
10282
|
{
|
10309
|
-
"
|
10310
|
-
"
|
10311
|
-
|
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
|
-
}
|
10283
|
+
"name": "triggerID",
|
10284
|
+
"type": {
|
10285
|
+
"text": "string"
|
10326
10286
|
},
|
10287
|
+
"default": "''",
|
10288
|
+
"description": "The ID of the element that triggers the popover.\nThis attribute is required for the popover to work.",
|
10289
|
+
"fieldName": "triggerID",
|
10327
10290
|
"inheritedFrom": {
|
10328
|
-
"name": "
|
10329
|
-
"module": "
|
10291
|
+
"name": "Popover",
|
10292
|
+
"module": "src/components/popover/popover.component.ts"
|
10330
10293
|
}
|
10331
10294
|
},
|
10332
10295
|
{
|
10333
|
-
"
|
10334
|
-
"
|
10335
|
-
|
10336
|
-
"parameters": [
|
10337
|
-
{
|
10338
|
-
"name": "activeElement",
|
10339
|
-
"type": {
|
10340
|
-
"text": "HTMLElement"
|
10341
|
-
},
|
10342
|
-
"description": "The active element."
|
10343
|
-
},
|
10344
|
-
{
|
10345
|
-
"name": "element",
|
10346
|
-
"type": {
|
10347
|
-
"text": "HTMLElement"
|
10348
|
-
},
|
10349
|
-
"description": "The element to compare."
|
10350
|
-
}
|
10351
|
-
],
|
10352
|
-
"description": "Checks if the active element is equal to the given element.",
|
10353
|
-
"return": {
|
10354
|
-
"type": {
|
10355
|
-
"text": ""
|
10356
|
-
}
|
10296
|
+
"name": "placement",
|
10297
|
+
"type": {
|
10298
|
+
"text": "PopoverPlacement"
|
10357
10299
|
},
|
10300
|
+
"description": "The placement of the popover.\n- **top**\n- **top-start**\n- **top-end**\n- **bottom**\n- **bottom-start**\n- **bottom-end**\n- **left**\n- **left-start**\n- **left-end**\n- **right**\n- **right-start**\n- **right-end**",
|
10301
|
+
"default": "bottom",
|
10302
|
+
"fieldName": "placement",
|
10358
10303
|
"inheritedFrom": {
|
10359
|
-
"name": "
|
10360
|
-
"module": "
|
10304
|
+
"name": "Popover",
|
10305
|
+
"module": "src/components/popover/popover.component.ts"
|
10361
10306
|
}
|
10362
10307
|
},
|
10363
10308
|
{
|
10364
|
-
"
|
10365
|
-
"
|
10366
|
-
|
10367
|
-
|
10368
|
-
|
10369
|
-
|
10370
|
-
|
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.",
|
10309
|
+
"name": "color",
|
10310
|
+
"type": {
|
10311
|
+
"text": "PopoverColor"
|
10312
|
+
},
|
10313
|
+
"description": "Color of the popover\n- **tonal**\n- **contrast**",
|
10314
|
+
"default": "tonal",
|
10315
|
+
"fieldName": "color",
|
10380
10316
|
"inheritedFrom": {
|
10381
|
-
"name": "
|
10382
|
-
"module": "
|
10317
|
+
"name": "Popover",
|
10318
|
+
"module": "src/components/popover/popover.component.ts"
|
10383
10319
|
}
|
10384
10320
|
},
|
10385
10321
|
{
|
10386
|
-
"
|
10387
|
-
"
|
10388
|
-
|
10389
|
-
|
10390
|
-
|
10391
|
-
|
10392
|
-
|
10393
|
-
"text": "KeyboardEvent"
|
10394
|
-
},
|
10395
|
-
"description": "The keyboard event."
|
10396
|
-
}
|
10397
|
-
],
|
10398
|
-
"description": "Traps focus within the container.",
|
10322
|
+
"name": "visible",
|
10323
|
+
"type": {
|
10324
|
+
"text": "boolean"
|
10325
|
+
},
|
10326
|
+
"description": "The visibility of the popover.",
|
10327
|
+
"default": "false",
|
10328
|
+
"fieldName": "visible",
|
10399
10329
|
"inheritedFrom": {
|
10400
|
-
"name": "
|
10401
|
-
"module": "
|
10330
|
+
"name": "Popover",
|
10331
|
+
"module": "src/components/popover/popover.component.ts"
|
10402
10332
|
}
|
10403
10333
|
},
|
10404
10334
|
{
|
10405
|
-
"
|
10406
|
-
"
|
10407
|
-
|
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
|
-
}
|
10335
|
+
"name": "offset",
|
10336
|
+
"type": {
|
10337
|
+
"text": "number"
|
10413
10338
|
},
|
10339
|
+
"description": "The offset of the popover.",
|
10340
|
+
"default": "4",
|
10341
|
+
"fieldName": "offset",
|
10414
10342
|
"inheritedFrom": {
|
10415
|
-
"name": "
|
10416
|
-
"module": "
|
10343
|
+
"name": "Popover",
|
10344
|
+
"module": "src/components/popover/popover.component.ts"
|
10417
10345
|
}
|
10418
|
-
}
|
10419
|
-
],
|
10420
|
-
"events": [
|
10421
|
-
{
|
10422
|
-
"description": "(React: onShown) Dispatched when the dialog is shown",
|
10423
|
-
"name": "shown",
|
10424
|
-
"reactName": "onShown"
|
10425
10346
|
},
|
10426
10347
|
{
|
10427
|
-
"
|
10428
|
-
"
|
10429
|
-
|
10348
|
+
"name": "boundary",
|
10349
|
+
"type": {
|
10350
|
+
"text": "'clippingAncestors' | string"
|
10351
|
+
},
|
10352
|
+
"description": "This describes the clipping element(s) or area that overflow will be checked relative to.\nThe default is 'clippingAncestors', which are the overflow ancestors which will cause the\nelement to be clipped.\n\nPossible values:\n - 'clippingAncestors'\n - any css selector",
|
10353
|
+
"default": "'clippingAncestors'",
|
10354
|
+
"fieldName": "boundary",
|
10355
|
+
"inheritedFrom": {
|
10356
|
+
"name": "Popover",
|
10357
|
+
"module": "src/components/popover/popover.component.ts"
|
10358
|
+
}
|
10430
10359
|
},
|
10431
10360
|
{
|
10432
|
-
"
|
10433
|
-
"
|
10434
|
-
|
10361
|
+
"name": "boundary-root",
|
10362
|
+
"type": {
|
10363
|
+
"text": "'viewport' | 'document'"
|
10364
|
+
},
|
10365
|
+
"description": "This describes the root boundary that the element will be checked for overflow relative to.\nThe default is 'viewport', which is the area of the page the user can see on the screen.\n\nThe other string option is 'document', which is the entire page outside the viewport.",
|
10366
|
+
"default": "'viewport'",
|
10367
|
+
"fieldName": "boundaryRoot",
|
10368
|
+
"inheritedFrom": {
|
10369
|
+
"name": "Popover",
|
10370
|
+
"module": "src/components/popover/popover.component.ts"
|
10371
|
+
}
|
10435
10372
|
},
|
10436
10373
|
{
|
10437
|
-
"
|
10438
|
-
"
|
10439
|
-
|
10374
|
+
"name": "boundary-padding",
|
10375
|
+
"type": {
|
10376
|
+
"text": "undefined | number"
|
10377
|
+
},
|
10378
|
+
"description": "Virtual padding around the boundary to check for overflow.\nSo the popover will not be placed on top of the edge of the boundary.\n\nDefault works well for most cases, but you can set this to customise it when necessary.",
|
10379
|
+
"default": "undefined",
|
10380
|
+
"fieldName": "boundaryPadding",
|
10381
|
+
"inheritedFrom": {
|
10382
|
+
"name": "Popover",
|
10383
|
+
"module": "src/components/popover/popover.component.ts"
|
10384
|
+
}
|
10440
10385
|
},
|
10441
10386
|
{
|
10442
|
-
"
|
10443
|
-
"name": "close",
|
10444
|
-
"reactName": "onClose"
|
10445
|
-
}
|
10446
|
-
],
|
10447
|
-
"attributes": [
|
10448
|
-
{
|
10449
|
-
"name": "id",
|
10387
|
+
"name": "focus-trap",
|
10450
10388
|
"type": {
|
10451
|
-
"text": "
|
10389
|
+
"text": "boolean"
|
10452
10390
|
},
|
10453
|
-
"
|
10454
|
-
"
|
10455
|
-
"fieldName": "
|
10391
|
+
"description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.",
|
10392
|
+
"default": "false",
|
10393
|
+
"fieldName": "focusTrap",
|
10394
|
+
"inheritedFrom": {
|
10395
|
+
"name": "Popover",
|
10396
|
+
"module": "src/components/popover/popover.component.ts"
|
10397
|
+
}
|
10456
10398
|
},
|
10457
10399
|
{
|
10458
|
-
"name": "
|
10400
|
+
"name": "prevent-scroll",
|
10459
10401
|
"type": {
|
10460
|
-
"text": "
|
10402
|
+
"text": "boolean"
|
10461
10403
|
},
|
10462
|
-
"description": "
|
10463
|
-
"default": "
|
10464
|
-
"fieldName": "
|
10404
|
+
"description": "Prevent outside scrolling when popover is shown.",
|
10405
|
+
"default": "false",
|
10406
|
+
"fieldName": "preventScroll",
|
10407
|
+
"inheritedFrom": {
|
10408
|
+
"name": "Popover",
|
10409
|
+
"module": "src/components/popover/popover.component.ts"
|
10410
|
+
}
|
10465
10411
|
},
|
10466
10412
|
{
|
10467
|
-
"name": "
|
10413
|
+
"name": "interactive",
|
10468
10414
|
"type": {
|
10469
10415
|
"text": "boolean"
|
10470
10416
|
},
|
10471
|
-
"description": "
|
10417
|
+
"description": "Determines whether the popover is interactive.\nMake sure to set focusTrap to true to keep the focus inside the popover in case necessary.\nSetting interactive to true will not automatically set focusTrap!",
|
10472
10418
|
"default": "false",
|
10473
|
-
"fieldName": "
|
10419
|
+
"fieldName": "interactive",
|
10420
|
+
"inheritedFrom": {
|
10421
|
+
"name": "Popover",
|
10422
|
+
"module": "src/components/popover/popover.component.ts"
|
10423
|
+
}
|
10474
10424
|
},
|
10475
10425
|
{
|
10476
|
-
"name": "
|
10426
|
+
"name": "delay",
|
10477
10427
|
"type": {
|
10478
|
-
"text": "
|
10428
|
+
"text": "string"
|
10479
10429
|
},
|
10480
|
-
"description": "The
|
10481
|
-
"default": "
|
10482
|
-
"fieldName": "
|
10430
|
+
"description": "The delay of the show/hide popover.",
|
10431
|
+
"default": "0,0",
|
10432
|
+
"fieldName": "delay",
|
10433
|
+
"inheritedFrom": {
|
10434
|
+
"name": "Popover",
|
10435
|
+
"module": "src/components/popover/popover.component.ts"
|
10436
|
+
}
|
10483
10437
|
},
|
10484
10438
|
{
|
10485
|
-
"name": "
|
10439
|
+
"name": "hide-on-escape",
|
10486
10440
|
"type": {
|
10487
|
-
"text": "
|
10441
|
+
"text": "boolean"
|
10488
10442
|
},
|
10489
|
-
"description": "
|
10490
|
-
"default": "
|
10491
|
-
"fieldName": "
|
10443
|
+
"description": "Hide popover on escape key press.",
|
10444
|
+
"default": "false",
|
10445
|
+
"fieldName": "hideOnEscape",
|
10446
|
+
"inheritedFrom": {
|
10447
|
+
"name": "Popover",
|
10448
|
+
"module": "src/components/popover/popover.component.ts"
|
10449
|
+
}
|
10492
10450
|
},
|
10493
10451
|
{
|
10494
|
-
"name": "
|
10452
|
+
"name": "propagate-event-on-escape",
|
10495
10453
|
"type": {
|
10496
|
-
"text": "
|
10454
|
+
"text": "boolean"
|
10497
10455
|
},
|
10498
|
-
"description": "
|
10499
|
-
"default": "
|
10500
|
-
"fieldName": "
|
10456
|
+
"description": "Propagates the event, when the escape key is pressed (only when pressed inside the popover)\nIf true, the escape key press close the popover and will propagate the keydown event.\nIf false, the escape key press will close the popover but will not propagate the keydown event.\n(set to false to prevent the event from bubbling up to the document).\n\nThis only works when `hideOnEscape` is true.",
|
10457
|
+
"default": "false",
|
10458
|
+
"fieldName": "propagateEventOnEscape",
|
10459
|
+
"inheritedFrom": {
|
10460
|
+
"name": "Popover",
|
10461
|
+
"module": "src/components/popover/popover.component.ts"
|
10462
|
+
}
|
10501
10463
|
},
|
10502
10464
|
{
|
10503
|
-
"name": "
|
10465
|
+
"name": "hide-on-blur",
|
10504
10466
|
"type": {
|
10505
|
-
"text": "
|
10467
|
+
"text": "boolean"
|
10506
10468
|
},
|
10507
|
-
"
|
10508
|
-
"
|
10509
|
-
"fieldName": "
|
10469
|
+
"description": "Hide popover on blur.",
|
10470
|
+
"default": "false",
|
10471
|
+
"fieldName": "hideOnBlur",
|
10472
|
+
"inheritedFrom": {
|
10473
|
+
"name": "Popover",
|
10474
|
+
"module": "src/components/popover/popover.component.ts"
|
10475
|
+
}
|
10510
10476
|
},
|
10511
10477
|
{
|
10512
|
-
"name": "
|
10478
|
+
"name": "hide-on-outside-click",
|
10513
10479
|
"type": {
|
10514
|
-
"text": "
|
10480
|
+
"text": "boolean"
|
10515
10481
|
},
|
10516
|
-
"
|
10517
|
-
"
|
10518
|
-
"fieldName": "
|
10482
|
+
"description": "Hide on outside click of the popover.",
|
10483
|
+
"default": "false",
|
10484
|
+
"fieldName": "hideOnOutsideClick",
|
10485
|
+
"inheritedFrom": {
|
10486
|
+
"name": "Popover",
|
10487
|
+
"module": "src/components/popover/popover.component.ts"
|
10488
|
+
}
|
10519
10489
|
},
|
10520
10490
|
{
|
10521
|
-
"name": "
|
10491
|
+
"name": "focus-back-to-trigger",
|
10522
10492
|
"type": {
|
10523
|
-
"text": "
|
10493
|
+
"text": "boolean"
|
10524
10494
|
},
|
10525
|
-
"
|
10526
|
-
"
|
10527
|
-
"fieldName": "
|
10495
|
+
"description": "The focus back to trigger after the popover hide.",
|
10496
|
+
"default": "false",
|
10497
|
+
"fieldName": "focusBackToTrigger",
|
10498
|
+
"inheritedFrom": {
|
10499
|
+
"name": "Popover",
|
10500
|
+
"module": "src/components/popover/popover.component.ts"
|
10501
|
+
}
|
10528
10502
|
},
|
10529
10503
|
{
|
10530
|
-
"name": "
|
10504
|
+
"name": "backdrop",
|
10531
10505
|
"type": {
|
10532
|
-
"text": "
|
10506
|
+
"text": "boolean"
|
10533
10507
|
},
|
10534
|
-
"
|
10535
|
-
"
|
10536
|
-
"fieldName": "
|
10508
|
+
"description": "Determines whether the popover with backdrop.\nOther than popover and trigger element, the rest of the screen will be covered with a backdrop.",
|
10509
|
+
"default": "false",
|
10510
|
+
"fieldName": "backdrop",
|
10511
|
+
"inheritedFrom": {
|
10512
|
+
"name": "Popover",
|
10513
|
+
"module": "src/components/popover/popover.component.ts"
|
10514
|
+
}
|
10537
10515
|
},
|
10538
10516
|
{
|
10539
|
-
"name": "
|
10517
|
+
"name": "flip",
|
10540
10518
|
"type": {
|
10541
|
-
"text": "
|
10519
|
+
"text": "boolean"
|
10542
10520
|
},
|
10543
|
-
"
|
10544
|
-
"
|
10545
|
-
"fieldName": "
|
10521
|
+
"description": "Changes the placement of popover to keep it in view when scrolling.",
|
10522
|
+
"default": "true",
|
10523
|
+
"fieldName": "flip",
|
10524
|
+
"inheritedFrom": {
|
10525
|
+
"name": "Popover",
|
10526
|
+
"module": "src/components/popover/popover.component.ts"
|
10527
|
+
}
|
10546
10528
|
},
|
10547
10529
|
{
|
10548
|
-
"name": "
|
10530
|
+
"name": "size",
|
10549
10531
|
"type": {
|
10550
|
-
"text": "
|
10532
|
+
"text": "boolean"
|
10551
10533
|
},
|
10552
|
-
"description": "
|
10553
|
-
"
|
10534
|
+
"description": "Changes the size of popover to keep it in view when scrolling.",
|
10535
|
+
"default": "false",
|
10536
|
+
"fieldName": "size",
|
10537
|
+
"inheritedFrom": {
|
10538
|
+
"name": "Popover",
|
10539
|
+
"module": "src/components/popover/popover.component.ts"
|
10540
|
+
}
|
10541
|
+
},
|
10542
|
+
{
|
10543
|
+
"name": "z-index",
|
10544
|
+
"type": {
|
10545
|
+
"text": "number"
|
10546
|
+
},
|
10547
|
+
"description": "The z-index of the popover.",
|
10548
|
+
"default": "1000",
|
10549
|
+
"fieldName": "zIndex",
|
10550
|
+
"inheritedFrom": {
|
10551
|
+
"name": "Popover",
|
10552
|
+
"module": "src/components/popover/popover.component.ts"
|
10553
|
+
}
|
10554
10554
|
},
|
10555
10555
|
{
|
10556
|
-
"name": "
|
10556
|
+
"name": "append-to",
|
10557
10557
|
"type": {
|
10558
10558
|
"text": "string | undefined"
|
10559
10559
|
},
|
10560
|
-
"description": "
|
10561
|
-
"
|
10562
|
-
|
10563
|
-
|
10564
|
-
|
10565
|
-
|
10566
|
-
|
10567
|
-
},
|
10568
|
-
"description": "The html tag to be used for the header text",
|
10569
|
-
"fieldName": "headerTagName"
|
10560
|
+
"description": "Element ID that the popover append to.",
|
10561
|
+
"default": "''",
|
10562
|
+
"fieldName": "appendTo",
|
10563
|
+
"inheritedFrom": {
|
10564
|
+
"name": "Popover",
|
10565
|
+
"module": "src/components/popover/popover.component.ts"
|
10566
|
+
}
|
10570
10567
|
},
|
10571
10568
|
{
|
10572
|
-
"name": "
|
10569
|
+
"name": "close-button-aria-label",
|
10573
10570
|
"type": {
|
10574
|
-
"text": "string"
|
10571
|
+
"text": "string | null"
|
10575
10572
|
},
|
10576
|
-
"
|
10577
|
-
"
|
10573
|
+
"default": "null",
|
10574
|
+
"description": "aria-label attribute to be set for close button accessibility.",
|
10575
|
+
"fieldName": "closeButtonAriaLabel",
|
10576
|
+
"inheritedFrom": {
|
10577
|
+
"name": "Popover",
|
10578
|
+
"module": "src/components/popover/popover.component.ts"
|
10579
|
+
}
|
10578
10580
|
},
|
10579
10581
|
{
|
10580
10582
|
"name": "role",
|
10581
10583
|
"type": {
|
10582
|
-
"text": "
|
10584
|
+
"text": "HTMLElement['role']"
|
10583
10585
|
},
|
10584
|
-
"description": "Role of the
|
10586
|
+
"description": "Role of the popover",
|
10585
10587
|
"default": "dialog",
|
10586
|
-
"fieldName": "role"
|
10588
|
+
"fieldName": "role",
|
10589
|
+
"inheritedFrom": {
|
10590
|
+
"name": "Popover",
|
10591
|
+
"module": "src/components/popover/popover.component.ts"
|
10592
|
+
}
|
10587
10593
|
},
|
10588
10594
|
{
|
10589
|
-
"name": "
|
10595
|
+
"name": "aria-labelledby",
|
10590
10596
|
"type": {
|
10591
|
-
"text": "
|
10597
|
+
"text": "string | null"
|
10592
10598
|
},
|
10593
|
-
"
|
10594
|
-
"
|
10595
|
-
"fieldName": "
|
10599
|
+
"default": "null",
|
10600
|
+
"description": "aria-labelledby for an interactive popover only, defaults to the trigger component id.\nUsed in nested cases where the triggerComponent isn't the actual button.",
|
10601
|
+
"fieldName": "ariaLabelledby",
|
10602
|
+
"inheritedFrom": {
|
10603
|
+
"name": "Popover",
|
10604
|
+
"module": "src/components/popover/popover.component.ts"
|
10605
|
+
}
|
10596
10606
|
},
|
10597
10607
|
{
|
10598
|
-
"name": "
|
10608
|
+
"name": "aria-describedby",
|
10599
10609
|
"type": {
|
10600
|
-
"text": "
|
10610
|
+
"text": "string | null"
|
10601
10611
|
},
|
10602
|
-
"
|
10603
|
-
"
|
10604
|
-
"fieldName": "
|
10612
|
+
"default": "null",
|
10613
|
+
"description": "aria-describedby of the popover.",
|
10614
|
+
"fieldName": "ariaDescribedby",
|
10615
|
+
"inheritedFrom": {
|
10616
|
+
"name": "Popover",
|
10617
|
+
"module": "src/components/popover/popover.component.ts"
|
10618
|
+
}
|
10605
10619
|
},
|
10606
10620
|
{
|
10607
|
-
"name": "
|
10621
|
+
"name": "disable-aria-haspopup",
|
10608
10622
|
"type": {
|
10609
10623
|
"text": "boolean"
|
10610
10624
|
},
|
10611
|
-
"
|
10612
|
-
"
|
10613
|
-
"fieldName": "
|
10625
|
+
"description": "Disable setting the aria-haspopup attribute on trigger element.\nMake sure to set this to true when the popover is extended and its role\nis not 'dialog' or 'alertdialog' i.e. listbox, menu, etc.",
|
10626
|
+
"default": "false",
|
10627
|
+
"fieldName": "disableAriaHasPopup",
|
10614
10628
|
"inheritedFrom": {
|
10615
|
-
"name": "
|
10616
|
-
"module": "src/
|
10629
|
+
"name": "Popover",
|
10630
|
+
"module": "src/components/popover/popover.component.ts"
|
10617
10631
|
}
|
10618
10632
|
}
|
10619
10633
|
],
|
10620
|
-
"mixins": [
|
10621
|
-
{
|
10622
|
-
"name": "PreventScrollMixin",
|
10623
|
-
"module": "/src/utils/mixins/PreventScrollMixin"
|
10624
|
-
},
|
10625
|
-
{
|
10626
|
-
"name": "FocusTrapMixin",
|
10627
|
-
"module": "/src/utils/mixins/FocusTrapMixin"
|
10628
|
-
},
|
10629
|
-
{
|
10630
|
-
"name": "CardAndDialogFooterMixin",
|
10631
|
-
"module": "/src/utils/mixins/CardAndDialogFooterMixin"
|
10632
|
-
}
|
10633
|
-
],
|
10634
10634
|
"superclass": {
|
10635
|
-
"name": "
|
10636
|
-
"module": "/src/
|
10635
|
+
"name": "Popover",
|
10636
|
+
"module": "/src/components/popover/popover.component"
|
10637
10637
|
},
|
10638
|
-
"tagName": "mdc-
|
10639
|
-
"jsDoc": "/**\n *
|
10638
|
+
"tagName": "mdc-coachmark",
|
10639
|
+
"jsDoc": "/**\n * Coachmark component based on top of the popover component,\n * with the default value of certain properties changed.\n *\n * @dependency mdc-popover\n *\n * @tagname mdc-coachmark\n *\n * @event shown - (React: onShown) This event is dispatched when the coachmark is shown\n * @event hidden - (React: onHidden) This event is dispatched when the coachmark is hidden\n * @event created - (React: onCreated) This event is dispatched when the coachmark is created (added to the DOM)\n * @event destroyed - (React: onDestroyed) This event is dispatched when the coachmark is\n * destroyed (removed from the DOM)\n *\n * @cssproperty --mdc-popover-arrow-border-radius - radius of the arrow border\n * @cssproperty --mdc-popover-arrow-border - border of the arrow\n * @cssproperty --mdc-popover-primary-background-color - primary background color of the popover\n * @cssproperty --mdc-popover-border-color - border color of the popover\n * @cssproperty --mdc-popover-inverted-background-color - inverted background color of the popover\n * @cssproperty --mdc-popover-inverted-border-color - inverted border color of the popover\n * @cssproperty --mdc-popover-inverted-text-color - inverted text color of the popover\n * @cssproperty --mdc-popover-elevation-3 - elevation of the popover\n *\n * @slot - Default slot for modal container\n *\n */",
|
10640
10640
|
"customElement": true
|
10641
10641
|
}
|
10642
10642
|
],
|
@@ -10645,8 +10645,8 @@
|
|
10645
10645
|
"kind": "js",
|
10646
10646
|
"name": "default",
|
10647
10647
|
"declaration": {
|
10648
|
-
"name": "
|
10649
|
-
"module": "components/
|
10648
|
+
"name": "Coachmark",
|
10649
|
+
"module": "components/coachmark/coachmark.component.js"
|
10650
10650
|
}
|
10651
10651
|
}
|
10652
10652
|
]
|
@@ -18457,169 +18457,28 @@
|
|
18457
18457
|
{
|
18458
18458
|
"description": "Allows customization of the disabled color.",
|
18459
18459
|
"name": "--mdc-listitem-disabled-color",
|
18460
|
-
"inheritedFrom": {
|
18461
|
-
"name": "ListItem",
|
18462
|
-
"module": "src/components/listitem/listitem.component.ts"
|
18463
|
-
}
|
18464
|
-
},
|
18465
|
-
{
|
18466
|
-
"description": "Allows customization of column gap.",
|
18467
|
-
"name": "--mdc-listitem-column-gap",
|
18468
|
-
"inheritedFrom": {
|
18469
|
-
"name": "ListItem",
|
18470
|
-
"module": "src/components/listitem/listitem.component.ts"
|
18471
|
-
}
|
18472
|
-
},
|
18473
|
-
{
|
18474
|
-
"description": "Allows customization of padding left and right.",
|
18475
|
-
"name": "--mdc-listitem-padding-left-and-right",
|
18476
|
-
"inheritedFrom": {
|
18477
|
-
"name": "ListItem",
|
18478
|
-
"module": "src/components/listitem/listitem.component.ts"
|
18479
|
-
}
|
18480
|
-
}
|
18481
|
-
]
|
18482
|
-
}
|
18483
|
-
],
|
18484
|
-
"exports": [
|
18485
|
-
{
|
18486
|
-
"kind": "js",
|
18487
|
-
"name": "default",
|
18488
|
-
"declaration": {
|
18489
|
-
"name": "MenuItemRadio",
|
18490
|
-
"module": "components/menuitemradio/menuitemradio.component.js"
|
18491
|
-
}
|
18492
|
-
}
|
18493
|
-
]
|
18494
|
-
},
|
18495
|
-
{
|
18496
|
-
"kind": "javascript-module",
|
18497
|
-
"path": "components/menusection/menusection.component.js",
|
18498
|
-
"declarations": [
|
18499
|
-
{
|
18500
|
-
"kind": "class",
|
18501
|
-
"description": "`mdc-menusection` is a container element used to group a set of menu items.\n\nThis component supports a mix of `menuitem`, `menuitemcheckbox`, and `menuitemradio` components.\n\n- If multiple `menuitemradio` components are slotted into the section, the group enforces a single-selection rule:\n only one radio item can be selected at a time.\n- If `menuitemcheckbox` components are included, their checked state can be toggled independently.",
|
18502
|
-
"name": "MenuSection",
|
18503
|
-
"slots": [
|
18504
|
-
{
|
18505
|
-
"description": "Default slot for inserting `menuitem`, `menuitemcheckbox`, or `menuitemradio`",
|
18506
|
-
"name": ""
|
18507
|
-
}
|
18508
|
-
],
|
18509
|
-
"members": [
|
18510
|
-
{
|
18511
|
-
"kind": "field",
|
18512
|
-
"name": "ariaLabel",
|
18513
|
-
"type": {
|
18514
|
-
"text": "string | null"
|
18515
|
-
},
|
18516
|
-
"default": "null",
|
18517
|
-
"description": "The aria-label for the section.\nThis is used for accessibility purposes to describe the section.\nIf not provided, it defaults to the `headerText`.",
|
18518
|
-
"attribute": "aria-label",
|
18519
|
-
"reflects": true
|
18520
|
-
},
|
18521
|
-
{
|
18522
|
-
"kind": "field",
|
18523
|
-
"name": "headerText",
|
18524
|
-
"type": {
|
18525
|
-
"text": "string | null"
|
18526
|
-
},
|
18527
|
-
"default": "null",
|
18528
|
-
"description": "The primary headerText of the list item.\nThis appears on the leading side of the list item.",
|
18529
|
-
"attribute": "header-text",
|
18530
|
-
"reflects": true
|
18531
|
-
},
|
18532
|
-
{
|
18533
|
-
"kind": "field",
|
18534
|
-
"name": "prefixIcon",
|
18535
|
-
"type": {
|
18536
|
-
"text": "IconNames | undefined"
|
18537
|
-
},
|
18538
|
-
"description": "Name of the icon rendered before the text\n\nIf not provided, no icon will be rendered and text will be aligned to the start.",
|
18539
|
-
"attribute": "prefix-icon"
|
18540
|
-
},
|
18541
|
-
{
|
18542
|
-
"kind": "field",
|
18543
|
-
"name": "showDivider",
|
18544
|
-
"type": {
|
18545
|
-
"text": "boolean"
|
18546
|
-
},
|
18547
|
-
"default": "false",
|
18548
|
-
"description": "Whether to show a divider below the section header.\nThis is useful for visually separating sections in the menu.",
|
18549
|
-
"attribute": "show-divider",
|
18550
|
-
"reflects": true
|
18551
|
-
},
|
18552
|
-
{
|
18553
|
-
"kind": "field",
|
18554
|
-
"name": "dividerVariant",
|
18555
|
-
"description": "The variant of the divider.\nCan be set to 'solid' or 'gradient'.\n\nKeep 'solid' if used in MenuPopovers, as it is the default style.",
|
18556
|
-
"default": "'solid'",
|
18557
|
-
"attribute": "divider-variant",
|
18558
|
-
"reflects": true
|
18559
|
-
},
|
18560
|
-
{
|
18561
|
-
"kind": "method",
|
18562
|
-
"name": "renderHeader",
|
18563
|
-
"privacy": "private"
|
18564
|
-
}
|
18565
|
-
],
|
18566
|
-
"events": [
|
18567
|
-
{
|
18568
|
-
"description": "(React: onChange) This event is dispatched when a `menuitemcheckbox`, or `menuitemradio` changes.",
|
18569
|
-
"name": "change",
|
18570
|
-
"reactName": "onChange"
|
18571
|
-
}
|
18572
|
-
],
|
18573
|
-
"attributes": [
|
18574
|
-
{
|
18575
|
-
"name": "aria-label",
|
18576
|
-
"type": {
|
18577
|
-
"text": "string | null"
|
18578
|
-
},
|
18579
|
-
"default": "null",
|
18580
|
-
"description": "The aria-label for the section.\nThis is used for accessibility purposes to describe the section.\nIf not provided, it defaults to the `headerText`.",
|
18581
|
-
"fieldName": "ariaLabel"
|
18582
|
-
},
|
18583
|
-
{
|
18584
|
-
"name": "header-text",
|
18585
|
-
"type": {
|
18586
|
-
"text": "string | null"
|
18587
|
-
},
|
18588
|
-
"default": "null",
|
18589
|
-
"description": "The primary headerText of the list item.\nThis appears on the leading side of the list item.",
|
18590
|
-
"fieldName": "headerText"
|
18591
|
-
},
|
18592
|
-
{
|
18593
|
-
"name": "prefix-icon",
|
18594
|
-
"type": {
|
18595
|
-
"text": "IconNames | undefined"
|
18596
|
-
},
|
18597
|
-
"description": "Name of the icon rendered before the text\n\nIf not provided, no icon will be rendered and text will be aligned to the start.",
|
18598
|
-
"fieldName": "prefixIcon"
|
18599
|
-
},
|
18600
|
-
{
|
18601
|
-
"name": "show-divider",
|
18602
|
-
"type": {
|
18603
|
-
"text": "boolean"
|
18604
|
-
},
|
18605
|
-
"default": "false",
|
18606
|
-
"description": "Whether to show a divider below the section header.\nThis is useful for visually separating sections in the menu.",
|
18607
|
-
"fieldName": "showDivider"
|
18460
|
+
"inheritedFrom": {
|
18461
|
+
"name": "ListItem",
|
18462
|
+
"module": "src/components/listitem/listitem.component.ts"
|
18463
|
+
}
|
18608
18464
|
},
|
18609
18465
|
{
|
18610
|
-
"
|
18611
|
-
"
|
18612
|
-
"
|
18613
|
-
|
18466
|
+
"description": "Allows customization of column gap.",
|
18467
|
+
"name": "--mdc-listitem-column-gap",
|
18468
|
+
"inheritedFrom": {
|
18469
|
+
"name": "ListItem",
|
18470
|
+
"module": "src/components/listitem/listitem.component.ts"
|
18471
|
+
}
|
18472
|
+
},
|
18473
|
+
{
|
18474
|
+
"description": "Allows customization of padding left and right.",
|
18475
|
+
"name": "--mdc-listitem-padding-left-and-right",
|
18476
|
+
"inheritedFrom": {
|
18477
|
+
"name": "ListItem",
|
18478
|
+
"module": "src/components/listitem/listitem.component.ts"
|
18479
|
+
}
|
18614
18480
|
}
|
18615
|
-
]
|
18616
|
-
"superclass": {
|
18617
|
-
"name": "Component",
|
18618
|
-
"module": "/src/models"
|
18619
|
-
},
|
18620
|
-
"tagName": "mdc-menusection",
|
18621
|
-
"jsDoc": "/**\n * `mdc-menusection` is a container element used to group a set of menu items.\n *\n * This component supports a mix of `menuitem`, `menuitemcheckbox`, and `menuitemradio` components.\n *\n * - If multiple `menuitemradio` components are slotted into the section, the group enforces a single-selection rule:\n * only one radio item can be selected at a time.\n * - If `menuitemcheckbox` components are included, their checked state can be toggled independently.\n *\n * @tagname mdc-menusection\n *\n * @slot - Default slot for inserting `menuitem`, `menuitemcheckbox`, or `menuitemradio`\n *\n * @event change - (React: onChange) This event is dispatched when a `menuitemcheckbox`, or `menuitemradio` changes.\n */",
|
18622
|
-
"customElement": true
|
18481
|
+
]
|
18623
18482
|
}
|
18624
18483
|
],
|
18625
18484
|
"exports": [
|
@@ -18627,8 +18486,8 @@
|
|
18627
18486
|
"kind": "js",
|
18628
18487
|
"name": "default",
|
18629
18488
|
"declaration": {
|
18630
|
-
"name": "
|
18631
|
-
"module": "components/
|
18489
|
+
"name": "MenuItemRadio",
|
18490
|
+
"module": "components/menuitemradio/menuitemradio.component.js"
|
18632
18491
|
}
|
18633
18492
|
}
|
18634
18493
|
]
|
@@ -20717,6 +20576,147 @@
|
|
20717
20576
|
}
|
20718
20577
|
]
|
20719
20578
|
},
|
20579
|
+
{
|
20580
|
+
"kind": "javascript-module",
|
20581
|
+
"path": "components/menusection/menusection.component.js",
|
20582
|
+
"declarations": [
|
20583
|
+
{
|
20584
|
+
"kind": "class",
|
20585
|
+
"description": "`mdc-menusection` is a container element used to group a set of menu items.\n\nThis component supports a mix of `menuitem`, `menuitemcheckbox`, and `menuitemradio` components.\n\n- If multiple `menuitemradio` components are slotted into the section, the group enforces a single-selection rule:\n only one radio item can be selected at a time.\n- If `menuitemcheckbox` components are included, their checked state can be toggled independently.",
|
20586
|
+
"name": "MenuSection",
|
20587
|
+
"slots": [
|
20588
|
+
{
|
20589
|
+
"description": "Default slot for inserting `menuitem`, `menuitemcheckbox`, or `menuitemradio`",
|
20590
|
+
"name": ""
|
20591
|
+
}
|
20592
|
+
],
|
20593
|
+
"members": [
|
20594
|
+
{
|
20595
|
+
"kind": "field",
|
20596
|
+
"name": "ariaLabel",
|
20597
|
+
"type": {
|
20598
|
+
"text": "string | null"
|
20599
|
+
},
|
20600
|
+
"default": "null",
|
20601
|
+
"description": "The aria-label for the section.\nThis is used for accessibility purposes to describe the section.\nIf not provided, it defaults to the `headerText`.",
|
20602
|
+
"attribute": "aria-label",
|
20603
|
+
"reflects": true
|
20604
|
+
},
|
20605
|
+
{
|
20606
|
+
"kind": "field",
|
20607
|
+
"name": "headerText",
|
20608
|
+
"type": {
|
20609
|
+
"text": "string | null"
|
20610
|
+
},
|
20611
|
+
"default": "null",
|
20612
|
+
"description": "The primary headerText of the list item.\nThis appears on the leading side of the list item.",
|
20613
|
+
"attribute": "header-text",
|
20614
|
+
"reflects": true
|
20615
|
+
},
|
20616
|
+
{
|
20617
|
+
"kind": "field",
|
20618
|
+
"name": "prefixIcon",
|
20619
|
+
"type": {
|
20620
|
+
"text": "IconNames | undefined"
|
20621
|
+
},
|
20622
|
+
"description": "Name of the icon rendered before the text\n\nIf not provided, no icon will be rendered and text will be aligned to the start.",
|
20623
|
+
"attribute": "prefix-icon"
|
20624
|
+
},
|
20625
|
+
{
|
20626
|
+
"kind": "field",
|
20627
|
+
"name": "showDivider",
|
20628
|
+
"type": {
|
20629
|
+
"text": "boolean"
|
20630
|
+
},
|
20631
|
+
"default": "false",
|
20632
|
+
"description": "Whether to show a divider below the section header.\nThis is useful for visually separating sections in the menu.",
|
20633
|
+
"attribute": "show-divider",
|
20634
|
+
"reflects": true
|
20635
|
+
},
|
20636
|
+
{
|
20637
|
+
"kind": "field",
|
20638
|
+
"name": "dividerVariant",
|
20639
|
+
"description": "The variant of the divider.\nCan be set to 'solid' or 'gradient'.\n\nKeep 'solid' if used in MenuPopovers, as it is the default style.",
|
20640
|
+
"default": "'solid'",
|
20641
|
+
"attribute": "divider-variant",
|
20642
|
+
"reflects": true
|
20643
|
+
},
|
20644
|
+
{
|
20645
|
+
"kind": "method",
|
20646
|
+
"name": "renderHeader",
|
20647
|
+
"privacy": "private"
|
20648
|
+
}
|
20649
|
+
],
|
20650
|
+
"events": [
|
20651
|
+
{
|
20652
|
+
"description": "(React: onChange) This event is dispatched when a `menuitemcheckbox`, or `menuitemradio` changes.",
|
20653
|
+
"name": "change",
|
20654
|
+
"reactName": "onChange"
|
20655
|
+
}
|
20656
|
+
],
|
20657
|
+
"attributes": [
|
20658
|
+
{
|
20659
|
+
"name": "aria-label",
|
20660
|
+
"type": {
|
20661
|
+
"text": "string | null"
|
20662
|
+
},
|
20663
|
+
"default": "null",
|
20664
|
+
"description": "The aria-label for the section.\nThis is used for accessibility purposes to describe the section.\nIf not provided, it defaults to the `headerText`.",
|
20665
|
+
"fieldName": "ariaLabel"
|
20666
|
+
},
|
20667
|
+
{
|
20668
|
+
"name": "header-text",
|
20669
|
+
"type": {
|
20670
|
+
"text": "string | null"
|
20671
|
+
},
|
20672
|
+
"default": "null",
|
20673
|
+
"description": "The primary headerText of the list item.\nThis appears on the leading side of the list item.",
|
20674
|
+
"fieldName": "headerText"
|
20675
|
+
},
|
20676
|
+
{
|
20677
|
+
"name": "prefix-icon",
|
20678
|
+
"type": {
|
20679
|
+
"text": "IconNames | undefined"
|
20680
|
+
},
|
20681
|
+
"description": "Name of the icon rendered before the text\n\nIf not provided, no icon will be rendered and text will be aligned to the start.",
|
20682
|
+
"fieldName": "prefixIcon"
|
20683
|
+
},
|
20684
|
+
{
|
20685
|
+
"name": "show-divider",
|
20686
|
+
"type": {
|
20687
|
+
"text": "boolean"
|
20688
|
+
},
|
20689
|
+
"default": "false",
|
20690
|
+
"description": "Whether to show a divider below the section header.\nThis is useful for visually separating sections in the menu.",
|
20691
|
+
"fieldName": "showDivider"
|
20692
|
+
},
|
20693
|
+
{
|
20694
|
+
"name": "divider-variant",
|
20695
|
+
"description": "The variant of the divider.\nCan be set to 'solid' or 'gradient'.\n\nKeep 'solid' if used in MenuPopovers, as it is the default style.",
|
20696
|
+
"default": "'solid'",
|
20697
|
+
"fieldName": "dividerVariant"
|
20698
|
+
}
|
20699
|
+
],
|
20700
|
+
"superclass": {
|
20701
|
+
"name": "Component",
|
20702
|
+
"module": "/src/models"
|
20703
|
+
},
|
20704
|
+
"tagName": "mdc-menusection",
|
20705
|
+
"jsDoc": "/**\n * `mdc-menusection` is a container element used to group a set of menu items.\n *\n * This component supports a mix of `menuitem`, `menuitemcheckbox`, and `menuitemradio` components.\n *\n * - If multiple `menuitemradio` components are slotted into the section, the group enforces a single-selection rule:\n * only one radio item can be selected at a time.\n * - If `menuitemcheckbox` components are included, their checked state can be toggled independently.\n *\n * @tagname mdc-menusection\n *\n * @slot - Default slot for inserting `menuitem`, `menuitemcheckbox`, or `menuitemradio`\n *\n * @event change - (React: onChange) This event is dispatched when a `menuitemcheckbox`, or `menuitemradio` changes.\n */",
|
20706
|
+
"customElement": true
|
20707
|
+
}
|
20708
|
+
],
|
20709
|
+
"exports": [
|
20710
|
+
{
|
20711
|
+
"kind": "js",
|
20712
|
+
"name": "default",
|
20713
|
+
"declaration": {
|
20714
|
+
"name": "MenuSection",
|
20715
|
+
"module": "components/menusection/menusection.component.js"
|
20716
|
+
}
|
20717
|
+
}
|
20718
|
+
]
|
20719
|
+
},
|
20720
20720
|
{
|
20721
20721
|
"kind": "javascript-module",
|
20722
20722
|
"path": "components/navmenuitem/navmenuitem.component.js",
|
@@ -29549,46 +29549,6 @@
|
|
29549
29549
|
}
|
29550
29550
|
]
|
29551
29551
|
},
|
29552
|
-
{
|
29553
|
-
"kind": "javascript-module",
|
29554
|
-
"path": "components/selectlistbox/selectlistbox.component.js",
|
29555
|
-
"declarations": [
|
29556
|
-
{
|
29557
|
-
"kind": "class",
|
29558
|
-
"description": "Selectlistbox component as Light DOM component to act as a simple wrapper\nfor mdc-option components to ensure accessibility and proper role assignment.\n\nOnce [ariaOwnsElements](https://developer.mozilla.org/en-US/docs/Web/API/ElementInternals/ariaOwnsElements) is supported in browsers, this component can be removed\nand mdc-option can be used directly in the select component with a listbox in a different\nshadow root and aria-owns attribute to connect them.",
|
29559
|
-
"name": "Selectlistbox",
|
29560
|
-
"slots": [
|
29561
|
-
{
|
29562
|
-
"description": "This is a default/unnamed slot, which can be used to insert mdc-option components.",
|
29563
|
-
"name": "default"
|
29564
|
-
}
|
29565
|
-
],
|
29566
|
-
"members": [
|
29567
|
-
{
|
29568
|
-
"kind": "field",
|
29569
|
-
"name": "role"
|
29570
|
-
}
|
29571
|
-
],
|
29572
|
-
"superclass": {
|
29573
|
-
"name": "Component",
|
29574
|
-
"module": "/src/models"
|
29575
|
-
},
|
29576
|
-
"tagName": "mdc-selectlistbox",
|
29577
|
-
"jsDoc": "/**\n * Selectlistbox component as Light DOM component to act as a simple wrapper\n * for mdc-option components to ensure accessibility and proper role assignment.\n *\n * Once [ariaOwnsElements](https://developer.mozilla.org/en-US/docs/Web/API/ElementInternals/ariaOwnsElements) is supported in browsers, this component can be removed\n * and mdc-option can be used directly in the select component with a listbox in a different\n * shadow root and aria-owns attribute to connect them.\n *\n * @tagname mdc-selectlistbox\n *\n * @slot default - This is a default/unnamed slot, which can be used to insert mdc-option components.\n */",
|
29578
|
-
"customElement": true
|
29579
|
-
}
|
29580
|
-
],
|
29581
|
-
"exports": [
|
29582
|
-
{
|
29583
|
-
"kind": "js",
|
29584
|
-
"name": "default",
|
29585
|
-
"declaration": {
|
29586
|
-
"name": "Selectlistbox",
|
29587
|
-
"module": "components/selectlistbox/selectlistbox.component.js"
|
29588
|
-
}
|
29589
|
-
}
|
29590
|
-
]
|
29591
|
-
},
|
29592
29552
|
{
|
29593
29553
|
"kind": "javascript-module",
|
29594
29554
|
"path": "components/select/select.component.js",
|
@@ -30513,6 +30473,46 @@
|
|
30513
30473
|
}
|
30514
30474
|
]
|
30515
30475
|
},
|
30476
|
+
{
|
30477
|
+
"kind": "javascript-module",
|
30478
|
+
"path": "components/selectlistbox/selectlistbox.component.js",
|
30479
|
+
"declarations": [
|
30480
|
+
{
|
30481
|
+
"kind": "class",
|
30482
|
+
"description": "Selectlistbox component as Light DOM component to act as a simple wrapper\nfor mdc-option components to ensure accessibility and proper role assignment.\n\nOnce [ariaOwnsElements](https://developer.mozilla.org/en-US/docs/Web/API/ElementInternals/ariaOwnsElements) is supported in browsers, this component can be removed\nand mdc-option can be used directly in the select component with a listbox in a different\nshadow root and aria-owns attribute to connect them.",
|
30483
|
+
"name": "Selectlistbox",
|
30484
|
+
"slots": [
|
30485
|
+
{
|
30486
|
+
"description": "This is a default/unnamed slot, which can be used to insert mdc-option components.",
|
30487
|
+
"name": "default"
|
30488
|
+
}
|
30489
|
+
],
|
30490
|
+
"members": [
|
30491
|
+
{
|
30492
|
+
"kind": "field",
|
30493
|
+
"name": "role"
|
30494
|
+
}
|
30495
|
+
],
|
30496
|
+
"superclass": {
|
30497
|
+
"name": "Component",
|
30498
|
+
"module": "/src/models"
|
30499
|
+
},
|
30500
|
+
"tagName": "mdc-selectlistbox",
|
30501
|
+
"jsDoc": "/**\n * Selectlistbox component as Light DOM component to act as a simple wrapper\n * for mdc-option components to ensure accessibility and proper role assignment.\n *\n * Once [ariaOwnsElements](https://developer.mozilla.org/en-US/docs/Web/API/ElementInternals/ariaOwnsElements) is supported in browsers, this component can be removed\n * and mdc-option can be used directly in the select component with a listbox in a different\n * shadow root and aria-owns attribute to connect them.\n *\n * @tagname mdc-selectlistbox\n *\n * @slot default - This is a default/unnamed slot, which can be used to insert mdc-option components.\n */",
|
30502
|
+
"customElement": true
|
30503
|
+
}
|
30504
|
+
],
|
30505
|
+
"exports": [
|
30506
|
+
{
|
30507
|
+
"kind": "js",
|
30508
|
+
"name": "default",
|
30509
|
+
"declaration": {
|
30510
|
+
"name": "Selectlistbox",
|
30511
|
+
"module": "components/selectlistbox/selectlistbox.component.js"
|
30512
|
+
}
|
30513
|
+
}
|
30514
|
+
]
|
30515
|
+
},
|
30516
30516
|
{
|
30517
30517
|
"kind": "javascript-module",
|
30518
30518
|
"path": "components/sidenavigation/sidenavigation.component.js",
|