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

# ListItem
[![Version](https://img.shields.io/npm/v/@tiptap/extension-list-item.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-list-item)
[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-list-item.svg)](https://npmcharts.com/compare/@tiptap/extension-list-item?minimal=true)

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
```bash
# with npm
npm install @tiptap/extension-list-item

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

This extension requires the [`BulletList`](/api/nodes/bullet-list) or [`OrderedList`](/api/nodes/ordered-list) node.

## Settings
| Option         | Type     | Default | Description                                                           |
| -------------- | -------- | ------- | --------------------------------------------------------------------- |
| HTMLAttributes | `Object` | `{}`    | Custom HTML attributes that should be added to the rendered HTML tag. |

## Keyboard shortcuts
| Command         | Windows/Linux      | macOS              |
| --------------- | ------------------ | ------------------ |
| splitListItem() | `Enter`            | `Enter`            |
| sinkListItem()  | `Tab`              | `Tab`              |
| liftListItem()  | `Shift`&nbsp;`Tab` | `Shift`&nbsp;`Tab` |

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

## Usage
<tiptap-demo name="Nodes/ListItem"></tiptap-demo>
-												move all extensions to separate pages

											
										
										
											2020-08-19 03:39:41 +08:00
+								# ListItem
-												docs: add badges to all extensions

											
										
										
											2021-01-25 17:35:52 +08:00
+								[![Version](https://img.shields.io/npm/v/@tiptap/extension-list-item.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-list-item)
 								[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-list-item.svg)](https://npmcharts.com/compare/@tiptap/extension-list-item?minimal=true)
-												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
-												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
 								```
-												docs: update content

											
										
										
											2021-02-12 22:02:40 +08:00
+								This extension requires the [`BulletList`](/api/nodes/bullet-list) or [`OrderedList`](/api/nodes/ordered-list) node.
-												a ton of improvements

											
										
										
											2020-09-23 18:03:03 +08:00
+								## Settings
-												docs: add HTMLAttributes

											
										
										
											2020-11-18 19:12:34 +08:00
+								| Option         | Type     | Default | Description                                                           |
 								| -------------- | -------- | ------- | --------------------------------------------------------------------- |
 								| HTMLAttributes | `Object` | `{}`    | Custom HTML attributes that should be added to the rendered HTML tag. |
-												add ordered list and list item

											
										
										
											2020-09-23 18:33:45 +08:00
 								## Keyboard shortcuts
-												docs: make all node keyboard shortcuts a table

											
										
										
											2021-10-02 04:57:27 +08:00
+								| Command         | Windows/Linux      | macOS              |
 								| --------------- | ------------------ | ------------------ |
 								| splitListItem() | `Enter`            | `Enter`            |
 								| sinkListItem()  | `Tab`              | `Tab`              |
 								| liftListItem()  | `Shift`&nbsp;`Tab` | `Shift`&nbsp;`Tab` |
-												add ordered list and list item

											
										
										
											2020-09-23 18:33:45 +08:00
 								## Source code
-												replace link to GitHub repository

											
										
										
											2021-04-21 21:31:11 +08:00
+								[packages/extension-list-item/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-list-item/)
-												add ordered list and list item

											
										
										
											2020-09-23 18:33:45 +08:00
 								## Usage
-												replace demo component with custom element

											
										
										
											2021-08-26 05:10:20 +08:00
+								<tiptap-demo name="Nodes/ListItem"></tiptap-demo>