@vaadin/tooltip 25.1.0-alpha8 → 25.1.0-beta1

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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vaadin/tooltip",
3
- "version": "25.1.0-alpha8",
3
+ "version": "25.1.0-beta1",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },
@@ -35,20 +35,20 @@
35
35
  ],
36
36
  "dependencies": {
37
37
  "@open-wc/dedupe-mixin": "^1.3.0",
38
- "@vaadin/a11y-base": "25.1.0-alpha8",
39
- "@vaadin/component-base": "25.1.0-alpha8",
40
- "@vaadin/markdown": "25.1.0-alpha8",
41
- "@vaadin/overlay": "25.1.0-alpha8",
42
- "@vaadin/popover": "25.1.0-alpha8",
43
- "@vaadin/vaadin-themable-mixin": "25.1.0-alpha8",
38
+ "@vaadin/a11y-base": "25.1.0-beta1",
39
+ "@vaadin/component-base": "25.1.0-beta1",
40
+ "@vaadin/markdown": "25.1.0-beta1",
41
+ "@vaadin/overlay": "25.1.0-beta1",
42
+ "@vaadin/popover": "25.1.0-beta1",
43
+ "@vaadin/vaadin-themable-mixin": "25.1.0-beta1",
44
44
  "lit": "^3.0.0"
45
45
  },
46
46
  "devDependencies": {
47
- "@vaadin/aura": "25.1.0-alpha8",
48
- "@vaadin/chai-plugins": "25.1.0-alpha8",
49
- "@vaadin/test-runner-commands": "25.1.0-alpha8",
47
+ "@vaadin/aura": "25.1.0-beta1",
48
+ "@vaadin/chai-plugins": "25.1.0-beta1",
49
+ "@vaadin/test-runner-commands": "25.1.0-beta1",
50
50
  "@vaadin/testing-helpers": "^2.0.0",
51
- "@vaadin/vaadin-lumo-styles": "25.1.0-alpha8",
51
+ "@vaadin/vaadin-lumo-styles": "25.1.0-beta1",
52
52
  "sinon": "^21.0.0"
53
53
  },
54
54
  "customElements": "custom-elements.json",
@@ -56,5 +56,5 @@
56
56
  "web-types.json",
57
57
  "web-types.lit.json"
58
58
  ],
59
- "gitHead": "810590c9c7682a9326c9352df795b5ea4891a71f"
59
+ "gitHead": "0ccf77c385fc6a92ac2a6344ce8804b94956226d"
60
60
  }
package/web-types.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "$schema": "https://json.schemastore.org/web-types",
3
3
  "name": "@vaadin/tooltip",
4
- "version": "25.1.0-alpha8",
4
+ "version": "25.1.0-beta1",
5
5
  "description-markup": "markdown",
