List Item

Function

a!richTextListItem( text, nestedList, showWhen )

Displays a nested list within a bulleted or numbered list in a Rich Text component.

See also: Rich text style guidance

Parameters

Name Keyword Types Description

Text

text

Text or Styled Text

Array of text to display as a rich text list item. Text can be formatted using a!richTextItem().

Nested List

nestedList

Bulleted List or Numbered List

A bulleted or numbered list to nest within the rich text list item. Use a!richTextBulletedList() or a!richTextNumberedList().

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 text and nestedList parameters

  • If text is null or contains an empty array, no text is displayed for the list item.
  • If nestedList is null, no nested list is displayed within the parent list.
  • A nested list doesn't need to be the same type of list as its parent list. Bulleted lists can be nested within numbered lists and vice versa.

Examples

Use the interactive editor below to test out your code:

Rich text list

Open in Github Built: Tue, May 23, 2023 (06:12:33 PM)

On This Page

FEEDBACK