Free cookie consent management tool by TermsFeed Tag Item (a!tagItem)
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.


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


Name Keyword Types Description




Text to display within the tag. The tag displays a maximum of 40 characters.

Background Color



Determines the background color. Valid values: Any valid hex color or "ACCENT" (default), "POSITIVE", "NEGATIVE", "SECONDARY"

Text Color



Determines the text color. Valid values: Any valid hex color or "STANDARD" (default).




Text to display as a tooltip on the tag.




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


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 SAIL 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

Custom record fields that evaluate in real time must be configured using one or more Custom Field functions.

Process Reports Incompatible

Cannot be used to configure a process report.

Process Events Incompatible

Cannot be used to configure a process event node, such as a start event or timer event.

The following patterns include usage of the Tag Item.

Tag Item