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!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
Name | Keyword | Types | Description |
---|---|---|---|
Label |
|
Text |
Text to display as the field label. |
Label Position |
|
Text |
Determines where the label appears. Valid values:
|
Instructions |
|
Text |
Supplemental text about this field. |
Help Tooltip |
|
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 |
Tags |
|
List of Variant |
List of tags to display. Configured using a!tagItem(). |
Alignment |
|
Text |
Determines alignment of the image(s). Valid values: |
Accessibility Text |
|
Text |
Additional text to be announced by screen readers. Used only for accessibility; produces no visible change. |
Size |
|
Text |
Determines the size of the tags. Valid values: |
Visibility |
|
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 |
|
Text |
Determines how much space is added above the layout. Valid values: |
Margin Below |
|
Text |
Determines how much space is added below the layout. Valid values: |
You can use the link parameter in the a!tagItem() function to add any link type to a tag, giving the tag additional functionality. For example, if you have tags representing categories (such as groups of products or sales regions), the tags could link to interfaces showing all relevant items in that category, or a related report.
Use the interactive editor below to test out your code:
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.
Tag Component