Module list

elsie.ext.list

source link

Classes

class ListBuilder
This holds information about the counters and nesting level of a (sub)list.

Functions

▷ def arabic_digit_render_fn(box: Box, level: List[int])
source link

▶ def ordered_list(parent: Box, indent: float = 10, start: int = 1, ...) -> ListBuilder

Create a new ordered list.

def ordered_list(

parent: Box,

indent: float = 10,

start: int = 1,

label_padding: float = 25,

label: LabelType = None,

**default_box_args,

) -> ListBuilder

source link

Parameters

parent : Box
```
Box that will contain the list.
```

indent : float

Default indentation used when creating sublists.

start : int

The counter value at which will the list start.

label_padding : float

Default horizontal gap between each label and its corresponding item.

label : LabelType

Either a string or a function.
If `label` is a string, it will be used as a label for each list item in the list.
If `label` is a function, it will be called for each label. It will be passed a Box and
a list of counter values for each nesting level and it should fill the box with the
contents of the label.

default_box_args : kwargs

Additional arguments that will be passed to the box of each list item in the list.

Reexports

Imported in elsie.ext.markdown.
Imported in elsie.ext.

▶ def unordered_list(parent: Box, indent: float = 10, label_padding: float = 25, ...) -> ListBuilder

Create a new unordered list.

def unordered_list(

parent: Box,

indent: float = 10,

label_padding: float = 25,

label: LabelType = None,

**default_box_args,

) -> ListBuilder

source link

Parameters

parent : Box
```
Box that will contain the list.
```

indent : float

Default indentation used when creating sublists.

label_padding : float

Default horizontal gap between each label and its corresponding item.

label : LabelType

Either a string or a function.
If `label` is a string, it will be used as a label for each list item in the list.
If `label` is a function, it will be called for each label. It will be passed a Box and
a list of counter values for each nesting level and it should fill the box with the
contents of the label.

default_box_args : kwargs

Additional arguments that will be passed to the box of each list item in the list.

Reexports

Imported in elsie.ext.markdown.
Imported in elsie.ext.