@vaadin/tooltip 25.1.0-alpha6 → 25.1.0-alpha7
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/custom-elements.json +783 -0
- package/package.json +14 -12
- package/src/vaadin-tooltip-overlay.js +1 -1
- package/src/vaadin-tooltip.js +1 -1
- package/web-types.json +1 -1
- package/web-types.lit.json +1 -1
|
@@ -0,0 +1,783 @@
|
|
|
1
|
+
{
|
|
2
|
+
"schemaVersion": "1.0.0",
|
|
3
|
+
"readme": "",
|
|
4
|
+
"modules": [
|
|
5
|
+
{
|
|
6
|
+
"kind": "javascript-module",
|
|
7
|
+
"path": "vaadin-tooltip.js",
|
|
8
|
+
"declarations": [],
|
|
9
|
+
"exports": [
|
|
10
|
+
{
|
|
11
|
+
"kind": "js",
|
|
12
|
+
"name": "*",
|
|
13
|
+
"declaration": {
|
|
14
|
+
"name": "*",
|
|
15
|
+
"module": "src/vaadin-tooltip.js"
|
|
16
|
+
}
|
|
17
|
+
}
|
|
18
|
+
]
|
|
19
|
+
},
|
|
20
|
+
{
|
|
21
|
+
"kind": "javascript-module",
|
|
22
|
+
"path": "src/vaadin-tooltip-mixin.js",
|
|
23
|
+
"declarations": [
|
|
24
|
+
{
|
|
25
|
+
"kind": "function",
|
|
26
|
+
"name": "resetGlobalTooltipState",
|
|
27
|
+
"description": "Resets the global tooltip warmup and cooldown state.\nOnly for internal use in tests.",
|
|
28
|
+
"privacy": "private"
|
|
29
|
+
},
|
|
30
|
+
{
|
|
31
|
+
"kind": "mixin",
|
|
32
|
+
"description": "A mixin providing common tooltip functionality.",
|
|
33
|
+
"name": "TooltipMixin",
|
|
34
|
+
"members": [
|
|
35
|
+
{
|
|
36
|
+
"kind": "field",
|
|
37
|
+
"name": "ariaTarget",
|
|
38
|
+
"privacy": "public",
|
|
39
|
+
"type": {
|
|
40
|
+
"text": "object"
|
|
41
|
+
},
|
|
42
|
+
"description": "Element used to link with the `aria-describedby`\nattribute. Supports array of multiple elements.\nWhen not set, defaults to `target`.",
|
|
43
|
+
"attribute": "aria-target"
|
|
44
|
+
},
|
|
45
|
+
{
|
|
46
|
+
"kind": "field",
|
|
47
|
+
"name": "context",
|
|
48
|
+
"privacy": "public",
|
|
49
|
+
"type": {
|
|
50
|
+
"text": "object"
|
|
51
|
+
},
|
|
52
|
+
"description": "Object with properties passed to `generator` and\n`shouldShow` functions for generating tooltip text\nor detecting whether to show the tooltip or not.",
|
|
53
|
+
"attribute": "context"
|
|
54
|
+
},
|
|
55
|
+
{
|
|
56
|
+
"kind": "field",
|
|
57
|
+
"name": "focusDelay",
|
|
58
|
+
"privacy": "public",
|
|
59
|
+
"type": {
|
|
60
|
+
"text": "number"
|
|
61
|
+
},
|
|
62
|
+
"description": "The delay in milliseconds before the tooltip\nis opened on keyboard focus, when not in manual mode.",
|
|
63
|
+
"attribute": "focus-delay"
|
|
64
|
+
},
|
|
65
|
+
{
|
|
66
|
+
"kind": "field",
|
|
67
|
+
"name": "for",
|
|
68
|
+
"privacy": "public",
|
|
69
|
+
"type": {
|
|
70
|
+
"text": "string"
|
|
71
|
+
},
|
|
72
|
+
"description": "The id of the element to be used as `target` value.\nThe element should be in the DOM by the time when\nthe attribute is set, otherwise a warning is shown.",
|
|
73
|
+
"attribute": "for",
|
|
74
|
+
"inheritedFrom": {
|
|
75
|
+
"name": "PopoverTargetMixin",
|
|
76
|
+
"package": "@vaadin/popover/src/vaadin-popover-target-mixin.js"
|
|
77
|
+
}
|
|
78
|
+
},
|
|
79
|
+
{
|
|
80
|
+
"kind": "field",
|
|
81
|
+
"name": "generator",
|
|
82
|
+
"privacy": "public",
|
|
83
|
+
"type": {
|
|
84
|
+
"text": "object"
|
|
85
|
+
},
|
|
86
|
+
"description": "Function used to generate the tooltip content.\nWhen provided, it overrides the `text` property.\nUse the `context` property to provide argument\nthat can be passed to the generator function.",
|
|
87
|
+
"attribute": "generator"
|
|
88
|
+
},
|
|
89
|
+
{
|
|
90
|
+
"kind": "field",
|
|
91
|
+
"name": "hideDelay",
|
|
92
|
+
"privacy": "public",
|
|
93
|
+
"type": {
|
|
94
|
+
"text": "number"
|
|
95
|
+
},
|
|
96
|
+
"description": "The delay in milliseconds before the tooltip\nis closed on losing hover, when not in manual mode.\nOn blur, the tooltip is closed immediately.",
|
|
97
|
+
"attribute": "hide-delay"
|
|
98
|
+
},
|
|
99
|
+
{
|
|
100
|
+
"kind": "field",
|
|
101
|
+
"name": "hoverDelay",
|
|
102
|
+
"privacy": "public",
|
|
103
|
+
"type": {
|
|
104
|
+
"text": "number"
|
|
105
|
+
},
|
|
106
|
+
"description": "The delay in milliseconds before the tooltip\nis opened on hover, when not in manual mode.",
|
|
107
|
+
"attribute": "hover-delay"
|
|
108
|
+
},
|
|
109
|
+
{
|
|
110
|
+
"kind": "field",
|
|
111
|
+
"name": "manual",
|
|
112
|
+
"privacy": "public",
|
|
113
|
+
"type": {
|
|
114
|
+
"text": "boolean"
|
|
115
|
+
},
|
|
116
|
+
"description": "When true, the tooltip is controlled programmatically\ninstead of reacting to focus and mouse events.",
|
|
117
|
+
"attribute": "manual"
|
|
118
|
+
},
|
|
119
|
+
{
|
|
120
|
+
"kind": "field",
|
|
121
|
+
"name": "markdown",
|
|
122
|
+
"privacy": "public",
|
|
123
|
+
"type": {
|
|
124
|
+
"text": "boolean"
|
|
125
|
+
},
|
|
126
|
+
"description": "When enabled, the tooltip text is rendered as Markdown.\n\n**Note:** Using Markdown is discouraged if accessibility of the tooltip\ncontent is essential, as semantics of the rendered HTML content\n(headers, lists, ...) will not be conveyed to assistive technologies.",
|
|
127
|
+
"attribute": "markdown"
|
|
128
|
+
},
|
|
129
|
+
{
|
|
130
|
+
"kind": "field",
|
|
131
|
+
"name": "opened",
|
|
132
|
+
"privacy": "public",
|
|
133
|
+
"type": {
|
|
134
|
+
"text": "boolean"
|
|
135
|
+
},
|
|
136
|
+
"description": "When true, the tooltip is opened.\nIn manual mode, this can be set programmatically.\nIn automatic mode, this is set automatically by internal logic.",
|
|
137
|
+
"attribute": "opened"
|
|
138
|
+
},
|
|
139
|
+
{
|
|
140
|
+
"kind": "field",
|
|
141
|
+
"name": "position",
|
|
142
|
+
"privacy": "public",
|
|
143
|
+
"type": {
|
|
144
|
+
"text": "string"
|
|
145
|
+
},
|
|
146
|
+
"description": "Position of the overlay with respect to the target.\nSupported values: `top-start`, `top`, `top-end`,\n`bottom-start`, `bottom`, `bottom-end`, `start-top`,\n`start`, `start-bottom`, `end-top`, `end`, `end-bottom`.",
|
|
147
|
+
"attribute": "position",
|
|
148
|
+
"inheritedFrom": {
|
|
149
|
+
"name": "PopoverPositionMixin",
|
|
150
|
+
"package": "@vaadin/popover/src/vaadin-popover-position-mixin.js"
|
|
151
|
+
}
|
|
152
|
+
},
|
|
153
|
+
{
|
|
154
|
+
"kind": "method",
|
|
155
|
+
"name": "setDefaultFocusDelay",
|
|
156
|
+
"static": true,
|
|
157
|
+
"parameters": [
|
|
158
|
+
{
|
|
159
|
+
"name": "focusDelay",
|
|
160
|
+
"type": {
|
|
161
|
+
"text": "number"
|
|
162
|
+
}
|
|
163
|
+
}
|
|
164
|
+
],
|
|
165
|
+
"description": "Sets the default focus delay to be used by all tooltip instances,\nexcept for those that have focus delay configured using property."
|
|
166
|
+
},
|
|
167
|
+
{
|
|
168
|
+
"kind": "method",
|
|
169
|
+
"name": "setDefaultHideDelay",
|
|
170
|
+
"static": true,
|
|
171
|
+
"parameters": [
|
|
172
|
+
{
|
|
173
|
+
"name": "hideDelay",
|
|
174
|
+
"type": {
|
|
175
|
+
"text": "number"
|
|
176
|
+
}
|
|
177
|
+
}
|
|
178
|
+
],
|
|
179
|
+
"description": "Sets the default hide delay to be used by all tooltip instances,\nexcept for those that have hide delay configured using property."
|
|
180
|
+
},
|
|
181
|
+
{
|
|
182
|
+
"kind": "method",
|
|
183
|
+
"name": "setDefaultHoverDelay",
|
|
184
|
+
"static": true,
|
|
185
|
+
"parameters": [
|
|
186
|
+
{
|
|
187
|
+
"name": "hoverDelay",
|
|
188
|
+
"type": {
|
|
189
|
+
"text": "number"
|
|
190
|
+
}
|
|
191
|
+
}
|
|
192
|
+
],
|
|
193
|
+
"description": "Sets the default hover delay to be used by all tooltip instances,\nexcept for those that have hover delay configured using property."
|
|
194
|
+
},
|
|
195
|
+
{
|
|
196
|
+
"kind": "field",
|
|
197
|
+
"name": "shouldShow",
|
|
198
|
+
"privacy": "public",
|
|
199
|
+
"type": {
|
|
200
|
+
"text": "object"
|
|
201
|
+
},
|
|
202
|
+
"description": "Function used to detect whether to show the tooltip based on a condition,\ncalled every time the tooltip is about to be shown on hover and focus.\nThe function takes two parameters: `target` and `context`, which contain\nvalues of the corresponding tooltip properties at the time of calling.\nThe tooltip is only shown when the function invocation returns `true`.",
|
|
203
|
+
"attribute": "should-show"
|
|
204
|
+
},
|
|
205
|
+
{
|
|
206
|
+
"kind": "field",
|
|
207
|
+
"name": "target",
|
|
208
|
+
"privacy": "public",
|
|
209
|
+
"type": {
|
|
210
|
+
"text": "object"
|
|
211
|
+
},
|
|
212
|
+
"description": "Reference to the DOM element used both to trigger the overlay\nby user interaction and to visually position it on the screen.\n\nDefaults to an element referenced with `for` attribute, in\nwhich case it must be located in the same shadow scope.",
|
|
213
|
+
"attribute": "target",
|
|
214
|
+
"inheritedFrom": {
|
|
215
|
+
"name": "PopoverTargetMixin",
|
|
216
|
+
"package": "@vaadin/popover/src/vaadin-popover-target-mixin.js"
|
|
217
|
+
}
|
|
218
|
+
},
|
|
219
|
+
{
|
|
220
|
+
"kind": "field",
|
|
221
|
+
"name": "text",
|
|
222
|
+
"privacy": "public",
|
|
223
|
+
"type": {
|
|
224
|
+
"text": "string"
|
|
225
|
+
},
|
|
226
|
+
"description": "String used as a tooltip content.",
|
|
227
|
+
"attribute": "text"
|
|
228
|
+
}
|
|
229
|
+
],
|
|
230
|
+
"events": [
|
|
231
|
+
{
|
|
232
|
+
"name": "content-changed",
|
|
233
|
+
"type": {
|
|
234
|
+
"text": "CustomEvent"
|
|
235
|
+
}
|
|
236
|
+
}
|
|
237
|
+
],
|
|
238
|
+
"attributes": [
|
|
239
|
+
{
|
|
240
|
+
"name": "focus-delay",
|
|
241
|
+
"type": {
|
|
242
|
+
"text": "number"
|
|
243
|
+
},
|
|
244
|
+
"description": "The delay in milliseconds before the tooltip\nis opened on keyboard focus, when not in manual mode.",
|
|
245
|
+
"fieldName": "focusDelay"
|
|
246
|
+
},
|
|
247
|
+
{
|
|
248
|
+
"name": "for",
|
|
249
|
+
"type": {
|
|
250
|
+
"text": "string"
|
|
251
|
+
},
|
|
252
|
+
"description": "The id of the element to be used as `target` value.\nThe element should be in the DOM by the time when\nthe attribute is set, otherwise a warning is shown.",
|
|
253
|
+
"fieldName": "for",
|
|
254
|
+
"inheritedFrom": {
|
|
255
|
+
"name": "PopoverTargetMixin",
|
|
256
|
+
"package": "@vaadin/popover/src/vaadin-popover-target-mixin.js"
|
|
257
|
+
}
|
|
258
|
+
},
|
|
259
|
+
{
|
|
260
|
+
"name": "hide-delay",
|
|
261
|
+
"type": {
|
|
262
|
+
"text": "number"
|
|
263
|
+
},
|
|
264
|
+
"description": "The delay in milliseconds before the tooltip\nis closed on losing hover, when not in manual mode.\nOn blur, the tooltip is closed immediately.",
|
|
265
|
+
"fieldName": "hideDelay"
|
|
266
|
+
},
|
|
267
|
+
{
|
|
268
|
+
"name": "hover-delay",
|
|
269
|
+
"type": {
|
|
270
|
+
"text": "number"
|
|
271
|
+
},
|
|
272
|
+
"description": "The delay in milliseconds before the tooltip\nis opened on hover, when not in manual mode.",
|
|
273
|
+
"fieldName": "hoverDelay"
|
|
274
|
+
},
|
|
275
|
+
{
|
|
276
|
+
"name": "manual",
|
|
277
|
+
"type": {
|
|
278
|
+
"text": "boolean"
|
|
279
|
+
},
|
|
280
|
+
"description": "When true, the tooltip is controlled programmatically\ninstead of reacting to focus and mouse events.",
|
|
281
|
+
"fieldName": "manual"
|
|
282
|
+
},
|
|
283
|
+
{
|
|
284
|
+
"name": "markdown",
|
|
285
|
+
"type": {
|
|
286
|
+
"text": "boolean"
|
|
287
|
+
},
|
|
288
|
+
"description": "When enabled, the tooltip text is rendered as Markdown.\n\n**Note:** Using Markdown is discouraged if accessibility of the tooltip\ncontent is essential, as semantics of the rendered HTML content\n(headers, lists, ...) will not be conveyed to assistive technologies.",
|
|
289
|
+
"fieldName": "markdown"
|
|
290
|
+
},
|
|
291
|
+
{
|
|
292
|
+
"name": "opened",
|
|
293
|
+
"type": {
|
|
294
|
+
"text": "boolean"
|
|
295
|
+
},
|
|
296
|
+
"description": "When true, the tooltip is opened.\nIn manual mode, this can be set programmatically.\nIn automatic mode, this is set automatically by internal logic.",
|
|
297
|
+
"fieldName": "opened"
|
|
298
|
+
},
|
|
299
|
+
{
|
|
300
|
+
"name": "position",
|
|
301
|
+
"type": {
|
|
302
|
+
"text": "string"
|
|
303
|
+
},
|
|
304
|
+
"description": "Position of the overlay with respect to the target.\nSupported values: `top-start`, `top`, `top-end`,\n`bottom-start`, `bottom`, `bottom-end`, `start-top`,\n`start`, `start-bottom`, `end-top`, `end`, `end-bottom`.",
|
|
305
|
+
"fieldName": "position",
|
|
306
|
+
"inheritedFrom": {
|
|
307
|
+
"name": "PopoverPositionMixin",
|
|
308
|
+
"package": "@vaadin/popover/src/vaadin-popover-position-mixin.js"
|
|
309
|
+
}
|
|
310
|
+
},
|
|
311
|
+
{
|
|
312
|
+
"name": "text",
|
|
313
|
+
"type": {
|
|
314
|
+
"text": "string"
|
|
315
|
+
},
|
|
316
|
+
"description": "String used as a tooltip content.",
|
|
317
|
+
"fieldName": "text"
|
|
318
|
+
}
|
|
319
|
+
],
|
|
320
|
+
"mixins": [
|
|
321
|
+
{
|
|
322
|
+
"name": "PopoverPositionMixin",
|
|
323
|
+
"package": "@vaadin/popover/src/vaadin-popover-position-mixin.js"
|
|
324
|
+
},
|
|
325
|
+
{
|
|
326
|
+
"name": "PopoverTargetMixin",
|
|
327
|
+
"package": "@vaadin/popover/src/vaadin-popover-target-mixin.js"
|
|
328
|
+
}
|
|
329
|
+
],
|
|
330
|
+
"parameters": [
|
|
331
|
+
{
|
|
332
|
+
"name": "superClass"
|
|
333
|
+
}
|
|
334
|
+
]
|
|
335
|
+
}
|
|
336
|
+
],
|
|
337
|
+
"exports": [
|
|
338
|
+
{
|
|
339
|
+
"kind": "js",
|
|
340
|
+
"name": "resetGlobalTooltipState",
|
|
341
|
+
"declaration": {
|
|
342
|
+
"name": "resetGlobalTooltipState",
|
|
343
|
+
"module": "src/vaadin-tooltip-mixin.js"
|
|
344
|
+
}
|
|
345
|
+
},
|
|
346
|
+
{
|
|
347
|
+
"kind": "js",
|
|
348
|
+
"name": "TooltipMixin",
|
|
349
|
+
"declaration": {
|
|
350
|
+
"name": "TooltipMixin",
|
|
351
|
+
"module": "src/vaadin-tooltip-mixin.js"
|
|
352
|
+
}
|
|
353
|
+
}
|
|
354
|
+
]
|
|
355
|
+
},
|
|
356
|
+
{
|
|
357
|
+
"kind": "javascript-module",
|
|
358
|
+
"path": "src/vaadin-tooltip-overlay.js",
|
|
359
|
+
"declarations": [],
|
|
360
|
+
"exports": []
|
|
361
|
+
},
|
|
362
|
+
{
|
|
363
|
+
"kind": "javascript-module",
|
|
364
|
+
"path": "src/vaadin-tooltip.js",
|
|
365
|
+
"declarations": [
|
|
366
|
+
{
|
|
367
|
+
"kind": "class",
|
|
368
|
+
"description": "`<vaadin-tooltip>` is a Web Component for creating tooltips.\n\n```html\n<button id=\"confirm\">Confirm</button>\n<vaadin-tooltip text=\"Click to save changes\" for=\"confirm\"></vaadin-tooltip>\n```\n\n### Markdown Support\n\nThe tooltip supports rendering Markdown content by setting the `markdown` property:\n\n```html\n<button id=\"info\">Info</button>\n<vaadin-tooltip\n text=\"**Important:** Click to view *detailed* information\"\n markdown\n for=\"info\">\n</vaadin-tooltip>\n```\n\n### Styling\n\nThe following shadow DOM parts are available for styling:\n\nPart name | Description\n----------- | ---------------\n`overlay` | The overlay element\n`content` | The overlay content element\n\nThe following state attributes are available for styling:\n\nAttribute | Description\n-----------------|----------------------------------------\n`markdown` | Reflects the `markdown` property value.\n`position` | Reflects the `position` property value.\n\nThe following custom CSS properties are available for styling:\n\nCustom CSS property |\n:----------------------------------|\n| `--vaadin-tooltip-background` |\n| `--vaadin-tooltip-border-color` |\n| `--vaadin-tooltip-border-radius` |\n| `--vaadin-tooltip-border-width` |\n| `--vaadin-tooltip-font-size` |\n| `--vaadin-tooltip-font-weight` |\n| `--vaadin-tooltip-line-height` |\n| `--vaadin-tooltip-max-width` |\n| `--vaadin-tooltip-offset-bottom` |\n| `--vaadin-tooltip-offset-end` |\n| `--vaadin-tooltip-offset-start` |\n| `--vaadin-tooltip-offset-top` |\n| `--vaadin-tooltip-padding` |\n| `--vaadin-tooltip-shadow` |\n| `--vaadin-tooltip-text-color` |\n\nSee [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.",
|
|
369
|
+
"name": "Tooltip",
|
|
370
|
+
"members": [
|
|
371
|
+
{
|
|
372
|
+
"kind": "field",
|
|
373
|
+
"name": "ariaTarget",
|
|
374
|
+
"privacy": "public",
|
|
375
|
+
"type": {
|
|
376
|
+
"text": "object"
|
|
377
|
+
},
|
|
378
|
+
"description": "Element used to link with the `aria-describedby`\nattribute. Supports array of multiple elements.\nWhen not set, defaults to `target`.",
|
|
379
|
+
"attribute": "aria-target",
|
|
380
|
+
"inheritedFrom": {
|
|
381
|
+
"name": "TooltipMixin",
|
|
382
|
+
"module": "src/vaadin-tooltip-mixin.js"
|
|
383
|
+
}
|
|
384
|
+
},
|
|
385
|
+
{
|
|
386
|
+
"kind": "field",
|
|
387
|
+
"name": "context",
|
|
388
|
+
"privacy": "public",
|
|
389
|
+
"type": {
|
|
390
|
+
"text": "object"
|
|
391
|
+
},
|
|
392
|
+
"description": "Object with properties passed to `generator` and\n`shouldShow` functions for generating tooltip text\nor detecting whether to show the tooltip or not.",
|
|
393
|
+
"attribute": "context",
|
|
394
|
+
"inheritedFrom": {
|
|
395
|
+
"name": "TooltipMixin",
|
|
396
|
+
"module": "src/vaadin-tooltip-mixin.js"
|
|
397
|
+
}
|
|
398
|
+
},
|
|
399
|
+
{
|
|
400
|
+
"kind": "field",
|
|
401
|
+
"name": "focusDelay",
|
|
402
|
+
"privacy": "public",
|
|
403
|
+
"type": {
|
|
404
|
+
"text": "number"
|
|
405
|
+
},
|
|
406
|
+
"description": "The delay in milliseconds before the tooltip\nis opened on keyboard focus, when not in manual mode.",
|
|
407
|
+
"attribute": "focus-delay",
|
|
408
|
+
"inheritedFrom": {
|
|
409
|
+
"name": "TooltipMixin",
|
|
410
|
+
"module": "src/vaadin-tooltip-mixin.js"
|
|
411
|
+
}
|
|
412
|
+
},
|
|
413
|
+
{
|
|
414
|
+
"kind": "field",
|
|
415
|
+
"name": "for",
|
|
416
|
+
"privacy": "public",
|
|
417
|
+
"type": {
|
|
418
|
+
"text": "string"
|
|
419
|
+
},
|
|
420
|
+
"description": "The id of the element to be used as `target` value.\nThe element should be in the DOM by the time when\nthe attribute is set, otherwise a warning is shown.",
|
|
421
|
+
"attribute": "for",
|
|
422
|
+
"inheritedFrom": {
|
|
423
|
+
"name": "PopoverTargetMixin",
|
|
424
|
+
"package": "@vaadin/popover/src/vaadin-popover-target-mixin.js"
|
|
425
|
+
}
|
|
426
|
+
},
|
|
427
|
+
{
|
|
428
|
+
"kind": "field",
|
|
429
|
+
"name": "generator",
|
|
430
|
+
"privacy": "public",
|
|
431
|
+
"type": {
|
|
432
|
+
"text": "object"
|
|
433
|
+
},
|
|
434
|
+
"description": "Function used to generate the tooltip content.\nWhen provided, it overrides the `text` property.\nUse the `context` property to provide argument\nthat can be passed to the generator function.",
|
|
435
|
+
"attribute": "generator",
|
|
436
|
+
"inheritedFrom": {
|
|
437
|
+
"name": "TooltipMixin",
|
|
438
|
+
"module": "src/vaadin-tooltip-mixin.js"
|
|
439
|
+
}
|
|
440
|
+
},
|
|
441
|
+
{
|
|
442
|
+
"kind": "field",
|
|
443
|
+
"name": "hideDelay",
|
|
444
|
+
"privacy": "public",
|
|
445
|
+
"type": {
|
|
446
|
+
"text": "number"
|
|
447
|
+
},
|
|
448
|
+
"description": "The delay in milliseconds before the tooltip\nis closed on losing hover, when not in manual mode.\nOn blur, the tooltip is closed immediately.",
|
|
449
|
+
"attribute": "hide-delay",
|
|
450
|
+
"inheritedFrom": {
|
|
451
|
+
"name": "TooltipMixin",
|
|
452
|
+
"module": "src/vaadin-tooltip-mixin.js"
|
|
453
|
+
}
|
|
454
|
+
},
|
|
455
|
+
{
|
|
456
|
+
"kind": "field",
|
|
457
|
+
"name": "hoverDelay",
|
|
458
|
+
"privacy": "public",
|
|
459
|
+
"type": {
|
|
460
|
+
"text": "number"
|
|
461
|
+
},
|
|
462
|
+
"description": "The delay in milliseconds before the tooltip\nis opened on hover, when not in manual mode.",
|
|
463
|
+
"attribute": "hover-delay",
|
|
464
|
+
"inheritedFrom": {
|
|
465
|
+
"name": "TooltipMixin",
|
|
466
|
+
"module": "src/vaadin-tooltip-mixin.js"
|
|
467
|
+
}
|
|
468
|
+
},
|
|
469
|
+
{
|
|
470
|
+
"kind": "field",
|
|
471
|
+
"name": "manual",
|
|
472
|
+
"privacy": "public",
|
|
473
|
+
"type": {
|
|
474
|
+
"text": "boolean"
|
|
475
|
+
},
|
|
476
|
+
"description": "When true, the tooltip is controlled programmatically\ninstead of reacting to focus and mouse events.",
|
|
477
|
+
"attribute": "manual",
|
|
478
|
+
"inheritedFrom": {
|
|
479
|
+
"name": "TooltipMixin",
|
|
480
|
+
"module": "src/vaadin-tooltip-mixin.js"
|
|
481
|
+
}
|
|
482
|
+
},
|
|
483
|
+
{
|
|
484
|
+
"kind": "field",
|
|
485
|
+
"name": "markdown",
|
|
486
|
+
"privacy": "public",
|
|
487
|
+
"type": {
|
|
488
|
+
"text": "boolean"
|
|
489
|
+
},
|
|
490
|
+
"description": "When enabled, the tooltip text is rendered as Markdown.\n\n**Note:** Using Markdown is discouraged if accessibility of the tooltip\ncontent is essential, as semantics of the rendered HTML content\n(headers, lists, ...) will not be conveyed to assistive technologies.",
|
|
491
|
+
"attribute": "markdown",
|
|
492
|
+
"inheritedFrom": {
|
|
493
|
+
"name": "TooltipMixin",
|
|
494
|
+
"module": "src/vaadin-tooltip-mixin.js"
|
|
495
|
+
}
|
|
496
|
+
},
|
|
497
|
+
{
|
|
498
|
+
"kind": "field",
|
|
499
|
+
"name": "opened",
|
|
500
|
+
"privacy": "public",
|
|
501
|
+
"type": {
|
|
502
|
+
"text": "boolean"
|
|
503
|
+
},
|
|
504
|
+
"description": "When true, the tooltip is opened.\nIn manual mode, this can be set programmatically.\nIn automatic mode, this is set automatically by internal logic.",
|
|
505
|
+
"attribute": "opened",
|
|
506
|
+
"inheritedFrom": {
|
|
507
|
+
"name": "TooltipMixin",
|
|
508
|
+
"module": "src/vaadin-tooltip-mixin.js"
|
|
509
|
+
}
|
|
510
|
+
},
|
|
511
|
+
{
|
|
512
|
+
"kind": "field",
|
|
513
|
+
"name": "position",
|
|
514
|
+
"privacy": "public",
|
|
515
|
+
"type": {
|
|
516
|
+
"text": "string"
|
|
517
|
+
},
|
|
518
|
+
"description": "Position of the overlay with respect to the target.\nSupported values: `top-start`, `top`, `top-end`,\n`bottom-start`, `bottom`, `bottom-end`, `start-top`,\n`start`, `start-bottom`, `end-top`, `end`, `end-bottom`.",
|
|
519
|
+
"attribute": "position",
|
|
520
|
+
"inheritedFrom": {
|
|
521
|
+
"name": "PopoverPositionMixin",
|
|
522
|
+
"package": "@vaadin/popover/src/vaadin-popover-position-mixin.js"
|
|
523
|
+
}
|
|
524
|
+
},
|
|
525
|
+
{
|
|
526
|
+
"kind": "method",
|
|
527
|
+
"name": "setDefaultFocusDelay",
|
|
528
|
+
"static": true,
|
|
529
|
+
"parameters": [
|
|
530
|
+
{
|
|
531
|
+
"name": "focusDelay",
|
|
532
|
+
"type": {
|
|
533
|
+
"text": "number"
|
|
534
|
+
}
|
|
535
|
+
}
|
|
536
|
+
],
|
|
537
|
+
"description": "Sets the default focus delay to be used by all tooltip instances,\nexcept for those that have focus delay configured using property.",
|
|
538
|
+
"inheritedFrom": {
|
|
539
|
+
"name": "TooltipMixin",
|
|
540
|
+
"module": "src/vaadin-tooltip-mixin.js"
|
|
541
|
+
}
|
|
542
|
+
},
|
|
543
|
+
{
|
|
544
|
+
"kind": "method",
|
|
545
|
+
"name": "setDefaultHideDelay",
|
|
546
|
+
"static": true,
|
|
547
|
+
"parameters": [
|
|
548
|
+
{
|
|
549
|
+
"name": "hideDelay",
|
|
550
|
+
"type": {
|
|
551
|
+
"text": "number"
|
|
552
|
+
}
|
|
553
|
+
}
|
|
554
|
+
],
|
|
555
|
+
"description": "Sets the default hide delay to be used by all tooltip instances,\nexcept for those that have hide delay configured using property.",
|
|
556
|
+
"inheritedFrom": {
|
|
557
|
+
"name": "TooltipMixin",
|
|
558
|
+
"module": "src/vaadin-tooltip-mixin.js"
|
|
559
|
+
}
|
|
560
|
+
},
|
|
561
|
+
{
|
|
562
|
+
"kind": "method",
|
|
563
|
+
"name": "setDefaultHoverDelay",
|
|
564
|
+
"static": true,
|
|
565
|
+
"parameters": [
|
|
566
|
+
{
|
|
567
|
+
"name": "hoverDelay",
|
|
568
|
+
"type": {
|
|
569
|
+
"text": "number"
|
|
570
|
+
}
|
|
571
|
+
}
|
|
572
|
+
],
|
|
573
|
+
"description": "Sets the default hover delay to be used by all tooltip instances,\nexcept for those that have hover delay configured using property.",
|
|
574
|
+
"inheritedFrom": {
|
|
575
|
+
"name": "TooltipMixin",
|
|
576
|
+
"module": "src/vaadin-tooltip-mixin.js"
|
|
577
|
+
}
|
|
578
|
+
},
|
|
579
|
+
{
|
|
580
|
+
"kind": "field",
|
|
581
|
+
"name": "shouldShow",
|
|
582
|
+
"privacy": "public",
|
|
583
|
+
"type": {
|
|
584
|
+
"text": "object"
|
|
585
|
+
},
|
|
586
|
+
"description": "Function used to detect whether to show the tooltip based on a condition,\ncalled every time the tooltip is about to be shown on hover and focus.\nThe function takes two parameters: `target` and `context`, which contain\nvalues of the corresponding tooltip properties at the time of calling.\nThe tooltip is only shown when the function invocation returns `true`.",
|
|
587
|
+
"attribute": "should-show",
|
|
588
|
+
"inheritedFrom": {
|
|
589
|
+
"name": "TooltipMixin",
|
|
590
|
+
"module": "src/vaadin-tooltip-mixin.js"
|
|
591
|
+
}
|
|
592
|
+
},
|
|
593
|
+
{
|
|
594
|
+
"kind": "field",
|
|
595
|
+
"name": "target",
|
|
596
|
+
"privacy": "public",
|
|
597
|
+
"type": {
|
|
598
|
+
"text": "object"
|
|
599
|
+
},
|
|
600
|
+
"description": "Reference to the DOM element used both to trigger the overlay\nby user interaction and to visually position it on the screen.\n\nDefaults to an element referenced with `for` attribute, in\nwhich case it must be located in the same shadow scope.",
|
|
601
|
+
"attribute": "target",
|
|
602
|
+
"inheritedFrom": {
|
|
603
|
+
"name": "PopoverTargetMixin",
|
|
604
|
+
"package": "@vaadin/popover/src/vaadin-popover-target-mixin.js"
|
|
605
|
+
}
|
|
606
|
+
},
|
|
607
|
+
{
|
|
608
|
+
"kind": "field",
|
|
609
|
+
"name": "text",
|
|
610
|
+
"privacy": "public",
|
|
611
|
+
"type": {
|
|
612
|
+
"text": "string"
|
|
613
|
+
},
|
|
614
|
+
"description": "String used as a tooltip content.",
|
|
615
|
+
"attribute": "text",
|
|
616
|
+
"inheritedFrom": {
|
|
617
|
+
"name": "TooltipMixin",
|
|
618
|
+
"module": "src/vaadin-tooltip-mixin.js"
|
|
619
|
+
}
|
|
620
|
+
}
|
|
621
|
+
],
|
|
622
|
+
"events": [
|
|
623
|
+
{
|
|
624
|
+
"name": "content-changed",
|
|
625
|
+
"type": {
|
|
626
|
+
"text": "CustomEvent"
|
|
627
|
+
},
|
|
628
|
+
"description": "Fired when the tooltip text content is changed.",
|
|
629
|
+
"inheritedFrom": {
|
|
630
|
+
"name": "TooltipMixin",
|
|
631
|
+
"module": "src/vaadin-tooltip-mixin.js"
|
|
632
|
+
}
|
|
633
|
+
}
|
|
634
|
+
],
|
|
635
|
+
"mixins": [
|
|
636
|
+
{
|
|
637
|
+
"name": "TooltipMixin",
|
|
638
|
+
"module": "src/vaadin-tooltip-mixin.js"
|
|
639
|
+
},
|
|
640
|
+
{
|
|
641
|
+
"name": "ThemePropertyMixin",
|
|
642
|
+
"package": "@vaadin/vaadin-themable-mixin/vaadin-theme-property-mixin.js"
|
|
643
|
+
},
|
|
644
|
+
{
|
|
645
|
+
"name": "ElementMixin",
|
|
646
|
+
"package": "@vaadin/component-base/src/element-mixin.js"
|
|
647
|
+
},
|
|
648
|
+
{
|
|
649
|
+
"name": "PolylitMixin",
|
|
650
|
+
"package": "@vaadin/component-base/src/polylit-mixin.js"
|
|
651
|
+
}
|
|
652
|
+
],
|
|
653
|
+
"superclass": {
|
|
654
|
+
"name": "LitElement",
|
|
655
|
+
"package": "lit"
|
|
656
|
+
},
|
|
657
|
+
"tagName": "vaadin-tooltip",
|
|
658
|
+
"customElement": true,
|
|
659
|
+
"attributes": [
|
|
660
|
+
{
|
|
661
|
+
"name": "focus-delay",
|
|
662
|
+
"type": {
|
|
663
|
+
"text": "number"
|
|
664
|
+
},
|
|
665
|
+
"description": "The delay in milliseconds before the tooltip\nis opened on keyboard focus, when not in manual mode.",
|
|
666
|
+
"fieldName": "focusDelay",
|
|
667
|
+
"inheritedFrom": {
|
|
668
|
+
"name": "TooltipMixin",
|
|
669
|
+
"module": "src/vaadin-tooltip-mixin.js"
|
|
670
|
+
}
|
|
671
|
+
},
|
|
672
|
+
{
|
|
673
|
+
"name": "for",
|
|
674
|
+
"type": {
|
|
675
|
+
"text": "string"
|
|
676
|
+
},
|
|
677
|
+
"description": "The id of the element to be used as `target` value.\nThe element should be in the DOM by the time when\nthe attribute is set, otherwise a warning is shown.",
|
|
678
|
+
"fieldName": "for",
|
|
679
|
+
"inheritedFrom": {
|
|
680
|
+
"name": "PopoverTargetMixin",
|
|
681
|
+
"package": "@vaadin/popover/src/vaadin-popover-target-mixin.js"
|
|
682
|
+
}
|
|
683
|
+
},
|
|
684
|
+
{
|
|
685
|
+
"name": "hide-delay",
|
|
686
|
+
"type": {
|
|
687
|
+
"text": "number"
|
|
688
|
+
},
|
|
689
|
+
"description": "The delay in milliseconds before the tooltip\nis closed on losing hover, when not in manual mode.\nOn blur, the tooltip is closed immediately.",
|
|
690
|
+
"fieldName": "hideDelay",
|
|
691
|
+
"inheritedFrom": {
|
|
692
|
+
"name": "TooltipMixin",
|
|
693
|
+
"module": "src/vaadin-tooltip-mixin.js"
|
|
694
|
+
}
|
|
695
|
+
},
|
|
696
|
+
{
|
|
697
|
+
"name": "hover-delay",
|
|
698
|
+
"type": {
|
|
699
|
+
"text": "number"
|
|
700
|
+
},
|
|
701
|
+
"description": "The delay in milliseconds before the tooltip\nis opened on hover, when not in manual mode.",
|
|
702
|
+
"fieldName": "hoverDelay",
|
|
703
|
+
"inheritedFrom": {
|
|
704
|
+
"name": "TooltipMixin",
|
|
705
|
+
"module": "src/vaadin-tooltip-mixin.js"
|
|
706
|
+
}
|
|
707
|
+
},
|
|
708
|
+
{
|
|
709
|
+
"name": "manual",
|
|
710
|
+
"type": {
|
|
711
|
+
"text": "boolean"
|
|
712
|
+
},
|
|
713
|
+
"description": "When true, the tooltip is controlled programmatically\ninstead of reacting to focus and mouse events.",
|
|
714
|
+
"fieldName": "manual",
|
|
715
|
+
"inheritedFrom": {
|
|
716
|
+
"name": "TooltipMixin",
|
|
717
|
+
"module": "src/vaadin-tooltip-mixin.js"
|
|
718
|
+
}
|
|
719
|
+
},
|
|
720
|
+
{
|
|
721
|
+
"name": "markdown",
|
|
722
|
+
"type": {
|
|
723
|
+
"text": "boolean"
|
|
724
|
+
},
|
|
725
|
+
"description": "When enabled, the tooltip text is rendered as Markdown.\n\n**Note:** Using Markdown is discouraged if accessibility of the tooltip\ncontent is essential, as semantics of the rendered HTML content\n(headers, lists, ...) will not be conveyed to assistive technologies.",
|
|
726
|
+
"fieldName": "markdown",
|
|
727
|
+
"inheritedFrom": {
|
|
728
|
+
"name": "TooltipMixin",
|
|
729
|
+
"module": "src/vaadin-tooltip-mixin.js"
|
|
730
|
+
}
|
|
731
|
+
},
|
|
732
|
+
{
|
|
733
|
+
"name": "opened",
|
|
734
|
+
"type": {
|
|
735
|
+
"text": "boolean"
|
|
736
|
+
},
|
|
737
|
+
"description": "When true, the tooltip is opened.\nIn manual mode, this can be set programmatically.\nIn automatic mode, this is set automatically by internal logic.",
|
|
738
|
+
"fieldName": "opened",
|
|
739
|
+
"inheritedFrom": {
|
|
740
|
+
"name": "TooltipMixin",
|
|
741
|
+
"module": "src/vaadin-tooltip-mixin.js"
|
|
742
|
+
}
|
|
743
|
+
},
|
|
744
|
+
{
|
|
745
|
+
"name": "position",
|
|
746
|
+
"type": {
|
|
747
|
+
"text": "string"
|
|
748
|
+
},
|
|
749
|
+
"description": "Position of the overlay with respect to the target.\nSupported values: `top-start`, `top`, `top-end`,\n`bottom-start`, `bottom`, `bottom-end`, `start-top`,\n`start`, `start-bottom`, `end-top`, `end`, `end-bottom`.",
|
|
750
|
+
"fieldName": "position",
|
|
751
|
+
"inheritedFrom": {
|
|
752
|
+
"name": "PopoverPositionMixin",
|
|
753
|
+
"package": "@vaadin/popover/src/vaadin-popover-position-mixin.js"
|
|
754
|
+
}
|
|
755
|
+
},
|
|
756
|
+
{
|
|
757
|
+
"name": "text",
|
|
758
|
+
"type": {
|
|
759
|
+
"text": "string"
|
|
760
|
+
},
|
|
761
|
+
"description": "String used as a tooltip content.",
|
|
762
|
+
"fieldName": "text",
|
|
763
|
+
"inheritedFrom": {
|
|
764
|
+
"name": "TooltipMixin",
|
|
765
|
+
"module": "src/vaadin-tooltip-mixin.js"
|
|
766
|
+
}
|
|
767
|
+
}
|
|
768
|
+
]
|
|
769
|
+
}
|
|
770
|
+
],
|
|
771
|
+
"exports": [
|
|
772
|
+
{
|
|
773
|
+
"kind": "js",
|
|
774
|
+
"name": "Tooltip",
|
|
775
|
+
"declaration": {
|
|
776
|
+
"name": "Tooltip",
|
|
777
|
+
"module": "src/vaadin-tooltip.js"
|
|
778
|
+
}
|
|
779
|
+
}
|
|
780
|
+
]
|
|
781
|
+
}
|
|
782
|
+
]
|
|
783
|
+
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vaadin/tooltip",
|
|
3
|
-
"version": "25.1.0-
|
|
3
|
+
"version": "25.1.0-alpha7",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"access": "public"
|
|
6
6
|
},
|
|
@@ -23,6 +23,7 @@
|
|
|
23
23
|
"src",
|
|
24
24
|
"vaadin-*.d.ts",
|
|
25
25
|
"vaadin-*.js",
|
|
26
|
+
"custom-elements.json",
|
|
26
27
|
"web-types.json",
|
|
27
28
|
"web-types.lit.json"
|
|
28
29
|
],
|
|
@@ -34,25 +35,26 @@
|
|
|
34
35
|
],
|
|
35
36
|
"dependencies": {
|
|
36
37
|
"@open-wc/dedupe-mixin": "^1.3.0",
|
|
37
|
-
"@vaadin/a11y-base": "25.1.0-
|
|
38
|
-
"@vaadin/component-base": "25.1.0-
|
|
39
|
-
"@vaadin/markdown": "25.1.0-
|
|
40
|
-
"@vaadin/overlay": "25.1.0-
|
|
41
|
-
"@vaadin/popover": "25.1.0-
|
|
42
|
-
"@vaadin/vaadin-themable-mixin": "25.1.0-
|
|
38
|
+
"@vaadin/a11y-base": "25.1.0-alpha7",
|
|
39
|
+
"@vaadin/component-base": "25.1.0-alpha7",
|
|
40
|
+
"@vaadin/markdown": "25.1.0-alpha7",
|
|
41
|
+
"@vaadin/overlay": "25.1.0-alpha7",
|
|
42
|
+
"@vaadin/popover": "25.1.0-alpha7",
|
|
43
|
+
"@vaadin/vaadin-themable-mixin": "25.1.0-alpha7",
|
|
43
44
|
"lit": "^3.0.0"
|
|
44
45
|
},
|
|
45
46
|
"devDependencies": {
|
|
46
|
-
"@vaadin/aura": "25.1.0-
|
|
47
|
-
"@vaadin/chai-plugins": "25.1.0-
|
|
48
|
-
"@vaadin/test-runner-commands": "25.1.0-
|
|
47
|
+
"@vaadin/aura": "25.1.0-alpha7",
|
|
48
|
+
"@vaadin/chai-plugins": "25.1.0-alpha7",
|
|
49
|
+
"@vaadin/test-runner-commands": "25.1.0-alpha7",
|
|
49
50
|
"@vaadin/testing-helpers": "^2.0.0",
|
|
50
|
-
"@vaadin/vaadin-lumo-styles": "25.1.0-
|
|
51
|
+
"@vaadin/vaadin-lumo-styles": "25.1.0-alpha7",
|
|
51
52
|
"sinon": "^21.0.0"
|
|
52
53
|
},
|
|
54
|
+
"customElements": "custom-elements.json",
|
|
53
55
|
"web-types": [
|
|
54
56
|
"web-types.json",
|
|
55
57
|
"web-types.lit.json"
|
|
56
58
|
],
|
|
57
|
-
"gitHead": "
|
|
59
|
+
"gitHead": "98c586125f769c8fefd307536965293668fda81d"
|
|
58
60
|
}
|
|
@@ -16,7 +16,7 @@ import { tooltipOverlayStyles } from './styles/vaadin-tooltip-overlay-base-style
|
|
|
16
16
|
/**
|
|
17
17
|
* An element used internally by `<vaadin-tooltip>`. Not intended to be used separately.
|
|
18
18
|
*
|
|
19
|
-
* @customElement
|
|
19
|
+
* @customElement vaadin-tooltip-overlay
|
|
20
20
|
* @extends HTMLElement
|
|
21
21
|
* @mixes DirMixin
|
|
22
22
|
* @mixes ThemableMixin
|
package/src/vaadin-tooltip.js
CHANGED
|
@@ -73,7 +73,7 @@ import { TooltipMixin } from './vaadin-tooltip-mixin.js';
|
|
|
73
73
|
*
|
|
74
74
|
* @fires {CustomEvent} content-changed - Fired when the tooltip text content is changed.
|
|
75
75
|
*
|
|
76
|
-
* @customElement
|
|
76
|
+
* @customElement vaadin-tooltip
|
|
77
77
|
* @extends HTMLElement
|
|
78
78
|
* @mixes ElementMixin
|
|
79
79
|
* @mixes ThemePropertyMixin
|
package/web-types.json
CHANGED