ListItem

Version Downloads

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

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

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

This extension requires the BulletList or OrderedList node.

Settings

HTMLAttributes

Custom HTML attributes that should be added to the rendered HTML tag.

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/

Usage