Tag Item

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.

The following patterns include usage of the Tag Item.

Open in Github Built: Wed, Aug 16, 2023 (04:37:39 PM)

On This Page

FEEDBACK