Skip to content

docs: dialog keep in viewport property #5154

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.

Sign up for GitHub

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

Merged
sissbruecker merged 3 commits into from
Feb 10, 2026
Merged

docs: dialog keep in viewport property #5154

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
357349a
docs: dialog keep in viewport property
sissbruecker Feb 10, 2026
98fddb0
add note
sissbruecker Feb 10, 2026
beb83b8
Merge branch 'main' into docs/dialog-keep-in-viewport
sissbruecker Feb 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions articles/components/dialog/index.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -257,6 +257,37 @@

Modal dialogs don't benefit from being draggable, as their modality curtain (the dark overlay behind the dialog) obscures the underlying user interface.

By default, the edges of dialogs can be dragged outside the viewport, which can make parts of a dialog inaccessible. To prevent this, set the `keepInViewport` property to `true` to keep the dialog fully within the viewport when dragging. Note that this option only affects the dialog's position when dragging, a dialog may still become partially invisible when resizing the viewport.

Check failure on line 260 in articles/components/dialog/index.adoc

View workflow job for this annotation

GitHub Actions / lint 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'dialog's'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'dialog's'?", "location": {"path": "articles/components/dialog/index.adoc", "range": {"start": {"line": 260, "column": 278}}}, "severity": "ERROR"}

[.example]
--

ifdef::lit[]
[source,html]
----
<source-info group="Lit"></source-info>
<vaadin-dialog keep-in-viewport>...</vaadin-dialog>
----
endif::[]

ifdef::flow[]
[source,java]
----
<source-info group="Flow"></source-info>
Dialog dialog = new Dialog();
dialog.setKeepInViewport(true);
----
endif::[]

ifdef::react[]
[source,html]
----
<source-info group="React"></source-info>
<Dialog keepInViewport>...</Dialog>
----
endif::[]
--


== Size

Expand Down