tiptap/docs/api/keyboard-shortcuts.md

tableOfContents
true

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!

Funfact: We built a keyboard shortcut learning app, to which we manually added exercises for thousands of keyboard shortcuts for a bunch of tools.

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

Action	Windows/Linux	macOS
Copy	Control C	Cmd C
Cut	Control X	Cmd X
Paste	Control V	Cmd V
Paste without formatting	Control Shift V	Cmd Shift V
Undo	Control Z	Cmd Z
Redo	Control Shift Z	Cmd Shift Z
Add a line break	Shift Enter	Shift Enter

Text Formatting

Action	Windows/Linux	macOS
Bold	Control B	Cmd B
Italicize	Control I	Cmd I
Underline	Control U	Cmd U
Strikethrough	Control Shift X	Cmd Shift X
Highlight	Control Shift H	Cmd Shift H
Code	Control E	Cmd E

Paragraph Formatting

Action	Windows/Linux	macOS
Apply normal text style	Control Alt 0	Cmd Alt 0
Apply heading style 1	Control Alt 1	Cmd Alt 1
Apply heading style 2	Control Alt 2	Cmd Alt 2
Apply heading style 3	Control Alt 3	Cmd Alt 3
Apply heading style 4	Control Alt 4	Cmd Alt 4
Apply heading style 5	Control Alt 5	Cmd Alt 5
Apply heading style 6	Control Alt 6	Cmd Alt 6
Ordered list	Control Shift 7	Cmd Shift 7
Bullet list	Control Shift 8	Cmd Shift 8
Task list	Control Shift 9	Cmd Shift 9
Blockquote	Control Shift B	Cmd Shift B
Left align	Control Shift L	Cmd Shift L
Center align	Control Shift E	Cmd Shift E
Right align	Control Shift R	Cmd Shift R
Justify	Control Shift J	Cmd Shift J
Code block	Control Alt C	Cmd Alt C
Subscript	Control ,	Cmd ,
Superscript	Control .	Cmd .

Text Selection

Action	Windows/Linux	macOS
Select all	Control A	Cmd A
Extend selection one character to left	Shift ←	Shift ←
Extend selection one character to right	Shift →	Shift →
Extend selection one line up	Shift ↑	Shift ↑
Extend selection one line down	Shift ↓	Shift ↓
Extend selection to the beginning of the document	Control Shift ↑	Cmd Shift ↑
Extend selection to the end of the document	Control Shift ↓	Cmd Shift ↓

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(),
    // …
  ],
})