BulletList extension

This extension enables you to use bullet lists in the editor. They are rendered as <ul> HTML tags. Type * , - or + at the beginning of a new line and it will magically transform to a bullet list.

Modify backspace behavior

If you want to modify the standard behavior of backspace and delete functions for lists, you should read about the ListKeymap extension.

Install

npm install @tiptap/extension-bullet-list @tiptap/extension-list-item

This extension requires the ListItem node.

Settings

HTMLAttributes

Custom HTML attributes that should be added to the rendered HTML tag.

BulletList.configure({
  HTMLAttributes: {
    class: 'my-custom-class',
  },
})

itemTypeName

Specify the list item name.

Default: 'listItem'

BulletList.configure({
  itemTypeName: 'listItem',
})

keepMarks

Decides whether to keep the marks from a previous line after toggling the list either using inputRule or using the button

Default: false

BulletList.configure({
  keepMarks: true,
})

keepAttributes

Decides whether to keep the attributes from a previous line after toggling the list either using inputRule or using the button

Default: false

BulletList.configure({
  keepAttributes: true,
})

Commands

toggleBulletList()

Toggles a bullet list.

editor.commands.toggleBulletList()

Keyboard shortcuts

Command	Windows/Linux	macOS
toggleBulletList	`Control` + `Shift` + `8`	`Cmd` + `Shift` + `8`

Source code

packages/extension-bullet-list/