Moodle User Interface Guidelines > Tooltip

Problem

You have an item in the user interface, the visual outlook of which does not communicate its function and usage. There is insufficient room in the UI for a more verbose UI element, the function and usage of which would be more clear at a glance.

Context

Forces: factors that affect selection

Solution

Moodle uses tooltips extensively. Tooltips can be simple title elements or YUI tooltips can be used for bigger tooltips.

Common mistakes

Tooltips are best used on functional elements that can be clicked, as an aiding device helping the user understand the concequences of the click.

Examples and implementation

As per A Pattern Language for Pattern writing, there should be as few examples here as possible. List one or two here and link to a separate Development:[GuidelineName] Examples and Code Samples page.

Patterns:

Example title

Moodle has many command icons, which have tooltips to help users understand/remember their usage.

In Moodle 2.0, YUI tooltips are used to display quick previews of Help Popups.

(Optional) Related guidelines

If some other guideline does something similar and could be considered in the same situation, list them here.

(Optional) Related issues in the tracker

MDL-99999999 A ticket for fixing something in Moodle to be in accordance with this guideline
CREATE: ticket not yet created in the tracker
To be decided: description of issue in Moodle that are in conflict with this guideline but a clear decision has not been reached what should be done about it

Pattern: Optional Elements When Helpful

(Optional) Further information / Sources

Link to sources for this guideline. If you quote from these sources, add a link to this section from the earlier sections with the author name.