Tooltips
Summary
Tooltips can describe a UI element in a little bit more detail when users deliberately hover on an element.
Status
| API status: | general |
|---|---|
| Web resource key: |
com.atlassian.auiplugin:aui-tooltips
|
| AMD Module key: | N/A |
| Experimental API: | 5.1 |
| General API: | 5.8 |
Examples
Hover over meCode
Calling .tooltip() will create a tipsy tooltip with ADG style and default options applied.
Options
Options are set by passing in an options object.
You can control the direction/positioning of the tooltip by setting the gravity option:
The text of the tooltip can be set arbitrarily:
You can unbind and remove tooltips by passing in the string value "destroy".
Tooltips bound using the live option cannot be destroyed.
- AUI uses a forked copy of Tipsy, which adds things like ARIA support. See https://github.com/atlassian/tipsy for details.
- For a list of core tipsy options, see http://onehackoranother.com/projects/jquery/tipsy/