Tag Component (a!tagField)

Display

Tag Component

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!tagField( label, labelPosition, instructions, helpTooltip, tags, align, accessibilityText, size, showWhen, marginAbove, marginBelow )

Displays a list of short text labels with colored background to highlight important attributes.

See also: Tag Item, Tag design guidance

Parameters

Name	Keyword	Types	Description
Label	`label`	Text	Text to display as the field label.
Label Position	`labelPosition`	Text	Determines where the label appears. Valid values: `"ABOVE"` (default) Displays the label above the component. `"ADJACENT"` Displays the label to the left of the component. `"COLLAPSED"` Hides the label. The label will still be read by screen readers; see accessibility considerations for more information. `"JUSTIFIED"` Aligns the label alongside the component starting at the edge of the page.
Instructions	`instructions`	Text	Supplemental text about this field.
Help Tooltip	`helpTooltip`	Text	Displays a help icon with the specified text as a tooltip. The tooltip displays a maximum of 500 characters. The help icon does not show when the label position is `"COLLAPSED"`.
Tags	`tags`	List of Variant	List of tags to display. Configured using a!tagItem().
Alignment	`align`	Text	Determines alignment of the image(s). Valid values: `"START"`, `"CENTER"`, `"END"`.
Accessibility Text	`accessibilityText`	Text	Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
Size	`size`	Text	Determines the size of the tags. Valid values: `"SMALL"`, `"STANDARD"` (default).
Visibility	`showWhen`	Boolean	Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default: true.
Margin Above	`marginAbove`	Text	Determines how much space is added above the layout. Valid values: `"NONE"` (default), `"EVEN_LESS"`, `"LESS"`, `"STANDARD"`, `"MORE"`, `"EVEN_MORE"`.
Margin Below	`marginBelow`	Text	Determines how much space is added below the layout. Valid values: `"NONE"`, `"EVEN_LESS"`, `"LESS"`, `"STANDARD"` (default), `"MORE"`, `"EVEN_MORE"`.

Usage considerations

Using the tag parameter with text values

If the tags parameter is null, contains an empty array, or only contains tag items with no text value, then the label and instructions render with no tags displayed.
If multiple tags are displayed in a narrow container, tags can wrap onto multiple lines. An individual tag will never be split onto two lines.

Examples

Use the interactive editor below to test out your code:

Display tags with custom colors

Display multiple tags using looping

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	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 Component.

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.