Class ProseMirrorContentLinkPlugin

A class responsible for handling the dropping of Documents onto the editor and creating content links for them.

Hierarchy (View Summary)

ProseMirrorPlugin
- ProseMirrorContentLinkPlugin

Index

Constructors

Accessors

Methods

Constructors

constructor

new ProseMirrorContentLinkPlugin(
schema: Schema,
options?: ProseMirrorContentLinkOptions,
): ProseMirrorContentLinkPlugin
Parameters
- schema: Schema
  The ProseMirror schema.
- options: ProseMirrorContentLinkOptions = {}
  Additional options to configure the plugin's behaviour.
Returns ProseMirrorContentLinkPlugin
Overrides ProseMirrorPlugin.constructor

Accessors

`Static`key

get key(): PluginKey<any>
A unique key for this plugin that can be used to identify a plugin instance in any given editor.

Returns PluginKey<any>
Inherited from ProseMirrorPlugin.key

Methods

`Protected`_onDrop

_onDrop(
    view: EditorView,
    event: DragEvent,
    slice: Slice,
    moved: boolean,
): true | undefined
Protected
Handle a drop onto the editor.
Parameters
- view: EditorView
  The ProseMirror editor view.
- event: DragEvent
  The drop event.
- slice: Slice
  A slice of editor content.
- moved: boolean
  Whether the slice has been moved from a different part of the editor.
Returns true | undefined

`Static`build

build(schema: any, options?: {}): Plugin<any>
Build the plugin.
Parameters
- schema: any
  The ProseMirror schema to build the plugin against.
- options: {} = {}
  Additional options to pass to the plugin.
Returns Plugin<any>
Overrides ProseMirrorPlugin.build