prosemirror-view 1.25.0 → 1.26.2

package/CHANGELOG.md

@@ -1,3 +1,21 @@
+## 1.26.2 (2022-06-22)
+
+### Bug fixes
+
+Mark prosemirror.css as having side effects in package.json.
+
+## 1.26.1 (2022-06-13)
+
+### Bug fixes
+
+Fix incorrect types for `handleDrop` and `decorations`. Document open properties on widget specs
+
+## 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

@@ -79,6 +79,10 @@ declare class Decoration {
         mapping
         */
         destroy?: (node: DOMNode) => void;
+        /**
+        Specs allow arbitrary additional properties.
+        */
+        [key: string]: any;
     }): Decoration;
     /**
     Creates an inline decoration, which adds the given attributes to
@@ -99,6 +103,10 @@ declare class Decoration {
         [`inclusiveStart`](https://prosemirror.net/docs/ref/#view.Decoration^inline^spec.inclusiveStart).
         */
         inclusiveEnd?: boolean;
+        /**
+        Specs may have arbitrary additional properties.
+        */
+        [key: string]: any;
     }): Decoration;
     /**
     Creates a node decoration. `from` and `to` should point precisely
@@ -536,7 +544,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;
@@ -575,7 +591,7 @@ interface EditorProps {
     default behavior).
     */
     handleDOMEvents?: {
-        [event in string]: (view: EditorView, event: DOMEventMap[event]) => boolean | void;
+        [event in keyof DOMEventMap]?: (view: EditorView, event: DOMEventMap[event]) => boolean | void;
     };
     /**
     Called when the editor receives a `keydown` event.
@@ -628,7 +644,7 @@ interface EditorProps {
     true if this drop moves from the current selection (which should
     thus be deleted).
     */
-    handleDrop?: (view: EditorView, event: MouseEvent, slice: Slice, moved: boolean) => boolean | void;
+    handleDrop?: (view: EditorView, event: DragEvent, slice: Slice, moved: boolean) => boolean | void;
     /**
     Called when the view, after updating its state, tries to scroll
     the selection into view. A handler function may return false to
@@ -738,7 +754,7 @@ interface EditorProps {
     A set of [document decorations](https://prosemirror.net/docs/ref/#view.Decoration) to show in the
     view.
     */
-    decorations?: (state: EditorState) => DecorationSource | null;
+    decorations?: (state: EditorState) => DecorationSource | null | undefined;
     /**
     When this returns false, the content of the view is not directly
     editable.
@@ -812,4 +828,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.2",
   "description": "ProseMirror's view component",
   "type": "module",
   "main": "dist/index.cjs",
@@ -13,7 +13,7 @@
     },
     "./style/prosemirror.css": "./style/prosemirror.css"
   },
-  "sideEffects": false,
+  "sideEffects": ["./style/prosemirror.css"],
   "style": "style/prosemirror.css",
   "license": "MIT",
   "maintainers": [

package/src/README.md

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

package/src/decoration.ts

@@ -182,6 +182,9 @@ export class Decoration {
     /// Called when the widget decoration is removed as a result of
     /// mapping
     destroy?: (node: DOMNode) => void
+
+    /// Specs allow arbitrary additional properties.
+    [key: string]: any
   }): Decoration {
     return new Decoration(pos, pos, new WidgetType(toDOM, spec))
   }
@@ -200,6 +203,9 @@ export class Decoration {
     /// See
     /// [`inclusiveStart`](#view.Decoration^inline^spec.inclusiveStart).
     inclusiveEnd?: boolean
+
+    /// Specs may have arbitrary additional properties.
+    [key: string]: any
   }) {
     return new Decoration(from, to, new InlineType(attrs, spec))
   }

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}
 
@@ -532,7 +537,7 @@ export interface EditorProps {
   /// `preventDefault` yourself (or not, if you want to allow the
   /// default behavior).
   handleDOMEvents?: {
-    [event in string]: (view: EditorView, event: DOMEventMap[event]) => boolean | void
+    [event in keyof DOMEventMap]?: (view: EditorView, event: DOMEventMap[event]) => boolean | void
   }
 
   /// Called when the editor receives a `keydown` event.
@@ -574,7 +579,7 @@ export interface EditorProps {
   /// Called when something is dropped on the editor. `moved` will be
   /// true if this drop moves from the current selection (which should
   /// thus be deleted).
-  handleDrop?: (view: EditorView, event: MouseEvent, slice: Slice, moved: boolean) => boolean | void
+  handleDrop?: (view: EditorView, event: DragEvent, slice: Slice, moved: boolean) => boolean | void
 
   /// Called when the view, after updating its state, tries to scroll
   /// the selection into view. A handler function may return false to
@@ -667,7 +672,7 @@ export interface EditorProps {
 
   /// A set of [document decorations](#view.Decoration) to show in the
   /// view.
-  decorations?: (state: EditorState) => DecorationSource | null
+  decorations?: (state: EditorState) => DecorationSource | null | undefined
 
   /// When this returns false, the content of the view is not directly
   /// editable.