Keyboard Shortcuts

• Introduction
• Predefined keyboard shortcuts
  • Essentials
  • Text Formatting
  • Paragraph Formatting
  • Text Selection
• Overwrite keyboard shortcuts

#Introduction

Tiptap comes with sensible keyboard shortcut defaults. Depending on what you want to use it for, you’ll probably want to change those keyboard shortcuts to your liking. Let’s have a look at what we defined for you, and show you how to change it then!

#Predefined keyboard shortcuts

Most of the core extensions register their own keyboard shortcuts. Depending on what set of extension you use, not all of the below listed keyboard shortcuts work for your editor.

#Essentials

#Text Formatting

#Paragraph Formatting

#Text Selection

#Overwrite keyboard shortcuts

Keyboard shortcuts may be strings like 'Shift-Control-Enter'. Keys are based on the strings that can appear in event.key, concatenated with a -. There is a little tool called keycode.info, which shows the event.key interactively.

Use lowercase letters to refer to letter keys (or uppercase letters if you want shift to be held). You may use Space as an alias for the  .

Modifiers can be given in any order. Shift, Alt, Control and Cmd are recognized. For characters that are created by holding shift, the Shift prefix is implied, and should not be added explicitly.

You can use Mod as a shorthand for Cmd on Mac and Control on other platforms.

Here is an example how you can overwrite the keyboard shortcuts for an existing extension:

// 1. Import the extension
import BulletList from '@tiptap/extension-bullet-list'

// 2. Overwrite the keyboard shortcuts
const CustomBulletList = BulletList.extend({
  addKeyboardShortcuts() {
    return {
      // ↓ your new keyboard shortcut
      'Mod-l': () => this.editor.commands.toggleBulletList(),
    }
  },
})

// 3. Add the custom extension to your editor
new Editor({
  extensions: [
    CustomBulletList(),
    // …
  ],
})