List Item Blocks

List item blocks are used to create different types of lists in your documents. BlockNote supports various list item blocks to help you structure and format your content effectively.

Bullet List Item

A bullet list item is a list item that is not numbered.

Type & Props

type BulletListItemBlock = {
  id: string;
  type: "bulletListItem";
  props: DefaultProps;
  content: InlineContent[];
  children: Block[];
};

Numbered List Item

A numbered list item is a list item that is numbered.

Type & Props

type NumberedListItemBlock = {
  id: string;
  type: "numberedListItem";
  props: DefaultProps & {
    start?: number;
  };
  content: InlineContent[];
  children: Block[];
};

start: The number of this list item. If not provided, it defaults to 1, or is incremented from the previous item.

Check List Item

A check list item is a list item that can be checked or unchecked.

Type & Props

type CheckListItemBlock = {
  id: string;
  type: "checkListItem";
  props: DefaultProps & {
    checked: boolean;
  };
  content: InlineContent[];
  children: Block[];
};

checked: Whether the list item is checked or not.

Toggle List Item

A toggle list item is a list item that can show or hide it's children.

Type & Props

type ToggleListItemBlock = {
  id: string;
  type: "toggleListItem";
  props: DefaultProps;
  content: InlineContent[];
  children: Block[];
};