@handlewithcare/react-prosemirror 3.1.0-tiptap.53 → 3.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (73) hide show
  1. package/README.md +3 -0
  2. package/dist/cjs/ReactEditorView.js +18 -7
  3. package/dist/cjs/components/ChildNodeViews.js +10 -16
  4. package/dist/cjs/components/CursorWrapper.js +6 -4
  5. package/dist/cjs/components/ProseMirror.js +12 -4
  6. package/dist/cjs/components/TextNodeView.js +7 -216
  7. package/dist/cjs/components/TrailingHackView.js +0 -70
  8. package/dist/cjs/components/nodes/NodeView.js +40 -4
  9. package/dist/cjs/contexts/ChildDescriptionsContext.js +1 -3
  10. package/dist/cjs/contexts/CompositionContext.js +14 -0
  11. package/dist/cjs/hooks/useMarkViewDescription.js +2 -63
  12. package/dist/cjs/hooks/useNodeViewDescription.js +2 -66
  13. package/dist/cjs/plugins/beforeInputPlugin.js +130 -120
  14. package/dist/cjs/plugins/reactKeys.js +16 -4
  15. package/dist/cjs/tiptap/tiptapNodeView.js +10 -9
  16. package/dist/cjs/viewdesc.js +4 -1
  17. package/dist/esm/ReactEditorView.js +18 -7
  18. package/dist/esm/components/ChildNodeViews.js +12 -18
  19. package/dist/esm/components/CursorWrapper.js +6 -4
  20. package/dist/esm/components/ProseMirror.js +12 -4
  21. package/dist/esm/components/TextNodeView.js +5 -165
  22. package/dist/esm/components/TrailingHackView.js +1 -71
  23. package/dist/esm/components/nodes/NodeView.js +38 -5
  24. package/dist/esm/contexts/ChildDescriptionsContext.js +1 -3
  25. package/dist/esm/contexts/CompositionContext.js +4 -0
  26. package/dist/esm/hooks/useIsEditorStatic.js +4 -1
  27. package/dist/esm/hooks/useMarkViewDescription.js +3 -64
  28. package/dist/esm/hooks/useNodeViewDescription.js +3 -67
  29. package/dist/esm/plugins/beforeInputPlugin.js +131 -121
  30. package/dist/esm/plugins/reactKeys.js +16 -4
  31. package/dist/esm/tiptap/ReactProseMirrorNodeView.js +1 -1
  32. package/dist/esm/tiptap/TiptapEditorContent.js +8 -1
  33. package/dist/esm/tiptap/hooks/useIsInReactProseMirror.js +5 -1
  34. package/dist/esm/tiptap/tiptapNodeView.js +13 -14
  35. package/dist/esm/viewdesc.js +4 -1
  36. package/dist/tsconfig.tsbuildinfo +1 -1
  37. package/dist/types/ReactEditorView.d.ts +8 -4
  38. package/dist/types/components/ChildNodeViews.d.ts +2 -2
  39. package/dist/types/components/CursorWrapper.d.ts +1 -1
  40. package/dist/types/components/TextNodeView.d.ts +6 -18
  41. package/dist/types/components/TrailingHackView.d.ts +1 -1
  42. package/dist/types/components/marks/DefaultMarkView.d.ts +1 -1
  43. package/dist/types/components/marks/MarkView.d.ts +1 -1
  44. package/dist/types/components/marks/MarkViewConstructorView.d.ts +1 -1
  45. package/dist/types/components/marks/ReactMarkView.d.ts +1 -1
  46. package/dist/types/components/nodes/DefaultNodeView.d.ts +1 -1
  47. package/dist/types/components/nodes/NodeView.d.ts +3 -1
  48. package/dist/types/components/nodes/NodeViewConstructorView.d.ts +1 -1
  49. package/dist/types/components/nodes/ReactNodeView.d.ts +1 -1
  50. package/dist/types/contexts/ChildDescriptionsContext.d.ts +1 -2
  51. package/dist/types/contexts/CompositionContext.d.ts +4 -0
  52. package/dist/types/hooks/useEditor.d.ts +2 -2
  53. package/dist/types/hooks/useIsEditorStatic.d.ts +4 -0
  54. package/dist/types/hooks/useMarkViewDescription.d.ts +1 -2
  55. package/dist/types/hooks/useNodeViewDescription.d.ts +1 -2
  56. package/dist/types/hooks/useReactKeys.d.ts +2 -5
  57. package/dist/types/plugins/reactKeys.d.ts +5 -5
  58. package/dist/types/props.d.ts +225 -225
  59. package/dist/types/tiptap/ReactProseMirrorNodeView.d.ts +1 -1
  60. package/dist/types/tiptap/TiptapEditorContent.d.ts +10 -1
  61. package/dist/types/tiptap/hooks/useIsInReactProseMirror.d.ts +5 -0
  62. package/dist/types/tiptap/tiptapNodeView.d.ts +5 -6
  63. package/dist/types/viewdesc.d.ts +2 -1
  64. package/package.json +20 -6
  65. package/dist/cjs/plugins/componentEventListeners.js +0 -28
  66. package/dist/cjs/plugins/componentEventListenersPlugin.js +0 -35
  67. package/dist/cjs/tiptap/utils/ssrJSDOMPatch.js +0 -59
  68. package/dist/esm/plugins/componentEventListeners.js +0 -18
  69. package/dist/esm/plugins/componentEventListenersPlugin.js +0 -25
  70. package/dist/esm/tiptap/utils/ssrJSDOMPatch.js +0 -56
  71. package/dist/types/plugins/componentEventListeners.d.ts +0 -3
  72. package/dist/types/plugins/componentEventListenersPlugin.d.ts +0 -4
  73. package/dist/types/tiptap/utils/ssrJSDOMPatch.d.ts +0 -1
