Interface: RichTextList
Description
A list block within a rich text field.
Extends
Properties
border?
optional border: 0 | 1;
Description
Whether to render a quote-block-like border on the inline side of the list. 0 renders no border
while 1 renders a border.
Inherited from
Defined in
elements
elements: RichTextSection[];
Description
An array of RichTextSection elements comprising each list item.
Defined in
block-kit/block-elements.ts:909
indent?
optional indent: number;
Description
The style of the list points. Can be a number from 0 (default) to 8. Yields a different character
or characters rendered as the list points. Also affected by the style property.
Defined in
block-kit/block-elements.ts:919
style
style: "bullet" | "ordered";
Description
The type of list. Can be either bullet (the list points are all rendered the same way) or ordered
(the list points increase numerically from 1).
Defined in
block-kit/block-elements.ts:914
type
type: "rich_text_list";
Description
The type of element. In this case type is always rich_text_list.