prosemirror-view 1.25.0 → 1.26.0

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 1.26.0 (2022-06-07)
+
+### New features
+
+Export the `NodeViewConstructor` and `MarkViewConstructor` types. Include Node/MarkViewConstructor in doc template
+
 ## 1.25.0 (2022-06-01)
 
 ### New features

package/dist/index.d.ts

@@ -536,7 +536,15 @@ declare class EditorView {
     */
     dispatch(tr: Transaction): void;
 }
+/**
+The type of function [provided](https://prosemirror.net/docs/ref/#view.ViewProps.nodeViews) to
+create [node views](https://prosemirror.net/docs/ref/#view.NodeView).
+*/
 declare type NodeViewConstructor = (node: Node, view: EditorView, getPos: () => number, decorations: readonly Decoration[], innerDecorations: DecorationSource) => NodeView;
+/**
+The function types [used](https://prosemirror.net/docs/ref/#view.ViewProps.markViews) to create
+mark views.
+*/
 declare type MarkViewConstructor = (mark: Mark, view: EditorView, inline: boolean) => {
     dom: HTMLElement;
     contentDOM?: HTMLElement;
@@ -812,4 +820,4 @@ interface DirectEditorProps extends EditorProps {
     dispatchTransaction?: (tr: Transaction) => void;
 }
 
-export { DOMEventMap, Decoration, DecorationAttrs, DecorationSet, DecorationSource, DirectEditorProps, EditorProps, EditorView, NodeView };
+export { DOMEventMap, Decoration, DecorationAttrs, DecorationSet, DecorationSource, DirectEditorProps, EditorProps, EditorView, MarkViewConstructor, NodeView, NodeViewConstructor };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prosemirror-view",
-  "version": "1.25.0",
+  "version": "1.26.0",
   "description": "ProseMirror's view component",
   "type": "module",
   "main": "dist/index.cjs",

package/src/README.md

@@ -10,6 +10,10 @@ this module.
 
 @EditorProps
 
+@NodeViewConstructor
+
+@MarkViewConstructor
+
 @DirectEditorProps
 
 @NodeView

package/src/index.ts

@@ -497,9 +497,14 @@ function checkStateComponent(plugin: Plugin) {
     throw new RangeError("Plugins passed directly to the view must not have a state component")
 }
 
-type NodeViewConstructor = (node: Node, view: EditorView, getPos: () => number,
-                            decorations: readonly Decoration[], innerDecorations: DecorationSource) => NodeView
-type MarkViewConstructor = (mark: Mark, view: EditorView, inline: boolean) => {dom: HTMLElement, contentDOM?: HTMLElement}
+/// The type of function [provided](#view.ViewProps.nodeViews) to
+/// create [node views](#view.NodeView).
+export type NodeViewConstructor = (node: Node, view: EditorView, getPos: () => number,
+                                   decorations: readonly Decoration[], innerDecorations: DecorationSource) => NodeView
+
+/// The function types [used](#view.ViewProps.markViews) to create
+/// mark views.
+export type MarkViewConstructor = (mark: Mark, view: EditorView, inline: boolean) => {dom: HTMLElement, contentDOM?: HTMLElement}
 
 type NodeViewSet = {[name: string]: NodeViewConstructor | MarkViewConstructor}