@handlewithcare/react-prosemirror 3.0.5 → 3.0.6

package/dist/types/components/CursorWrapper.d.ts

@@ -1,5 +1,3 @@
 import React from "react";
-export declare const CursorWrapper: React.ForwardRefExoticComponent<{
-    widget: import("../decorations/ReactWidgetType.js").ReactWidgetDecoration;
-    getPos: () => number;
-} & React.HTMLAttributes<HTMLElement> & React.RefAttributes<HTMLImageElement>>;
+import { WidgetViewComponentProps } from "./WidgetViewComponentProps.js";
+export declare const CursorWrapper: React.ForwardRefExoticComponent<Omit<WidgetViewComponentProps<React.AllHTMLAttributes<HTMLElement>>, "ref"> & React.RefAttributes<HTMLImageElement>>;

package/dist/types/components/WidgetViewComponentProps.d.ts

@@ -1,6 +1,7 @@
-import { HTMLAttributes } from "react";
+import { AllHTMLAttributes, LegacyRef } from "react";
 import { ReactWidgetDecoration } from "../decorations/ReactWidgetType.js";
-export type WidgetViewComponentProps = {
+export type WidgetViewComponentProps<Attributes = AllHTMLAttributes<HTMLElement>> = Attributes & {
     widget: ReactWidgetDecoration;
     getPos: () => number;
-} & HTMLAttributes<HTMLElement>;
+    ref: LegacyRef<any>;
+};

package/dist/types/contexts/EditorContext.d.ts

@@ -1,7 +1,7 @@
 import type { DOMEventMap } from "prosemirror-view";
 import { MutableRefObject } from "react";
 import { AbstractEditorView } from "../AbstractEditorView.js";
