Skip to content

Commit f583430

Browse files
authored
docs: update popover JSDoc to remove mentions of the overlay (#9983)
1 parent 4367470 commit f583430

File tree

2 files changed

+26
-32
lines changed

2 files changed

+26
-32
lines changed

packages/popover/src/vaadin-popover.d.ts

Lines changed: 13 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -109,13 +109,13 @@ declare class Popover extends PopoverPositionMixin(PopoverTargetMixin(ThemePrope
109109
autofocus: boolean;
110110

111111
/**
112-
* Set the height of the overlay.
112+
* Set the height of the popover.
113113
* If a unitless number is provided, pixels are assumed.
114114
*/
115115
height: string | null;
116116

117117
/**
118-
* Set the width of the overlay.
118+
* Set the width of the popover.
119119
* If a unitless number is provided, pixels are assumed.
120120
*/
121121
width: string | null;
@@ -152,24 +152,24 @@ declare class Popover extends PopoverPositionMixin(PopoverTargetMixin(ThemePrope
152152
hoverDelay: number;
153153

154154
/**
155-
* True if the popover overlay is opened, false otherwise.
155+
* True if the popover is visible and available for interaction.
156156
*/
157157
opened: boolean;
158158

159159
/**
160-
* The `role` attribute value to be set on the overlay.
160+
* The `role` attribute value to be set on the popover.
161161
*
162162
* @attr {string} overlay-role
163163
* @deprecated Use standard `role` attribute on the popover instead
164164
*/
165165
overlayRole: string;
166166

167167
/**
168-
* Custom function for rendering the content of the overlay.
168+
* Custom function for rendering the content of the popover.
169169
* Receives two arguments:
170170
*
171171
* - `root` The root container DOM element. Append your content to it.
172-
* - `popover` The reference to the `vaadin-popover` element (overlay host).
172+
* - `popover` The reference to the `vaadin-popover` element.
173173
*
174174
* @deprecated Add content elements as children of the popover using default slot
175175
*/
@@ -178,37 +178,34 @@ declare class Popover extends PopoverPositionMixin(PopoverTargetMixin(ThemePrope
178178
/**
179179
* When true, the popover prevents interacting with background elements
180180
* by setting `pointer-events` style on the document body to `none`.
181-
* This also enables trapping focus inside the overlay.
181+
* This also enables trapping focus inside the popover.
182182
*/
183183
modal: boolean;
184184

185185
/**
186-
* Set to true to disable closing popover overlay on outside click.
186+
* Set to true to disable closing popover on outside click.
187187
*
188188
* @attr {boolean} no-close-on-outside-click
189189
*/
190190
noCloseOnOutsideClick: boolean;
191191

192192
/**
193-
* Set to true to disable closing popover overlay on Escape press.
194-
* When the popover is modal, pressing Escape anywhere in the
195-
* document closes the overlay. Otherwise, only Escape press
196-
* from the popover itself or its target closes the overlay.
193+
* Set to true to disable closing popover on Escape press.
197194
*
198195
* @attr {boolean} no-close-on-esc
199196
*/
200197
noCloseOnEsc: boolean;
201198

202199
/**
203-
* Popover trigger mode, used to configure how the overlay is opened or closed.
200+
* Popover trigger mode, used to configure how the popover is opened or closed.
204201
* Could be set to multiple by providing an array, e.g. `trigger = ['hover', 'focus']`.
205202
*
206203
* Supported values:
207204
* - `click` (default) - opens and closes on target click.
208205
* - `hover` - opens on target mouseenter, closes on target mouseleave. Moving mouse
209-
* to the popover overlay content keeps the overlay opened.
206+
* to the popover content keeps the popover opened.
210207
* - `focus` - opens on target focus, closes on target blur. Moving focus to the
211-
* popover overlay content keeps the overlay opened.
208+
* popover content keeps the popover opened.
212209
*
213210
* In addition to the behavior specified by `trigger`, the popover can be closed by:
214211
* - pressing Escape key (unless `noCloseOnEsc` property is true)
@@ -221,7 +218,7 @@ declare class Popover extends PopoverPositionMixin(PopoverTargetMixin(ThemePrope
221218
trigger: PopoverTrigger[] | null | undefined;
222219

223220
/**
224-
* When true, the overlay has a backdrop (modality curtain) on top of the
221+
* When true, the popover has a backdrop (modality curtain) on top of the
225222
* underlying page content, covering the whole viewport.
226223
*
227224
* @attr {boolean} with-backdrop

packages/popover/src/vaadin-popover.js

Lines changed: 13 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -252,15 +252,15 @@ class Popover extends PopoverPositionMixin(
252252
},
253253

254254
/**
255-
* Set the height of the overlay.
255+
* Set the height of the popover.
256256
* If a unitless number is provided, pixels are assumed.
257257
*/
258258
height: {
259259
type: String,
260260
},
261261

262262
/**
263-
* Set the width of the overlay.
263+
* Set the width of the popover.
264264
* If a unitless number is provided, pixels are assumed.
265265
*/
266266
width: {
@@ -305,7 +305,7 @@ class Popover extends PopoverPositionMixin(
305305
},
306306

307307
/**
308-
* True if the popover overlay is opened, false otherwise.
308+
* True if the popover is visible and available for interaction.
309309
*/
310310
opened: {
311311
type: Boolean,
@@ -325,7 +325,7 @@ class Popover extends PopoverPositionMixin(
325325
},
326326

327327
/**
328-
* The `role` attribute value to be set on the overlay.
328+
* The `role` attribute value to be set on the popover.
329329
*
330330
* @attr {string} overlay-role
331331
* @deprecated Use standard `role` attribute on the popover instead
@@ -335,11 +335,11 @@ class Popover extends PopoverPositionMixin(
335335
},
336336

337337
/**
338-
* Custom function for rendering the content of the overlay.
338+
* Custom function for rendering the content of the popover.
339339
* Receives two arguments:
340340
*
341341
* - `root` The root container DOM element. Append your content to it.
342-
* - `popover` The reference to the `vaadin-popover` element (overlay host).
342+
* - `popover` The reference to the `vaadin-popover` element.
343343
*
344344
* @deprecated Use the content in the `vaadin-popover` via default slot
345345
*/
@@ -350,15 +350,15 @@ class Popover extends PopoverPositionMixin(
350350
/**
351351
* When true, the popover prevents interacting with background elements
352352
* by setting `pointer-events` style on the document body to `none`.
353-
* This also enables trapping focus inside the overlay.
353+
* This also enables trapping focus inside the popover.
354354
*/
355355
modal: {
356356
type: Boolean,
357357
value: false,
358358
},
359359

360360
/**
361-
* Set to true to disable closing popover overlay on outside click.
361+
* Set to true to disable closing popover on outside click.
362362
*
363363
* @attr {boolean} no-close-on-outside-click
364364
*/
@@ -368,10 +368,7 @@ class Popover extends PopoverPositionMixin(
368368
},
369369

370370
/**
371-
* Set to true to disable closing popover overlay on Escape press.
372-
* When the popover is modal, pressing Escape anywhere in the
373-
* document closes the overlay. Otherwise, only Escape press
374-
* from the popover itself or its target closes the overlay.
371+
* Set to true to disable closing popover on Escape press.
375372
*
376373
* @attr {boolean} no-close-on-esc
377374
*/
@@ -381,15 +378,15 @@ class Popover extends PopoverPositionMixin(
381378
},
382379

383380
/**
384-
* Popover trigger mode, used to configure how the overlay is opened or closed.
381+
* Popover trigger mode, used to configure how the popover is opened or closed.
385382
* Could be set to multiple by providing an array, e.g. `trigger = ['hover', 'focus']`.
386383
*
387384
* Supported values:
388385
* - `click` (default) - opens and closes on target click.
389386
* - `hover` - opens on target mouseenter, closes on target mouseleave. Moving mouse
390-
* to the popover overlay content keeps the overlay opened.
387+
* to the popover content keeps the popover opened.
391388
* - `focus` - opens on target focus, closes on target blur. Moving focus to the
392-
* popover overlay content keeps the overlay opened.
389+
* popover content keeps the popover opened.
393390
*
394391
* In addition to the behavior specified by `trigger`, the popover can be closed by:
395392
* - pressing Escape key (unless `noCloseOnEsc` property is true)
@@ -405,7 +402,7 @@ class Popover extends PopoverPositionMixin(
405402
},
406403

407404
/**
408-
* When true, the overlay has a backdrop (modality curtain) on top of the
405+
* When true, the popover has a backdrop (modality curtain) on top of the
409406
* underlying page content, covering the whole viewport.
410407
*
411408
* @attr {boolean} with-backdrop

0 commit comments

Comments
 (0)