Class Editor

constructor

• new Editor(options?: Partial<EditorOptions>): Editor

  Parameters

  • Optionaloptions: Partial<EditorOptions>

  Returns Editor

extensionManager

extensionStorage

instanceId

isCapturingTransaction

isFocused

isInitialized

options

schema

$doc

• get $doc(): NodePos

  Returns NodePos

commands

• get commands(): SingleCommands

  An object of all registered commands.

  Returns SingleCommands

isDestroyed

• get isDestroyed(): boolean

  Check if the editor is already destroyed.

  Returns boolean

isEditable

• get isEditable(): boolean

  Returns whether the editor is editable.

  Returns boolean

isEmpty

• get isEmpty(): boolean

  Check if there is no content.

  Returns boolean

state

• get state(): EditorState

  Returns the editor state.

  Returns EditorState

storage

• get storage(): Storage

  Returns the editor storage.

  Returns Storage

view

• get view(): EditorView

  Returns the editor state.

  Returns EditorView

$node

• $node(selector: string, attributes?: { [key: string]: any }): null | NodePos

  Parameters

  • selector: string
  • Optionalattributes: { [key: string]: any }

  Returns null | NodePos

$nodes

• $nodes(selector: string, attributes?: { [key: string]: any }): null | NodePos[]

  Parameters

  • selector: string
  • Optionalattributes: { [key: string]: any }

  Returns null | NodePos[]

$pos

• $pos(pos: number): NodePos

  Parameters

  • pos: number

  Returns NodePos

can

• can(): CanCommands

  Check if a command or a command chain can be executed. Without executing it.

  Returns CanCommands

captureTransaction

• captureTransaction(fn: () => void): null | Transaction

  Parameters

  • fn: () => void

  Returns null | Transaction

chain

• chain(): ChainedCommands

  Create a command chain to call multiple commands at once.

  Returns ChainedCommands

createNodeViews

• createNodeViews(): void

  Creates all node and mark views.

  Returns void

destroy

• destroy(): void

  Destroy the editor.

  Returns void

getAttributes

• getAttributes(nameOrType: string | NodeType | MarkType): Record<string, any>

  Get attributes of the currently selected node or mark.

  Parameters

  • nameOrType: string | NodeType | MarkType

  Returns Record<string, any>

getHTML

• getHTML(): string

  Get the document as HTML.

  Returns string

getJSON

• getJSON(): DocumentType<
      undefined
      | Record<string, any>,
      NodeType<
          string,
          undefined
          | Record<string, any>,
          any,
          (NodeType<any, any, any, any> | TextType<MarkType<any, any>>)[],
      >[],
  >

  Get the document as JSON.

  Returns DocumentType<
      undefined
      | Record<string, any>,
      NodeType<
          string,
          undefined
          | Record<string, any>,
          any,
          (NodeType<any, any, any, any> | TextType<MarkType<any, any>>)[],
      >[],
  >

getText

• getText(
      options?: {
          blockSeparator?: string;
          textSerializers?: Record<string, TextSerializer>;
      },
  ): string

  Get the document as text.

  Parameters

  • Optionaloptions: { blockSeparator?: string; textSerializers?: Record<string, TextSerializer> }

  Returns string

isActive

• isActive(name: string, attributes?: {}): boolean

  Returns if the currently selected node or mark is active.

  Parameters

  • name: string

    Name of the node or mark

  • Optionalattributes: {}

    Attributes of the node or mark

  Returns boolean

• isActive(attributes: {}): boolean

  Returns if the currently selected node or mark is active.

  Parameters

  • attributes: {}

    Attributes of the node or mark

  Returns boolean

mount

• mount(
      el: Element | { mount: HTMLElement } | ((editor: HTMLElement) => void),
  ): void

  Attach the editor to the DOM, creating a new editor view.

  Parameters

  • el: Element | { mount: HTMLElement } | ((editor: HTMLElement) => void)

  Returns void

prependClass

• prependClass(): void

  Prepend class name to element.

  Returns void

registerPlugin

• registerPlugin(
      plugin: Plugin,
      handlePlugins?: (
          newPlugin: Plugin,
          plugins: Plugin<any>[],
      ) => Plugin<any>[],
  ): EditorState

  Register a ProseMirror plugin.

  Parameters

  • plugin: Plugin

    A ProseMirror plugin

  • OptionalhandlePlugins: (newPlugin: Plugin, plugins: Plugin<any>[]) => Plugin<any>[]

    Control how to merge the plugin into the existing plugins.

  Returns EditorState

  The new editor state

setEditable

• setEditable(editable: boolean, emitUpdate?: boolean): void

  Update editable state of the editor.

  Parameters

  • editable: boolean
  • OptionalemitUpdate: boolean

  Returns void

setOptions

• setOptions(options?: Partial<EditorOptions>): void

  Update editor options.

  Parameters

  • Optionaloptions: Partial<EditorOptions>

    A list of options

  Returns void

unmount

• unmount(): void

  Remove the editor from the DOM, but still allow remounting at a different point in time

  Returns void

unregisterPlugin

• unregisterPlugin(
      nameOrPluginKeyToRemove:
          | string
          | PluginKey<any>
          | (string | PluginKey<any>)[],
  ): undefined | EditorState

  Unregister a ProseMirror plugin.

  Parameters

  • nameOrPluginKeyToRemove: string | PluginKey<any> | (string | PluginKey<any>)[]

    The plugins name

  Returns undefined | EditorState

  The new editor state or undefined if the editor is destroyed