4.0 KiB
4.0 KiB
Editor
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.
Configuration
All of the listed settings can be set before initialization, or read during runtime, or some of them even updated for a running instance (e. g. editable).
| Setting | Type | Default | Description |
|---|---|---|---|
autoFocus |
Boolean |
false |
Focus the editor on init. |
content |
`Object | String` | null |
dropCursor |
Object |
{} |
Config for prosemirror-dropcursor. |
editable |
Boolean |
true |
When set to false the editor is read-only. |
editorProps |
Object |
{} |
A list of Prosemirror editorProps. |
enableDropCursor |
Boolean |
true |
Enable/disable showing a cursor at the drop position when something is dragged over the editor. |
enableGapCursor |
Boolean |
true |
Enable/disable a cursor at places that don’t allow regular selection (such as positions that have a leaf block node, table, or the end of the document both before and after them). |
extensions |
Array |
[] |
A list of extensions used, by the editor. This can be Nodes, Marks or Plugins. |
parseOptions |
Object |
{} |
A list of Prosemirror parseOptions. |
onBlur |
Function |
undefined |
Returns an object with the event and current state and view of Prosemirror on blur. |
onFocus |
Function |
undefined |
Returns an object with the event and current state and view of Prosemirror on focus. |
onInit |
Function |
undefined |
Returns an object with the current state and view of Prosemirror on init. |
onUpdate |
Function |
undefined |
Returns an object with the current state of Prosemirror, a json() and html() function and the transaction on every change. |