Guidance on "dialog", "modal", and "window"
We use dialog
, modal
, and window
quite interchangeably in the docs. There's some subtle difference between all three terms (see, for example, Modal & Nonmodal Dialogs: When (& When Not) to Use Them). However, I don't think this technicality matters to the end user.
I'd suggest we avoid modal
and window
and use dialog
instead. This is also consistent with the Microsoft style guide:
When you need to refer to a dialog box, use
dialog
. Don't usepop-up window
,dialog box
, ordialogue box
.
There might be use cases for window
, but I wouldn't use the word in this context for consistency.
Dialog
Style guide
Dialog
is mentioned only in the context of confirmation dialog and type.
Examples
- For Key usage permissions, add the GitLab AWS account using the Other AWS accounts dialog.
- In the Add permission scheme dialog:
- In the dialog, enter a label for your token and select Create.
Modal
Style guide
Modal
is not mentioned in the documentation style guide, recommended word list, or Microsoft Style Guide.
Examples
- The Remove status check? modal is then shown.
- Confirm by selecting Delete destination in the modal.
We also have a few instances of modal window
:
- In the modal window, select which entity is allowed to approve the deployment job.
- In the modal window, you can supply a Summary comment, approve the merge request, and include quick actions:
Window
Style guide
Window
is mentioned only in the context of while, terminal window, and browser window.
Examples
- Select Get it now and the Create this app in Azure window opens.
- Close the Preferences window.
- The task window opens.