6
6
  "contributions": {
7
7
  "html": {
@@ -11,11 +11,11 @@
11
11
  "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.",
12
12
  "attributes": [
13
13
  {
14
- "name": "position",
15
- "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`.",
14
+ "name": "focus-delay",
15
+ "description": "The delay in milliseconds before the tooltip\nis opened on keyboard focus, when not in manual mode.",
16
16
  "value": {
17
17
  "type": [
18
- "string",
18
+ "number",
19
19
  "null",
20
20
  "undefined"
21
21
  ]
@@ -33,8 +33,8 @@
33
33
  }
34
34
  },
35
35
  {
36
- "name": "focus-delay",
37
- "description": "The delay in milliseconds before the tooltip\nis opened on keyboard focus, when not in manual mode.",
36
+ "name": "hide-delay",
37
+ "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.",
38
38
  "value": {
39
39
  "type": [
40
40
  "number",
@@ -44,8 +44,8 @@
44
44
  }
45
45
  },
46
46
  {
47
- "name": "hide-delay",
48
- "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.",
47
+ "name": "hover-delay",
48
+ "description": "The delay in milliseconds before the tooltip\nis opened on hover, when not in manual mode.",
49
49
  "value": {
50
50
  "type": [
51
51
  "number",
@@ -55,19 +55,19 @@
55
55
  }
56
56
  },
57
57
  {
58
- "name": "hover-delay",
59
- "description": "The delay in milliseconds before the tooltip\nis opened on hover, when not in manual mode.",
58
+ "name": "manual",
59
+ "description": "When true, the tooltip is controlled programmatically\ninstead of reacting to focus and mouse events.",
60
60
  "value": {
61
61
  "type": [
62
- "number",
62
+ "boolean",
63
63
  "null",
64
64
  "undefined"
65
65
  ]
66
66
  }
67
67
  },
68
68
  {
69
- "name": "manual",
70
- "description": "When true, the tooltip is controlled programmatically\ninstead of reacting to focus and mouse events.",
69
+ "name": "markdown",
70
+ "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.",
71
71
  "value": {
72
72
  "type": [
73
73
  "boolean",
@@ -88,8 +88,8 @@
88
88
  }
89
89
  },
90
90
  {
91
- "name": "text",
92
- "description": "String used as a tooltip content.",
91
+ "name": "position",
92
+ "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`.",
93
93
  "value": {
94
94
  "type": [
95
95
  "string",
@@ -99,11 +99,11 @@
99
99
  }
100
100
  },
101
101
  {
102
- "name": "markdown",
103
- "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.",
102
+ "name": "text",
103
+ "description": "String used as a tooltip content.",
104
104
  "value": {
105
105
  "type": [
106
- "boolean",
106
+ "string",
107
107
  "null",
108
108
  "undefined"
109
109
  ]
@@ -124,52 +124,52 @@
124
124
  "js": {
125
125
  "properties": [
126
126
  {
127
- "name": "position",
128
- "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`.",
127
+ "name": "ariaTarget",
128
+ "description": "Element used to link with the `aria-describedby`\nattribute. Supports array of multiple elements.\nWhen not set, defaults to `target`.",
129
129
  "value": {
130
130
  "type": [
131
- "string",
131
+ "Object",
132
132
  "null",
133
133
  "undefined"
134
134
  ]
135
135
  }
136
136
  },
137
137
  {
138
- "name": "for",
139
- "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.",
138
+ "name": "context",
139
+ "description": "Object with properties passed to `generator` and\n`shouldShow` functions for generating tooltip text\nor detecting whether to show the tooltip or not.",
140
140
  "value": {
141
141
  "type": [
142
- "string",
142
+ "Object",
143
143
  "null",
144
144
  "undefined"
145
145
  ]
146
146
  }
147
147
  },
148
148
  {
149
- "name": "target",
150
- "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.",
149
+ "name": "focusDelay",
150
+ "description": "The delay in milliseconds before the tooltip\nis opened on keyboard focus, when not in manual mode.",
151
151
  "value": {
152
152
  "type": [
153
- "Object",
153
+ "number",
154
154
  "null",
155
155
  "undefined"
156
156
  ]
157
157
  }
158
158
  },
159
159
  {
160
- "name": "ariaTarget",
161
- "description": "Element used to link with the `aria-describedby`\nattribute. Supports array of multiple elements.\nWhen not set, defaults to `target`.",
160
+ "name": "for",
161
+ "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.",
162
162
  "value": {
163
163
  "type": [
164
- "Object",
164
+ "string",
165
165
  "null",
166
166
  "undefined"
167
167
  ]
168
168
  }
169
169
  },
170
170
  {
171
- "name": "context",
172
- "description": "Object with properties passed to `generator` and\n`shouldShow` functions for generating tooltip text\nor detecting whether to show the tooltip or not.",
171
+ "name": "generator",
172
+ "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.",
173
173
  "value": {
174
174
  "type": [
175
175
  "Object",
@@ -179,8 +179,8 @@
179
179
  }
180
180
  },
181
181
  {
182
- "name": "focusDelay",
183
- "description": "The delay in milliseconds before the tooltip\nis opened on keyboard focus, when not in manual mode.",
182
+ "name": "hideDelay",
183
+ "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.",
184
184
  "value": {
185
185
  "type": [
186
186
  "number",
@@ -190,41 +190,41 @@
190
190
  }
191
191
  },
192
192
  {
193
- "name": "generator",
194
- "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.",
193
+ "name": "hoverDelay",
194
+ "description": "The delay in milliseconds before the tooltip\nis opened on hover, when not in manual mode.",
195
195
  "value": {
196
196
  "type": [
197
- "Object",
197
+ "number",
198
198
  "null",
199
199
  "undefined"
200
200
  ]
201
201
  }
202
202
  },
203
203
  {
204
- "name": "hideDelay",
205
- "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.",
204
+ "name": "manual",
205
+ "description": "When true, the tooltip is controlled programmatically\ninstead of reacting to focus and mouse events.",
206
206
  "value": {
207
207
  "type": [
208
- "number",
208
+ "boolean",
209
209
  "null",
210
210
  "undefined"
211
211
  ]
212
212
  }
213
213
  },
214
214
  {
215
- "name": "hoverDelay",
216
- "description": "The delay in milliseconds before the tooltip\nis opened on hover, when not in manual mode.",
215
+ "name": "markdown",
216
+ "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.",
217
217
  "value": {
218
218
  "type": [
219
- "number",
219
+ "boolean",
220
220
  "null",
221
221
  "undefined"
222
222
  ]
223
223
  }
224
224
  },
225
225
  {
226
- "name": "manual",
227
- "description": "When true, the tooltip is controlled programmatically\ninstead of reacting to focus and mouse events.",
226
+ "name": "opened",
227
+ "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.",
228
228
  "value": {
229
229
  "type": [
230
230
  "boolean",
@@ -234,11 +234,11 @@
234
234
  }
235
235
  },
236
236
  {
237
- "name": "opened",
238
- "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.",
237
+ "name": "position",
238
+ "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`.",
239
239
  "value": {
240
240
  "type": [
241
- "boolean",
241
+ "string",
242
242
  "null",
243
243
  "undefined"
244
244
  ]
@@ -256,22 +256,22 @@
256
256
  }
257
257
  },
258
258
  {
259
- "name": "text",
260
- "description": "String used as a tooltip content.",
259
+ "name": "target",
260
+ "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.",
261
261
  "value": {
262
262
  "type": [
263
- "string",
263
+ "Object",
264
264
  "null",
265
265
  "undefined"
266
266
  ]
267
267
  }
268
268
  },
269
269
  {
270
- "name": "markdown",
271
- "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.",
270
+ "name": "text",
271
+ "description": "String used as a tooltip content.",
272
272
  "value": {
273
273
  "type": [
274
- "boolean",
274
+ "string",
275
275
  "null",
276
276
  "undefined"
277
277
  ]
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "$schema": "https://json.schemastore.org/web-types",
3
3
  "name": "@vaadin/tooltip",
4
- "version": "25.1.0-alpha8",
4
+ "version": "25.1.0-beta1",
5
5
  "description-markup": "markdown",
6
6
  "framework": "lit",
7
7
  "framework-config": {
@@ -26,13 +26,6 @@
26
26
  "kind": "expression"
27
27
  }
28
28
  },
29
- {
30
- "name": "?opened",
31
- "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.",
32
- "value": {
33
- "kind": "expression"
34
- }
35
- },
36
29
  {
37
30
  "name": "?markdown",
38
31
  "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.",
@@ -41,22 +34,8 @@
41
34
  }
42
35
  },
43
36
  {
44
- "name": ".position",
45
- "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`.",
46
- "value": {
47
- "kind": "expression"
48
- }
49
- },
50
- {
51
- "name": ".for",
52
- "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.",
53
- "value": {
54
- "kind": "expression"
55
- }
56
- },
57
- {
58
- "name": ".target",
59
- "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.",
37
+ "name": "?opened",
38
+ "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.",
60
39
  "value": {
61
40
  "kind": "expression"
62
41
  }
@@ -82,6 +61,13 @@
82
61
  "kind": "expression"
83
62
  }
84
63
  },
64
+ {
65
+ "name": ".for",
66
+ "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.",
67
+ "value": {
68
+ "kind": "expression"
69
+ }
70
+ },
85
71
  {
86
72
  "name": ".generator",
87
73
  "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.",
@@ -103,6 +89,13 @@
103
89
  "kind": "expression"
104
90
  }
105
91
  },
92
+ {
93
+ "name": ".position",
94
+ "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`.",
95
+ "value": {
96
+ "kind": "expression"
97
+ }
98
+ },
106
99
  {
107
100
  "name": ".shouldShow",
108
101
  "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`.",
@@ -110,6 +103,13 @@
110
103
  "kind": "expression"
111
104
  }
112
105
  },
106
+ {
107
+ "name": ".target",
108
+ "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.",
109
+ "value": {
110
+ "kind": "expression"
111
+ }
112
+ },
113
113
  {
114
114
  "name": ".text",
115
115
  "description": "String used as a tooltip content.",