Class NodeView<Component, NodeEditor, Options>

constructor

• new NodeView<
      Component,
      NodeEditor extends Editor = Editor,
      Options extends NodeViewRendererOptions = NodeViewRendererOptions,
  >(
      component: Component,
      props: NodeViewRendererProps,
      options?: Partial<Options>,
  ): NodeView<Component, NodeEditor, Options>

  Type Parameters

  • Component
  • NodeEditor extends Editor = Editor
  • Options extends NodeViewRendererOptions = NodeViewRendererOptions

  Parameters

  • component: Component
  • props: NodeViewRendererProps
  • Optionaloptions: Partial<Options>

  Returns NodeView<Component, NodeEditor, Options>

component

decorations

editor

extension

getPos

HTMLAttributes

innerDecorations

isDragging

node

options

view

contentDOM

• get contentDOM(): HTMLElement | null

  The DOM node that should hold the node's content. Only meaningful if the node view also defines a dom property and if its node type is not a leaf node type. When this is present, ProseMirror will take care of rendering the node's children into it. When it is not present, the node view itself is responsible for rendering (or deciding not to render) its child nodes.

  Returns HTMLElement | null

dom

• get dom(): HTMLElement

  The outer DOM node that represents the document node.

  Returns HTMLElement

deleteNode

• deleteNode(): void

  Delete the node.

  Returns void

ignoreMutation

• ignoreMutation(mutation: ViewMutationRecord): boolean

  Called when a DOM mutation or a selection change happens within the view.

  Parameters

  • mutation: ViewMutationRecord

  Returns boolean

  false if the editor should re-read the selection or re-parse the range around the mutation

mount

• mount(): void

  Returns void

onDragStart

• onDragStart(event: DragEvent): void

  Parameters

  • event: DragEvent

  Returns void

stopEvent

• stopEvent(event: Event): boolean

  Can be used to prevent the editor view from trying to handle some or all DOM events that bubble up from the node view. Events for which this returns true are not handled by the editor.

  Parameters

  • event: Event

  Returns boolean

updateAttributes

• updateAttributes(attributes: Record<string, any>): void

  Update the attributes of the prosemirror node.

  Parameters

  • attributes: Record<string, any>

  Returns void