Interface IListConfiguration

A structure defining layout settings and format of lists in text elements.

Package: @aurigma/design-atoms-text

Properties

bulletChar

The bulleted list marker that will be used when creating lists through the Top toolbar. The default value is "•" (0x8226).

Declaration

bulletChar: string;

Property Value

Type	Description
string	The bulleted list marker that will be used when creating lists through the Top toolbar. The default value is "•" (0x8226).

firstLineIndent

The distance between the bullet and text in the first line of a list item, in points. The default value is -20.

Declaration

firstLineIndent: number;

Property Value

Type	Description
number	The distance between the bullet and text in the first line of a list item, in points. The default value is -20.

levelIndent

The offset of each next level of the list relative to the previous level, in points. The default value is 30.

Declaration

levelIndent: number;

Property Value

Type	Description
number	The offset of each next level of the list relative to the previous level, in points. The default value is 30.

listIndent

The distance between the left edge of the text element and the leftmost line of list items in this text element, in points. The default value is 30.

Declaration

listIndent: number;

Property Value

Type	Description
number	The distance between the left edge of the text element and the leftmost line of list items in this text element, in points. The default value is 30.

maxLevel

The maximum number of levels in multilevel lists. The default value is 3.

Declaration

maxLevel: number;

Property Value

Type	Description
number	The maximum number of levels in multilevel lists. The default value is 3.

numberingFormat

The numbered list marker format, one of "none", "number", "lowerLetter", "upperLetter", "lowerRoman", or "upperRoman". If "none", then list items will represent paragraphs without numbers. This marker format will be used when creating lists through the Top toolbar. The default value is "number".

Declaration

numberingFormat: NumberingFormatType;

Property Value

Type	Description
NumberingFormatType	The numbered list marker format, one of "none", "number", "lowerLetter", "upperLetter", "lowerRoman", or "upperRoman". If "none", then list items will represent paragraphs without numbers. This marker format will be used when creating lists through the Top toolbar. The default value is "number".

tabOffset

The offset that will appear before text on the first line if this text may overlap the bullet, in points. If this value is not enough to create an indent, it will be added again. The default value is 30.

Declaration

tabOffset: number;

Property Value

Type	Description
number	The offset that will appear before text on the first line if this text may overlap the bullet, in points. If this value is not enough to create an indent, it will be added again. The default value is 30.