@handlewithcare/react-prosemirror 2.4.10 → 2.4.12

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

@@ -0,0 +1,7 @@
+import type { ReactNode } from "react";
+import type { UseEditorViewOptions } from "../hooks/useEditorView.js";
+export interface EditorProps extends UseEditorViewOptions {
+    mount: HTMLElement | null;
+    children?: ReactNode | null;
+}
+export declare function Editor({ mount, children, ...options }: EditorProps): JSX.Element;

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

@@ -0,0 +1,6 @@
+import type { NodeViewsContextValue } from "../contexts/NodeViewsContext.js";
+type NodeViewsProps = {
+    portals: NodeViewsContextValue;
+};
+export declare function NodeViews({ portals }: NodeViewsProps): JSX.Element;
+export {};

package/dist/types/components/__tests__/LayoutGroup.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,19 @@
+import type { ReactPortal } from "react";
+import type { NodeKey } from "../plugins/react";
+type NodeViewRegistration = {
+    getPos: () => number;
+    portal: ReactPortal;
+};
+export interface NodeViewsContextValue {
+    [key: NodeKey]: NodeViewRegistration[];
+}
+/**
+ * A context containing a map of node view keys to portals.
+ *
+ * Each node view registers a portal under its parent's
+ * key. Each can then retrieve the list of portals under their
+ * key, allowing portals to be rendered with the appropriate
+ * hierarchy.
+ */
+export declare const NodeViewsContext: import("react").Context<NodeViewsContextValue>;
+export {};

package/dist/types/decorations/ReactWidgetType.d.ts

