List Keymap extension

VersionDownloads

The List Keymap extension modifies the default ProseMirror and Tiptap behavior. Without this extension, pressing backspace at the start of a list item keeps the list item content on the same line. With the List Keymap, the content is lifted into the list item above.

Install

npm install @tiptap/extension-list-keymap

Settings

listTypes

A array of list items and their parent wrapper node types.

Default:

;[
  {
    itemName: 'listItem',
    wrapperNames: ['bulletList', 'orderedList'],
  },
  {
    itemName: 'taskItem',
    wrapperNames: ['taskList'],
  },
]
ListKeymap.configure({
  listTypes: [
    {
      itemName: 'taskItem',
      wrapperNames: ['customTaskList'],
    },
  ],
})

Source code

packages/extension-list-keymap/