@spectrum-web-components/tooltip 0.35.1-rc.41 → 0.36.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.
@@ -0,0 +1,376 @@
1
+ {
2
+ "schemaVersion": "1.0.0",
3
+ "readme": "",
4
+ "modules": [
5
+ {
6
+ "kind": "javascript-module",
7
+ "path": "sp-tooltip.js",
8
+ "declarations": [],
9
+ "exports": [
10
+ {
11
+ "kind": "custom-element-definition",
12
+ "name": "sp-tooltip",
13
+ "declaration": {
14
+ "name": "Tooltip",
15
+ "module": "/src/Tooltip.js"
16
+ }
17
+ }
18
+ ]
19
+ },
20
+ {
21
+ "kind": "javascript-module",
22
+ "path": "src/Tooltip.js",
23
+ "declarations": [
24
+ {
25
+ "kind": "class",
26
+ "description": "",
27
+ "name": "TooltipProxy",
28
+ "events": [
29
+ {
30
+ "name": "disconnected",
31
+ "type": {
32
+ "text": "Event"
33
+ }
34
+ }
35
+ ],
36
+ "superclass": {
37
+ "name": "HTMLElement"
38
+ },
39
+ "tagName": "tooltip-proxy",
40
+ "customElement": true
41
+ },
42
+ {
43
+ "kind": "class",
44
+ "description": "",
45
+ "name": "Tooltip",
46
+ "slots": [
47
+ {
48
+ "description": "the icon element appearing at the start of the label",
49
+ "name": "icon"
50
+ },
51
+ {
52
+ "description": "the text label of the Tooltip",
53
+ "name": ""
54
+ }
55
+ ],
56
+ "members": [
57
+ {
58
+ "kind": "field",
59
+ "name": "instanceCount",
60
+ "type": {
61
+ "text": "number"
62
+ },
63
+ "static": true,
64
+ "default": "0",
65
+ "privacy": "private"
66
+ },
67
+ {
68
+ "kind": "field",
69
+ "name": "_tooltipId",
70
+ "privacy": "private",
71
+ "default": "`sp-tooltip-describedby-helper-${Tooltip.instanceCount++}`"
72
+ },
73
+ {
74
+ "kind": "field",
75
+ "name": "selfManaged",
76
+ "type": {
77
+ "text": "boolean"
78
+ },
79
+ "privacy": "public",
80
+ "default": "false",
81
+ "description": "Automatically bind to the parent element's hover interaction. Without this, you must provide your own `overlay-trigger`.",
82
+ "attribute": "self-managed"
83
+ },
84
+ {
85
+ "kind": "field",
86
+ "name": "offset",
87
+ "type": {
88
+ "text": "number"
89
+ },
90
+ "privacy": "public",
91
+ "default": "6",
92
+ "attribute": "offset",
93
+ "reflects": true
94
+ },
95
+ {
96
+ "kind": "field",
97
+ "name": "hadTooltipId",
98
+ "type": {
99
+ "text": "boolean"
100
+ },
101
+ "privacy": "private",
102
+ "default": "false"
103
+ },
104
+ {
105
+ "kind": "field",
106
+ "name": "open",
107
+ "type": {
108
+ "text": "boolean"
109
+ },
110
+ "privacy": "public",
111
+ "default": "false",
112
+ "attribute": "open",
113
+ "reflects": true
114
+ },
115
+ {
116
+ "kind": "field",
117
+ "name": "placement",
118
+ "type": {
119
+ "text": "\"auto\" | \"auto-start\" | \"auto-end\" | \"top\" | \"bottom\" | \"right\" | \"left\" | \"top-start\" | \"top-end\" | \"bottom-start\" | \"bottom-end\" | \"right-start\" | \"right-end\" | \"left-start\" | \"left-end\" | \"none\""
120
+ },
121
+ "privacy": "public",
122
+ "default": "'top'",
123
+ "attribute": "placement",
124
+ "reflects": true
125
+ },
126
+ {
127
+ "kind": "field",
128
+ "name": "tipElement",
129
+ "type": {
130
+ "text": "HTMLSpanElement"
131
+ },
132
+ "privacy": "private"
133
+ },
134
+ {
135
+ "kind": "field",
136
+ "name": "_variant",
137
+ "type": {
138
+ "text": "string"
139
+ },
140
+ "privacy": "private",
141
+ "default": "''"
142
+ },
143
+ {
144
+ "kind": "field",
145
+ "name": "variant",
146
+ "type": {
147
+ "text": "string"
148
+ },
149
+ "privacy": "public",
150
+ "attribute": "variant"
151
+ },
152
+ {
153
+ "kind": "method",
154
+ "name": "onOverlayQuery",
155
+ "privacy": "public",
156
+ "return": {
157
+ "type": {
158
+ "text": "void"
159
+ }
160
+ },
161
+ "parameters": [
162
+ {
163
+ "name": "event",
164
+ "type": {
165
+ "text": "CustomEvent<OverlayDisplayQueryDetail>"
166
+ }
167
+ }
168
+ ]
169
+ },
170
+ {
171
+ "kind": "field",
172
+ "name": "_proxy",
173
+ "type": {
174
+ "text": "HTMLElement"
175
+ },
176
+ "privacy": "private"
177
+ },
178
+ {
179
+ "kind": "method",
180
+ "name": "generateProxy",
181
+ "privacy": "private",
182
+ "return": {
183
+ "type": {
184
+ "text": "void"
185
+ }
186
+ }
187
+ },
188
+ {
189
+ "kind": "method",
190
+ "name": "overlayWillOpenCallback",
191
+ "privacy": "public",
192
+ "return": {
193
+ "type": {
194
+ "text": "void"
195
+ }
196
+ },
197
+ "parameters": [
198
+ {
199
+ "name": "{\n trigger,\n }",
200
+ "type": {
201
+ "text": "{\n trigger: HTMLElement;\n }"
202
+ }
203
+ }
204
+ ]
205
+ },
206
+ {
207
+ "kind": "method",
208
+ "name": "overlayOpenCancelledCallback",
209
+ "privacy": "public",
210
+ "return": {
211
+ "type": {
212
+ "text": "void"
213
+ }
214
+ },
215
+ "parameters": [
216
+ {
217
+ "name": "{\n trigger,\n }",
218
+ "type": {
219
+ "text": "{\n trigger: HTMLElement;\n }"
220
+ }
221
+ }
222
+ ]
223
+ },
224
+ {
225
+ "kind": "method",
226
+ "name": "overlayCloseCallback",
227
+ "privacy": "public",
228
+ "return": {
229
+ "type": {
230
+ "text": "void"
231
+ }
232
+ },
233
+ "parameters": [
234
+ {
235
+ "name": "{ trigger }",
236
+ "type": {
237
+ "text": "{ trigger: HTMLElement }"
238
+ }
239
+ }
240
+ ]
241
+ },
242
+ {
243
+ "kind": "method",
244
+ "name": "removeProxy",
245
+ "privacy": "private",
246
+ "return": {
247
+ "type": {
248
+ "text": "void"
249
+ }
250
+ }
251
+ },
252
+ {
253
+ "kind": "field",
254
+ "name": "closeOverlayCallback",
255
+ "type": {
256
+ "text": "Promise<() => void> | undefined"
257
+ },
258
+ "privacy": "private"
259
+ },
260
+ {
261
+ "kind": "field",
262
+ "name": "abortOverlay",
263
+ "type": {
264
+ "text": "(cancelled: boolean) => void"
265
+ },
266
+ "privacy": "private"
267
+ },
268
+ {
269
+ "kind": "field",
270
+ "name": "openOverlay",
271
+ "privacy": "private"
272
+ },
273
+ {
274
+ "kind": "field",
275
+ "name": "closeOverlay",
276
+ "privacy": "private"
277
+ },
278
+ {
279
+ "kind": "field",
280
+ "name": "previousSlot",
281
+ "type": {
282
+ "text": "string | undefined"
283
+ },
284
+ "privacy": "private"
285
+ },
286
+ {
287
+ "kind": "method",
288
+ "name": "manageTooltip",
289
+ "privacy": "private",
290
+ "return": {
291
+ "type": {
292
+ "text": "void"
293
+ }
294
+ }
295
+ }
296
+ ],
297
+ "attributes": [
298
+ {
299
+ "name": "placement",
300
+ "type": {
301
+ "text": "\"auto\" | \"auto-start\" | \"auto-end\" | \"top\" | \"bottom\" | \"right\" | \"left\" | \"top-start\" | \"top-end\" | \"bottom-start\" | \"bottom-end\" | \"right-start\" | \"right-end\" | \"left-start\" | \"left-end\" | \"none\""
302
+ },
303
+ "default": "'top'",
304
+ "fieldName": "placement",
305
+ "attribute": "placement"
306
+ },
307
+ {
308
+ "name": "self-managed",
309
+ "type": {
310
+ "text": "boolean"
311
+ },
312
+ "default": "false",
313
+ "description": "Automatically bind to the parent element's hover interaction. Without this, you must provide your own `overlay-trigger`.",
314
+ "fieldName": "selfManaged"
315
+ },
316
+ {
317
+ "name": "offset",
318
+ "type": {
319
+ "text": "number"
320
+ },
321
+ "default": "6",
322
+ "fieldName": "offset"
323
+ },
324
+ {
325
+ "name": "open",
326
+ "type": {
327
+ "text": "boolean"
328
+ },
329
+ "default": "false",
330
+ "fieldName": "open"
331
+ },
332
+ {
333
+ "name": "variant",
334
+ "type": {
335
+ "text": "string"
336
+ },
337
+ "fieldName": "variant"
338
+ }
339
+ ],
340
+ "superclass": {
341
+ "name": "SpectrumElement",
342
+ "package": "@spectrum-web-components/base"
343
+ },
344
+ "tagName": "sp-tooltip",
345
+ "customElement": true
346
+ }
347
+ ],
348
+ "exports": [
349
+ {
350
+ "kind": "js",
351
+ "name": "TooltipProxy",
352
+ "declaration": {
353
+ "name": "TooltipProxy",
354
+ "module": "src/Tooltip.js"
355
+ }
356
+ },
357
+ {
358
+ "kind": "custom-element-definition",
359
+ "name": "tooltip-proxy",
360
+ "declaration": {
361
+ "name": "TooltipProxy",
362
+ "module": "src/Tooltip.js"
363
+ }
364
+ },
365
+ {
366
+ "kind": "js",
367
+ "name": "Tooltip",
368
+ "declaration": {
369
+ "name": "Tooltip",
370
+ "module": "src/Tooltip.js"
371
+ }
372
+ }
373
+ ]
374
+ }
375
+ ]
376
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@spectrum-web-components/tooltip",
3
- "version": "0.35.1-rc.41+6ac4e82f0",
3
+ "version": "0.36.0",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },
@@ -57,12 +57,11 @@
57
57
  "lit-html"
