@handlewithcare/react-prosemirror 3.1.0-tiptap.51 → 3.1.0-tiptap.52

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 (39) hide show
  1. package/dist/cjs/ReactEditorView.js +0 -2
  2. package/dist/cjs/components/ChildNodeViews.js +9 -14
  3. package/dist/cjs/components/CursorWrapper.js +9 -6
  4. package/dist/cjs/components/TextNodeView.js +38 -109
  5. package/dist/cjs/components/TrailingHackView.js +0 -29
  6. package/dist/cjs/components/WidgetView.js +1 -0
  7. package/dist/cjs/hooks/useComponentEventListeners.js +6 -14
  8. package/dist/cjs/hooks/useNodeViewDescription.js +16 -37
  9. package/dist/cjs/plugins/beforeInputPlugin.js +43 -41
  10. package/dist/cjs/plugins/componentEventListeners.js +2 -9
  11. package/dist/cjs/tiptap/utils/ssrJSDOMPatch.js +59 -0
  12. package/dist/cjs/viewdesc.js +3 -10
  13. package/dist/esm/ReactEditorView.js +0 -2
  14. package/dist/esm/components/ChildNodeViews.js +9 -14
  15. package/dist/esm/components/CursorWrapper.js +10 -7
  16. package/dist/esm/components/TextNodeView.js +38 -109
  17. package/dist/esm/components/TrailingHackView.js +1 -30
  18. package/dist/esm/components/WidgetView.js +1 -0
  19. package/dist/esm/hooks/useComponentEventListeners.js +6 -14
  20. package/dist/esm/hooks/useNodeViewDescription.js +17 -38
  21. package/dist/esm/plugins/beforeInputPlugin.js +43 -41
  22. package/dist/esm/plugins/componentEventListeners.js +2 -9
  23. package/dist/esm/tiptap/hooks/useTiptapEditor.js +7 -1
  24. package/dist/esm/tiptap/utils/ssrJSDOMPatch.js +56 -0
  25. package/dist/esm/viewdesc.js +3 -10
  26. package/dist/tsconfig.tsbuildinfo +1 -1
  27. package/dist/types/ReactEditorView.d.ts +0 -4
  28. package/dist/types/components/CursorWrapper.d.ts +2 -4
  29. package/dist/types/components/TextNodeView.d.ts +4 -14
  30. package/dist/types/components/TrailingHackView.d.ts +1 -1
  31. package/dist/types/components/WidgetViewComponentProps.d.ts +4 -3
  32. package/dist/types/constants.d.ts +1 -1
  33. package/dist/types/hooks/useComponentEventListeners.d.ts +1 -1
  34. package/dist/types/plugins/componentEventListeners.d.ts +2 -3
  35. package/dist/types/props.d.ts +26 -26
  36. package/dist/types/tiptap/hooks/useTiptapEditor.d.ts +7 -0
  37. package/dist/types/tiptap/utils/ssrJSDOMPatch.d.ts +1 -0
  38. package/dist/types/viewdesc.d.ts +2 -2
  39. package/package.json +1 -2
@@ -11,10 +11,7 @@ interface DOMObserver {
11
11
  onSelectionChange(): void;
12
12
  }
