Stamp Component (a!stampField)

Display

Stamp Component

Function

a!stampField( label, labelPosition, instructions, helpTooltip, icon, text, backgroundColor, contentColor, size, align, tooltip, showWhen, accessibilityText, link, marginAbove, marginBelow )

Displays an icon and/or text on a colored circular background. They are 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.

Stamps can include a link and are an alternative style in places where you might otherwise use a button or a link.

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"`.
Icon	`icon`	Text	Icon to display inside the stamp. See the documentation for details.
Text	`text`	Text	Text to display within the stamp.
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.
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.
Link	`link`	Any Type	Link to apply to the stamp. Create a link with `a!documentDownloadLink()`, `a!dynamicLink()`, `a!newsEntryLink()`, `a!processTaskLink()`, `a!recordLink()`, `a!reportLink()`, `a!safeLink()`, `a!startProcessLink()`, `a!submitLink()`, `a!userRecordLink()`, or `a!authorizationLink()`.
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

Stamp color

A stamp with a "TRANSPARENT" background displays an icon and/or text with a colored circular border. The contentColor will be used for the icon, text, and circular border.

Examples

Use the interactive editor below to test out your code:

Stamp with an ACCENT background

Stamp with a TRANSPARENT background

Stamp with text

Stamps with dynamic links

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
Process Reports	Incompatible	You cannot use this function to configure a process report.
Process Events	Incompatible	You cannot use this function to configure a process event node, such as a start event or timer event.

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.
Comments Patterns (Comments, Looping): Use this pattern when displaying a chronological list of messages from different users, such as comments on a topic or notes on a case.
Form Steps (Stamps): Use the form steps patten to break down complicated forms into a series of quickly completed steps that are well organized and easy to navigate. This pattern uses a combination of cards and rich text to create steps that can represent fields from one or more interfaces.
Milestone Patterns (Looping): There are three options for milestone patterns which all display some form of a progress indicator to guide users through a series of steps.
Navigation Patterns (Conditional Display, Formatting, Navigation): Use the navigation patterns to help orient users and enable them to easily navigate pages and content.
Stamp Steps (Stamps): There are two similar stamp steps patterns. The stamp steps (icon) pattern is primarily icons and titles. It should be used for simple steps that don't require much information or instruction. The stamp steps (numbered) pattern is primarily text and should be used for steps that require context or explanation.