Rich Text Icon

SAIL Design System guidance available for Rich Text

Enhance readability and comprehension on your interface by using rich text formatting to visually differentiate text.

Function

a!richTextIcon( icon, altText, caption, size, color, link, linkStyle, showWhen )

Displays an icon for use in rich text display. Icons can be formatted by configuring a color, size, or link. To show documents as images within rich text, see Rich Text Image.

See also: Rich text style guidance

Parameters

Name	Keyword	Types	Description
Icon	`icon`	Text	The key of the icon to display. See Available Icons below.
Alternative Text	`altText`	Text	Equivalent alternate text to display when accessibility or browser compatibility issues prevent the icon from displaying.
Caption	`caption`	Text	Text to display in mouseovers.
Size	`size`	Text	Determines the icon size. Valid values: `"STANDARD"` (default), `"SMALL"`, `"MEDIUM"`, `"MEDIUM_PLUS"`, `"LARGE"`, `"LARGE_PLUS"`, and `"EXTRA_LARGE"`.
Color	`color`	Text	Determines the icon color. Valid values: Any hex color or `"STANDARD"` (default), `"ACCENT"`, `"POSITIVE"`, `"NEGATIVE"`, and `"SECONDARY"`.
Link	`link`	Link	Link that determines the behavior of the icon when clicked. Create links with: a!authorizationLink() a!documentDownloadLink() a!dynamicLink() a!newsEntryLink() a!processTaskLink() a!recordLink() a!reportLink() a!startProcessLink() a!submitLink() a!userRecordLink() a!safeLink()
Link Style	`linkStyle`	Text	Determines how the link is underlined. Valid values: `"INLINE"` (default), `"STANDALONE"`.
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.

Usage considerations

Using the icon, link, and style parameters

If icon is null or contains an empty array, no icon is displayed.
If link is null, the icon is not displayed as a link.
For nested rich text, if two conflicting styles are found (for example, both SMALL and LARGE), the innermost style will be displayed.

Adding decorative icons

An icon is considered decorative if it only serves a design purpose and does not add meaning or provide information. To meet accessibility guidelines for decorative elements, you should not include the altText, caption, or link parameters for a decorative icon. Appian will indicate the icon's purpose as decorative—and screen readers will skip it—when those parameters are not set and the icon is used in one of the following components:

Examples

Use the interactive editor below to test out your code:

Linked icons within text

Icons in a grid

Standalone links

Available icons

The following table shows all available icons. Search the table to find specific icons.

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 Rich Text Icon.

Add Validations to an Inline Editable Grid (Validation, Grids, Looping): Allows the user to change data directly in a grid, and validate a various entries.
Add, Edit, and Remove Data in an Inline Editable Grid (Grids, Looping): Allow the user to change data directly in an inline editable grid.
Alert Banner Patterns (Choice Components): The alert banners pattern is good for creating a visual cue of different types of alerts about information on a page.
Cards as Buttons Pattern (Choice Components, Formatting, Conditional Display): The cards as buttons pattern is a great way to prominently display a select few choices.
Cards as List Items Patterns (Choice Components, Images): Use the cards as list items pattern to create visually rich lists as an alternative to grids or feeds. This pattern uses a combination of cards and billboards to show lists of like items. You can easily modify the pattern to change the card content or the number of cards per row to fit your use case.
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.
Document List (Documents): Use the document list items pattern to display a list of documents that can be searched and filtered. This pattern uses a combination of cards and rich text to show an easy to navigate list of documents of different types.
Drilldown Pattern (Grids): The drilldown pattern allows users to select an item from a grid to see more details in place of the grid.
Drilldown Report Pattern (Grids, Charts, Reports): The drilldown report pattern consists of a bar chart and column chart, which each drill down into a grid.
Duration Display (Rich Text, Events): Use the duration display pattern to show the amount of time in between events in a quick, easy-to-read way.
Dynamic Inputs (Inputs, Dynamic Links): Use the dynamic inputs pattern to allow users to easily add or remove as many values as needed.
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.
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.
Leaderboard (Looping): Use the leaderboard pattern to show a selection of your data in an easy to read ranked display.
Limit the Number of Rows in a Grid That Can Be Selected (Validation, Grids, Records): Limit the number of rows that can be selected to an arbitrary number.
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.
Offline Mobile Task Report (Grids, Filtering, Process Task Links, Task Reports, Looping): Display a task report for a user that will work in Appian Mobile, even when the user is offline.
Set a Numeric Rating Using Rich Text Icons (Conditional Display): Save a numeric score using a set of clickable rich text icons.
Show a Numeric Rating as Rich Text Icons (Conditional Display): Dynamically show a star rating based on a numeric score.
Task Report Pattern (Grids, Filters, Process Task Links, Task Reports): Provides a simple way to create and display an Appian task report.
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.

Feedback

Was this page helpful?