-import type { EventHandler } from "../plugins/componentEventListeners.js";
+import type { EventHandler } from "../hooks/useComponentEventListeners.js";
 export interface EditorContextValue {
     view: AbstractEditorView;
     flushSyncRef: MutableRefObject<boolean>;

package/dist/types/hooks/useComponentEventListeners.d.ts

@@ -1,5 +1,6 @@
-import type { DOMEventMap } from "prosemirror-view";
-import { EventHandler } from "../plugins/componentEventListeners.js";
+import type { DOMEventMap, EditorView } from "prosemirror-view";
+export type EventHandler<EventType extends keyof DOMEventMap = keyof DOMEventMap> = (view: EditorView, event: DOMEventMap[EventType]) => boolean | void;
+export type HandleDOMEvents = Record<keyof DOMEventMap, EventHandler | undefined>;
 /**
  * Produces a plugin that can be used with ProseMirror to handle DOM
  * events at the EditorView.dom element.
@@ -14,20 +15,20 @@ import { EventHandler } from "../plugins/componentEventListeners.js";
  * @privateRemarks
  *
  * This hook uses a combination of mutable and immutable updates to give
- * us precise control over when we re-create the ProseMirror plugin.
+ * us precise control over when we re-create the event listeners.
  *
- * The plugin has a mutable reference to the set of handlers for each
+ * The hook has a mutable reference to the set of handlers for each
  * event type, but the set of event types is static. This means that we
- * need to produce a new ProseMirror plugin whenever a new event type is
- * registered. We avoid producing a new ProseMirrer plugin in any other
- * scenario to avoid the performance overhead of reconfiguring the plugins
- * in the EditorView.
+ * need to produce a new handleDOMEVents record whenever a new event type is
+ * registered. We avoid producing a new record in any other
+ * scenario to avoid the performance overhead of re-registering the event
+ * listeners in the EditorView.
  *
  * To accomplish this, we shallowly clone the registry whenever a new event
  * type is registered.
  */
-export declare function useComponentEventListeners(): {
+export declare function useComponentEventListeners(handleDOMEventsProp: HandleDOMEvents | undefined): {
     registerEventListener: (eventType: keyof DOMEventMap, handler: EventHandler) => void;
     unregisterEventListener: (eventType: keyof DOMEventMap, handler: EventHandler) => void;
-    componentEventListenersPlugin: import("prosemirror-state").Plugin<any>;
+    handleDOMEvents: HandleDOMEvents;
 };

package/dist/types/hooks/useEditor.d.ts

@@ -21,8 +21,8 @@ export declare function useEditor<T extends HTMLElement = HTMLElement>(mount: T
     editor: {
         view: AbstractEditorView;
         flushSyncRef: import("react").MutableRefObject<boolean>;
-        registerEventListener: (eventType: keyof import("prosemirror-view").DOMEventMap, handler: import("../plugins/componentEventListeners.js").EventHandler<keyof import("prosemirror-view").DOMEventMap>) => void;
-        unregisterEventListener: (eventType: keyof import("prosemirror-view").DOMEventMap, handler: import("../plugins/componentEventListeners.js").EventHandler<keyof import("prosemirror-view").DOMEventMap>) => void;
+        registerEventListener: (eventType: keyof import("prosemirror-view").DOMEventMap, handler: import("./useComponentEventListeners.js").EventHandler<keyof import("prosemirror-view").DOMEventMap>) => void;
+        unregisterEventListener: (eventType: keyof import("prosemirror-view").DOMEventMap, handler: import("./useComponentEventListeners.js").EventHandler<keyof import("prosemirror-view").DOMEventMap>) => void;
         isStatic: boolean;
     };
     cursorWrapper: Decoration | null;

package/dist/types/hooks/useEditorEventListener.d.ts

@@ -1,5 +1,5 @@
 import type { DOMEventMap } from "prosemirror-view";
-import type { EventHandler } from "../plugins/componentEventListeners.js";
+import type { EventHandler } from "./useComponentEventListeners.js";
 /**
  * Attaches an event listener at the `EditorView`'s DOM node. See
  * [the ProseMirror docs](https://prosemirror.net/docs/ref/#view.EditorProps.handleDOMEvents)

package/dist/types/props.d.ts

@@ -960,7 +960,7 @@ export declare function mergeReactProps(a: HTMLProps<HTMLElement>, b: HTMLProps<
     "aria-colindextext"?: string | undefined;
     "aria-colspan"?: number | undefined;
     "aria-controls"?: string | undefined;
-    "aria-current"?: boolean | "false" | "true" | "page" | "step" | "location" | "date" | "time" | undefined;
+    "aria-current"?: boolean | "false" | "true" | "step" | "page" | "location" | "date" | "time" | undefined;
     "aria-describedby"?: string | undefined;
     "aria-description"?: string | undefined;
     "aria-details"?: string | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@handlewithcare/react-prosemirror",
-  "version": "3.0.5",
+  "version": "3.0.6",
   "license": "Apache-2.0",
   "type": "module",
   "main": "dist/cjs/index.js",

package/dist/cjs/plugins/componentEventListeners.js

@@ -1,35 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(exports, "componentEventListeners", {
-    enumerable: true,
-    get: function() {
-        return componentEventListeners;
-    }
-});
-const _prosemirrorstate = require("prosemirror-state");
-const _reactdom = require("react-dom");
-function componentEventListeners(eventHandlerRegistry) {
-    const domEventHandlers = {};
-    for (const [eventType, handlers] of eventHandlerRegistry.entries()){
-        function handleEvent(view, event) {
-            for (const handler of handlers){
-                let handled = false;
-                (0, _reactdom.unstable_batchedUpdates)(()=>{
-                    handled = !!handler.call(this, view, event);
-                });
-                if (handled || event.defaultPrevented) return true;
-            }
-            return false;
-        }
-        domEventHandlers[eventType] = handleEvent;
-    }
-    const plugin = new _prosemirrorstate.Plugin({
-        key: new _prosemirrorstate.PluginKey("@handlewithcare/react-prosemirror/componentEventListeners"),
-        props: {
-            handleDOMEvents: domEventHandlers
-        }
-    });
-    return plugin;
-}

package/dist/cjs/plugins/componentEventListenersPlugin.js

@@ -1,35 +0,0 @@
-/* Copyright (c) The New York Times Company */ "use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(exports, "createComponentEventListenersPlugin", {
-    enumerable: true,
-    get: function() {
-        return createComponentEventListenersPlugin;
-    }
-});
-const _prosemirrorstate = require("prosemirror-state");
-const _reactdom = require("react-dom");
-function createComponentEventListenersPlugin(eventHandlerRegistry) {
-    const domEventHandlers = {};
-    for (const [eventType, handlers] of eventHandlerRegistry.entries()){
-        function handleEvent(view, event) {
-            for (const handler of handlers){
-                let handled = false;
-                (0, _reactdom.unstable_batchedUpdates)(()=>{
-                    handled = !!handler.call(this, view, event);
-                });
-                if (handled || event.defaultPrevented) return true;
-            }
-            return false;
-        }
-        domEventHandlers[eventType] = handleEvent;
-    }
-    const plugin = new _prosemirrorstate.Plugin({
-        key: new _prosemirrorstate.PluginKey("componentEventListeners"),
-        props: {
-            handleDOMEvents: domEventHandlers
-        }
-    });
-    return plugin;
-}

package/dist/esm/plugins/componentEventListeners.js

@@ -1,25 +0,0 @@
-import { Plugin, PluginKey } from "prosemirror-state";
-import { unstable_batchedUpdates as batch } from "react-dom";
-export function componentEventListeners(eventHandlerRegistry) {
-    const domEventHandlers = {};
-    for (const [eventType, handlers] of eventHandlerRegistry.entries()){
-        function handleEvent(view, event) {
-            for (const handler of handlers){
-                let handled = false;
-                batch(()=>{
-                    handled = !!handler.call(this, view, event);
-                });
-                if (handled || event.defaultPrevented) return true;
-            }
-            return false;
-        }
-        domEventHandlers[eventType] = handleEvent;
-    }
-    const plugin = new Plugin({
-        key: new PluginKey("@handlewithcare/react-prosemirror/componentEventListeners"),
-        props: {
-            handleDOMEvents: domEventHandlers
-        }
-    });
-    return plugin;
-}

package/dist/esm/plugins/componentEventListenersPlugin.js

@@ -1,25 +0,0 @@
-/* Copyright (c) The New York Times Company */ import { Plugin, PluginKey } from "prosemirror-state";
-import { unstable_batchedUpdates as batch } from "react-dom";
-export function createComponentEventListenersPlugin(eventHandlerRegistry) {
-    const domEventHandlers = {};
-    for (const [eventType, handlers] of eventHandlerRegistry.entries()){
-        function handleEvent(view, event) {
-            for (const handler of handlers){
-                let handled = false;
-                batch(()=>{
-                    handled = !!handler.call(this, view, event);
-                });
-                if (handled || event.defaultPrevented) return true;
-            }
-            return false;
-        }
-        domEventHandlers[eventType] = handleEvent;
-    }
-    const plugin = new Plugin({
-        key: new PluginKey("componentEventListeners"),
-        props: {
-            handleDOMEvents: domEventHandlers
-        }
-    });
-    return plugin;
-}

package/dist/types/plugins/componentEventListeners.d.ts

@@ -1,4 +0,0 @@
-import { Plugin } from "prosemirror-state";
-import { DOMEventMap, EditorView } from "prosemirror-view";
-export type EventHandler<EventType extends keyof DOMEventMap = keyof DOMEventMap> = (this: Plugin, view: EditorView, event: DOMEventMap[EventType]) => boolean | void;
-export declare function componentEventListeners(eventHandlerRegistry: Map<keyof DOMEventMap, Iterable<EventHandler>>): Plugin<any>;

package/dist/types/plugins/componentEventListenersPlugin.d.ts

@@ -1,4 +0,0 @@
-import { Plugin } from "prosemirror-state";
-import { DOMEventMap, EditorView } from "prosemirror-view";
-export type EventHandler<EventType extends keyof DOMEventMap = keyof DOMEventMap> = (this: Plugin, view: EditorView, event: DOMEventMap[EventType]) => boolean | void;
-export declare function createComponentEventListenersPlugin(eventHandlerRegistry: Map<keyof DOMEventMap, Set<EventHandler>>): Plugin<any>;