Files
tiptap/docs/src/docPages/api/extensions/list-item.md
2020-09-23 12:33:45 +02:00

1.1 KiB
Raw Blame History

ListItem

The ListItem extension adds support for the <li> HTML tag. Its used for bullet lists and ordered lists and cant really be used without them.

Installation

::: warning Restrictions This extensions is intended to be used with the BulletList or OrderedList extension. It doesnt work without at least using one of them. :::

# With npm
npm install @tiptap/extension-list-item

# Or: 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 + Tab

Source code

packages/extension-list-item/

Usage