Context Help

Inline help text

Use an inline help text in settings dialogs that are not constrained by space and are not frequently used. Since settings are rarely changed, users may forget their purpose, so displaying the information immediately makes sense.

Tooltip

Use a tooltip:

• If the space is not enough for showing the inline help text.

• In frequently used dialogs, tool windows, or popups. The more often a person uses an interface, the more likely they are to remember what each option does.

• For icons or other controls that do not have a label.

Empty state

Fill in empty states of tool windows, tables, trees, and other containers with:

• a reason why the data is missing

• an action that can fix it

• a link to a corresponding article in the web help.

When to use

Below you will find rules for tooltips and inline texts.

	Explain complex behavior that a short action or a setting name cannot convey clearly.
	Provide input format requirements and examples.
	Suggest alternative ways.
	Warn about possible issues.
	Explain limitations.
	Provide quick navigation to related settings.
	Explain IDE-specific entities.

When not to use

Do not explain UI

Do not use context help to explain how the user interface works. If you need to explain that, consider redesigning the UI.

Correct

Incorrect

Do not explain common actions

Do not explain common actions and entities. Show a regular tooltip with an action name and shortcut in this case.

Correct

Incorrect

Do not clutter UI with context help

Do not explain each option. Too many help icons or too much inline text make a dialog cluttered and harder to navigate visually. If all options need to be explained, consider rewriting the labels to make them clearer.

Correct

Incorrect

How to use

See Inline help text, Tooltip, and Empty State.