@@ -2,13 +2,18 @@ import { EditorState } from "prosemirror-state";
2
2
  import { Decoration, DirectEditorProps, EditorProps, EditorView } from "prosemirror-view";
3
3
  import { AbstractEditorView, NodeViewSet } from "./AbstractEditorView.js";
4
4
  import { DOMNode, DOMSelection, DOMSelectionRange } from "./dom.js";
5
- import { NodeViewDesc, TextViewDesc, ViewDesc } from "./viewdesc.js";
5
+ import { NodeViewDesc, ViewDesc } from "./viewdesc.js";
6
6
  interface DOMObserver {
7
7
  observer: MutationObserver | null;
8
8
  queue: MutationRecord[];
9
9
  start(): void;
10
10
  stop(): void;
11
11
  onSelectionChange(): void;
12
+ setCurSelection(): void;
13
+ disconnectSelection(): void;
14
+ connectSelection(): void;
15
+ flush(): void;
16
+ lastChangedTextNode: Text | null;
12
17
  }
13
18
  interface InputState {
14
19
  composing: boolean;
@@ -33,7 +38,7 @@ interface InputState {
33
38
  mouseDown: {
34
39
  allowDefault: boolean;
35
40
  delayedSelectionSync: boolean;
36
- };
41
+ } | null;
37
42
  }
