-
Notifications
You must be signed in to change notification settings - Fork 87
docs: update popover JSDoc to reduce mentions of the overlay #9983
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
@@ -152,20 +152,20 @@ declare class Popover extends PopoverPositionMixin(PopoverTargetMixin(ThemePrope | |||
hoverDelay: number; | |||
|
|||
/** | |||
* True if the popover overlay is opened, false otherwise. | |||
* True if the popover is visible and available for interaction. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Adjusted wording based on the MDN description of <dialog open>
:
Indicates that the dialog box is active and is available for interaction.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some additional things that could be cleaned up:
Set the height of the overlay.
Set the width of the overlay.
popover
The reference to thevaadin-popover
element (overlay host).
This also enables trapping focus inside the overlay.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, done.
2bdf8fd
to
d3c7121
Compare
Co-authored-by: Sascha Ißbrücker <sissbruecker@vaadin.com>
Co-authored-by: Sascha Ißbrücker <sissbruecker@vaadin.com>
|
Description
Replaced some mentions of the
overlay
with thepopover
as the overlay is more of implementation detail in V25.Also updated JSDoc for
noCloseOnEsc
to match the new behavior after changing to global listener in #9972.Type of change