BulletList

Version Downloads

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.

Installation

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

# with Yarn
yarn add @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',
  },
})

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/

Usage