Tag Item

SAIL Design System guidance available for Tags

Draw attention and drive engagement to the right places on your interface. Learn how to use tags to highlight valuable links, sections, or other components so users don't miss important or notable items.

Function

a!tagItem( text, backgroundColor, textColor, tooltip, showWhen, recordLink )

Displays a short text label with colored background for use with a!tagField. Tag items can contain a record link or user record link.

See also: Tag Field, Tag design guidance

Parameters

Name	Keyword	Types	Description
Text	`text`	Text	Text to display within the tag. The tag displays a maximum of 40 characters.
Background Color	`backgroundColor`	Text	Determines the background color. Valid values: Any valid hex color or `"ACCENT"` (default), `"POSITIVE"`, `"NEGATIVE"`, `"SECONDARY"`
Text Color	`textColor`	Text	Determines the text color. Valid values: Any valid hex color or `"STANDARD"` (default).
Tooltip	`tooltip`	Text	Text to display as a tooltip on the tag.
Visibility	`showWhen`	Boolean	Determines whether the tag is displayed on the interface. When set to false, the tag is hidden and is not evaluated. Default: true.
Record Link	`recordLink`	Record Link	The record link to apply to the tag. Create a link with `a!recordLink()` or `a!userRecordLink()`.

Usage considerations

Using the text parameter

A tag will not render if no text is specified.
Any tabs, line breaks, and leading or trailing spaces are trimmed. Spaces between words are trimmed down to one space.
If the text is too long to display within a tag, the text is truncated. The full text is shown on hover.

Feature compatibility

The table below lists this component's compatibility with various features in Appian.

Feature	Compatibility	Note
Portals	Compatible
Offline Mobile	Compatible
Sync-Time Custom Record Fields	Incompatible
Real-Time Custom Record Fields	Incompatible
Process Reports	Incompatible	You cannot use this function to configure a process report.
Process Events	Incompatible	You cannot use this function to configure a process event node, such as a start event or timer event.

The following patterns include usage of the Tag Item.

Inline Tags for Side-by-Side Layout Pattern (Formatting): This pattern shows the best practice for combining tags with standard-sized rich text, or plain text, using a side by side layout.

Feedback

Was this page helpful?