Stamp Component

Stamp

Function: a!stampField()

Displays an icon on a colored circular border. Best used as a decorative component to add visual interest to your page. This feature is perfect for drawing attention to important content and reduces the need for custom images.

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

Background Color

backgroundColor

Text

Determines the background color. Valid values: Any valid hex color or "ACCENT" (default), "POSITIVE", "NEGATIVE", "SECONDARY", "TRANSPARENT". If "TRANSPARENT" is selected, the circle border will take on the content color and the circle fill will be transparent.

Icon

icon

Text

Icon to display inside the stamp. See the documentation for details.

Content Color

contentColor

Text

Determines the icon color. Valid values: Any hex color or "STANDARD" (default), "ACCENT", "POSITIVE", "NEGATIVE".

Size

size

Text

Determines the size of the stamp. Valid values: "TINY", "SMALL", "MEDIUM" (default), "LARGE".

Align

align

Text

Determines alignment of the stamp. Valid values: "START", "CENTER" (default), "END".

Tooltip

tooltip

Text

Text to display on mouseover (web) or tap (mobile).

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.

Accessibility Text

accessibilityText

Text

Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.

Notes

  • A stamp with a "TRANSPARENT" background displays an icon with a colored circular border. The contentColor will be used for both the icon and the circular border.

Examples

Copy and paste an example into the INTERFACE DEFINITION in EXPRESSION MODE to see it displayed.

Stamp with an ACCENT background

1
2
3
4
5
6
7

=a!stampField(
  label: "Stamp",
  labelPosition: "COLLAPSED",
  backgroundColor: "ACCENT",
  icon: "STAR",
  contentColor: "STANDARD"
)

Displays the following:

screenshot of an accent stamp with a star icon

Stamp with a TRANSPARENT background

1
2
3
4
5
6
7

a!stampField(
  label: "Stamp",
  labelPosition: "COLLAPSED",
  backgroundColor: "TRANSPARENT",
  icon: "HOME",
  contentColor: "POSITIVE" 
)

Displays the following:

screenshot of a transparent stamp with a home icon and positive content color

The following patterns include usage of the Stamp Component.

  • Activity History Pattern (Formatting): The Activity History pattern provides a common style and format for displaying an organization's activity measures.

  • Milestone Stamp Pattern (Looping): Use the milestone stamp pattern to visually guide users through sequential steps to complete tasks and show users their progress as they move through the steps.

Open in Github Built: Tue, May 17, 2022 (03:05:45 PM)

On This Page

FEEDBACK