prosemirror-view 1.26.0 → 1.26.1

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 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

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
@@ -583,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.
@@ -636,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
@@ -746,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.

package/package.json

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

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

@@ -537,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.
@@ -579,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
@@ -672,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.