13
13
  interface InputState {
14
- composing: boolean;
15
14
  compositionID: number;
16
- compositionNode: Text | null;
17
- compositionEndedAt: number;
18
15
  compositionNodes: ViewDesc[];
19
16
  compositionPendingChanges: number;
20
17
  hideSelectionGuard: (() => void) | null;
@@ -61,7 +58,6 @@ export declare class ReactEditorView extends EditorView implements AbstractEdito
61
58
  private nextProps;
62
59
  private prevState;
63
60
  private _destroyed;
64
- deferPendingEffects: boolean;
65
61
  constructor(place: {
66
62
  mount: HTMLElement;
67
63
  }, props: DirectEditorProps);
@@ -1,5 +1,3 @@
1
1
  import React from "react";
2
- export declare const CursorWrapper: React.ForwardRefExoticComponent<{
3
- widget: import("../decorations/ReactWidgetType.js").ReactWidgetDecoration;
4
- getPos: () => number;
5
- } & React.HTMLAttributes<HTMLElement> & React.RefAttributes<HTMLImageElement>>;
2
+ import { WidgetViewComponentProps } from "./WidgetViewComponentProps.js";
3
+ export declare const CursorWrapper: React.ForwardRefExoticComponent<Omit<WidgetViewComponentProps<React.AllHTMLAttributes<HTMLElement>>, "ref"> & React.RefAttributes<HTMLImageElement>>;
@@ -1,9 +1,8 @@
1
1
  import { Node } from "prosemirror-model";
2
- import { DOMEventMap, Decoration } from "prosemirror-view";
2
+ import { Decoration } from "prosemirror-view";
3
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 { ViewDesc } from "../viewdesc.js";
7
6
  type Props = {
8
7
  view: AbstractEditorView;
9
8
  node: Node;
@@ -11,19 +10,10 @@ type Props = {
11
10
  siblingsRef: MutableRefObject<ViewDesc[]>;
12
11
  parentRef: MutableRefObject<ViewDesc | undefined>;
13
12
  decorations: readonly Decoration[];
14
- registerEventListener<EventType extends keyof DOMEventMap>(eventType: EventType, handler: EventHandler<EventType>): void;
15
- unregisterEventListener<EventType extends keyof DOMEventMap>(eventType: EventType, handler: EventHandler<EventType>): void;
16
13
  };
17
14
  export declare class TextNodeView extends Component<Props> {
18
- viewDescRef: null | TextViewDesc | CompositionViewDesc;
19
- renderRef: null | JSX.Element;
20
- wasProtecting: boolean;
21
- containsCompositionNodeText: boolean;
22
- shouldProtect(props: Props): boolean;
23
- handleCompositionEnd: () => void;
24
- create(): TextViewDesc | CompositionViewDesc | null;
25
- update(): boolean;
26
- destroy(): void;
15
+ private viewDescRef;
16
+ private renderRef;
27
17
  updateEffect(): void;
28
18
  shouldComponentUpdate(nextProps: Props): boolean;
29
19
  componentDidMount(): void;
@@ -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,6 +1,7 @@
1
- import { HTMLAttributes } from "react";
1
+ import { AllHTMLAttributes, LegacyRef } from "react";
2
2
  import { ReactWidgetDecoration } from "../decorations/ReactWidgetType.js";
3
- export type WidgetViewComponentProps = {
3
+ export type WidgetViewComponentProps<Attributes = AllHTMLAttributes<HTMLElement>> = Attributes & {
4
4
  widget: ReactWidgetDecoration;
5
5
  getPos: () => number;
6
- } & HTMLAttributes<HTMLElement>;
6
+ ref: LegacyRef<any>;
7
+ };
@@ -1,4 +1,4 @@
1
1
  import { Schema } from "prosemirror-model";
2
2
  import { EditorState } from "prosemirror-state";
3
- export declare const EMPTY_SCHEMA: Schema<"text" | "doc", any>;
3
+ export declare const EMPTY_SCHEMA: Schema<"doc" | "text", any>;
4
4
  export declare const EMPTY_STATE: EditorState;
@@ -27,7 +27,7 @@ export type HandleDOMEvents = Record<keyof DOMEventMap, EventHandler | undefined
27
27
  * To accomplish this, we shallowly clone the registry whenever a new event
28
28
  * type is registered.
29
29
  */
30
- export declare function useComponentEventListeners(existingHandlers: HandleDOMEvents | undefined): {
30
+ export declare function useComponentEventListeners(handleDOMEventsProp: HandleDOMEvents | undefined): {
31
31
  registerEventListener: (eventType: keyof DOMEventMap, handler: EventHandler) => void;
32
32
  unregisterEventListener: (eventType: keyof DOMEventMap, handler: EventHandler) => void;
33
33
  handleDOMEvents: HandleDOMEvents;
@@ -1,4 +1,3 @@
1
- import { Plugin } from "prosemirror-state";
2
1
  import { DOMEventMap, EditorView } from "prosemirror-view";
3
- export type EventHandler<EventType extends keyof DOMEventMap = keyof DOMEventMap> = (this: Plugin, view: EditorView, event: DOMEventMap[EventType]) => boolean | void;
4
- export declare function componentEventListeners(eventHandlerRegistry: Map<keyof DOMEventMap, Iterable<EventHandler>>): Plugin<any>;
2
+ export type EventHandler<EventType extends keyof DOMEventMap = keyof DOMEventMap> = (view: EditorView, event: DOMEventMap[EventType]) => boolean | void;
3
+ export declare function componentEventListeners(eventHandlerRegistry: Map<keyof DOMEventMap, Iterable<EventHandler>>): Record<keyof DOMEventMap, EventHandler<keyof DOMEventMap>>;
@@ -904,19 +904,19 @@ export declare function mergeReactProps(a: HTMLProps<HTMLElement>, b: HTMLProps<
904
904
  suppressContentEditableWarning?: boolean | undefined;
905
905
  suppressHydrationWarning?: boolean | undefined;
906
906
  accessKey?: string | undefined;
907
- autoCapitalize?: "none" | (string & {}) | "off" | "on" | "sentences" | "words" | "characters" | undefined;
907
+ autoCapitalize?: "off" | "none" | "on" | "sentences" | "words" | "characters" | (string & {}) | undefined;
908
908
  autoFocus?: boolean | undefined;
909
- contentEditable?: (boolean | "true" | "false") | "inherit" | "plaintext-only" | undefined;
909
+ contentEditable?: (boolean | "false" | "true") | "inherit" | "plaintext-only" | undefined;
910
910
  contextMenu?: string | undefined;
911
911
  dir?: string | undefined;
912
- draggable?: (boolean | "true" | "false") | undefined;
913
- enterKeyHint?: "search" | "enter" | "done" | "go" | "next" | "previous" | "send" | undefined;
912
+ draggable?: (boolean | "false" | "true") | undefined;
913
+ enterKeyHint?: "enter" | "done" | "go" | "next" | "previous" | "search" | "send" | undefined;
914
914
  hidden?: boolean | undefined;
915
915
  id?: string | undefined;
916
916
  lang?: string | undefined;
917
917
  nonce?: string | undefined;
918
918
  slot?: string | undefined;
919
- spellCheck?: (boolean | "true" | "false") | undefined;
919
+ spellCheck?: (boolean | "false" | "true") | undefined;
920
920
  tabIndex?: number | undefined;
921
921
  title?: string | undefined;
922
922
  translate?: "yes" | "no" | undefined;
@@ -944,57 +944,57 @@ export declare function mergeReactProps(a: HTMLProps<HTMLElement>, b: HTMLProps<
944
944
  results?: number | undefined;
945
945
  security?: string | undefined;
946
946
  unselectable?: "off" | "on" | undefined;
947
- inputMode?: "search" | "text" | "none" | "email" | "tel" | "url" | "numeric" | "decimal" | undefined;
947
+ inputMode?: "text" | "none" | "search" | "tel" | "url" | "email" | "numeric" | "decimal" | undefined;
948
948
  is?: string | undefined;
949
949
  exportparts?: string | undefined;
950
950
  part?: string | undefined;
951
951
  "aria-activedescendant"?: string | undefined;
952
- "aria-atomic"?: (boolean | "true" | "false") | undefined;
953
- "aria-autocomplete"?: "list" | "none" | "both" | "inline" | undefined;
952
+ "aria-atomic"?: (boolean | "false" | "true") | undefined;
953
+ "aria-autocomplete"?: "none" | "list" | "inline" | "both" | undefined;
954
954
  "aria-braillelabel"?: string | undefined;
955
955
  "aria-brailleroledescription"?: string | undefined;
956
- "aria-busy"?: (boolean | "true" | "false") | undefined;
957
- "aria-checked"?: boolean | "true" | "false" | "mixed" | undefined;
956
+ "aria-busy"?: (boolean | "false" | "true") | undefined;
957
+ "aria-checked"?: boolean | "false" | "true" | "mixed" | undefined;
958
958
  "aria-colcount"?: number | undefined;
959
959
  "aria-colindex"?: number | undefined;
960
960
  "aria-colindextext"?: string | undefined;
961
961
  "aria-colspan"?: number | undefined;
962
962
  "aria-controls"?: string | undefined;
963
- "aria-current"?: boolean | "time" | "step" | "date" | "true" | "false" | "page" | "location" | undefined;
963
+ "aria-current"?: boolean | "false" | "true" | "step" | "page" | "location" | "date" | "time" | undefined;
964
964
  "aria-describedby"?: string | undefined;
965
965
  "aria-description"?: string | undefined;
966
966
  "aria-details"?: string | undefined;
967
- "aria-disabled"?: (boolean | "true" | "false") | undefined;
968
- "aria-dropeffect"?: "copy" | "link" | "none" | "move" | "execute" | "popup" | undefined;
967
+ "aria-disabled"?: (boolean | "false" | "true") | undefined;
968
+ "aria-dropeffect"?: "none" | "link" | "copy" | "execute" | "move" | "popup" | undefined;
969
969
  "aria-errormessage"?: string | undefined;
970
- "aria-expanded"?: (boolean | "true" | "false") | undefined;
970
+ "aria-expanded"?: (boolean | "false" | "true") | undefined;
971
971
  "aria-flowto"?: string | undefined;
972
- "aria-grabbed"?: (boolean | "true" | "false") | undefined;
973
- "aria-haspopup"?: boolean | "dialog" | "menu" | "grid" | "listbox" | "tree" | "true" | "false" | undefined;
974
- "aria-hidden"?: (boolean | "true" | "false") | undefined;
975
- "aria-invalid"?: boolean | "true" | "false" | "grammar" | "spelling" | undefined;
972
+ "aria-grabbed"?: (boolean | "false" | "true") | undefined;
973
+ "aria-haspopup"?: boolean | "false" | "true" | "dialog" | "grid" | "listbox" | "menu" | "tree" | undefined;
974
+ "aria-hidden"?: (boolean | "false" | "true") | undefined;
975
+ "aria-invalid"?: boolean | "false" | "true" | "grammar" | "spelling" | undefined;
976
976
  "aria-keyshortcuts"?: string | undefined;
977
977
  "aria-label"?: string | undefined;
978
978
  "aria-labelledby"?: string | undefined;
979
979
  "aria-level"?: number | undefined;
980
980
  "aria-live"?: "off" | "assertive" | "polite" | undefined;
981
- "aria-modal"?: (boolean | "true" | "false") | undefined;
982
- "aria-multiline"?: (boolean | "true" | "false") | undefined;
983
- "aria-multiselectable"?: (boolean | "true" | "false") | undefined;
981
+ "aria-modal"?: (boolean | "false" | "true") | undefined;
982
+ "aria-multiline"?: (boolean | "false" | "true") | undefined;
983
+ "aria-multiselectable"?: (boolean | "false" | "true") | undefined;
984
984
  "aria-orientation"?: "horizontal" | "vertical" | undefined;
985
985
  "aria-owns"?: string | undefined;
986
986
  "aria-placeholder"?: string | undefined;
987
987
  "aria-posinset"?: number | undefined;
988
- "aria-pressed"?: boolean | "true" | "false" | "mixed" | undefined;
989
- "aria-readonly"?: (boolean | "true" | "false") | undefined;
990
- "aria-relevant"?: "text" | "all" | "additions" | "additions removals" | "additions text" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals" | undefined;
991
- "aria-required"?: (boolean | "true" | "false") | undefined;
988
+ "aria-pressed"?: boolean | "false" | "true" | "mixed" | undefined;
989
+ "aria-readonly"?: (boolean | "false" | "true") | undefined;
990
+ "aria-relevant"?: "text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals" | undefined;
991
+ "aria-required"?: (boolean | "false" | "true") | undefined;
992
992
  "aria-roledescription"?: string | undefined;
993
993
  "aria-rowcount"?: number | undefined;
994
994
  "aria-rowindex"?: number | undefined;
995
995
  "aria-rowindextext"?: string | undefined;
996
996
  "aria-rowspan"?: number | undefined;
997
- "aria-selected"?: (boolean | "true" | "false") | undefined;
997
+ "aria-selected"?: (boolean | "false" | "true") | undefined;
998
998
  "aria-setsize"?: number | undefined;
999
999
  "aria-sort"?: "none" | "ascending" | "descending" | "other" | undefined;
1000
1000
  "aria-valuemax"?: number | undefined;
@@ -1,4 +1,11 @@
1
1
  import { DependencyList } from "react";
2
2
  import { useEditor } from "./useEditor.js";
3
3
  export type UseTiptapEditorOptions = Omit<Parameters<typeof useEditor>[0], "element">;
4
+ /**
5
+ * Create a React ProseMirror integrated Tiptap Editor instance.
6
+ * @param options The editor options
7
+ * @param deps The dependencies to watch for changes
8
+ * @returns The editor instance
9
+ * @example const editor = useEditor({ extensions: [...] })
10
+ */
4
11
  export declare function useTiptapEditor(options: UseTiptapEditorOptions, deps?: DependencyList): import("@tiptap/core").Editor;
@@ -0,0 +1 @@
1
+ export {};
@@ -119,7 +119,7 @@ export declare class NodeViewDesc extends ViewDesc {
119
119
  parseRule(): Omit<TagParseRule, "tag"> | null;
120
120
  matchesNode(node: Node, outerDeco: readonly Decoration[], innerDeco: DecorationSource): boolean;
121
121
  get size(): number;
122
- get border(): 0 | 1;
122
+ get border(): 1 | 0;
123
123
  updateChildren(_view: EditorView, _pos: number): void;
124
124
  update(node: Node, outerDeco: readonly Decoration[], innerDeco: DecorationSource, view: EditorView): boolean;
125
125
  updateInner(node: Node, outerDeco: readonly Decoration[], innerDeco: DecorationSource, view: EditorView): void;
@@ -133,7 +133,7 @@ export declare class TextViewDesc extends NodeViewDesc {
133
133
  parseRule(): {
134
134
  skip: any;
135
135
  };
136
- update(node: Node, outerDeco: readonly Decoration[], _innerDeco: DecorationSource, _view: ReactEditorView): boolean;
136
+ update(_node: Node, _outerDeco: readonly Decoration[], _innerDeco: DecorationSource, _view: ReactEditorView): boolean;
137
137
  inParent(): boolean;
138
138
  domFromPos(pos: number): {
139
139
  node: globalThis.Node;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@handlewithcare/react-prosemirror",
3
- "version": "3.1.0-tiptap.51",
3
+ "version": "3.1.0-tiptap.52",
4
4
  "license": "Apache-2.0",
5
5
  "type": "module",
6
6
  "main": "dist/cjs/index.js",
@@ -71,7 +71,6 @@
71
71
  "@typescript-eslint/eslint-plugin": "^5.51.0",
72
72
  "@typescript-eslint/parser": "^5.51.0",
73
73
  "@uiw/react-codemirror": "^4.23.7",
74
- "@vitejs/plugin-basic-ssl": "^2.3.0",
75
74
  "@vitejs/plugin-react": "^4.3.1",
76
75
  "@wdio/browser-runner": "^9.18.1",
77
76
  "@wdio/cli": "^9.18.1",