@momentum-design/components 0.35.0 → 0.36.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/browser/index.js +217 -217
- package/dist/browser/index.js.map +4 -4
- package/dist/components/coachmark/coachmark.component.d.ts +52 -0
- package/dist/components/coachmark/coachmark.component.js +82 -0
- package/dist/components/coachmark/coachmark.constants.d.ts +9 -0
- package/dist/components/coachmark/coachmark.constants.js +11 -0
- package/dist/components/coachmark/index.d.ts +8 -0
- package/dist/components/coachmark/index.js +5 -0
- package/dist/components/popover/popover.component.js +2 -2
- package/dist/custom-elements.json +1559 -2
- package/dist/index.d.ts +2 -1
- package/dist/index.js +2 -1
- package/dist/react/coachmark/index.d.ts +23 -0
- package/dist/react/coachmark/index.js +32 -0
- package/dist/react/index.d.ts +1 -0
- package/dist/react/index.js +1 -0
- package/package.json +1 -1
@@ -2798,6 +2798,1559 @@
|
|
2798
2798
|
}
|
2799
2799
|
]
|
2800
2800
|
},
|
2801
|
+
{
|
2802
|
+
"kind": "javascript-module",
|
2803
|
+
"path": "components/coachmark/coachmark.component.js",
|
2804
|
+
"declarations": [
|
2805
|
+
{
|
2806
|
+
"kind": "class",
|
2807
|
+
"description": "Coachmark component based on top of the popover component,\nwith the default value of certain properties changed.",
|
2808
|
+
"name": "Coachmark",
|
2809
|
+
"cssProperties": [
|
2810
|
+
{
|
2811
|
+
"description": "radius of the arrow border",
|
2812
|
+
"name": "--mdc-popover-arrow-border-radius",
|
2813
|
+
"inheritedFrom": {
|
2814
|
+
"name": "Popover",
|
2815
|
+
"module": "src/components/popover/popover.component.ts"
|
2816
|
+
}
|
2817
|
+
},
|
2818
|
+
{
|
2819
|
+
"description": "border of the arrow",
|
2820
|
+
"name": "--mdc-popover-arrow-border",
|
2821
|
+
"inheritedFrom": {
|
2822
|
+
"name": "Popover",
|
2823
|
+
"module": "src/components/popover/popover.component.ts"
|
2824
|
+
}
|
2825
|
+
},
|
2826
|
+
{
|
2827
|
+
"description": "primary background color of the popover",
|
2828
|
+
"name": "--mdc-popover-primary-background-color",
|
2829
|
+
"inheritedFrom": {
|
2830
|
+
"name": "Popover",
|
2831
|
+
"module": "src/components/popover/popover.component.ts"
|
2832
|
+
}
|
2833
|
+
},
|
2834
|
+
{
|
2835
|
+
"description": "border color of the popover",
|
2836
|
+
"name": "--mdc-popover-border-color",
|
2837
|
+
"inheritedFrom": {
|
2838
|
+
"name": "Popover",
|
2839
|
+
"module": "src/components/popover/popover.component.ts"
|
2840
|
+
}
|
2841
|
+
},
|
2842
|
+
{
|
2843
|
+
"description": "inverted background color of the popover",
|
2844
|
+
"name": "--mdc-popover-inverted-background-color",
|
2845
|
+
"inheritedFrom": {
|
2846
|
+
"name": "Popover",
|
2847
|
+
"module": "src/components/popover/popover.component.ts"
|
2848
|
+
}
|
2849
|
+
},
|
2850
|
+
{
|
2851
|
+
"description": "inverted border color of the popover",
|
2852
|
+
"name": "--mdc-popover-inverted-border-color",
|
2853
|
+
"inheritedFrom": {
|
2854
|
+
"name": "Popover",
|
2855
|
+
"module": "src/components/popover/popover.component.ts"
|
2856
|
+
}
|
2857
|
+
},
|
2858
|
+
{
|
2859
|
+
"description": "inverted text color of the popover",
|
2860
|
+
"name": "--mdc-popover-inverted-text-color",
|
2861
|
+
"inheritedFrom": {
|
2862
|
+
"name": "Popover",
|
2863
|
+
"module": "src/components/popover/popover.component.ts"
|
2864
|
+
}
|
2865
|
+
},
|
2866
|
+
{
|
2867
|
+
"description": "elevation of the popover",
|
2868
|
+
"name": "--mdc-popover-elevation-3",
|
2869
|
+
"inheritedFrom": {
|
2870
|
+
"name": "Popover",
|
2871
|
+
"module": "src/components/popover/popover.component.ts"
|
2872
|
+
}
|
2873
|
+
}
|
2874
|
+
],
|
2875
|
+
"slots": [
|
2876
|
+
{
|
2877
|
+
"description": "Default slot for modal container",
|
2878
|
+
"name": "",
|
2879
|
+
"inheritedFrom": {
|
2880
|
+
"name": "Popover",
|
2881
|
+
"module": "src/components/popover/popover.component.ts"
|
2882
|
+
}
|
2883
|
+
}
|
2884
|
+
],
|
2885
|
+
"members": [
|
2886
|
+
{
|
2887
|
+
"kind": "field",
|
2888
|
+
"name": "trigger",
|
2889
|
+
"type": {
|
2890
|
+
"text": "PopoverTrigger"
|
2891
|
+
},
|
2892
|
+
"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**",
|
2893
|
+
"default": "manual",
|
2894
|
+
"attribute": "trigger",
|
2895
|
+
"reflects": true,
|
2896
|
+
"inheritedFrom": {
|
2897
|
+
"name": "Popover",
|
2898
|
+
"module": "components/popover/popover.component.js"
|
2899
|
+
}
|
2900
|
+
},
|
2901
|
+
{
|
2902
|
+
"kind": "field",
|
2903
|
+
"name": "showArrow",
|
2904
|
+
"type": {
|
2905
|
+
"text": "boolean"
|
2906
|
+
},
|
2907
|
+
"description": "The arrow visibility of the Coachmark.",
|
2908
|
+
"default": "true",
|
2909
|
+
"attribute": "show-arrow",
|
2910
|
+
"reflects": true,
|
2911
|
+
"inheritedFrom": {
|
2912
|
+
"name": "Popover",
|
2913
|
+
"module": "components/popover/popover.component.js"
|
2914
|
+
}
|
2915
|
+
},
|
2916
|
+
{
|
2917
|
+
"kind": "field",
|
2918
|
+
"name": "closeButton",
|
2919
|
+
"type": {
|
2920
|
+
"text": "boolean"
|
2921
|
+
},
|
2922
|
+
"description": "The close button visibility of the Coachmark.",
|
2923
|
+
"default": "true",
|
2924
|
+
"attribute": "close-button",
|
2925
|
+
"reflects": true,
|
2926
|
+
"inheritedFrom": {
|
2927
|
+
"name": "Popover",
|
2928
|
+
"module": "components/popover/popover.component.js"
|
2929
|
+
}
|
2930
|
+
},
|
2931
|
+
{
|
2932
|
+
"kind": "field",
|
2933
|
+
"name": "disableAriaExpanded",
|
2934
|
+
"type": {
|
2935
|
+
"text": "boolean"
|
2936
|
+
},
|
2937
|
+
"description": "Disable aria-expanded attribute on trigger element.",
|
2938
|
+
"default": "true",
|
2939
|
+
"attribute": "disable-aria-expanded",
|
2940
|
+
"reflects": true,
|
2941
|
+
"inheritedFrom": {
|
2942
|
+
"name": "Popover",
|
2943
|
+
"module": "components/popover/popover.component.js"
|
2944
|
+
}
|
2945
|
+
},
|
2946
|
+
{
|
2947
|
+
"kind": "field",
|
2948
|
+
"name": "color",
|
2949
|
+
"type": {
|
2950
|
+
"text": "PopoverColor"
|
2951
|
+
},
|
2952
|
+
"description": "Color of the popover\n- **tonal**\n- **contrast**",
|
2953
|
+
"default": "tonal",
|
2954
|
+
"attribute": "color",
|
2955
|
+
"reflects": true,
|
2956
|
+
"inheritedFrom": {
|
2957
|
+
"name": "Popover",
|
2958
|
+
"module": "components/popover/popover.component.js"
|
2959
|
+
}
|
2960
|
+
},
|
2961
|
+
{
|
2962
|
+
"kind": "field",
|
2963
|
+
"name": "enabledFocusTrap",
|
2964
|
+
"type": {
|
2965
|
+
"text": "boolean"
|
2966
|
+
},
|
2967
|
+
"description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.",
|
2968
|
+
"default": "false",
|
2969
|
+
"attribute": "enabledFocusTrap",
|
2970
|
+
"inheritedFrom": {
|
2971
|
+
"name": "FocusTrapMixin",
|
2972
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
2973
|
+
}
|
2974
|
+
},
|
2975
|
+
{
|
2976
|
+
"kind": "field",
|
2977
|
+
"name": "enabledPreventScroll",
|
2978
|
+
"type": {
|
2979
|
+
"text": "boolean"
|
2980
|
+
},
|
2981
|
+
"description": "Prevent outside scrolling when popover show.",
|
2982
|
+
"default": "false",
|
2983
|
+
"attribute": "enabledPreventScroll",
|
2984
|
+
"inheritedFrom": {
|
2985
|
+
"name": "FocusTrapMixin",
|
2986
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
2987
|
+
}
|
2988
|
+
},
|
2989
|
+
{
|
2990
|
+
"kind": "field",
|
2991
|
+
"name": "shouldWrapFocus",
|
2992
|
+
"type": {
|
2993
|
+
"text": "() => boolean"
|
2994
|
+
},
|
2995
|
+
"inheritedFrom": {
|
2996
|
+
"name": "FocusTrapMixin",
|
2997
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
2998
|
+
}
|
2999
|
+
},
|
3000
|
+
{
|
3001
|
+
"kind": "method",
|
3002
|
+
"name": "deactivateFocusTrap",
|
3003
|
+
"description": "Deactivate the focus trap.",
|
3004
|
+
"inheritedFrom": {
|
3005
|
+
"name": "FocusTrapMixin",
|
3006
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
3007
|
+
}
|
3008
|
+
},
|
3009
|
+
{
|
3010
|
+
"kind": "method",
|
3011
|
+
"name": "hasNoClientRects",
|
3012
|
+
"privacy": "private",
|
3013
|
+
"parameters": [
|
3014
|
+
{
|
3015
|
+
"name": "element",
|
3016
|
+
"type": {
|
3017
|
+
"text": "HTMLElement"
|
3018
|
+
},
|
3019
|
+
"description": "The element to check."
|
3020
|
+
}
|
3021
|
+
],
|
3022
|
+
"description": "Checks if the element has no client rectangles (not visible in the viewport).",
|
3023
|
+
"return": {
|
3024
|
+
"type": {
|
3025
|
+
"text": ""
|
3026
|
+
}
|
3027
|
+
},
|
3028
|
+
"inheritedFrom": {
|
3029
|
+
"name": "FocusTrapMixin",
|
3030
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
3031
|
+
}
|
3032
|
+
},
|
3033
|
+
{
|
3034
|
+
"kind": "method",
|
3035
|
+
"name": "hasZeroDimensions",
|
3036
|
+
"privacy": "private",
|
3037
|
+
"parameters": [
|
3038
|
+
{
|
3039
|
+
"name": "element",
|
3040
|
+
"type": {
|
3041
|
+
"text": "HTMLElement"
|
3042
|
+
},
|
3043
|
+
"description": "The element to check."
|
3044
|
+
}
|
3045
|
+
],
|
3046
|
+
"description": "Checks if the element has zero dimensions (width and height are both 0).",
|
3047
|
+
"return": {
|
3048
|
+
"type": {
|
3049
|
+
"text": ""
|
3050
|
+
}
|
3051
|
+
},
|
3052
|
+
"inheritedFrom": {
|
3053
|
+
"name": "FocusTrapMixin",
|
3054
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
3055
|
+
}
|
3056
|
+
},
|
3057
|
+
{
|
3058
|
+
"kind": "method",
|
3059
|
+
"name": "isNotVisible",
|
3060
|
+
"privacy": "private",
|
3061
|
+
"parameters": [
|
3062
|
+
{
|
3063
|
+
"name": "element",
|
3064
|
+
"type": {
|
3065
|
+
"text": "HTMLElement"
|
3066
|
+
},
|
3067
|
+
"description": "The element to check."
|
3068
|
+
}
|
3069
|
+
],
|
3070
|
+
"description": "Determines if the element is not visible in the DOM.",
|
3071
|
+
"return": {
|
3072
|
+
"type": {
|
3073
|
+
"text": ""
|
3074
|
+
}
|
3075
|
+
},
|
3076
|
+
"inheritedFrom": {
|
3077
|
+
"name": "FocusTrapMixin",
|
3078
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
3079
|
+
}
|
3080
|
+
},
|
3081
|
+
{
|
3082
|
+
"kind": "method",
|
3083
|
+
"name": "hasHiddenStyle",
|
3084
|
+
"privacy": "private",
|
3085
|
+
"parameters": [
|
3086
|
+
{
|
3087
|
+
"name": "element",
|
3088
|
+
"type": {
|
3089
|
+
"text": "HTMLElement"
|
3090
|
+
},
|
3091
|
+
"description": "The element to check."
|
3092
|
+
}
|
3093
|
+
],
|
3094
|
+
"description": "Checks if the element has inline styles that make it hidden.",
|
3095
|
+
"return": {
|
3096
|
+
"type": {
|
3097
|
+
"text": ""
|
3098
|
+
}
|
3099
|
+
},
|
3100
|
+
"inheritedFrom": {
|
3101
|
+
"name": "FocusTrapMixin",
|
3102
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
3103
|
+
}
|
3104
|
+
},
|
3105
|
+
{
|
3106
|
+
"kind": "method",
|
3107
|
+
"name": "hasComputedHidden",
|
3108
|
+
"privacy": "private",
|
3109
|
+
"parameters": [
|
3110
|
+
{
|
3111
|
+
"name": "element",
|
3112
|
+
"type": {
|
3113
|
+
"text": "HTMLElement"
|
3114
|
+
},
|
3115
|
+
"description": "The element to check."
|
3116
|
+
}
|
3117
|
+
],
|
3118
|
+
"description": "Checks if the element is hidden by a computed style.",
|
3119
|
+
"return": {
|
3120
|
+
"type": {
|
3121
|
+
"text": ""
|
3122
|
+
}
|
3123
|
+
},
|
3124
|
+
"inheritedFrom": {
|
3125
|
+
"name": "FocusTrapMixin",
|
3126
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
3127
|
+
}
|
3128
|
+
},
|
3129
|
+
{
|
3130
|
+
"kind": "method",
|
3131
|
+
"name": "isHidden",
|
3132
|
+
"privacy": "private",
|
3133
|
+
"parameters": [
|
3134
|
+
{
|
3135
|
+
"name": "element",
|
3136
|
+
"type": {
|
3137
|
+
"text": "HTMLElement"
|
3138
|
+
},
|
3139
|
+
"description": "The element to check."
|
3140
|
+
}
|
3141
|
+
],
|
3142
|
+
"description": "Checks if the element is hidden from the user.",
|
3143
|
+
"return": {
|
3144
|
+
"type": {
|
3145
|
+
"text": ""
|
3146
|
+
}
|
3147
|
+
},
|
3148
|
+
"inheritedFrom": {
|
3149
|
+
"name": "FocusTrapMixin",
|
3150
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
3151
|
+
}
|
3152
|
+
},
|
3153
|
+
{
|
3154
|
+
"kind": "method",
|
3155
|
+
"name": "isNotTabbable",
|
3156
|
+
"privacy": "private",
|
3157
|
+
"parameters": [
|
3158
|
+
{
|
3159
|
+
"name": "element",
|
3160
|
+
"type": {
|
3161
|
+
"text": "HTMLElement"
|
3162
|
+
},
|
3163
|
+
"description": "The element to check."
|
3164
|
+
}
|
3165
|
+
],
|
3166
|
+
"description": "Checks if the element is not tabbable.",
|
3167
|
+
"return": {
|
3168
|
+
"type": {
|
3169
|
+
"text": ""
|
3170
|
+
}
|
3171
|
+
},
|
3172
|
+
"inheritedFrom": {
|
3173
|
+
"name": "FocusTrapMixin",
|
3174
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
3175
|
+
}
|
3176
|
+
},
|
3177
|
+
{
|
3178
|
+
"kind": "method",
|
3179
|
+
"name": "isInteractiveElement",
|
3180
|
+
"privacy": "private",
|
3181
|
+
"return": {
|
3182
|
+
"type": {
|
3183
|
+
"text": ""
|
3184
|
+
}
|
3185
|
+
},
|
3186
|
+
"parameters": [
|
3187
|
+
{
|
3188
|
+
"name": "element",
|
3189
|
+
"type": {
|
3190
|
+
"text": "HTMLElement"
|
3191
|
+
},
|
3192
|
+
"description": "The element to check."
|
3193
|
+
}
|
3194
|
+
],
|
3195
|
+
"description": "Checks if the element is interactive.",
|
3196
|
+
"inheritedFrom": {
|
3197
|
+
"name": "FocusTrapMixin",
|
3198
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
3199
|
+
}
|
3200
|
+
},
|
3201
|
+
{
|
3202
|
+
"kind": "method",
|
3203
|
+
"name": "isFocusable",
|
3204
|
+
"privacy": "private",
|
3205
|
+
"parameters": [
|
3206
|
+
{
|
3207
|
+
"name": "element",
|
3208
|
+
"type": {
|
3209
|
+
"text": "HTMLElement"
|
3210
|
+
},
|
3211
|
+
"description": "The element to check."
|
3212
|
+
}
|
3213
|
+
],
|
3214
|
+
"description": "Checks if the element is focusable.",
|
3215
|
+
"return": {
|
3216
|
+
"type": {
|
3217
|
+
"text": ""
|
3218
|
+
}
|
3219
|
+
},
|
3220
|
+
"inheritedFrom": {
|
3221
|
+
"name": "FocusTrapMixin",
|
3222
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
3223
|
+
}
|
3224
|
+
},
|
3225
|
+
{
|
3226
|
+
"kind": "method",
|
3227
|
+
"name": "findFocusable",
|
3228
|
+
"privacy": "private",
|
3229
|
+
"return": {
|
3230
|
+
"type": {
|
3231
|
+
"text": ""
|
3232
|
+
}
|
3233
|
+
},
|
3234
|
+
"parameters": [
|
3235
|
+
{
|
3236
|
+
"name": "root",
|
3237
|
+
"type": {
|
3238
|
+
"text": "ShadowRoot | HTMLElement"
|
3239
|
+
},
|
3240
|
+
"description": "The root element to search for focusable elements."
|
3241
|
+
},
|
3242
|
+
{
|
3243
|
+
"name": "matches",
|
3244
|
+
"default": "new Set()",
|
3245
|
+
"type": {
|
3246
|
+
"text": "Set<HTMLElement>"
|
3247
|
+
},
|
3248
|
+
"description": "The set of focusable elements."
|
3249
|
+
}
|
3250
|
+
],
|
3251
|
+
"description": "Recursively finds all focusable elements within the given root and its descendants.",
|
3252
|
+
"inheritedFrom": {
|
3253
|
+
"name": "FocusTrapMixin",
|
3254
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
3255
|
+
}
|
3256
|
+
},
|
3257
|
+
{
|
3258
|
+
"kind": "method",
|
3259
|
+
"name": "setFocusableElements",
|
3260
|
+
"privacy": "public",
|
3261
|
+
"description": "Updates the list of focusable elements within the component's shadow root.",
|
3262
|
+
"inheritedFrom": {
|
3263
|
+
"name": "FocusTrapMixin",
|
3264
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
3265
|
+
}
|
3266
|
+
},
|
3267
|
+
{
|
3268
|
+
"kind": "method",
|
3269
|
+
"name": "setInitialFocus",
|
3270
|
+
"privacy": "public",
|
3271
|
+
"parameters": [
|
3272
|
+
{
|
3273
|
+
"name": "prefferableElement",
|
3274
|
+
"default": "0",
|
3275
|
+
"type": {
|
3276
|
+
"text": "number"
|
3277
|
+
},
|
3278
|
+
"description": "The index of the prefferable element to focus."
|
3279
|
+
}
|
3280
|
+
],
|
3281
|
+
"description": "Sets the initial focus within the container.",
|
3282
|
+
"inheritedFrom": {
|
3283
|
+
"name": "FocusTrapMixin",
|
3284
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
3285
|
+
}
|
3286
|
+
},
|
3287
|
+
{
|
3288
|
+
"kind": "method",
|
3289
|
+
"name": "calculateNextIndex",
|
3290
|
+
"privacy": "private",
|
3291
|
+
"parameters": [
|
3292
|
+
{
|
3293
|
+
"name": "currentIndex",
|
3294
|
+
"type": {
|
3295
|
+
"text": "number"
|
3296
|
+
},
|
3297
|
+
"description": "The current index."
|
3298
|
+
},
|
3299
|
+
{
|
3300
|
+
"name": "step",
|
3301
|
+
"type": {
|
3302
|
+
"text": "number"
|
3303
|
+
},
|
3304
|
+
"description": "The step to calculate the next index."
|
3305
|
+
}
|
3306
|
+
],
|
3307
|
+
"description": "Calculates the next index for the focus trap.",
|
3308
|
+
"return": {
|
3309
|
+
"type": {
|
3310
|
+
"text": ""
|
3311
|
+
}
|
3312
|
+
},
|
3313
|
+
"inheritedFrom": {
|
3314
|
+
"name": "FocusTrapMixin",
|
3315
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
3316
|
+
}
|
3317
|
+
},
|
3318
|
+
{
|
3319
|
+
"kind": "method",
|
3320
|
+
"name": "getDeepActiveElement",
|
3321
|
+
"privacy": "private",
|
3322
|
+
"description": "Returns the deepest active element in the shadow DOM.",
|
3323
|
+
"return": {
|
3324
|
+
"type": {
|
3325
|
+
"text": ""
|
3326
|
+
}
|
3327
|
+
},
|
3328
|
+
"inheritedFrom": {
|
3329
|
+
"name": "FocusTrapMixin",
|
3330
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
3331
|
+
}
|
3332
|
+
},
|
3333
|
+
{
|
3334
|
+
"kind": "method",
|
3335
|
+
"name": "findElement",
|
3336
|
+
"privacy": "private",
|
3337
|
+
"parameters": [
|
3338
|
+
{
|
3339
|
+
"name": "activeElement",
|
3340
|
+
"type": {
|
3341
|
+
"text": "HTMLElement"
|
3342
|
+
},
|
3343
|
+
"description": "The active element."
|
3344
|
+
}
|
3345
|
+
],
|
3346
|
+
"description": "Finds the index of the active element within the focusable elements.",
|
3347
|
+
"return": {
|
3348
|
+
"type": {
|
3349
|
+
"text": ""
|
3350
|
+
}
|
3351
|
+
},
|
3352
|
+
"inheritedFrom": {
|
3353
|
+
"name": "FocusTrapMixin",
|
3354
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
3355
|
+
}
|
3356
|
+
},
|
3357
|
+
{
|
3358
|
+
"kind": "method",
|
3359
|
+
"name": "isEqualFocusNode",
|
3360
|
+
"privacy": "private",
|
3361
|
+
"parameters": [
|
3362
|
+
{
|
3363
|
+
"name": "activeElement",
|
3364
|
+
"type": {
|
3365
|
+
"text": "HTMLElement"
|
3366
|
+
},
|
3367
|
+
"description": "The active element."
|
3368
|
+
},
|
3369
|
+
{
|
3370
|
+
"name": "element",
|
3371
|
+
"type": {
|
3372
|
+
"text": "HTMLElement"
|
3373
|
+
},
|
3374
|
+
"description": "The element to compare."
|
3375
|
+
}
|
3376
|
+
],
|
3377
|
+
"description": "Checks if the active element is equal to the given element.",
|
3378
|
+
"return": {
|
3379
|
+
"type": {
|
3380
|
+
"text": ""
|
3381
|
+
}
|
3382
|
+
},
|
3383
|
+
"inheritedFrom": {
|
3384
|
+
"name": "FocusTrapMixin",
|
3385
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
3386
|
+
}
|
3387
|
+
},
|
3388
|
+
{
|
3389
|
+
"kind": "method",
|
3390
|
+
"name": "trapFocus",
|
3391
|
+
"privacy": "private",
|
3392
|
+
"parameters": [
|
3393
|
+
{
|
3394
|
+
"name": "direction",
|
3395
|
+
"type": {
|
3396
|
+
"text": "boolean"
|
3397
|
+
},
|
3398
|
+
"description": "The direction of the focus trap.\nIf true, the focus will be trapped in the previous element."
|
3399
|
+
}
|
3400
|
+
],
|
3401
|
+
"description": "Traps focus within the container.",
|
3402
|
+
"inheritedFrom": {
|
3403
|
+
"name": "FocusTrapMixin",
|
3404
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
3405
|
+
}
|
3406
|
+
},
|
3407
|
+
{
|
3408
|
+
"kind": "method",
|
3409
|
+
"name": "handleKeydown",
|
3410
|
+
"privacy": "private",
|
3411
|
+
"parameters": [
|
3412
|
+
{
|
3413
|
+
"name": "event",
|
3414
|
+
"type": {
|
3415
|
+
"text": "KeyboardEvent"
|
3416
|
+
},
|
3417
|
+
"description": "The keyboard event."
|
3418
|
+
}
|
3419
|
+
],
|
3420
|
+
"description": "Traps focus within the container.",
|
3421
|
+
"inheritedFrom": {
|
3422
|
+
"name": "FocusTrapMixin",
|
3423
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
3424
|
+
}
|
3425
|
+
},
|
3426
|
+
{
|
3427
|
+
"kind": "field",
|
3428
|
+
"name": "id",
|
3429
|
+
"type": {
|
3430
|
+
"text": "string"
|
3431
|
+
},
|
3432
|
+
"default": "''",
|
3433
|
+
"description": "The unique ID of the popover.",
|
3434
|
+
"attribute": "id",
|
3435
|
+
"reflects": true,
|
3436
|
+
"inheritedFrom": {
|
3437
|
+
"name": "Popover",
|
3438
|
+
"module": "components/popover/popover.component.js"
|
3439
|
+
}
|
3440
|
+
},
|
3441
|
+
{
|
3442
|
+
"kind": "field",
|
3443
|
+
"name": "triggerID",
|
3444
|
+
"type": {
|
3445
|
+
"text": "string"
|
3446
|
+
},
|
3447
|
+
"default": "''",
|
3448
|
+
"description": "The ID of the element that triggers the popover.\nThis attribute is required for the popover to work.",
|
3449
|
+
"attribute": "triggerID",
|
3450
|
+
"reflects": true,
|
3451
|
+
"inheritedFrom": {
|
3452
|
+
"name": "Popover",
|
3453
|
+
"module": "components/popover/popover.component.js"
|
3454
|
+
}
|
3455
|
+
},
|
3456
|
+
{
|
3457
|
+
"kind": "field",
|
3458
|
+
"name": "placement",
|
3459
|
+
"type": {
|
3460
|
+
"text": "PopoverPlacement"
|
3461
|
+
},
|
3462
|
+
"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**",
|
3463
|
+
"default": "bottom",
|
3464
|
+
"attribute": "placement",
|
3465
|
+
"reflects": true,
|
3466
|
+
"inheritedFrom": {
|
3467
|
+
"name": "Popover",
|
3468
|
+
"module": "components/popover/popover.component.js"
|
3469
|
+
}
|
3470
|
+
},
|
3471
|
+
{
|
3472
|
+
"kind": "field",
|
3473
|
+
"name": "visible",
|
3474
|
+
"type": {
|
3475
|
+
"text": "boolean"
|
3476
|
+
},
|
3477
|
+
"description": "The visibility of the popover.",
|
3478
|
+
"default": "false",
|
3479
|
+
"attribute": "visible",
|
3480
|
+
"reflects": true,
|
3481
|
+
"inheritedFrom": {
|
3482
|
+
"name": "Popover",
|
3483
|
+
"module": "components/popover/popover.component.js"
|
3484
|
+
}
|
3485
|
+
},
|
3486
|
+
{
|
3487
|
+
"kind": "field",
|
3488
|
+
"name": "offset",
|
3489
|
+
"type": {
|
3490
|
+
"text": "number"
|
3491
|
+
},
|
3492
|
+
"description": "The offset of the popover.",
|
3493
|
+
"default": "4",
|
3494
|
+
"attribute": "offset",
|
3495
|
+
"reflects": true,
|
3496
|
+
"inheritedFrom": {
|
3497
|
+
"name": "Popover",
|
3498
|
+
"module": "components/popover/popover.component.js"
|
3499
|
+
}
|
3500
|
+
},
|
3501
|
+
{
|
3502
|
+
"kind": "field",
|
3503
|
+
"name": "focusTrap",
|
3504
|
+
"type": {
|
3505
|
+
"text": "boolean"
|
3506
|
+
},
|
3507
|
+
"description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.",
|
3508
|
+
"default": "false",
|
3509
|
+
"attribute": "focus-trap",
|
3510
|
+
"reflects": true,
|
3511
|
+
"inheritedFrom": {
|
3512
|
+
"name": "Popover",
|
3513
|
+
"module": "components/popover/popover.component.js"
|
3514
|
+
}
|
3515
|
+
},
|
3516
|
+
{
|
3517
|
+
"kind": "field",
|
3518
|
+
"name": "preventScroll",
|
3519
|
+
"type": {
|
3520
|
+
"text": "boolean"
|
3521
|
+
},
|
3522
|
+
"description": "Prevent outside scrolling when popover show.",
|
3523
|
+
"default": "false",
|
3524
|
+
"attribute": "prevent-scroll",
|
3525
|
+
"reflects": true,
|
3526
|
+
"inheritedFrom": {
|
3527
|
+
"name": "Popover",
|
3528
|
+
"module": "components/popover/popover.component.js"
|
3529
|
+
}
|
3530
|
+
},
|
3531
|
+
{
|
3532
|
+
"kind": "field",
|
3533
|
+
"name": "interactive",
|
3534
|
+
"type": {
|
3535
|
+
"text": "boolean"
|
3536
|
+
},
|
3537
|
+
"description": "Determines whether the popover is interactive。",
|
3538
|
+
"default": "false",
|
3539
|
+
"attribute": "interactive",
|
3540
|
+
"reflects": true,
|
3541
|
+
"inheritedFrom": {
|
3542
|
+
"name": "Popover",
|
3543
|
+
"module": "components/popover/popover.component.js"
|
3544
|
+
}
|
3545
|
+
},
|
3546
|
+
{
|
3547
|
+
"kind": "field",
|
3548
|
+
"name": "delay",
|
3549
|
+
"type": {
|
3550
|
+
"text": "string"
|
3551
|
+
},
|
3552
|
+
"description": "The delay of the show/hide popover.",
|
3553
|
+
"default": "0,0",
|
3554
|
+
"attribute": "delay",
|
3555
|
+
"reflects": true,
|
3556
|
+
"inheritedFrom": {
|
3557
|
+
"name": "Popover",
|
3558
|
+
"module": "components/popover/popover.component.js"
|
3559
|
+
}
|
3560
|
+
},
|
3561
|
+
{
|
3562
|
+
"kind": "field",
|
3563
|
+
"name": "hideOnEscape",
|
3564
|
+
"type": {
|
3565
|
+
"text": "boolean"
|
3566
|
+
},
|
3567
|
+
"description": "Hide popover on escape key press.",
|
3568
|
+
"default": "false",
|
3569
|
+
"attribute": "hide-on-escape",
|
3570
|
+
"reflects": true,
|
3571
|
+
"inheritedFrom": {
|
3572
|
+
"name": "Popover",
|
3573
|
+
"module": "components/popover/popover.component.js"
|
3574
|
+
}
|
3575
|
+
},
|
3576
|
+
{
|
3577
|
+
"kind": "field",
|
3578
|
+
"name": "hideOnBlur",
|
3579
|
+
"type": {
|
3580
|
+
"text": "boolean"
|
3581
|
+
},
|
3582
|
+
"description": "Hide popover on blur.",
|
3583
|
+
"default": "false",
|
3584
|
+
"attribute": "hide-on-blur",
|
3585
|
+
"reflects": true,
|
3586
|
+
"inheritedFrom": {
|
3587
|
+
"name": "Popover",
|
3588
|
+
"module": "components/popover/popover.component.js"
|
3589
|
+
}
|
3590
|
+
},
|
3591
|
+
{
|
3592
|
+
"kind": "field",
|
3593
|
+
"name": "hideOnOutsideClick",
|
3594
|
+
"type": {
|
3595
|
+
"text": "boolean"
|
3596
|
+
},
|
3597
|
+
"description": "Hide on outside click of the popover.",
|
3598
|
+
"default": "false",
|
3599
|
+
"attribute": "hide-on-outside-click",
|
3600
|
+
"reflects": true,
|
3601
|
+
"inheritedFrom": {
|
3602
|
+
"name": "Popover",
|
3603
|
+
"module": "components/popover/popover.component.js"
|
3604
|
+
}
|
3605
|
+
},
|
3606
|
+
{
|
3607
|
+
"kind": "field",
|
3608
|
+
"name": "focusBackToTrigger",
|
3609
|
+
"type": {
|
3610
|
+
"text": "boolean"
|
3611
|
+
},
|
3612
|
+
"description": "The focus back to trigger after the popover hide.",
|
3613
|
+
"default": "false",
|
3614
|
+
"attribute": "focus-back-to-trigger",
|
3615
|
+
"reflects": true,
|
3616
|
+
"inheritedFrom": {
|
3617
|
+
"name": "Popover",
|
3618
|
+
"module": "components/popover/popover.component.js"
|
3619
|
+
}
|
3620
|
+
},
|
3621
|
+
{
|
3622
|
+
"kind": "field",
|
3623
|
+
"name": "backdrop",
|
3624
|
+
"type": {
|
3625
|
+
"text": "boolean"
|
3626
|
+
},
|
3627
|
+
"description": "Determines whether the popover with backdrop.\nOther than popover and trigger element, the rest of the screen will be covered with a backdrop.",
|
3628
|
+
"default": "false",
|
3629
|
+
"attribute": "backdrop",
|
3630
|
+
"reflects": true,
|
3631
|
+
"inheritedFrom": {
|
3632
|
+
"name": "Popover",
|
3633
|
+
"module": "components/popover/popover.component.js"
|
3634
|
+
}
|
3635
|
+
},
|
3636
|
+
{
|
3637
|
+
"kind": "field",
|
3638
|
+
"name": "flip",
|
3639
|
+
"type": {
|
3640
|
+
"text": "boolean"
|
3641
|
+
},
|
3642
|
+
"description": "Changes the placement of popover to keep it in view when scrolling.",
|
3643
|
+
"default": "true",
|
3644
|
+
"attribute": "flip",
|
3645
|
+
"reflects": true,
|
3646
|
+
"inheritedFrom": {
|
3647
|
+
"name": "Popover",
|
3648
|
+
"module": "components/popover/popover.component.js"
|
3649
|
+
}
|
3650
|
+
},
|
3651
|
+
{
|
3652
|
+
"kind": "field",
|
3653
|
+
"name": "size",
|
3654
|
+
"type": {
|
3655
|
+
"text": "boolean"
|
3656
|
+
},
|
3657
|
+
"description": "Changes the size of popover to keep it in view when scrolling.",
|
3658
|
+
"default": "false",
|
3659
|
+
"attribute": "size",
|
3660
|
+
"reflects": true,
|
3661
|
+
"inheritedFrom": {
|
3662
|
+
"name": "Popover",
|
3663
|
+
"module": "components/popover/popover.component.js"
|
3664
|
+
}
|
3665
|
+
},
|
3666
|
+
{
|
3667
|
+
"kind": "field",
|
3668
|
+
"name": "zIndex",
|
3669
|
+
"type": {
|
3670
|
+
"text": "number"
|
3671
|
+
},
|
3672
|
+
"description": "The z-index of the popover.",
|
3673
|
+
"default": "1000",
|
3674
|
+
"attribute": "z-index",
|
3675
|
+
"reflects": true,
|
3676
|
+
"inheritedFrom": {
|
3677
|
+
"name": "Popover",
|
3678
|
+
"module": "components/popover/popover.component.js"
|
3679
|
+
}
|
3680
|
+
},
|
3681
|
+
{
|
3682
|
+
"kind": "field",
|
3683
|
+
"name": "appendTo",
|
3684
|
+
"type": {
|
3685
|
+
"text": "string"
|
3686
|
+
},
|
3687
|
+
"default": "''",
|
3688
|
+
"description": "Element ID that the popover append to.",
|
3689
|
+
"attribute": "append-to",
|
3690
|
+
"reflects": true,
|
3691
|
+
"inheritedFrom": {
|
3692
|
+
"name": "Popover",
|
3693
|
+
"module": "components/popover/popover.component.js"
|
3694
|
+
}
|
3695
|
+
},
|
3696
|
+
{
|
3697
|
+
"kind": "field",
|
3698
|
+
"name": "closeButtonAriaLabel",
|
3699
|
+
"type": {
|
3700
|
+
"text": "string | null"
|
3701
|
+
},
|
3702
|
+
"default": "null",
|
3703
|
+
"description": "aria-label attribute to be set for close button accessibility.",
|
3704
|
+
"attribute": "close-button-aria-label",
|
3705
|
+
"inheritedFrom": {
|
3706
|
+
"name": "Popover",
|
3707
|
+
"module": "components/popover/popover.component.js"
|
3708
|
+
}
|
3709
|
+
},
|
3710
|
+
{
|
3711
|
+
"kind": "field",
|
3712
|
+
"name": "role",
|
3713
|
+
"type": {
|
3714
|
+
"text": "HTMLElement['role']"
|
3715
|
+
},
|
3716
|
+
"description": "Role of the popover",
|
3717
|
+
"default": "dialog",
|
3718
|
+
"attribute": "role",
|
3719
|
+
"reflects": true,
|
3720
|
+
"inheritedFrom": {
|
3721
|
+
"name": "Popover",
|
3722
|
+
"module": "components/popover/popover.component.js"
|
3723
|
+
}
|
3724
|
+
},
|
3725
|
+
{
|
3726
|
+
"kind": "field",
|
3727
|
+
"name": "ariaLabelledby",
|
3728
|
+
"type": {
|
3729
|
+
"text": "string | null"
|
3730
|
+
},
|
3731
|
+
"default": "null",
|
3732
|
+
"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.",
|
3733
|
+
"attribute": "aria-labelledby",
|
3734
|
+
"reflects": true,
|
3735
|
+
"inheritedFrom": {
|
3736
|
+
"name": "Popover",
|
3737
|
+
"module": "components/popover/popover.component.js"
|
3738
|
+
}
|
3739
|
+
},
|
3740
|
+
{
|
3741
|
+
"kind": "field",
|
3742
|
+
"name": "ariaDescribedby",
|
3743
|
+
"type": {
|
3744
|
+
"text": "string | null"
|
3745
|
+
},
|
3746
|
+
"default": "null",
|
3747
|
+
"description": "aria-describedby of the popover.",
|
3748
|
+
"attribute": "aria-describedby",
|
3749
|
+
"reflects": true,
|
3750
|
+
"inheritedFrom": {
|
3751
|
+
"name": "Popover",
|
3752
|
+
"module": "components/popover/popover.component.js"
|
3753
|
+
}
|
3754
|
+
},
|
3755
|
+
{
|
3756
|
+
"kind": "field",
|
3757
|
+
"name": "arrowElement",
|
3758
|
+
"type": {
|
3759
|
+
"text": "HTMLElement | null"
|
3760
|
+
},
|
3761
|
+
"privacy": "public",
|
3762
|
+
"default": "null",
|
3763
|
+
"inheritedFrom": {
|
3764
|
+
"name": "Popover",
|
3765
|
+
"module": "components/popover/popover.component.js"
|
3766
|
+
}
|
3767
|
+
},
|
3768
|
+
{
|
3769
|
+
"kind": "field",
|
3770
|
+
"name": "triggerElement",
|
3771
|
+
"type": {
|
3772
|
+
"text": "HTMLElement | null"
|
3773
|
+
},
|
3774
|
+
"privacy": "public",
|
3775
|
+
"default": "null",
|
3776
|
+
"inheritedFrom": {
|
3777
|
+
"name": "Popover",
|
3778
|
+
"module": "components/popover/popover.component.js"
|
3779
|
+
}
|
3780
|
+
},
|
3781
|
+
{
|
3782
|
+
"kind": "method",
|
3783
|
+
"name": "setupTriggerListener",
|
3784
|
+
"privacy": "private",
|
3785
|
+
"description": "Sets up the trigger event listeners based on the trigger type.",
|
3786
|
+
"inheritedFrom": {
|
3787
|
+
"name": "Popover",
|
3788
|
+
"module": "components/popover/popover.component.js"
|
3789
|
+
}
|
3790
|
+
},
|
3791
|
+
{
|
3792
|
+
"kind": "method",
|
3793
|
+
"name": "removeEventListeners",
|
3794
|
+
"privacy": "private",
|
3795
|
+
"description": "Removes the trigger event listeners.",
|
3796
|
+
"inheritedFrom": {
|
3797
|
+
"name": "Popover",
|
3798
|
+
"module": "components/popover/popover.component.js"
|
3799
|
+
}
|
3800
|
+
},
|
3801
|
+
{
|
3802
|
+
"kind": "field",
|
3803
|
+
"name": "onOutsidePopoverClick",
|
3804
|
+
"privacy": "private",
|
3805
|
+
"description": "Handles the outside click event to close the popover.",
|
3806
|
+
"parameters": [
|
3807
|
+
{
|
3808
|
+
"description": "The mouse event.",
|
3809
|
+
"name": "event"
|
3810
|
+
}
|
3811
|
+
],
|
3812
|
+
"inheritedFrom": {
|
3813
|
+
"name": "Popover",
|
3814
|
+
"module": "components/popover/popover.component.js"
|
3815
|
+
}
|
3816
|
+
},
|
3817
|
+
{
|
3818
|
+
"kind": "field",
|
3819
|
+
"name": "onEscapeKeydown",
|
3820
|
+
"privacy": "private",
|
3821
|
+
"description": "Handles the escape keydown event to close the popover.",
|
3822
|
+
"parameters": [
|
3823
|
+
{
|
3824
|
+
"description": "The keyboard event.",
|
3825
|
+
"name": "event"
|
3826
|
+
}
|
3827
|
+
],
|
3828
|
+
"inheritedFrom": {
|
3829
|
+
"name": "Popover",
|
3830
|
+
"module": "components/popover/popover.component.js"
|
3831
|
+
}
|
3832
|
+
},
|
3833
|
+
{
|
3834
|
+
"kind": "field",
|
3835
|
+
"name": "onPopoverFocusOut",
|
3836
|
+
"privacy": "private",
|
3837
|
+
"description": "Handles the popover focus out event.",
|
3838
|
+
"parameters": [
|
3839
|
+
{
|
3840
|
+
"description": "The focus event.",
|
3841
|
+
"name": "event"
|
3842
|
+
}
|
3843
|
+
],
|
3844
|
+
"inheritedFrom": {
|
3845
|
+
"name": "Popover",
|
3846
|
+
"module": "components/popover/popover.component.js"
|
3847
|
+
}
|
3848
|
+
},
|
3849
|
+
{
|
3850
|
+
"kind": "method",
|
3851
|
+
"name": "isOpenUpdated",
|
3852
|
+
"privacy": "private",
|
3853
|
+
"parameters": [
|
3854
|
+
{
|
3855
|
+
"name": "oldValue",
|
3856
|
+
"type": {
|
3857
|
+
"text": "boolean"
|
3858
|
+
},
|
3859
|
+
"description": "The old value of the visible property."
|
3860
|
+
},
|
3861
|
+
{
|
3862
|
+
"name": "newValue",
|
3863
|
+
"type": {
|
3864
|
+
"text": "boolean"
|
3865
|
+
},
|
3866
|
+
"description": "The new value of the visible property."
|
3867
|
+
}
|
3868
|
+
],
|
3869
|
+
"description": "Handles the popover visibility change and position the popover.\nHandles the exit event to close the popover.",
|
3870
|
+
"inheritedFrom": {
|
3871
|
+
"name": "Popover",
|
3872
|
+
"module": "components/popover/popover.component.js"
|
3873
|
+
}
|
3874
|
+
},
|
3875
|
+
{
|
3876
|
+
"kind": "field",
|
3877
|
+
"name": "startCloseDelay",
|
3878
|
+
"privacy": "private",
|
3879
|
+
"description": "Starts the close delay timer.\nIf the popover is not interactive, it will close the popover after the delay.",
|
3880
|
+
"inheritedFrom": {
|
3881
|
+
"name": "Popover",
|
3882
|
+
"module": "components/popover/popover.component.js"
|
3883
|
+
}
|
3884
|
+
},
|
3885
|
+
{
|
3886
|
+
"kind": "field",
|
3887
|
+
"name": "cancelCloseDelay",
|
3888
|
+
"privacy": "private",
|
3889
|
+
"description": "Cancels the close delay timer.",
|
3890
|
+
"inheritedFrom": {
|
3891
|
+
"name": "Popover",
|
3892
|
+
"module": "components/popover/popover.component.js"
|
3893
|
+
}
|
3894
|
+
},
|
3895
|
+
{
|
3896
|
+
"kind": "field",
|
3897
|
+
"name": "showPopover",
|
3898
|
+
"privacy": "public",
|
3899
|
+
"description": "Shows the popover.",
|
3900
|
+
"inheritedFrom": {
|
3901
|
+
"name": "Popover",
|
3902
|
+
"module": "components/popover/popover.component.js"
|
3903
|
+
}
|
3904
|
+
},
|
3905
|
+
{
|
3906
|
+
"kind": "field",
|
3907
|
+
"name": "hidePopover",
|
3908
|
+
"privacy": "public",
|
3909
|
+
"description": "Hides the popover.",
|
3910
|
+
"inheritedFrom": {
|
3911
|
+
"name": "Popover",
|
3912
|
+
"module": "components/popover/popover.component.js"
|
3913
|
+
}
|
3914
|
+
},
|
3915
|
+
{
|
3916
|
+
"kind": "field",
|
3917
|
+
"name": "togglePopoverVisible",
|
3918
|
+
"privacy": "public",
|
3919
|
+
"description": "Toggles the popover visibility.",
|
3920
|
+
"inheritedFrom": {
|
3921
|
+
"name": "Popover",
|
3922
|
+
"module": "components/popover/popover.component.js"
|
3923
|
+
}
|
3924
|
+
},
|
3925
|
+
{
|
3926
|
+
"kind": "method",
|
3927
|
+
"name": "handleCreatePopoverFirstUpdate",
|
3928
|
+
"privacy": "private",
|
3929
|
+
"description": "Sets the focusable elements inside the popover.",
|
3930
|
+
"inheritedFrom": {
|
3931
|
+
"name": "Popover",
|
3932
|
+
"module": "components/popover/popover.component.js"
|
3933
|
+
}
|
3934
|
+
},
|
3935
|
+
{
|
3936
|
+
"kind": "method",
|
3937
|
+
"name": "positionPopover",
|
3938
|
+
"privacy": "private",
|
3939
|
+
"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.",
|
3940
|
+
"inheritedFrom": {
|
3941
|
+
"name": "Popover",
|
3942
|
+
"module": "components/popover/popover.component.js"
|
3943
|
+
}
|
3944
|
+
},
|
3945
|
+
{
|
3946
|
+
"kind": "field",
|
3947
|
+
"name": "utils",
|
3948
|
+
"default": "new PopoverUtils(this)",
|
3949
|
+
"inheritedFrom": {
|
3950
|
+
"name": "Popover",
|
3951
|
+
"module": "components/popover/popover.component.js"
|
3952
|
+
}
|
3953
|
+
}
|
3954
|
+
],
|
3955
|
+
"attributes": [
|
3956
|
+
{
|
3957
|
+
"name": "trigger",
|
3958
|
+
"type": {
|
3959
|
+
"text": "PopoverTrigger"
|
3960
|
+
},
|
3961
|
+
"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**",
|
3962
|
+
"default": "manual",
|
3963
|
+
"fieldName": "trigger",
|
3964
|
+
"inheritedFrom": {
|
3965
|
+
"name": "Popover",
|
3966
|
+
"module": "src/components/popover/popover.component.ts"
|
3967
|
+
}
|
3968
|
+
},
|
3969
|
+
{
|
3970
|
+
"name": "show-arrow",
|
3971
|
+
"type": {
|
3972
|
+
"text": "boolean"
|
3973
|
+
},
|
3974
|
+
"description": "The arrow visibility of the Coachmark.",
|
3975
|
+
"default": "true",
|
3976
|
+
"fieldName": "showArrow",
|
3977
|
+
"inheritedFrom": {
|
3978
|
+
"name": "Popover",
|
3979
|
+
"module": "src/components/popover/popover.component.ts"
|
3980
|
+
}
|
3981
|
+
},
|
3982
|
+
{
|
3983
|
+
"name": "close-button",
|
3984
|
+
"type": {
|
3985
|
+
"text": "boolean"
|
3986
|
+
},
|
3987
|
+
"description": "The close button visibility of the Coachmark.",
|
3988
|
+
"default": "true",
|
3989
|
+
"fieldName": "closeButton",
|
3990
|
+
"inheritedFrom": {
|
3991
|
+
"name": "Popover",
|
3992
|
+
"module": "src/components/popover/popover.component.ts"
|
3993
|
+
}
|
3994
|
+
},
|
3995
|
+
{
|
3996
|
+
"name": "disable-aria-expanded",
|
3997
|
+
"type": {
|
3998
|
+
"text": "boolean"
|
3999
|
+
},
|
4000
|
+
"description": "Disable aria-expanded attribute on trigger element.",
|
4001
|
+
"default": "true",
|
4002
|
+
"fieldName": "disableAriaExpanded",
|
4003
|
+
"inheritedFrom": {
|
4004
|
+
"name": "Popover",
|
4005
|
+
"module": "src/components/popover/popover.component.ts"
|
4006
|
+
}
|
4007
|
+
},
|
4008
|
+
{
|
4009
|
+
"name": "enabledFocusTrap",
|
4010
|
+
"type": {
|
4011
|
+
"text": "boolean"
|
4012
|
+
},
|
4013
|
+
"description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.",
|
4014
|
+
"default": "false",
|
4015
|
+
"fieldName": "enabledFocusTrap",
|
4016
|
+
"inheritedFrom": {
|
4017
|
+
"name": "FocusTrapMixin",
|
4018
|
+
"module": "src/utils/mixins/FocusTrapMixin.ts"
|
4019
|
+
}
|
4020
|
+
},
|
4021
|
+
{
|
4022
|
+
"name": "enabledPreventScroll",
|
4023
|
+
"type": {
|
4024
|
+
"text": "boolean"
|
4025
|
+
},
|
4026
|
+
"description": "Prevent outside scrolling when popover show.",
|
4027
|
+
"default": "false",
|
4028
|
+
"fieldName": "enabledPreventScroll",
|
4029
|
+
"inheritedFrom": {
|
4030
|
+
"name": "FocusTrapMixin",
|
4031
|
+
"module": "src/utils/mixins/FocusTrapMixin.ts"
|
4032
|
+
}
|
4033
|
+
},
|
4034
|
+
{
|
4035
|
+
"name": "id",
|
4036
|
+
"type": {
|
4037
|
+
"text": "string"
|
4038
|
+
},
|
4039
|
+
"default": "''",
|
4040
|
+
"description": "The unique ID of the popover.",
|
4041
|
+
"fieldName": "id",
|
4042
|
+
"inheritedFrom": {
|
4043
|
+
"name": "Popover",
|
4044
|
+
"module": "src/components/popover/popover.component.ts"
|
4045
|
+
}
|
4046
|
+
},
|
4047
|
+
{
|
4048
|
+
"name": "triggerID",
|
4049
|
+
"type": {
|
4050
|
+
"text": "string"
|
4051
|
+
},
|
4052
|
+
"default": "''",
|
4053
|
+
"description": "The ID of the element that triggers the popover.\nThis attribute is required for the popover to work.",
|
4054
|
+
"fieldName": "triggerID",
|
4055
|
+
"inheritedFrom": {
|
4056
|
+
"name": "Popover",
|
4057
|
+
"module": "src/components/popover/popover.component.ts"
|
4058
|
+
}
|
4059
|
+
},
|
4060
|
+
{
|
4061
|
+
"name": "placement",
|
4062
|
+
"type": {
|
4063
|
+
"text": "PopoverPlacement"
|
4064
|
+
},
|
4065
|
+
"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**",
|
4066
|
+
"default": "bottom",
|
4067
|
+
"fieldName": "placement",
|
4068
|
+
"inheritedFrom": {
|
4069
|
+
"name": "Popover",
|
4070
|
+
"module": "src/components/popover/popover.component.ts"
|
4071
|
+
}
|
4072
|
+
},
|
4073
|
+
{
|
4074
|
+
"name": "color",
|
4075
|
+
"type": {
|
4076
|
+
"text": "PopoverColor"
|
4077
|
+
},
|
4078
|
+
"description": "Color of the popover\n- **tonal**\n- **contrast**",
|
4079
|
+
"default": "tonal",
|
4080
|
+
"fieldName": "color",
|
4081
|
+
"inheritedFrom": {
|
4082
|
+
"name": "Popover",
|
4083
|
+
"module": "src/components/popover/popover.component.ts"
|
4084
|
+
}
|
4085
|
+
},
|
4086
|
+
{
|
4087
|
+
"name": "visible",
|
4088
|
+
"type": {
|
4089
|
+
"text": "boolean"
|
4090
|
+
},
|
4091
|
+
"description": "The visibility of the popover.",
|
4092
|
+
"default": "false",
|
4093
|
+
"fieldName": "visible",
|
4094
|
+
"inheritedFrom": {
|
4095
|
+
"name": "Popover",
|
4096
|
+
"module": "src/components/popover/popover.component.ts"
|
4097
|
+
}
|
4098
|
+
},
|
4099
|
+
{
|
4100
|
+
"name": "offset",
|
4101
|
+
"type": {
|
4102
|
+
"text": "number"
|
4103
|
+
},
|
4104
|
+
"description": "The offset of the popover.",
|
4105
|
+
"default": "4",
|
4106
|
+
"fieldName": "offset",
|
4107
|
+
"inheritedFrom": {
|
4108
|
+
"name": "Popover",
|
4109
|
+
"module": "src/components/popover/popover.component.ts"
|
4110
|
+
}
|
4111
|
+
},
|
4112
|
+
{
|
4113
|
+
"name": "focus-trap",
|
4114
|
+
"type": {
|
4115
|
+
"text": "boolean"
|
4116
|
+
},
|
4117
|
+
"description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.",
|
4118
|
+
"default": "false",
|
4119
|
+
"fieldName": "focusTrap",
|
4120
|
+
"inheritedFrom": {
|
4121
|
+
"name": "Popover",
|
4122
|
+
"module": "src/components/popover/popover.component.ts"
|
4123
|
+
}
|
4124
|
+
},
|
4125
|
+
{
|
4126
|
+
"name": "prevent-scroll",
|
4127
|
+
"type": {
|
4128
|
+
"text": "boolean"
|
4129
|
+
},
|
4130
|
+
"description": "Prevent outside scrolling when popover show.",
|
4131
|
+
"default": "false",
|
4132
|
+
"fieldName": "preventScroll",
|
4133
|
+
"inheritedFrom": {
|
4134
|
+
"name": "Popover",
|
4135
|
+
"module": "src/components/popover/popover.component.ts"
|
4136
|
+
}
|
4137
|
+
},
|
4138
|
+
{
|
4139
|
+
"name": "interactive",
|
4140
|
+
"type": {
|
4141
|
+
"text": "boolean"
|
4142
|
+
},
|
4143
|
+
"description": "Determines whether the popover is interactive。",
|
4144
|
+
"default": "false",
|
4145
|
+
"fieldName": "interactive",
|
4146
|
+
"inheritedFrom": {
|
4147
|
+
"name": "Popover",
|
4148
|
+
"module": "src/components/popover/popover.component.ts"
|
4149
|
+
}
|
4150
|
+
},
|
4151
|
+
{
|
4152
|
+
"name": "delay",
|
4153
|
+
"type": {
|
4154
|
+
"text": "string"
|
4155
|
+
},
|
4156
|
+
"description": "The delay of the show/hide popover.",
|
4157
|
+
"default": "0,0",
|
4158
|
+
"fieldName": "delay",
|
4159
|
+
"inheritedFrom": {
|
4160
|
+
"name": "Popover",
|
4161
|
+
"module": "src/components/popover/popover.component.ts"
|
4162
|
+
}
|
4163
|
+
},
|
4164
|
+
{
|
4165
|
+
"name": "hide-on-escape",
|
4166
|
+
"type": {
|
4167
|
+
"text": "boolean"
|
4168
|
+
},
|
4169
|
+
"description": "Hide popover on escape key press.",
|
4170
|
+
"default": "false",
|
4171
|
+
"fieldName": "hideOnEscape",
|
4172
|
+
"inheritedFrom": {
|
4173
|
+
"name": "Popover",
|
4174
|
+
"module": "src/components/popover/popover.component.ts"
|
4175
|
+
}
|
4176
|
+
},
|
4177
|
+
{
|
4178
|
+
"name": "hide-on-blur",
|
4179
|
+
"type": {
|
4180
|
+
"text": "boolean"
|
4181
|
+
},
|
4182
|
+
"description": "Hide popover on blur.",
|
4183
|
+
"default": "false",
|
4184
|
+
"fieldName": "hideOnBlur",
|
4185
|
+
"inheritedFrom": {
|
4186
|
+
"name": "Popover",
|
4187
|
+
"module": "src/components/popover/popover.component.ts"
|
4188
|
+
}
|
4189
|
+
},
|
4190
|
+
{
|
4191
|
+
"name": "hide-on-outside-click",
|
4192
|
+
"type": {
|
4193
|
+
"text": "boolean"
|
4194
|
+
},
|
4195
|
+
"description": "Hide on outside click of the popover.",
|
4196
|
+
"default": "false",
|
4197
|
+
"fieldName": "hideOnOutsideClick",
|
4198
|
+
"inheritedFrom": {
|
4199
|
+
"name": "Popover",
|
4200
|
+
"module": "src/components/popover/popover.component.ts"
|
4201
|
+
}
|
4202
|
+
},
|
4203
|
+
{
|
4204
|
+
"name": "focus-back-to-trigger",
|
4205
|
+
"type": {
|
4206
|
+
"text": "boolean"
|
4207
|
+
},
|
4208
|
+
"description": "The focus back to trigger after the popover hide.",
|
4209
|
+
"default": "false",
|
4210
|
+
"fieldName": "focusBackToTrigger",
|
4211
|
+
"inheritedFrom": {
|
4212
|
+
"name": "Popover",
|
4213
|
+
"module": "src/components/popover/popover.component.ts"
|
4214
|
+
}
|
4215
|
+
},
|
4216
|
+
{
|
4217
|
+
"name": "backdrop",
|
4218
|
+
"type": {
|
4219
|
+
"text": "boolean"
|
4220
|
+
},
|
4221
|
+
"description": "Determines whether the popover with backdrop.\nOther than popover and trigger element, the rest of the screen will be covered with a backdrop.",
|
4222
|
+
"default": "false",
|
4223
|
+
"fieldName": "backdrop",
|
4224
|
+
"inheritedFrom": {
|
4225
|
+
"name": "Popover",
|
4226
|
+
"module": "src/components/popover/popover.component.ts"
|
4227
|
+
}
|
4228
|
+
},
|
4229
|
+
{
|
4230
|
+
"name": "flip",
|
4231
|
+
"type": {
|
4232
|
+
"text": "boolean"
|
4233
|
+
},
|
4234
|
+
"description": "Changes the placement of popover to keep it in view when scrolling.",
|
4235
|
+
"default": "true",
|
4236
|
+
"fieldName": "flip",
|
4237
|
+
"inheritedFrom": {
|
4238
|
+
"name": "Popover",
|
4239
|
+
"module": "src/components/popover/popover.component.ts"
|
4240
|
+
}
|
4241
|
+
},
|
4242
|
+
{
|
4243
|
+
"name": "size",
|
4244
|
+
"type": {
|
4245
|
+
"text": "boolean"
|
4246
|
+
},
|
4247
|
+
"description": "Changes the size of popover to keep it in view when scrolling.",
|
4248
|
+
"default": "false",
|
4249
|
+
"fieldName": "size",
|
4250
|
+
"inheritedFrom": {
|
4251
|
+
"name": "Popover",
|
4252
|
+
"module": "src/components/popover/popover.component.ts"
|
4253
|
+
}
|
4254
|
+
},
|
4255
|
+
{
|
4256
|
+
"name": "z-index",
|
4257
|
+
"type": {
|
4258
|
+
"text": "number"
|
4259
|
+
},
|
4260
|
+
"description": "The z-index of the popover.",
|
4261
|
+
"default": "1000",
|
4262
|
+
"fieldName": "zIndex",
|
4263
|
+
"inheritedFrom": {
|
4264
|
+
"name": "Popover",
|
4265
|
+
"module": "src/components/popover/popover.component.ts"
|
4266
|
+
}
|
4267
|
+
},
|
4268
|
+
{
|
4269
|
+
"name": "append-to",
|
4270
|
+
"type": {
|
4271
|
+
"text": "string"
|
4272
|
+
},
|
4273
|
+
"default": "''",
|
4274
|
+
"description": "Element ID that the popover append to.",
|
4275
|
+
"fieldName": "appendTo",
|
4276
|
+
"inheritedFrom": {
|
4277
|
+
"name": "Popover",
|
4278
|
+
"module": "src/components/popover/popover.component.ts"
|
4279
|
+
}
|
4280
|
+
},
|
4281
|
+
{
|
4282
|
+
"name": "close-button-aria-label",
|
4283
|
+
"type": {
|
4284
|
+
"text": "string | null"
|
4285
|
+
},
|
4286
|
+
"default": "null",
|
4287
|
+
"description": "aria-label attribute to be set for close button accessibility.",
|
4288
|
+
"fieldName": "closeButtonAriaLabel",
|
4289
|
+
"inheritedFrom": {
|
4290
|
+
"name": "Popover",
|
4291
|
+
"module": "src/components/popover/popover.component.ts"
|
4292
|
+
}
|
4293
|
+
},
|
4294
|
+
{
|
4295
|
+
"name": "role",
|
4296
|
+
"type": {
|
4297
|
+
"text": "HTMLElement['role']"
|
4298
|
+
},
|
4299
|
+
"description": "Role of the popover",
|
4300
|
+
"default": "dialog",
|
4301
|
+
"fieldName": "role",
|
4302
|
+
"inheritedFrom": {
|
4303
|
+
"name": "Popover",
|
4304
|
+
"module": "src/components/popover/popover.component.ts"
|
4305
|
+
}
|
4306
|
+
},
|
4307
|
+
{
|
4308
|
+
"name": "aria-labelledby",
|
4309
|
+
"type": {
|
4310
|
+
"text": "string | null"
|
4311
|
+
},
|
4312
|
+
"default": "null",
|
4313
|
+
"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.",
|
4314
|
+
"fieldName": "ariaLabelledby",
|
4315
|
+
"inheritedFrom": {
|
4316
|
+
"name": "Popover",
|
4317
|
+
"module": "src/components/popover/popover.component.ts"
|
4318
|
+
}
|
4319
|
+
},
|
4320
|
+
{
|
4321
|
+
"name": "aria-describedby",
|
4322
|
+
"type": {
|
4323
|
+
"text": "string | null"
|
4324
|
+
},
|
4325
|
+
"default": "null",
|
4326
|
+
"description": "aria-describedby of the popover.",
|
4327
|
+
"fieldName": "ariaDescribedby",
|
4328
|
+
"inheritedFrom": {
|
4329
|
+
"name": "Popover",
|
4330
|
+
"module": "src/components/popover/popover.component.ts"
|
4331
|
+
}
|
4332
|
+
}
|
4333
|
+
],
|
4334
|
+
"superclass": {
|
4335
|
+
"name": "Popover",
|
4336
|
+
"module": "/src/components/popover/popover.component"
|
4337
|
+
},
|
4338
|
+
"tagName": "mdc-coachmark",
|
4339
|
+
"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 * @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 */",
|
4340
|
+
"customElement": true
|
4341
|
+
}
|
4342
|
+
],
|
4343
|
+
"exports": [
|
4344
|
+
{
|
4345
|
+
"kind": "js",
|
4346
|
+
"name": "default",
|
4347
|
+
"declaration": {
|
4348
|
+
"name": "Coachmark",
|
4349
|
+
"module": "components/coachmark/coachmark.component.js"
|
4350
|
+
}
|
4351
|
+
}
|
4352
|
+
]
|
4353
|
+
},
|
2801
4354
|
{
|
2802
4355
|
"kind": "javascript-module",
|
2803
4356
|
"path": "components/divider/divider.component.js",
|
@@ -5911,7 +7464,8 @@
|
|
5911
7464
|
},
|
5912
7465
|
"default": "''",
|
5913
7466
|
"description": "The unique ID of the popover.",
|
5914
|
-
"attribute": "id"
|
7467
|
+
"attribute": "id",
|
7468
|
+
"reflects": true
|
5915
7469
|
},
|
5916
7470
|
{
|
5917
7471
|
"kind": "field",
|
@@ -5921,7 +7475,8 @@
|
|
5921
7475
|
},
|
5922
7476
|
"default": "''",
|
5923
7477
|
"description": "The ID of the element that triggers the popover.\nThis attribute is required for the popover to work.",
|
5924
|
-
"attribute": "triggerID"
|
7478
|
+
"attribute": "triggerID",
|
7479
|
+
"reflects": true
|
5925
7480
|
},
|
5926
7481
|
{
|
5927
7482
|
"kind": "field",
|
@@ -11983,6 +13538,7 @@
|
|
11983
13538
|
"default": "''",
|
11984
13539
|
"description": "The unique ID of the popover.",
|
11985
13540
|
"attribute": "id",
|
13541
|
+
"reflects": true,
|
11986
13542
|
"inheritedFrom": {
|
11987
13543
|
"name": "Popover",
|
11988
13544
|
"module": "components/popover/popover.component.js"
|
@@ -11997,6 +13553,7 @@
|
|
11997
13553
|
"default": "''",
|
11998
13554
|
"description": "The ID of the element that triggers the popover.\nThis attribute is required for the popover to work.",
|
11999
13555
|
"attribute": "triggerID",
|
13556
|
+
"reflects": true,
|
12000
13557
|
"inheritedFrom": {
|
12001
13558
|
"name": "Popover",
|
12002
13559
|
"module": "components/popover/popover.component.js"
|