58
58
  ],
59
59
  "dependencies": {
60
- "@spectrum-web-components/base": "^0.35.1-rc.41+6ac4e82f0",
61
- "@spectrum-web-components/overlay": "^0.35.1-rc.41+6ac4e82f0",
62
- "@spectrum-web-components/shared": "^0.35.1-rc.41+6ac4e82f0"
60
+ "@spectrum-web-components/base": "^0.36.0",
61
+ "@spectrum-web-components/overlay": "^0.36.0"
63
62
  },
64
63
  "devDependencies": {
65
- "@spectrum-css/tooltip": "^5.0.42"
64
+ "@spectrum-css/tooltip": "^5.1.3"
66
65
  },
67
66
  "types": "./src/index.d.ts",
68
67
  "customElements": "custom-elements.json",
@@ -70,5 +69,5 @@
70
69
  "./sp-*.js",
71
70
  "./**/*.dev.js"
72
71
  ],
73
- "gitHead": "6ac4e82f0a4a68eb50b5dd4b96a562060162ac6f"
72
+ "gitHead": "a532ff8a410abeefb54d9638a2316ae82570566e"
74
73
  }
package/src/Tooltip.d.ts CHANGED
@@ -1,6 +1,8 @@
1
- import { CSSResultArray, SpectrumElement, TemplateResult } from '@spectrum-web-components/base';
2
- import type { Overlay, Placement } from '@spectrum-web-components/overlay';
3
- import '@spectrum-web-components/overlay/sp-overlay.js';
1
+ import { CSSResultArray, PropertyValues, SpectrumElement, TemplateResult } from '@spectrum-web-components/base';
2
+ import type { OverlayDisplayQueryDetail, Placement } from '@spectrum-web-components/overlay';
3
+ export declare class TooltipProxy extends HTMLElement {
4
+ disconnectedCallback(): void;
5
+ }
4
6
  /**
5
7
  * @element sp-tooltip
6
8
  *
@@ -10,28 +12,47 @@ import '@spectrum-web-components/overlay/sp-overlay.js';
10
12
  export declare class Tooltip extends SpectrumElement {
11
13
  static get styles(): CSSResultArray;
12
14
  /**
13
- * Automatically bind to the parent element of the assigned `slot` or the parent element of the `sp-tooltip`.
14
- * Without this, you must provide your own `overlay-trigger`.
15
+ * @private
16
+ */
17
+ static instanceCount: number;
18
+ private _tooltipId;
19
+ /**
20
+ * Automatically bind to the parent element's hover interaction. Without this, you must provide your own `overlay-trigger`.
15
21
  */
