Class ProseMirrorContentLinkPlugin

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

Hierarchy

ProseMirrorPlugin
- ProseMirrorContentLinkPlugin

Index

Constructors

constructor

Methods

Constructors

constructor

new ProseMirrorContentLinkPlugin(schema: Schema, options?: ProseMirrorContentLinkOptions): ProseMirrorContentLinkPlugin

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

Methods

Protected _onDrop

_onDrop(view: EditorView, event: DragEvent, slice: Slice, moved: boolean): boolean

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 boolean

Static build

build(schema: any, options?: {}): Plugin<any>

Overrides ProseMirrorPlugin.build

Build the plugin.

Parameters
- schema: any
  
  The ProseMirror schema to build the plugin against.
- options: {} = {}
Returns Plugin<any>