List Items

Super Editor ships with support for ordered and unordered list items.

List Item Node

List items are represented in Documents with ListItemNodes.

To represent an unordered list item, use the ListItemNode.unordered() constructor.

final document = MutableDocument(nodes: [
  ListItemNode.unordered(
    id: Editor.createNodeId(),
    text: AttributedText("An unordered list item"),
  ),
]);

To represent an ordered list item, use the ListItemNode.ordered() constructor.

final document = MutableDocument(nodes: [
  ListItemNode.ordered(
    id: Editor.createNodeId(),
    text: AttributedText("An unordered list item"),
  ),
]);

Both ordered and unordered list items support a variable indent level, allowing for lists within lists.

Visual Presentation

By default, SuperEditor includes an UnorderedListItemComponentBuilder, and an OrderedListItemComponentBuilder, which builds widgets for the respective types of list items. Therefore, no additional steps are required to display list items.

The easiest way to make stylistic adjustments to the built-in list item presentation is to customize Super Editor's default stylesheet.

References

      GitHub   Discord   Sponsor