Numbered List

Function

a!richTextNumberedList( items, showWhen )

Displays a numbered list within a rich text component.

See also: Rich text style guidance

Parameters

Name Keyword Types Description

Items

items

Text, Styled Text, List

Array of text to display as a numbered list. Text can be further formatted using a!richTextItem(). Nested lists can be created using a!richTextListItem().

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 items parameter

  • Specific values within items can be further formatted using styled text.
  • If items is null or contains an empty array, no list is displayed.
  • If the items array contains one or more null values, those items in the list have no text displayed.

Formatting numbered lists and using styled text

  • Numbered lists cannot be nested within styled text.
  • Top-level numbered lists use Arabic numerals (e.g. 1, 2, 3); second-level numbered lists use letters (e.g. a, b, c); third-level numbered lists use lower-case roman numerals (e.g. i, ii, iii). Further nested numbered lists repeat the same pattern starting with Arabic numerals.

Example

Use the interactive editor below to test out your code:

Rich text numbered list

Open in Github Built: Thu, Oct 14, 2021 (02:44:31 PM)

On This Page

FEEDBACK