Style GuideSkip to start of content.

Interaction Verbs

Use these guidelines to describes users' interactions with the user interface.

click

Use click and its variations (double-click, right-click) to refer to activating most affordances except when described more precisely by the other verbs listed here. Where the specific interaction method is unknown, click is well understood not to be exclusive to mouse-based interactions, and is less technical than other alternatives such as activate.

  • Don't include the preposition on or descriptions of the type of affordance.
    Do
    Click OK.
    Don't
    Click on OK.

    Click the OK button.

  • Use click...for when describing a contextual action.
    Do
    Click Edit for the widget you want to configure.
  • Use > to separate items in a series of consecutive affordances such as a cascading menu.
    Do
    Click File > Save.
  • Don't use click if the interaction is primarily through a touch interface.

    See Touch interactions.

  • Don't use click if the interaction is primarily through a keyboard or voice interface.

display

Use displays, is displayed, or less frequently, opens to describe the system's showing something. Passive voice is OK because the system is the actor.

Do
A confirmation is displayed.

A confirmation displays.

Don't use appears (implies magic).

drag

Use drag to describe using the pointer to move an item on the screen. Don't use click and drag.

Do
Drag each term to its definition.
Don't
Click and drag each term to its definition.
For accessibility, provide information about performing the action without dragging if an alternative method is supported by the interface.

hover

Use hover to describe positioning the pointer above an item.

Do
To display the Options menu, hover over the widget.
For accessibility, provide information about performing the action without hovering. Usually, users navigate to the item with the keyboard.

select/clear

Use select and clear to describe changing the state of a check box.

Do
To turn on the widget, select Enable widget.

To turn off the widget, clear Enable widget.

set...to

Use set...to to describe interacting with a toggle affordance that has labeled states.

Do
Set Ownership to Yes.

turn on/off

Use turn on and turn off to describe interacting with a toggle affordance that does not have labeled states.

Do
Turn on Editing toggle switch.
Consider displaying the toggle switch toggle switch as a visual aid for this interaction.

Touch interactions

For web applications for which no specific kind of device is targeted, use the standard click interaction verbs. Even though some or many users might use touch pads or touch screens, click is well understood and does not cause confusion for these users.

For applications targeted for devices whose primary interface is a touch screen, use the following verbs:
  • Tap
  • Tap and hold
  • Double-tap
  • Drag
  • Pinch in (per Apple)
  • Pinch out (per Apple)
  • Swipe left
  • Swipe right

Accessibility

In addition to standard accessibility considerations for documentation, check that the interactions can be performed by users with motor or visual limitations. Where needed and supported by the interface, describe alternative interaction modalities. For example, navigation buttons might be provided as an alternative to swiping.