UI terms
In most situations, the design should be clear so you don’t need to provide directional instructions.
When you do need to provide instructions or talk about a specific UI element, follow these guidelines.
Guidelines
When providing instructions that describe a direct interaction with a UI element, write the name exactly as it appears in the UI and make the name bold.
Avoid describing what the element is (e.g. a button) unless it’s unclear.
In the Credentials management page, select Add credentials.
In the Credentials management page, select the Add credentials button.
Terms
| Term | Usage |
|---|---|
| box | Refer to input fields using their label. If you need a descriptor, use box. |
| button | A button in the UI. |
| chart | A graphical representation of data. |
| checkbox | A checkbox in the UI. |
| dialog | A small window that communicates information to the user and prompts them for a response. Dialog boxes are classified as 'modal' or 'modeless', depending on whether they block interaction with the software that initiated the dialog. |
| field | Refer to input fields using their label. If you need a descriptor, use box. |
| icon | A graphic representation of an object that a user can select and open. |
| link | A link in the UI. |
| list | Any type of list in the UI (e.g. a drop-down list). |
| notification | Any notification triggered by an app and displayed in the UI. Don't use pop-up, toast or banner. |
| page | A page in the dashboard. |
| table | A table in the UI. |