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

# ListItem
The ListItem extension adds support for the `<li>` HTML tag. It’s used for bullet lists and ordered lists and can’t really be used without them.

## Installation
::: warning Restrictions
This extension is intended to be used with the [`BulletList`](/api/extensions/bullet-list) or [`OrderedList`](/api/extensions/ordered-list) extension. It doesn’t work without at least using one of them.
:::

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

# with Yarn
yarn add @tiptap/extension-list-item
```

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

## Commands
*None*

## Keyboard shortcuts
* New list item: `Enter`
* Sink a list item: `Tab`
* Lift a list item: `Shift`&nbsp;`Tab`

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

## Usage
<demo name="Extensions/ListItem" highlight="3-8,20-22,41-43" />
-												move all extensions to separate pages

											
										
										
											2020-08-19 03:39:41 +08:00
+								# ListItem
-												add ordered list and list item

											
										
										
											2020-09-23 18:33:45 +08:00
+								The ListItem extension adds support for the `<li>` HTML tag. It’s used for bullet lists and ordered lists and can’t really be used without them.
-												move all extensions to separate pages

											
										
										
											2020-08-19 03:39:41 +08:00
-												add ordered list and list item

											
										
										
											2020-09-23 18:33:45 +08:00
+								## Installation
-												move all extensions to separate pages

											
										
										
											2020-08-19 03:39:41 +08:00
+								::: warning Restrictions
-												move nodes and marks to a separate folder, add missing extensions

											
										
										
											2020-11-02 22:54:15 +08:00
+								This extension is intended to be used with the [`BulletList`](/api/extensions/bullet-list) or [`OrderedList`](/api/extensions/ordered-list) extension. It doesn’t work without at least using one of them.
-												add the custom class option to all extensions that generate HTML tags

											
										
										
											2020-09-09 22:15:22 +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
-												add installation instructions to all extensions

											
										
										
											2020-09-23 15:52:04 +08:00
+								npm install @tiptap/extension-list-item
-												update content

											
										
										
											2020-10-30 21:24:16 +08:00
+								# with Yarn
-												add installation instructions to all extensions

											
										
										
											2020-09-23 15:52:04 +08:00
+								yarn add @tiptap/extension-list-item
 								```
-												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                                  |
 								| ------ | ------ | ------- | -------------------------------------------- |
-												add ordered list and list item

											
										
										
											2020-09-23 18:33:45 +08:00
+								| class  | string | –       | Add a custom class to the rendered HTML tag. |
 								## Commands
 								*None*
 								## Keyboard shortcuts
 								* New list item: `Enter`
 								* Sink a list item: `Tab`
-												replace non-breaking-space with html entity

											
										
										
											2020-09-27 17:01:25 +08:00
+								* Lift a list item: `Shift`&nbsp;`Tab`
-												add ordered list and list item

											
										
										
											2020-09-23 18:33:45 +08:00
 								## Source code
 								[packages/extension-list-item/](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-list-item/)
 								## Usage
-												format keyboard shortcuts

											
										
										
											2020-09-24 23:27:26 +08:00
+								<demo name="Extensions/ListItem" highlight="3-8,20-22,41-43" />