Labels

Ask a question Design guidelines

Summary

Labels are used to tag or label content with certain keywords; and optionally to link to resources showing more information related to that keyword.

Status

API status: general
Included in AUI core? Not in core You must explicitly require the web resource key.
Web resource key: com.atlassian.auiplugin:aui-labels
AMD Module key: N/A
Experimental API: 5
General API: 5.8

Behaviour

AUI Labels can be created in four configurations:

  • unclickable (information only)
  • unclickable, but closeable
  • clickable
  • clickable AND closeable - a "split label" with two distinct actions

Note that removable labels only appear removable. They require you to implement your own removing logic.

Examples

Code

Soy

AخA
 
{call aui.labels.label}
    {param text: 'unclickableUncloseable' /}
    {param id: 'unclickable-label' /}
{/call}
{call aui.labels.label}
    {param text: 'clickable' /}
    {param id: 'clickable-label' /}
    {param url: 'http://example.com/' /}
{/call}
{call aui.labels.label}
    {param text: 'closableNoUrl' /}
    {param id: 'closeable-label-nourl' /}
    {param isCloseable: true /}
{/call}
{call aui.labels.label}
    {param text: 'splitLabel' /}
    {param id: 'split-label' /}
    {param url: 'http://example.com/' /}
    {param isCloseable: true /}
{/call}