1.6 KiB
1.6 KiB
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
# 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
| Option | Type | Default | Description |
|---|---|---|---|
| HTMLAttributes | Object |
{} |
Custom HTML attributes that should be added to the rendered HTML tag. |
Commands
| Command | Parameters | Description |
|---|---|---|
| bulletList | — | Toggle a bullet list. |
Keyboard shortcuts
- Windows/Linux:
ControlShift8 - macOS:
CmdShift8
Source code
packages/extension-bullet-list/