Skip to main content

Lists

Bullet lists​

<bullet-list>
<list-item><paragraph><run>First item</run></paragraph></list-item>
<list-item><paragraph><run>Second item</run></paragraph></list-item>
<list-item><paragraph><run>Third item</run></paragraph></list-item>
</bullet-list>

Numbered lists​

<numbered-list>
<list-item><paragraph><run>Step one</run></paragraph></list-item>
<list-item><paragraph><run>Step two</run></paragraph></list-item>
<list-item><paragraph><run>Step three</run></paragraph></list-item>
</numbered-list>

Numbering formats​

The format prop on <numbered-list> controls the numbering style:

FormatExample
"decimal" (default)1, 2, 3
"lowerRoman"i, ii, iii
"upperRoman"I, II, III
"lowerLetter"a, b, c
"upperLetter"A, B, C
<numbered-list format="lowerRoman">
<list-item><paragraph><run>First</run></paragraph></list-item>
<list-item><paragraph><run>Second</run></paragraph></list-item>
</numbered-list>

Custom start number​

<numbered-list start={5}>
<list-item><paragraph><run>Starts at five</run></paragraph></list-item>
<list-item><paragraph><run>Six</run></paragraph></list-item>
</numbered-list>

Nested lists​

Use the level prop on <list-item> to create nested lists:

<bullet-list>
<list-item level={0}><paragraph><run>Top level</run></paragraph></list-item>
<list-item level={1}><paragraph><run>Nested item</run></paragraph></list-item>
<list-item level={1}><paragraph><run>Another nested</run></paragraph></list-item>
<list-item level={0}><paragraph><run>Back to top</run></paragraph></list-item>
</bullet-list>

Levels are 0-indexed and support up to 9 levels of nesting (0-8).

Dynamic lists​

const items = ["Apples", "Bananas", "Cherries"];

<bullet-list>
{items.map((item) => (
<list-item key={item}>
<paragraph><run>{item}</run></paragraph>
</list-item>
))}
</bullet-list>

List item props​

PropTypeDescription
levelnumberNesting level (0-8, default 0)
numberingNumberingPropsOverride numbering reference

Numbered list props​

PropTypeDescription
formatNumberingFormatNumbering style
startnumberStarting number
referencestringNamed numbering definition

Bullet list props​

PropTypeDescription
referencestringNamed numbering definition