Componentsv2.189.0
Iconsv1.19.0
MCPv0.8.61
Tokensv0.34.3

List a group of text-only content.

Importing

A list consists of two components:

  • List - wraps the list items (renders a ul or ol tag)
  • ListItem - the individual list items (li tags)

The components can be imported via:

import { 
	List, 
	ListItem 
} from '@customerio/pluma-components/react';

Usage

Use the List component as the container, and place ListItem components as its children:

Loading editor

Type

By default, the component will render an unordered (ul) list. To render an ordered (ol) list instead, set the type prop to ordered:

Loading editor

Style

To change the bullet or number style, use the styleType prop. Supported values are:

  • none
  • disc
  • circle
  • square
  • decimal
  • decimal-leading-zero
  • lower-roman
  • upper-roman
Loading editor
Loading editor

Gap

To change the gap between list items, use the gap prop, which accepts a space token value.

Loading editor
Loading editor

API

PlumaList extends Text

Default:'unordered'

Whether the list should render a ul (unordered) or ol (ordered) tag.

On this page