38
43
  /**
39
44
  * Extends EditorView to make prop and state updates pure, remove the DOM
@@ -61,8 +66,7 @@ export declare class ReactEditorView extends EditorView implements AbstractEdito
61
66
  private nextProps;
62
67
  private prevState;
63
68
  private _destroyed;
64
- compositionStarting: boolean;
65
- displacedNodes: TextViewDesc[];
69
+ cursorWrapped: boolean;
66
70
  constructor(place: {
67
71
  mount: HTMLElement;
68
72
  }, props: DirectEditorProps);
@@ -2,8 +2,8 @@ import { Node } from "prosemirror-model";
2
2
  import { Decoration, DecorationSource } from "prosemirror-view";
3
3
  import React from "react";
4
4
  export declare function wrapInDeco(reactNode: JSX.Element | string, deco: Decoration): React.DetailedReactHTMLElement<React.HTMLProps<HTMLElement>, HTMLElement> | React.FunctionComponentElement<any>;
5
- export declare const ChildNodeViews: React.NamedExoticComponent<{
5
+ export declare const ChildNodeViews: React.MemoExoticComponent<({ getPos, node, innerDecorations, }: {
6
6
  getPos: () => number;
7
7
  node: Node | undefined;
8
8
  innerDecorations: DecorationSource;
9
- }>;
9
+ }) => React.JSX.Element | null>;
@@ -1,3 +1,3 @@
1
1
  import React from "react";
2
2
  import { WidgetViewComponentProps } from "./WidgetViewComponentProps.js";
3
- export declare const CursorWrapper: React.ForwardRefExoticComponent<Omit<WidgetViewComponentProps<React.AllHTMLAttributes<HTMLElement>>, "ref"> & React.RefAttributes<HTMLImageElement>>;
3
+ export declare const CursorWrapper: React.ForwardRefExoticComponent<Omit<WidgetViewComponentProps, "ref"> & React.RefAttributes<HTMLImageElement>>;
@@ -1,29 +1,19 @@
1
1
  import { Node } from "prosemirror-model";
2
- import { DOMEventMap, Decoration } from "prosemirror-view";
3
- import React, { Component, MutableRefObject } from "react";
2
+ import { Decoration } from "prosemirror-view";
3
+ import { Component, MutableRefObject } from "react";
4
4
  import { AbstractEditorView } from "../AbstractEditorView.js";
5
- import { EventHandler } from "../hooks/useComponentEventListeners.js";
6
- import { CompositionViewDesc, TextViewDesc, ViewDesc } from "../viewdesc.js";
5
+ import { TextViewDesc, ViewDesc } from "../viewdesc.js";
7
6
  type Props = {
8
7
  view: AbstractEditorView;
9
8
  node: Node;
10
9
  getPos: () => number;
11
10
  siblingsRef: MutableRefObject<ViewDesc[]>;
12
11
  parentRef: MutableRefObject<ViewDesc | undefined>;
13
- findCompositionDOM: (compositionViewDesc: CompositionViewDesc) => void;
14
- forceRemount: () => void;
15
12
  decorations: readonly Decoration[];
16
- registerEventListener<EventType extends keyof DOMEventMap>(eventType: EventType, handler: EventHandler<EventType>): void;
17
- unregisterEventListener<EventType extends keyof DOMEventMap>(eventType: EventType, handler: EventHandler<EventType>): void;
18
13
  };
19
14
  export declare class TextNodeView extends Component<Props> {
20
- viewDescRef: React.MutableRefObject<CompositionViewDesc | TextViewDesc | null>;
21
- renderRef: React.MutableRefObject<JSX.Element | null>;
22
- wasProtecting: React.MutableRefObject<boolean | null>;
23
- containsCompositionNodeText: React.MutableRefObject<boolean | null>;
24
- shouldProtect(props: Props): boolean;
25
- handleCompositionEnd: () => void;
26
- create(): CompositionViewDesc | TextViewDesc | null;
15
+ viewDescRef: MutableRefObject<TextViewDesc | null>;
16
+ create(): TextViewDesc | null;
27
17
  update(): boolean;
28
18
  destroy(): void;
29
19
  updateEffect(): void;
@@ -31,9 +21,7 @@ export declare class TextNodeView extends Component<Props> {
31
21
  constructor(props: Props);
32
22
  componentDidMount(): void;
33
23
  componentDidUpdate(): void;
34
- private reattachAtCorrectPosition;
35
24
  componentWillUnmount(): void;
36
- render(): JSX.Element | null;
25
+ render(): JSX.Element;
37
26
  }
38
- export declare function RemountableTextNodeView(props: Omit<Props, "forceRemount">): React.JSX.Element;
39
27
  export {};
@@ -2,5 +2,5 @@ import React from "react";
2
2
  type Props = {
3
3
  getPos: () => number;
4
4
  };
5
- export declare function TrailingHackView({ getPos }: Props): React.JSX.Element | null;
5
+ export declare function TrailingHackView({ getPos }: Props): React.JSX.Element;
6
6
  export {};
@@ -1,3 +1,3 @@
1
1
  import React from "react";
2
2
  import { MarkViewComponentProps } from "./MarkViewComponentProps.js";
3
- export declare const DefaultMarkView: React.ForwardRefExoticComponent<Omit<MarkViewComponentProps<React.AllHTMLAttributes<HTMLElement>>, "ref"> & React.RefAttributes<HTMLElement>>;
3
+ export declare const DefaultMarkView: React.ForwardRefExoticComponent<Omit<MarkViewComponentProps, "ref"> & React.RefAttributes<HTMLElement>>;
@@ -6,5 +6,5 @@ type Props = {
6
6
  getPos: () => number;
7
7
  children: ReactNode;
8
8
  };
9
- export declare const MarkView: React.NamedExoticComponent<Props>;
9
+ export declare const MarkView: React.MemoExoticComponent<(props: Props) => React.JSX.Element>;
10
10
  export {};
@@ -8,5 +8,5 @@ interface Props {
8
8
  getPos: () => number;
9
9
  children: ReactNode;
10
10
  }
11
- export declare const MarkViewConstructorView: React.NamedExoticComponent<Props>;
11
+ export declare const MarkViewConstructorView: React.MemoExoticComponent<({ constructor, mark, inline, getPos, children, }: Props) => React.JSX.Element>;
12
12
  export {};
@@ -8,5 +8,5 @@ interface Props {
8
8
  inline: boolean;
9
9
  children: ReactNode;
10
10
  }
11
- export declare const ReactMarkView: React.NamedExoticComponent<Props>;
11
+ export declare const ReactMarkView: React.MemoExoticComponent<({ component: Component, mark, inline, getPos, children, }: Props) => React.JSX.Element>;
12
12
  export {};
@@ -1,3 +1,3 @@
1
1
  import React from "react";
2
2
  import { NodeViewComponentProps } from "../nodes/NodeViewComponentProps.js";
3
- export declare const DefaultNodeView: React.ForwardRefExoticComponent<Omit<NodeViewComponentProps<React.AllHTMLAttributes<HTMLElement>>, "ref"> & React.RefAttributes<HTMLElement>>;
3
+ export declare const DefaultNodeView: React.ForwardRefExoticComponent<Omit<NodeViewComponentProps, "ref"> & React.RefAttributes<HTMLElement>>;
@@ -6,7 +6,9 @@ type Props = {
6
6
  getPos: () => number;
7
7
  outerDeco: readonly Decoration[];
8
8
  innerDeco: DecorationSource;
9
+ forceRemount: () => void;
9
10
  };
10
- export declare const NodeView: React.NamedExoticComponent<Props>;
11
+ export declare const NodeView: React.MemoExoticComponent<({ forceRemount, ...props }: Props) => JSX.Element | null>;
11
12
  export declare const GetPosContext: React.Context<() => number>;
13
+ export declare function RemountableNodeView(props: Omit<Props, "forceRemount">): React.JSX.Element;
12
14
  export {};
@@ -8,5 +8,5 @@ interface Props {
8
8
  innerDeco: DecorationSource;
9
9
  outerDeco: readonly Decoration[];
10
10
  }
11
- export declare const NodeViewConstructorView: React.NamedExoticComponent<Props>;
11
+ export declare const NodeViewConstructorView: React.MemoExoticComponent<({ constructor, node, getPos, innerDeco, outerDeco, }: Props) => React.FunctionComponentElement<any>>;
12
12
  export {};
@@ -9,5 +9,5 @@ type Props = {
9
9
  node: Node;
10
10
  innerDeco: DecorationSource;
11
11
  };
12
- export declare const ReactNodeView: React.NamedExoticComponent<Props>;
12
+ export declare const ReactNodeView: React.MemoExoticComponent<({ component: Component, outerDeco, getPos, node, innerDeco, }: Props) => React.JSX.Element>;
13
13
  export {};
@@ -1,8 +1,7 @@
1
1
  import { MutableRefObject } from "react";
2
- import { CompositionViewDesc, ViewDesc } from "../viewdesc.js";
2
+ import { ViewDesc } from "../viewdesc.js";
3
3
  export type ChildDescriptionsContextValue = {
4
4
  parentRef: MutableRefObject<ViewDesc | undefined>;
5
5
  siblingsRef: MutableRefObject<ViewDesc[]>;
6
- findCompositionDOM: (compositionViewDesc: CompositionViewDesc) => void;
7
6
  };
8
7
  export declare const ChildDescriptionsContext: import("react").Context<ChildDescriptionsContextValue>;
@@ -0,0 +1,4 @@
1
+ export interface CompositionContextValue {
2
+ freezeFrom: number | null;
3
+ }
4
+ export declare const CompositionContext: import("react").Context<CompositionContextValue>;
@@ -21,8 +21,8 @@ export declare function useEditor<T extends HTMLElement = HTMLElement>(mount: T
21
21
  editor: {
22
22
  view: AbstractEditorView;
23
23
  flushSyncRef: import("react").MutableRefObject<boolean>;
24
- registerEventListener: (eventType: keyof import("prosemirror-view").DOMEventMap, handler: import("./useComponentEventListeners.js").EventHandler<keyof import("prosemirror-view").DOMEventMap>) => void;
25
- unregisterEventListener: (eventType: keyof import("prosemirror-view").DOMEventMap, handler: import("./useComponentEventListeners.js").EventHandler<keyof import("prosemirror-view").DOMEventMap>) => void;
24
+ registerEventListener: (eventType: keyof import("prosemirror-view").DOMEventMap, handler: import("./useComponentEventListeners.js").EventHandler) => void;
25
+ unregisterEventListener: (eventType: keyof import("prosemirror-view").DOMEventMap, handler: import("./useComponentEventListeners.js").EventHandler) => void;
26
26
  isStatic: boolean;
27
27
  };
28
28
  state: EditorState;
@@ -1 +1,5 @@
1
+ /**
2
+ * Returns true if the nearest ProseMirror component
3
+ * is rendered with the `static` prop set to `true`.
4
+ */
1
5
  export declare function useIsEditorStatic(): boolean;
