UI element descriptions

Last Updated : Aug 02, 2024 |
Prolog information
Metadata
Keywords:
Use the reference table or the subsequent detailed sections for information about documenting UI elements. The examples in these sections are not exhaustive. Your product might use UI elements that are not described.

Reference table

The following table provides quick reference information for a subset of commonly-used UI elements and related content:
Element
Common usage
Examples
Button
Use with the following verbs:
  • Click for desktop applications.
  • Tap for mobile applications.
If you need an input-neutral term, you can use select, but click and tap are the most common.
  • Desktop: Click OK.
  • Mobile: Tap OK.
Check box
Use with the following verbs:
  • Select to mean enabling the check box.
  • Clear to mean disabling the check box.
  • Select the Format check box.
  • Clear the Scope and Type check boxes.
Dialog box or notification
Use the preposition in for a dialog box.
In most cases, do not include the word pop-up to describe a window, dialog box, or notification.
In the confirmation dialog box, click Yes to confirm.
Drop-down menu or list
Use a list to select an option.
A menu is navigational. The items in a menu are usually clickable.
You can use the preposition from for a list or menu.
Use the word drop-down as an adjective where required for clarity. Do not use drop-down to describe a menu in a simple navigation pane or a clearly-marked list on a page or window with few other elements.
Select an audio device from the Output Devices list.
Field
Use with the preposition in.
When the user can both type and select an option, use the verb enter. If the user can only type in the field, use the verb type.
  • In the Search field, enter the name of a colleague.
  • In the Port field, type the port number.
Switch
Use with the verb enable or disable to mean turning the switch on or off.
If the name of the switch starts with Enable, use the verb toggle on.
Toggle on the Enable A.I. noise removal switch.
Tab
In most cases, use the preposition on. You can use from to indicate a starting point.
Use the wintitle tag for tab names unless instructing the user to click the tab.
  • On the Meetings tab, set your default meeting settings.
  • Click the General tab.
Window
Use the preposition on when first accessing a window.
On the User Preferences window, click the Notifications tab.
Related links
UI prepositions