docs(overlays): clarify how to remove an overlay #28989
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In #28981 there was some confusion surrounding how to remove an overlay from the DOM if it was never presented. The
dismiss
method will remove the overlay from the DOM, but only if the overlay is visible. Otherwise, it's a no-op.This PR updates the
dismiss
method docs for each overlay component to note that developers can use the browser's remove method to remove the element from the DOM.