Class ProseMirrorClickHandler

A class responsible for managing click events inside a ProseMirror editor.

Hierarchy (view full)

ProseMirrorPlugin
- ProseMirrorClickHandler

Index

Constructors

Methods

Constructors

constructor

new ProseMirrorClickHandler(schema): ProseMirrorClickHandler
An abstract class for building a ProseMirror Plugin.
Parameters
- schema: Schema
  The schema to build the plugin against.
Returns ProseMirrorClickHandler
See
Inherited from ProseMirrorPlugin.constructor

Methods

`Protected` _onClick

_onClick(view, pos, node, nodePos, event, direct): boolean | void
Protected
Handle a click on the editor.
Parameters
- view: EditorView
  The ProseMirror editor view.
- pos: number
  The position in the ProseMirror document that the click occurred at.
- node: Node
  The current ProseMirror Node that the click has bubbled to.
- nodePos: number
  The position of the click within this Node.
- event: PointerEvent
  The click event.
- direct: boolean
  Whether this Node is the one that was directly clicked on.
Returns boolean | void
A return value of true indicates the event has been handled, it will not propagate to other plugins, and ProseMirror will call preventDefault on it.

`Static` build

build(schema, options?): Plugin<any>
Parameters
- schema: any
- options: {} = {}
Returns Plugin<any>
Overrides ProseMirrorPlugin.build