tiptap/docs/src/docPages/api/extensions/bullet-list.md

BulletList

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

::: warning Use with ListItem The BulletList extension is intended to be used with the ListItem extension. Make sure to import that one too, otherwise you’ll get a SyntaxError. :::

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

# Or: With Yarn
yarn add @tiptap/extension-bullet-list @tiptap/extension-list-item

Settings

Option	Type	Default	Description
class	string	–	Add a custom class to the rendered HTML tag.

Commands

Command	Options	Description
bullet_list	—	Toggle a bullet list.

Keyboard shortcuts

• Control Shift 8

Source code

packages/extension-bullet-list/

Usage