@@ -1,7 +1,7 @@
1
1
  import { MarkViewConstructor } from "prosemirror-view";
2
2
  import { MarkViewComponentProps } from "../components/marks/MarkViewComponentProps.js";
3
3
  import { DOMNode } from "../dom.js";
4
- import { CompositionViewDesc, MarkViewDesc, ViewDesc } from "../viewdesc.js";
4
+ import { MarkViewDesc, ViewDesc } from "../viewdesc.js";
5
5
  type Props = Omit<MarkViewComponentProps["markProps"], "contentDOMRef">;
6
6
  export declare function useMarkViewDescription(getDOM: () => DOMNode | null, getContentDOM: (markView: {
7
7
  contentDOM?: HTMLElement | null;
@@ -9,7 +9,6 @@ export declare function useMarkViewDescription(getDOM: () => DOMNode | null, get
9
9
  childContextValue: {
10
10
  parentRef: import("react").MutableRefObject<MarkViewDesc | undefined>;
11
11
  siblingsRef: import("react").MutableRefObject<ViewDesc[]>;
12
- findCompositionDOM: (compositionViewDesc: CompositionViewDesc) => void;
13
12
  };
14
13
  contentDOM: HTMLElement | undefined;
15
14
  refUpdated: () => void;
@@ -1,7 +1,7 @@
1
1
  import { NodeViewConstructor } from "prosemirror-view";
2
2
  import { NodeViewComponentProps } from "../components/nodes/NodeViewComponentProps.js";
3
3
  import { DOMNode } from "../dom.js";
4
- import { CompositionViewDesc, NodeViewDesc, ViewDesc } from "../viewdesc.js";
4
+ import { NodeViewDesc, ViewDesc } from "../viewdesc.js";
5
5
  type Props = Omit<NodeViewComponentProps["nodeProps"], "contentDOMRef">;
6
6
  export declare function useNodeViewDescription(getDOM: () => DOMNode | null, getContentDOM: (nodeView: {
7
7
  contentDOM?: HTMLElement | null;
@@ -9,7 +9,6 @@ export declare function useNodeViewDescription(getDOM: () => DOMNode | null, get
9
9
  childContextValue: {
10
10
  parentRef: import("react").MutableRefObject<NodeViewDesc | undefined>;
11
11
  siblingsRef: import("react").MutableRefObject<ViewDesc[]>;
12
- findCompositionDOM: (compositionViewDesc: CompositionViewDesc) => void;
13
12
  };
14
13
  contentDOM: HTMLElement | null;
15
14
  refUpdated: () => void;
@@ -1,5 +1,2 @@
1
- export declare function useReactKeys(): {
2
- posToKey: Map<number, string>;
3
- keyToPos: Map<string, number>;
4
- posToNode: Map<number, import("prosemirror-model").Node>;
5
- } | undefined;
1
+ import { ReactKeysPluginState } from "../plugins/reactKeys.js";
2
+ export declare function useReactKeys(): ReactKeysPluginState | undefined;
@@ -1,16 +1,17 @@
1
1
  import { Plugin, PluginKey } from "prosemirror-state";
2
2
  import { Decoration } from "prosemirror-view";
3
3
  export declare function createNodeKey(): string;
4
- interface ReactKeysPluginState {
4
+ export interface ReactKeysPluginState {
5
5
  posToKey: Map<number, string>;
6
6
  keyToPos: Map<string, number>;
7
7
  cursorWrapper: Decoration | null;
8
+ freezeFrom: number | null;
8
9
  }
9
10
  export declare const reactKeysPluginKey: PluginKey<ReactKeysPluginState>;
10
11
  export type ReactKeysPluginMeta = {
11
- overrides: Record<number, number>;
12
- } | {
13
- cursorWrapper: Decoration | null;
12
+ overrides?: Record<number, number>;
13
+ cursorWrapper?: Decoration | null;
14
+ freezeFrom?: number | null;
14
15
  } | undefined;
15
16
  /**
16
17
  * Tracks a unique key for each (non-text) node in the
@@ -20,4 +21,3 @@ export type ReactKeysPluginMeta = {
20
21
  * current position in the document, and vice versa.
21
22
  */
22
23
  export declare function reactKeys(): Plugin<ReactKeysPluginState>;
23
- export {};