@handlewithcare/react-prosemirror 3.1.0-tiptap.52 → 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 (75) hide show
  1. package/README.md +3 -0
  2. package/dist/cjs/ReactEditorView.js +18 -1
  3. package/dist/cjs/components/ChildNodeViews.js +4 -4
  4. package/dist/cjs/components/CursorWrapper.js +9 -11
  5. package/dist/cjs/components/ProseMirror.js +13 -3
  6. package/dist/cjs/components/TextNodeView.js +54 -50
  7. package/dist/cjs/components/WidgetView.js +3 -1
  8. package/dist/cjs/components/nodes/NodeView.js +40 -4
  9. package/dist/cjs/contexts/CompositionContext.js +14 -0
  10. package/dist/cjs/decorations/viewDecorations.js +1 -6
  11. package/dist/cjs/hooks/useEditor.js +2 -10
  12. package/dist/cjs/hooks/useMarkViewDescription.js +1 -4
  13. package/dist/cjs/hooks/useNodeViewDescription.js +1 -22
  14. package/dist/cjs/plugins/beforeInputPlugin.js +162 -50
  15. package/dist/cjs/plugins/reactKeys.js +34 -15
  16. package/dist/cjs/tiptap/tiptapNodeView.js +10 -9
  17. package/dist/cjs/viewdesc.js +55 -4
  18. package/dist/esm/ReactEditorView.js +18 -1
  19. package/dist/esm/components/ChildNodeViews.js +5 -5
  20. package/dist/esm/components/CursorWrapper.js +9 -11
  21. package/dist/esm/components/ProseMirror.js +13 -3
  22. package/dist/esm/components/TextNodeView.js +56 -52
  23. package/dist/esm/components/WidgetView.js +3 -1
  24. package/dist/esm/components/nodes/NodeView.js +38 -5
  25. package/dist/esm/contexts/CompositionContext.js +4 -0
  26. package/dist/esm/decorations/viewDecorations.js +1 -6
  27. package/dist/esm/hooks/useEditor.js +2 -10
  28. package/dist/esm/hooks/useIsEditorStatic.js +4 -1
  29. package/dist/esm/hooks/useMarkViewDescription.js +1 -4
  30. package/dist/esm/hooks/useNodeViewDescription.js +2 -23
  31. package/dist/esm/plugins/beforeInputPlugin.js +162 -50
  32. package/dist/esm/plugins/reactKeys.js +34 -15
  33. package/dist/esm/tiptap/ReactProseMirrorNodeView.js +1 -1
  34. package/dist/esm/tiptap/TiptapEditorContent.js +8 -1
  35. package/dist/esm/tiptap/hooks/useIsInReactProseMirror.js +5 -1
  36. package/dist/esm/tiptap/tiptapNodeView.js +13 -14
  37. package/dist/esm/viewdesc.js +54 -4
  38. package/dist/tsconfig.tsbuildinfo +1 -1
  39. package/dist/types/ReactEditorView.d.ts +10 -1
  40. package/dist/types/components/ChildNodeViews.d.ts +2 -2
  41. package/dist/types/components/CursorWrapper.d.ts +1 -1
  42. package/dist/types/components/TextNodeView.d.ts +7 -4
  43. package/dist/types/components/__tests__/ProseMirror.composition.test.d.ts +17 -1
  44. package/dist/types/components/marks/DefaultMarkView.d.ts +1 -1
  45. package/dist/types/components/marks/MarkView.d.ts +1 -1
  46. package/dist/types/components/marks/MarkViewConstructorView.d.ts +1 -1
  47. package/dist/types/components/marks/ReactMarkView.d.ts +1 -1
  48. package/dist/types/components/nodes/DefaultNodeView.d.ts +1 -1
  49. package/dist/types/components/nodes/NodeView.d.ts +3 -1
  50. package/dist/types/components/nodes/NodeViewConstructorView.d.ts +1 -1
  51. package/dist/types/components/nodes/ReactNodeView.d.ts +1 -1
  52. package/dist/types/contexts/ChildDescriptionsContext.d.ts +3 -2
  53. package/dist/types/contexts/CompositionContext.d.ts +4 -0
  54. package/dist/types/decorations/viewDecorations.d.ts +2 -2
  55. package/dist/types/hooks/useEditor.d.ts +3 -4
  56. package/dist/types/hooks/useIsEditorStatic.d.ts +4 -0
  57. package/dist/types/hooks/useReactKeys.d.ts +2 -5
  58. package/dist/types/plugins/beforeInputPlugin.d.ts +1 -2
  59. package/dist/types/plugins/reactKeys.d.ts +10 -9
  60. package/dist/types/props.d.ts +225 -225
  61. package/dist/types/tiptap/ReactProseMirrorNodeView.d.ts +1 -1
  62. package/dist/types/tiptap/TiptapEditorContent.d.ts +10 -1
  63. package/dist/types/tiptap/hooks/useIsInReactProseMirror.d.ts +5 -0
  64. package/dist/types/tiptap/tiptapNodeView.d.ts +5 -6
  65. package/dist/types/viewdesc.d.ts +5 -3
  66. package/package.json +22 -6
  67. package/dist/cjs/plugins/componentEventListeners.js +0 -28
  68. package/dist/cjs/plugins/componentEventListenersPlugin.js +0 -35
  69. package/dist/cjs/tiptap/utils/ssrJSDOMPatch.js +0 -59
  70. package/dist/esm/plugins/componentEventListeners.js +0 -18
  71. package/dist/esm/plugins/componentEventListenersPlugin.js +0 -25
  72. package/dist/esm/tiptap/utils/ssrJSDOMPatch.js +0 -56
  73. package/dist/types/plugins/componentEventListeners.d.ts +0 -3
  74. package/dist/types/plugins/componentEventListenersPlugin.d.ts +0 -4
  75. package/dist/types/tiptap/utils/ssrJSDOMPatch.d.ts +0 -1