16
22
  selfManaged: boolean;
17
23
  offset: number;
24
+ private hadTooltipId;
18
25
  open: boolean;
19
- overlayElement?: Overlay;
20
26
  /**
21
- * @type {"auto" | "auto-start" | "auto-end" | "top" | "bottom" | "right" | "left" | "top-start" | "top-end" | "bottom-start" | "bottom-end" | "right-start" | "right-end" | "left-start" | "left-end"}
27
+ * @type {"auto" | "auto-start" | "auto-end" | "top" | "bottom" | "right" | "left" | "top-start" | "top-end" | "bottom-start" | "bottom-end" | "right-start" | "right-end" | "left-start" | "left-end" | "none"}
22
28
  * @attr
23
29
  */
24
- placement?: Placement;
25
- tipElement: HTMLSpanElement;
26
- tipPadding?: number;
30
+ placement: Placement;
31
+ private tipElement;
27
32
  private _variant;
28
33
  get variant(): string;
29
34
  set variant(variant: string);
30
- private handleOpenOverlay;
31
- protected handleCloseOverlay: () => void;
32
- protected handleTransitionrun(event: TransitionEvent): void;
33
- protected handleTransitionend(event: TransitionEvent): void;
34
- private get triggerElement();
35
+ constructor();
36
+ onOverlayQuery(event: CustomEvent<OverlayDisplayQueryDetail>): void;
37
+ private _proxy;
38
+ private generateProxy;
39
+ overlayWillOpenCallback({ trigger, }: {
40
+ trigger: HTMLElement;
41
+ }): void;
42
+ overlayOpenCancelledCallback({ trigger, }: {
43
+ trigger: HTMLElement;
44
+ }): void;
45
+ overlayCloseCallback({ trigger }: {
46
+ trigger: HTMLElement;
47
+ }): void;
48
+ private removeProxy;
49
+ private closeOverlayCallback?;
50
+ private abortOverlay;
51
+ private openOverlay;
52
+ private closeOverlay;
53
+ private previousSlot?;
54
+ private manageTooltip;
35
55
  render(): TemplateResult;
36
- connectedCallback(): void;
56
+ protected update(changed: PropertyValues<this>): Promise<void>;
57
+ protected updated(changed: PropertyValues<this>): void;
37
58
  }