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

# BulletList
This extension enables you to use bullet lists in the editor. They are rendered as `<ul>` HTML tags.

Type <code>*&nbsp;</code>, <code>-&nbsp;</code> or <code>+&nbsp;</code> at the beginning of a new line and it will magically transform to a bullet list.

## Installation
::: warning Use with ListItem
This extension requires the [`ListItem`](/api/nodes/list-item) extension.
:::

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

# 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     | Parameters | Description           |
| ----------- | ---------- | --------------------- |
| bullet_list | —          | Toggle a bullet list. |

## Keyboard shortcuts
* `Control`&nbsp;`Shift`&nbsp;`8`

## Source code
[packages/extension-bullet-list/](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-bullet-list/)

## Usage
<demo name="Nodes/BulletList" highlight="3-5,17-18,37-38" />
-												move all extensions to separate pages

											
										
										
											2020-08-19 03:39:41 +08:00
+								# BulletList
-												update content, add text align justify

											
										
										
											2020-11-03 23:13:13 +08:00
+								This extension enables you to use bullet lists in the editor. They are rendered as `<ul>` HTML tags.
-												move all extensions to separate pages

											
										
										
											2020-08-19 03:39:41 +08:00
-												a ton of improvements

											
										
										
											2020-09-23 18:03:03 +08:00
+								Type <code>*&nbsp;</code>, <code>-&nbsp;</code> or <code>+&nbsp;</code> at the beginning of a new line and it will magically transform to a bullet list.
-												improve the bullet list page

											
										
										
											2020-09-15 23:26:42 +08:00
-												a ton of improvements

											
										
										
											2020-09-23 18:03:03 +08:00
+								## Installation
-												improve the bullet list page

											
										
										
											2020-09-15 23:26:42 +08:00
+								::: warning Use with ListItem
-												add more content, add tests to the tasklist extension

											
										
										
											2020-11-04 00:05:27 +08:00
+								This extension requires the [`ListItem`](/api/nodes/list-item) extension.
-												move all extensions to separate pages

											
										
										
											2020-08-19 03:39:41 +08:00
+								:::
-												add installation instructions to all extensions

											
										
										
											2020-09-23 15:52:04 +08:00
+								```bash
-												update content

											
										
										
											2020-10-30 21:24:16 +08:00
+								# with npm
-												a ton of improvements

											
										
										
											2020-09-23 18:03:03 +08:00
+								npm install @tiptap/extension-bullet-list @tiptap/extension-list-item
-												add installation instructions to all extensions

											
										
										
											2020-09-23 15:52:04 +08:00
-												update content

											
										
										
											2020-10-30 21:24:16 +08:00
+								# with Yarn
-												a ton of improvements

											
										
										
											2020-09-23 18:03:03 +08:00
+								yarn add @tiptap/extension-bullet-list @tiptap/extension-list-item
-												add installation instructions to all extensions

											
										
										
											2020-09-23 15:52:04 +08:00
+								```
-												a ton of improvements

											
										
										
											2020-09-23 18:03:03 +08:00
+								## Settings
-												format tables

											
										
										
											2020-09-10 16:21:24 +08:00
+								| Option | Type   | Default | Description                                  |
 								| ------ | ------ | ------- | -------------------------------------------- |
 								| class  | string | –       | Add a custom class to the rendered HTML tag. |
-												move all extensions to separate pages

											
										
										
											2020-08-19 03:39:41 +08:00
-												improve the extensions documentation

											
										
										
											2020-08-20 21:33:16 +08:00
+								## Commands
-												move everything around, add more content and a first test for images

											
										
										
											2020-11-03 23:43:35 +08:00
+								| Command     | Parameters | Description           |
 								| ----------- | ---------- | --------------------- |
 								| bullet_list | —          | Toggle a bullet list. |
-												move all extensions to separate pages

											
										
										
											2020-08-19 03:39:41 +08:00
-												rename keybindings to keyboard shortcuts

											
										
										
											2020-09-10 17:24:33 +08:00
+								## Keyboard shortcuts
-												replace non-breaking-space with html entity

											
										
										
											2020-09-27 17:01:25 +08:00
+								* `Control`&nbsp;`Shift`&nbsp;`8`
-												move all extensions to separate pages

											
										
										
											2020-08-19 03:39:41 +08:00
-												minor improvements

											
										
										
											2020-09-21 22:59:28 +08:00
+								## Source code
-												add a demo to the bullet list extension page

											
										
										
											2020-09-15 22:50:54 +08:00
+								[packages/extension-bullet-list/](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-bullet-list/)
-												move all extensions to separate pages

											
										
										
											2020-08-19 03:39:41 +08:00
-												add a demo to the bullet list extension page

											
										
										
											2020-09-15 22:50:54 +08:00
+								## Usage
-												move everything around, add more content and a first test for images

											
										
										
											2020-11-03 23:43:35 +08:00
+								<demo name="Nodes/BulletList" highlight="3-5,17-18,37-38" />