Search

Upgrade Guide

toc

Reasons to upgrade to tiptap 2.x

Yes, it’s tedious work to upgrade your favorite text editor to a new API, but we made sure you’ve got enough reasons to upgrade to the newest version

  • Autocompletion in your IDE (thanks to TypeScript)
  • Amazing documentation with 100+ pages
  • Active development, new features in the making
  • Tons of new extensions planned
  • Well-tested code base

Upgrading from 1.x to 2.x

The new API will look pretty familiar to you, but there are a ton of changes though. To make the upgrade a little bit easier, here is everything you need to know:

Uninstall tiptap 1.x

The whole package structure has changed, we even moved to another npm namespace, so you’ll need to remove the old version entirely before upgrading to tiptap 2.

Otherwise you’ll run into an exception, for example “looks like multiple versions of prosemirror-model were loaded”.

# with npm
npm uninstall tiptap tiptap-commands tiptap-extensions tiptap-utils

# with Yarn
yarn remove tiptap tiptap-commands tiptap-extensions tiptap-utils

Install tiptap 2.x

Once you have uninstalled the old version of tiptap, install the new Vue 2 package and the starter kit:

# install with npm
npm install @tiptap/vue-2 @tiptap/starter-kit

# install with Yarn
yarn add @tiptap/vue-2 @tiptap/starter-kit

Explicitly register the Document, Text and Paragraph extensions

tiptap 1 tried to hide a few required extensions from you with the default setting useBuiltInExtensions: true. That setting has been removed and you’re required to import all extensions. Be sure to explicitly import at least the Document, Paragraph and Text extensions.

import Document from '@tiptap/extension-document'
import Paragraph from '@tiptap/extension-paragraph'
import Text from '@tiptap/extension-text'

new Editor({
  extensions: [
    Document,
    Paragraph,
    Text,
    // all your other extensions
  ],
})

And we removed some settings: dropCursor, enableDropCursor, and enableGapCursor. Those are separate extensions now: Dropcursor and Gapcursor. You probably want to load them, but if you don’t, just ignore this.

New names for most extensions

We switched to lowerCamelCase, so there’s a lot type names that changed. If you stored your content as JSON you need to loop through it and rename them. Sorry for that one.

Old typeNew type
bullet_listbulletList
code_blockcodeBlock
hard_breakhardBreak
horizontal_rulehorizontalRule
list_itemlistItem
ordered_listorderedList
table_celltableCell
table_headertableHeader
table_rowtableRow
todo_listtaskList (new name!)
todo_itemtaskItem (new name!)

Removed methods

We removed the .state() method. No worries though, it’s still available through editor.state.

New extension API

In case you’ve built some custom extensions for your project, you’re required to rewrite them to fit the new API. No worries, you can keep a lot of your work though. The schema, commands, keys, inputRules and pasteRules all work like they did before. It’s just different how you register them.

import { Node } from '@tiptap/core'

const CustomExtension = Node.create({
  name: 'custom_extension'
  defaultOptions: {},
  addAttributes() {},
  parseHTML() {},
  renderHTML({ node, HTMLAttributes }) {},
  addCommands() {},
  addKeyboardShortcuts() {},
  addInputRules() {},
  // and more …
})

Read more about all the nifty details building custom extensions in our guide.

Renamed settings and methods

We renamed a lot of settings and methods. Hopefully you can migrate to the new API with search & replace. Here is a list of what changed:

Old nameNew name
autoFocusautofocus

Renamed commands

All new extensions come with specific commands to set, unset and toggle styles. So instead of .bold(), it’s now .toggleBold(). Also, we switched to lowerCamelCase, below are a few examples. Oh, and we renamed todo_list, to taskList, sorry for that one.

Old commandNew command
.redo().redo() (nothing changed)
.undo().undo() (nothing changed)
.todo_list().toggleTaskList() (new name!)
.blockquote().toggleBlockquote()
.bold().toggleBold()
.bullet_list().toggleBulletList()
.code().toggleCode()
.code_block().toggleCodeBlock()
.hard_break().toggleHardBreak()
.heading().toggleHeading()
.horizontal_rule().toggleHorizontalRule()
.italic().toggleItalic()
.link().toggleLink()
.ordered_list().toggleOrderedList()
.paragraph().toggleParagraph()
.strike().toggleStrike()
.underline().toggleUnderline()

Read the dedicated guide on creating menus to migrate your menus.

Commands can be chained now

Most commands can be combined to one call now. That’s shorter than separate function calls in most cases. Here is an example to make the selected text bold:

editor.chain().toggleBold().focus().run()

The .chain() is required to start a new chain and the .run() is needed to actually execute all the commands in between. Read more about the new tiptap commands in our API documentation.

.focus() isn’t called on every command anymore

We tried to hide the .focus() command from you with tiptap 1 and executed that on every command. That led to issues in specific use cases, where you want to run a command, but don’t want to focus the editor.

With tiptap 2.x you have to explicitly call the focus() and you probably want to do that in a lot of places. Here is an example:

editor.chain().focus().toggleBold().run()

Event callbacks have fewer parameters

The new event callbacks have fewer parameters. The same things should be available through this. now. Read more about events here.

Collaborative editing

The reference implementation for collaborative editing uses Y.js now. That’s a whole different thing. You still can use the tiptap 1 extension, but it’s up to you to adapt it to the new extension API. If you’ve done this, don’t forget to share it with us so we can link to it from here!

Read more about the new collaborative editing experience in our guide.

Marks don’t support node view anymore

For marks, node views are not well supported in ProseMirror. There is also a related issue for tiptap 1. That’s why we removed it in tiptap 2.

Become a sponsor

tiptap wouldn’t exist without the funding of its community. If you fell in love with tiptap, don’t forget to become a sponsor and make the maintenance, development and support sustainable.

In exchange, we’ll take you into our hearts, invite you to private repositories, add a sponsor ♥ label to your issues and pull requests and more.