Labels

Ask a question Design guidelines

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 since: 5.0
General API status: 5.8

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. Can be closeable.

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

Label text Label link Removable label(remove closableNoUrl)

Removable label link(remove splitLabel)

Code

Soy

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