tiptap/docs/src/docPages/api/editor.md

Editor

toc

Introduction

This class is a central building block of tiptap. It does most of the heavy lifting of creating a working ProseMirror editor such as creating the EditorView, setting the initial EditorState and so on.

Methods

The editor instance will provide a bunch of public methods. They’ll help you to work with the editor.

Don’t confuse methods with commands. Commands are used to change the state of editor (content, selection, and so on) and only return true or false. Methods are regular functions and can return anything.

Method	Parameters	Description
can()	-	Check if a command or a command chain can be executed. Without executing it.
chain()	-	Create a command chain to call multiple commands at once.
destroy()	–	Stops the editor instance and unbinds all events.
getHTML()	–	Returns the current content as HTML.
getJSON()	–	Returns the current content as JSON.
getMarkAttributes()	name Name of the mark	Get attributes of the currently selected mark.
getNodeAttributes()	name Name of the node	Get attributes of the currently selected node.
isActive()	name Name of the node or mark attrs Attributes of the node or mark	Returns if the currently selected node or mark is active.
isEditable()	-	Returns whether the editor is editable.
isEmpty()	-	Check if there is no content.
getCharacterCount()	-	Get the number of characters for the current document.
registerPlugin()	plugin A ProseMirror plugin handlePlugins Control how to merge the plugin into the existing plugins.	Register a ProseMirror plugin.
setOptions()	options A list of options	Update editor options.
unregisterPlugin()	name The plugins name	Unregister a ProseMirror plugin.

Settings

Element

The element specifies the HTML element the editor will be binded too. The following code will integrate tiptap with an element with the .element class:

import { Editor } from '@tiptap/core'
import { defaultExtensions } from '@tiptap/starter-kit'

new Editor({
  element: document.querySelector('.element'),
  extensions: defaultExtensions(),
})

You can even initiate your editor before mounting it to an element. This is useful when your DOM is not yet available. Just leave out the element, we’ll create one for you. Append it to your container at a later date like that:

yourContainerElement.append(editor.options.element)

Extensions

It’s required to pass a list of extensions to the extensions property, even if you only want to allow paragraphs.

import { Editor } from '@tiptap/core'
import { defaultExtensions } from '@tiptap/starter-kit'
import Document from '@tiptap/extension-document'
import Paragraph from '@tiptap/extension-paragraph'
import Text from '@tiptap/extension-text'
import Highlight from '@tiptap/extension-highlight'

new Editor({
  // Use the default extensions
  extensions: defaultExtensions(),

  // … or use specific extensions
  extensions: [
    Document,
    Paragraph,
    Text,
  ],

  // … or both
  extensions: [
    ...defaultExtensions(),
    Highlight,
  ],
})

Content

With the content property you can provide the initial content for the editor. This can be HTML or JSON.

import { Editor } from '@tiptap/core'
import { defaultExtensions } from '@tiptap/starter-kit'

new Editor({
  content: `<p>Example Text</p>`,
  extensions: defaultExtensions(),
})

Editable

The editable property determines if users can write into the editor.

import { Editor } from '@tiptap/core'
import { defaultExtensions } from '@tiptap/starter-kit'

new Editor({
  content: `<p>Example Text</p>`,
  extensions: defaultExtensions(),
  editable: false,
})

Autofocus

With autofocus you can force the cursor to jump in the editor on initialization.

import { Editor } from '@tiptap/core'
import { defaultExtensions } from '@tiptap/starter-kit'

new Editor({
  extensions: defaultExtensions(),
  autofocus: false,
})

Value	Description
'start'	Sets the focus to the beginning of the document.
'end'	Sets the focus to the end of the document.
Number	Sets the focus to a specific position in the document.
true	Enables autofocus.
false	Disables autofocus.
null	Disables autofocus.

Enable input rules

By default, tiptap enables all input rules. With enableInputRules you can disable that.

import { Editor } from '@tiptap/core'
import { defaultExtensions } from '@tiptap/starter-kit'

new Editor({
  content: `<p>Example Text</p>`,
  extensions: defaultExtensions(),
  enableInputRules: false,
})

Enable paste rules

By default, tiptap enables all paste rules. With enablePasteRules you can disable that.

import { Editor } from '@tiptap/core'
import { defaultExtensions } from '@tiptap/starter-kit'

new Editor({
  content: `<p>Example Text</p>`,
  extensions: defaultExtensions(),
  enablePasteRules: false,
})

Inject CSS

By default, tiptap injects a little bit of CSS. With injectCSS you can disable that.

import { Editor } from '@tiptap/core'
import { defaultExtensions } from '@tiptap/starter-kit'

new Editor({
  extensions: defaultExtensions(),
  injectCSS: false,
})

Editor props

For advanced use cases, you can pass editorProps which will be handled by ProseMirror. Here is an example how you can pass a few Tailwind classes to the editor container, but there is a lot more you can do.

new Editor({
  // Learn more: https://prosemirror.net/docs/ref/#view.EditorProps
  editorProps: {
    attributes: {
      class: 'prose prose-sm sm:prose lg:prose-lg xl:prose-2xl mx-auto focus:outline-none',
    }
  },
})

Parse options

Passed content is parsed by ProseMirror. To hook into the parsing, you can pass parseOptions which are then handled by ProseMirror.

new Editor({
  // Learn more: https://prosemirror.net/docs/ref/#model.ParseOptions
  parseOptions: {
    preserveWhitespace: 'full',
  },
})