mirror of
https://github.com/ueberdosis/tiptap.git
synced 2024-12-14 02:09:01 +08:00
33 lines
1.3 KiB
Markdown
33 lines
1.3 KiB
Markdown
# 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
|
||
* New list item: `Enter`
|
||
* Sink a list item: `Tab`
|
||
* Lift a list item: `Shift` `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>
|