ListKit extension

The ListKit is a collection of all necessary Tiptap list extensions. If you quickly want to setup lists in Tiptap, this extension is for you.

Install

npm install @tiptap/extension-list

Included extensions

Nodes

BulletList
ListItem
OrderedList
TaskItem
TaskList

Extensions

ListKeymap

Source code

packages/extension-list/

Using the ListKit extension

Pass ListKit to the editor to load all included extension at once.

import { Editor } from '@tiptap/core'
import { ListKit } from '@tiptap/extension-list'

const editor = new Editor({
  extensions: [ListKit],
})

You can configure the included extensions, or even disable a few of them, like shown below.

import { Editor } from '@tiptap/core'
import { ListKit } from '@tiptap/extension-list'

const editor = new Editor({
  extensions: [
    ListKit.configure({
      // Disable an extension
      bulletList: false,

      // Configure an extension
      listItem: {
        HTMLAttributes: { class: 'list-item' },
      },
    }),
  ],
})