Free cookie consent management tool by TermsFeed Header Text Component (a!richTextHeader)
Header Text Component
This function cannot be used with Custom Record Field Expressions.
For a full list of functions and their feature compatibility, explore the Appian Functions table.


a!richTextHeader( text, size, link, linkStyle, showWhen )

Displays heading-styled text within a rich text component.

See also: Rich text style guidance


Name Keyword Types Description



Text or Styled Text

Array of text to display as a rich text item.




Determines the text size. Valid values: "ICON" (default), "TINY", "GALLERY", "SMALL", "MEDIUM", and "LARGE".




Link to apply to the text. Create links with:

Link Style



Determines how the link is underlined. Valid values: "INLINE" (default), "STANDALONE".




Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default: true.

Usage considerations

  • If text is null or contains an empty array, no text is displayed.
  • If link is null, the text is not displayed as a link.

Header text and grids

  • While rich text components can be placed inside a grid layout, header styles are not supported within a grid layout.


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

Use the interactive editor below to test out your code:

The following patterns include usage of the Header Text Component.

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

  • Grid with Selection Pattern (Grids): This pattern is an example of good UX design for a grid that allows users to select items and easily view their selections when there are multiple pages of data. It also provides information on a common save behavior.

  • Inline Survey (Radio Buttons, Checkboxes, Buttons): Use this pattern to create a clean and easy to navigate survey.

  • Percentage of Online Sales (Records, Reports, Formatting): This pattern illustrates how to calculate the percent of sales generated from online orders and display it in a gauge component.

  • User List Pattern (Looping): The user list pattern retrieves all the users in a specified group and displays them in a single column.

  • Year-Over-Year Report (Charts, Reports, Formatting): This is a feature-rich, interactive report for sales and profits by products over select periods of time.

Open in Github Built: Fri, Nov 10, 2023 (03:42:48 PM)

Header Text Component