mirror of
https://github.com/ueberdosis/tiptap.git
synced 2024-12-04 11:49:02 +08:00
44 lines
1.5 KiB
Markdown
44 lines
1.5 KiB
Markdown
---
|
||
description: Simply does its job. Doesn’t even care if it’s part of a bullet list or an ordered list.
|
||
icon: asterisk
|
||
---
|
||
|
||
# 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
|
||
npm install @tiptap/extension-list-item
|
||
```
|
||
|
||
This extension requires the [`BulletList`](/api/nodes/bullet-list) or [`OrderedList`](/api/nodes/ordered-list) node.
|
||
|
||
## Settings
|
||
|
||
### HTMLAttributes
|
||
Custom HTML attributes that should be added to the rendered HTML tag.
|
||
|
||
```js
|
||
ListItem.configure({
|
||
HTMLAttributes: {
|
||
class: 'my-custom-class',
|
||
},
|
||
})
|
||
```
|
||
|
||
## Keyboard shortcuts
|
||
| Command | Windows/Linux | macOS |
|
||
| --------------- | ------------------ | ------------------ |
|
||
| splitListItem() | `Enter` | `Enter` |
|
||
| sinkListItem() | `Tab` | `Tab` |
|
||
| liftListItem() | `Shift` `Tab` | `Shift` `Tab` |
|
||
|
||
## Source code
|
||
[packages/extension-list-item/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-list-item/)
|
||
|
||
## Usage
|
||
https://embed.tiptap.dev/preview/Nodes/ListItem
|