@@ -20,6 +20,7 @@ type ReactWidgetSpec = {
     stopEvent?: (event: Event) => boolean;
     ignoreSelection?: boolean;
     key?: string;
+    [key: string]: unknown;
 };
 export declare class ReactWidgetType implements DecorationType {
     Component: ForwardRefExoticComponent<RefAttributes<HTMLElement> & WidgetViewComponentProps>;

package/dist/types/hooks/__tests__/useNodeViews.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,23 @@
+import { EditorState } from "prosemirror-state";
+import type { Plugin, Transaction } from "prosemirror-state";
+import { EditorView } from "prosemirror-view";
+import type { EditorProps } from "prosemirror-view";
+import type { EditorContextValue } from "../contexts/EditorContext.js";
+import type { ReactNodeViewConstructor } from "../nodeViews/createReactNodeViewConstructor.js";
+export interface UseEditorViewOptions extends EditorProps {
+    nodeViews?: Record<string, ReactNodeViewConstructor>;
+    defaultState?: EditorState;
+    state?: EditorState;
+    plugins?: Plugin[];
+    view?: EditorView | null;
+    dispatchTransaction?(this: EditorView, tr: Transaction): void;
+}
+/**
+ * Creates, mounts, and manages a ProseMirror `EditorView`.
+ *
+ * All state and props updates are executed in a layout effect.
+ * To ensure that the EditorState and EditorView are never out of
+ * sync, it's important that the EditorView produced by this hook
+ * is only accessed through the provided hooks.
+ */
+export declare function useEditorView<T extends HTMLElement = HTMLElement>(mount: T | null, options: UseEditorViewOptions): EditorContextValue;

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

@@ -0,0 +1,9 @@
+import type { ReactNode } from "react";
+import type { NodeKey } from "../plugins/react.js";
+type Props = {
+    nodeKey: NodeKey;
+    children: ReactNode;
+};
+export declare function NodePosProvider({ nodeKey, children }: Props): JSX.Element;
+export declare function useNodePos(): number;
+export {};

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

@@ -0,0 +1,5 @@
+import type { ReactNodeViewConstructor } from "../nodeViews/createReactNodeViewConstructor.js";
+export declare function useNodeViews(nodeViews?: Record<string, ReactNodeViewConstructor>): {
+    nodeViews: any;
+    nodeViewsComponent: JSX.Element;
+};

package/dist/types/nodeViews/createReactNodeViewConstructor.d.ts

@@ -0,0 +1,48 @@
+import type { Node } from "prosemirror-model";
+import type { Decoration, DecorationSource, EditorView, NodeView, NodeViewConstructor } from "prosemirror-view";
+import type { ComponentType, ReactNode, ReactPortal } from "react";
+import type { NodeKey } from "../plugins/react.js";
+export interface NodeViewComponentProps {
+    decorations: readonly Decoration[];
+    node: Node;
+    children: ReactNode;
+    isSelected: boolean;
+}
+export type UnregisterElement = () => void;
+export type RegisterPortal = (view: EditorView, getPos: () => number, portal: ReactPortal) => UnregisterElement;
+export type ReactNodeView = NodeView & {
+    component?: ComponentType<NodeViewComponentProps>;
+};
+export type ReactNodeViewConstructor = (...args: Parameters<NodeViewConstructor>) => ReactNodeView;
+/**
+ * Identifies a node view constructor as having been created
+ * by @nytimes/react-prosemirror
+ */
+export declare const REACT_NODE_VIEW: unique symbol;
+/**
+ * Searches upward for the nearest node with a node key,
+ * returning the first node key it finds associated with
+ * a React node view.
+ *
+ * Returns the root key if no ancestor nodes have node keys.
+ */
+export declare function findNodeKeyUp(editorView: EditorView, pos: number): NodeKey;
+/**
+ * Factory function for creating nodeViewConstructors that
+ * render as React components.
+ *
+ * `NodeView` can be any React component that takes
+ * `NodeViewComponentProps`. It will be passed all of the
+ * arguments to the `nodeViewConstructor` except for
+ * `editorView`. NodeView components that need access
+ * directly to the EditorView should use the
+ * `useEditorViewEvent` and `useEditorViewLayoutEffect`
+ * hooks to ensure safe access.
+ *
+ * For contentful Nodes, the NodeView component will also
+ * be passed a `children` prop containing an empty element.
+ * ProseMirror will render content nodes into this element.
+ */
+export declare function createReactNodeViewConstructor(nodeViewConstructor: ReactNodeViewConstructor, registerPortal: RegisterPortal): ((node: Node, editorView: EditorView, getPos: () => number, decorations: readonly Decoration[], innerDecorations: DecorationSource) => NodeView) & {
+    [REACT_NODE_VIEW]: boolean;
+};

package/dist/types/nodeViews/phrasingContentTags.d.ts

@@ -0,0 +1 @@
+export declare const phrasingContentTags: string[];

package/dist/types/plugins/__tests__/react.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,21 @@
+import { Plugin, PluginKey } from "prosemirror-state";
+/**
+ * This is a stand-in for the doc node itself, which doesn't have a
+ * unique position to map to.
+ */
+export declare const ROOT_NODE_KEY: unique symbol;
+export type NodeKey = string | symbol;
+export declare function createNodeKey(): string;
+export type ReactPluginState = {
+    posToKey: Map<number, string>;
+    keyToPos: Map<NodeKey, number>;
+};
+export declare const reactPluginKey: PluginKey<ReactPluginState>;
+/**
+ * Tracks a unique key for each (non-text) node in the
+ * document, identified by its current position. Keys are
+ * (mostly) stable across transaction applications. The
+ * key for a given node can be accessed by that node's
+ * current position in the document, and vice versa.
+ */
+export declare function react(): Plugin<ReactPluginState>;

package/dist/types/props.d.ts

@@ -904,22 +904,22 @@ export declare function mergeReactProps(a: HTMLProps<HTMLElement>, b: HTMLProps<
     suppressContentEditableWarning?: boolean | undefined;
     suppressHydrationWarning?: boolean | undefined;
     accessKey?: string | undefined;
-    autoCapitalize?: "none" | (string & {}) | "off" | "on" | "sentences" | "words" | "characters" | undefined;
+    autoCapitalize?: "off" | "none" | "on" | "sentences" | "words" | "characters" | (string & {}) | undefined;
     autoFocus?: boolean | undefined;
-    contentEditable?: (boolean | "true" | "false") | "inherit" | "plaintext-only" | undefined;
+    contentEditable?: (boolean | "false" | "true") | "inherit" | "plaintext-only" | undefined;
     contextMenu?: string | undefined;
     dir?: string | undefined;
-    draggable?: (boolean | "true" | "false") | undefined;
-    enterKeyHint?: "search" | "enter" | "done" | "go" | "next" | "previous" | "send" | undefined;
+    draggable?: (boolean | "false" | "true") | undefined;
+    enterKeyHint?: "enter" | "done" | "go" | "next" | "previous" | "search" | "send" | undefined;
     hidden?: boolean | undefined;
     id?: string | undefined;
     lang?: string | undefined;
     nonce?: string | undefined;
     slot?: string | undefined;
-    spellCheck?: (boolean | "true" | "false") | undefined;
+    spellCheck?: (boolean | "false" | "true") | undefined;
     tabIndex?: number | undefined;
     title?: string | undefined;
-    translate?: "yes" | "no" | undefined;
+    translate?: "no" | "yes" | undefined;
     radioGroup?: string | undefined;
     role?: import("react").AriaRole | undefined;
     about?: string | undefined;
@@ -944,57 +944,57 @@ export declare function mergeReactProps(a: HTMLProps<HTMLElement>, b: HTMLProps<
     results?: number | undefined;
     security?: string | undefined;
     unselectable?: "off" | "on" | undefined;
-    inputMode?: "search" | "text" | "none" | "email" | "tel" | "url" | "numeric" | "decimal" | undefined;
+    inputMode?: "none" | "search" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | undefined;
     is?: string | undefined;
     exportparts?: string | undefined;
     part?: string | undefined;
     "aria-activedescendant"?: string | undefined;
-    "aria-atomic"?: (boolean | "true" | "false") | undefined;
-    "aria-autocomplete"?: "list" | "none" | "both" | "inline" | undefined;
+    "aria-atomic"?: (boolean | "false" | "true") | undefined;
+    "aria-autocomplete"?: "none" | "list" | "inline" | "both" | undefined;
     "aria-braillelabel"?: string | undefined;
     "aria-brailleroledescription"?: string | undefined;
-    "aria-busy"?: (boolean | "true" | "false") | undefined;
-    "aria-checked"?: boolean | "true" | "false" | "mixed" | undefined;
+    "aria-busy"?: (boolean | "false" | "true") | undefined;
+    "aria-checked"?: boolean | "false" | "true" | "mixed" | undefined;
     "aria-colcount"?: number | undefined;
     "aria-colindex"?: number | undefined;
     "aria-colindextext"?: string | undefined;
     "aria-colspan"?: number | undefined;
     "aria-controls"?: string | undefined;
-    "aria-current"?: boolean | "time" | "step" | "date" | "true" | "false" | "page" | "location" | undefined;
+    "aria-current"?: boolean | "false" | "true" | "page" | "step" | "location" | "date" | "time" | undefined;
     "aria-describedby"?: string | undefined;
     "aria-description"?: string | undefined;
     "aria-details"?: string | undefined;
-    "aria-disabled"?: (boolean | "true" | "false") | undefined;
-    "aria-dropeffect"?: "link" | "none" | "copy" | "move" | "execute" | "popup" | undefined;
+    "aria-disabled"?: (boolean | "false" | "true") | undefined;
+    "aria-dropeffect"?: "copy" | "none" | "link" | "execute" | "move" | "popup" | undefined;
     "aria-errormessage"?: string | undefined;
-    "aria-expanded"?: (boolean | "true" | "false") | undefined;
+    "aria-expanded"?: (boolean | "false" | "true") | undefined;
     "aria-flowto"?: string | undefined;
-    "aria-grabbed"?: (boolean | "true" | "false") | undefined;
-    "aria-haspopup"?: boolean | "dialog" | "menu" | "grid" | "listbox" | "tree" | "true" | "false" | undefined;
-    "aria-hidden"?: (boolean | "true" | "false") | undefined;
-    "aria-invalid"?: boolean | "true" | "false" | "grammar" | "spelling" | undefined;
+    "aria-grabbed"?: (boolean | "false" | "true") | undefined;
+    "aria-haspopup"?: boolean | "false" | "true" | "dialog" | "grid" | "listbox" | "menu" | "tree" | undefined;
+    "aria-hidden"?: (boolean | "false" | "true") | undefined;
+    "aria-invalid"?: boolean | "false" | "true" | "grammar" | "spelling" | undefined;
     "aria-keyshortcuts"?: string | undefined;
     "aria-label"?: string | undefined;
     "aria-labelledby"?: string | undefined;
     "aria-level"?: number | undefined;
     "aria-live"?: "off" | "assertive" | "polite" | undefined;
-    "aria-modal"?: (boolean | "true" | "false") | undefined;
-    "aria-multiline"?: (boolean | "true" | "false") | undefined;
-    "aria-multiselectable"?: (boolean | "true" | "false") | undefined;
+    "aria-modal"?: (boolean | "false" | "true") | undefined;
+    "aria-multiline"?: (boolean | "false" | "true") | undefined;
+    "aria-multiselectable"?: (boolean | "false" | "true") | undefined;
     "aria-orientation"?: "horizontal" | "vertical" | undefined;
     "aria-owns"?: string | undefined;
     "aria-placeholder"?: string | undefined;
     "aria-posinset"?: number | undefined;
-    "aria-pressed"?: boolean | "true" | "false" | "mixed" | undefined;
-    "aria-readonly"?: (boolean | "true" | "false") | undefined;
-    "aria-relevant"?: "text" | "all" | "additions" | "additions removals" | "additions text" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals" | undefined;
-    "aria-required"?: (boolean | "true" | "false") | undefined;
+    "aria-pressed"?: boolean | "false" | "true" | "mixed" | undefined;
+    "aria-readonly"?: (boolean | "false" | "true") | undefined;
+    "aria-relevant"?: "text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals" | undefined;
+    "aria-required"?: (boolean | "false" | "true") | undefined;
     "aria-roledescription"?: string | undefined;
     "aria-rowcount"?: number | undefined;
     "aria-rowindex"?: number | undefined;
     "aria-rowindextext"?: string | undefined;
     "aria-rowspan"?: number | undefined;
-    "aria-selected"?: (boolean | "true" | "false") | undefined;
+    "aria-selected"?: (boolean | "false" | "true") | undefined;
     "aria-setsize"?: number | undefined;
     "aria-sort"?: "none" | "ascending" | "descending" | "other" | undefined;
     "aria-valuemax"?: number | undefined;

package/package.json

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