@@ -9,9 +9,17 @@ interface DOMObserver {
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 {
19
+ composing: boolean;
14
20
  compositionID: number;
21
+ compositionNode: Text | null;
22
+ compositionEndedAt: number;
15
23
  compositionNodes: ViewDesc[];
16
24
  compositionPendingChanges: number;
17
25
  hideSelectionGuard: (() => void) | null;
@@ -30,7 +38,7 @@ interface InputState {
30
38
  mouseDown: {
31
39
  allowDefault: boolean;
32
40
  delayedSelectionSync: boolean;
33
- };
41
+ } | null;
34
42
  }
35
43
  /**
36
44
  * Extends EditorView to make prop and state updates pure, remove the DOM
@@ -58,6 +66,7 @@ export declare class ReactEditorView extends EditorView implements AbstractEdito
58
66
  private nextProps;
59
67
  private prevState;
60
68
  private _destroyed;
69
+ cursorWrapped: boolean;
61
70
  constructor(place: {
62
71
  mount: HTMLElement;
63
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>>;
@@ -2,7 +2,7 @@ import { Node } from "prosemirror-model";
2
2
  import { Decoration } from "prosemirror-view";
3
3
  import { Component, MutableRefObject } from "react";
4
4
  import { AbstractEditorView } from "../AbstractEditorView.js";
5
- import { ViewDesc } from "../viewdesc.js";
5
+ import { TextViewDesc, ViewDesc } from "../viewdesc.js";
6
6
  type Props = {
7
7
  view: AbstractEditorView;
8
8
  node: Node;
@@ -12,13 +12,16 @@ type Props = {
12
12
  decorations: readonly Decoration[];
13
13
  };
14
14
  export declare class TextNodeView extends Component<Props> {
15
- private viewDescRef;
16
- private renderRef;
15
+ viewDescRef: MutableRefObject<TextViewDesc | null>;
16
+ create(): TextViewDesc | null;
17
+ update(): boolean;
18
+ destroy(): void;
17
19
  updateEffect(): void;
18
20
  shouldComponentUpdate(nextProps: Props): boolean;
21
+ constructor(props: Props);
19
22
  componentDidMount(): void;
20
23
  componentDidUpdate(): void;
21
24
  componentWillUnmount(): void;
22
- render(): JSX.Element | null;
25
+ render(): JSX.Element;
23
26
  }
24
27
  export {};
@@ -1 +1,17 @@
1
- export {};
1
+ import "@wdio/types";
2
+ declare global {
3
+ namespace WebdriverIO {
4
+ interface Browser {
5
+ imeSetComposition(params: {
6
+ text: string;
7
+ selectionStart?: number;
8
+ selectionEnd?: number;
9
+ replacementStart?: number;
10
+ replacementEnd?: number;
11
+ }): Promise<void>;
12
+ imeInsertText(params: {
13
+ text: string;
14
+ }): Promise<void>;
15
+ }
16
+ }
17
+ }
@@ -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,6 +1,7 @@
1
1
  import { MutableRefObject } from "react";
2
2
  import { ViewDesc } from "../viewdesc.js";
3
- export declare const ChildDescriptionsContext: import("react").Context<{
3
+ export type ChildDescriptionsContextValue = {
4
4
  parentRef: MutableRefObject<ViewDesc | undefined>;
5
5
  siblingsRef: MutableRefObject<ViewDesc[]>;
6
- }>;
6
+ };
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>;
@@ -1,4 +1,4 @@
1
- import { Decoration, DecorationSource } from "prosemirror-view";
1
+ import { DecorationSource } from "prosemirror-view";
2
2
  import { AbstractEditorView } from "../AbstractEditorView.js";
3
3
  /**
4
4
  * Produces the DecorationSource for the current state, based
@@ -11,4 +11,4 @@ import { AbstractEditorView } from "../AbstractEditorView.js";
11
11
  * This makes it safe to call in a React render function, even
12
12
  * if its result is used in a dependencies array for a hook.
13
13
  */
14
- export declare function viewDecorations(view: AbstractEditorView, cursorWrapper: Decoration | null): DecorationSource;
14
+ export declare function viewDecorations(view: AbstractEditorView): DecorationSource;
@@ -1,5 +1,5 @@
1
1
  import { EditorState, Plugin, Transaction } from "prosemirror-state";
2
- import { Decoration, EditorProps, EditorView } from "prosemirror-view";
2
+ import { EditorProps, EditorView } from "prosemirror-view";
3
3
  import { AbstractEditorView } from "../AbstractEditorView.js";
4
4
  export interface UseEditorOptions extends EditorProps {
5
5
  defaultState?: EditorState;
@@ -21,10 +21,9 @@ 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
- cursorWrapper: Decoration | null;
29
28
  state: EditorState;
30
29
  };
@@ -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,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,3 +1,2 @@
1
1
  import { Plugin } from "prosemirror-state";
2
- import { Decoration } from "prosemirror-view";
3
- export declare function beforeInputPlugin(setCursorWrapper: (deco: Decoration | null) => void): Plugin<any>;
2
+ export declare function beforeInputPlugin(): Plugin<any>;
@@ -1,13 +1,17 @@
1
- import { Node } from "prosemirror-model";
2
1
  import { Plugin, PluginKey } from "prosemirror-state";
2
+ import { Decoration } from "prosemirror-view";
3
3
  export declare function createNodeKey(): string;
4
- export declare const reactKeysPluginKey: PluginKey<{
4
+ export interface ReactKeysPluginState {
5
5
  posToKey: Map<number, string>;
6
6
  keyToPos: Map<string, number>;
7
- posToNode: Map<number, Node>;
8
- }>;
7
+ cursorWrapper: Decoration | null;
8
+ freezeFrom: number | null;
9
+ }
10
+ export declare const reactKeysPluginKey: PluginKey<ReactKeysPluginState>;
9
11
  export type ReactKeysPluginMeta = {
10
- overrides: Record<number, number>;
12
+ overrides?: Record<number, number>;
13
+ cursorWrapper?: Decoration | null;
14
+ freezeFrom?: number | null;
11
15
  } | undefined;
12
16
  /**
13
17
  * Tracks a unique key for each (non-text) node in the
@@ -16,7 +20,4 @@ export type ReactKeysPluginMeta = {
16
20
  * key for a given node can be accessed by that node's
17
21
  * current position in the document, and vice versa.
18
22
  */
19
- export declare function reactKeys(): Plugin<{
20
- posToKey: Map<number, string>;
21
- keyToPos: Map<string, number>;
22
- }>;
23
+ export declare function reactKeys(): Plugin<ReactKeysPluginState>;