@tiptap/react 2.5.0-beta.2 → 2.5.0-beta.4

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 (186) hide show
  1. package/dist/index.cjs +529 -536
  2. package/dist/index.cjs.map +1 -1
  3. package/dist/index.js +527 -527
  4. package/dist/index.js.map +1 -1
  5. package/dist/index.umd.js +529 -536
  6. package/dist/index.umd.js.map +1 -1
  7. package/dist/packages/core/src/CommandManager.d.ts +20 -0
  8. package/dist/packages/core/src/Editor.d.ts +161 -0
  9. package/dist/packages/core/src/EventEmitter.d.ts +11 -0
  10. package/dist/packages/core/src/Extension.d.ts +343 -0
  11. package/dist/packages/core/src/ExtensionManager.d.ts +55 -0
  12. package/dist/packages/core/src/InputRule.d.ts +42 -0
  13. package/dist/packages/core/src/Mark.d.ts +451 -0
  14. package/dist/packages/core/src/Node.d.ts +611 -0
  15. package/dist/packages/core/src/NodePos.d.ts +44 -0
  16. package/dist/packages/core/src/NodeView.d.ts +31 -0
  17. package/dist/packages/core/src/PasteRule.d.ts +50 -0
  18. package/dist/packages/core/src/Tracker.d.ts +11 -0
  19. package/dist/packages/core/src/commands/blur.d.ts +13 -0
  20. package/dist/packages/core/src/commands/clearContent.d.ts +14 -0
  21. package/dist/packages/core/src/commands/clearNodes.d.ts +13 -0
  22. package/dist/packages/core/src/commands/command.d.ts +18 -0
  23. package/dist/packages/core/src/commands/createParagraphNear.d.ts +13 -0
  24. package/dist/packages/core/src/commands/cut.d.ts +20 -0
  25. package/dist/packages/core/src/commands/deleteCurrentNode.d.ts +13 -0
  26. package/dist/packages/core/src/commands/deleteNode.d.ts +15 -0
  27. package/dist/packages/core/src/commands/deleteRange.d.ts +14 -0
  28. package/dist/packages/core/src/commands/deleteSelection.d.ts +13 -0
  29. package/dist/packages/core/src/commands/enter.d.ts +13 -0
  30. package/dist/packages/core/src/commands/exitCode.d.ts +13 -0
  31. package/dist/packages/core/src/commands/extendMarkRange.d.ts +25 -0
  32. package/dist/packages/core/src/commands/first.d.ts +14 -0
  33. package/dist/packages/core/src/commands/focus.d.ts +27 -0
  34. package/dist/packages/core/src/commands/forEach.d.ts +14 -0
  35. package/dist/packages/core/src/commands/index.d.ts +55 -0
  36. package/dist/packages/core/src/commands/insertContent.d.ts +34 -0
  37. package/dist/packages/core/src/commands/insertContentAt.d.ts +47 -0
  38. package/dist/packages/core/src/commands/join.d.ts +41 -0
  39. package/dist/packages/core/src/commands/joinItemBackward.d.ts +13 -0
  40. package/dist/packages/core/src/commands/joinItemForward.d.ts +13 -0
  41. package/dist/packages/core/src/commands/joinTextblockBackward.d.ts +12 -0
  42. package/dist/packages/core/src/commands/joinTextblockForward.d.ts +12 -0
  43. package/dist/packages/core/src/commands/keyboardShortcut.d.ts +14 -0
  44. package/dist/packages/core/src/commands/lift.d.ts +17 -0
  45. package/dist/packages/core/src/commands/liftEmptyBlock.d.ts +13 -0
  46. package/dist/packages/core/src/commands/liftListItem.d.ts +15 -0
  47. package/dist/packages/core/src/commands/newlineInCode.d.ts +13 -0
  48. package/dist/packages/core/src/commands/resetAttributes.d.ts +16 -0
  49. package/dist/packages/core/src/commands/scrollIntoView.d.ts +13 -0
  50. package/dist/packages/core/src/commands/selectAll.d.ts +13 -0
  51. package/dist/packages/core/src/commands/selectNodeBackward.d.ts +13 -0
  52. package/dist/packages/core/src/commands/selectNodeForward.d.ts +13 -0
  53. package/dist/packages/core/src/commands/selectParentNode.d.ts +13 -0
  54. package/dist/packages/core/src/commands/selectTextblockEnd.d.ts +13 -0
  55. package/dist/packages/core/src/commands/selectTextblockStart.d.ts +13 -0
  56. package/dist/packages/core/src/commands/setContent.d.ts +40 -0
  57. package/dist/packages/core/src/commands/setMark.d.ts +15 -0
  58. package/dist/packages/core/src/commands/setMeta.d.ts +15 -0
  59. package/dist/packages/core/src/commands/setNode.d.ts +16 -0
  60. package/dist/packages/core/src/commands/setNodeSelection.d.ts +14 -0
  61. package/dist/packages/core/src/commands/setTextSelection.d.ts +14 -0
  62. package/dist/packages/core/src/commands/sinkListItem.d.ts +15 -0
  63. package/dist/packages/core/src/commands/splitBlock.d.ts +17 -0
  64. package/dist/packages/core/src/commands/splitListItem.d.ts +15 -0
  65. package/dist/packages/core/src/commands/toggleList.d.ts +18 -0
  66. package/dist/packages/core/src/commands/toggleMark.d.ts +30 -0
  67. package/dist/packages/core/src/commands/toggleNode.d.ts +17 -0
  68. package/dist/packages/core/src/commands/toggleWrap.d.ts +16 -0
  69. package/dist/packages/core/src/commands/undoInputRule.d.ts +13 -0
  70. package/dist/packages/core/src/commands/unsetAllMarks.d.ts +13 -0
  71. package/dist/packages/core/src/commands/unsetMark.d.ts +25 -0
  72. package/dist/packages/core/src/commands/updateAttributes.d.ts +24 -0
  73. package/dist/packages/core/src/commands/wrapIn.d.ts +16 -0
  74. package/dist/packages/core/src/commands/wrapInList.d.ts +16 -0
  75. package/dist/packages/core/src/extensions/clipboardTextSerializer.d.ts +5 -0
  76. package/dist/packages/core/src/extensions/commands.d.ts +3 -0
  77. package/dist/packages/core/src/extensions/editable.d.ts +2 -0
  78. package/dist/packages/core/src/extensions/focusEvents.d.ts +2 -0
  79. package/dist/packages/core/src/extensions/index.d.ts +6 -0
  80. package/dist/packages/core/src/extensions/keymap.d.ts +2 -0
  81. package/dist/packages/core/src/extensions/tabindex.d.ts +2 -0
  82. package/dist/packages/core/src/helpers/combineTransactionSteps.d.ts +10 -0
  83. package/dist/packages/core/src/helpers/createChainableState.d.ts +10 -0
  84. package/dist/packages/core/src/helpers/createDocument.d.ts +12 -0
  85. package/dist/packages/core/src/helpers/createNodeFromContent.d.ts +15 -0
  86. package/dist/packages/core/src/helpers/defaultBlockAt.d.ts +7 -0
  87. package/dist/packages/core/src/helpers/findChildren.d.ts +9 -0
  88. package/dist/packages/core/src/helpers/findChildrenInRange.d.ts +10 -0
  89. package/dist/packages/core/src/helpers/findParentNode.d.ts +16 -0
  90. package/dist/packages/core/src/helpers/findParentNodeClosestToPos.d.ts +17 -0
  91. package/dist/packages/core/src/helpers/generateHTML.d.ts +8 -0
  92. package/dist/packages/core/src/helpers/generateJSON.d.ts +8 -0
  93. package/dist/packages/core/src/helpers/generateText.d.ts +12 -0
  94. package/dist/packages/core/src/helpers/getAttributes.d.ts +9 -0
  95. package/dist/packages/core/src/helpers/getAttributesFromExtensions.d.ts +6 -0
  96. package/dist/packages/core/src/helpers/getChangedRanges.d.ts +11 -0
  97. package/dist/packages/core/src/helpers/getDebugJSON.d.ts +8 -0
  98. package/dist/packages/core/src/helpers/getExtensionField.d.ts +9 -0
  99. package/dist/packages/core/src/helpers/getHTMLFromFragment.d.ts +2 -0
  100. package/dist/packages/core/src/helpers/getMarkAttributes.d.ts +3 -0
  101. package/dist/packages/core/src/helpers/getMarkRange.d.ts +3 -0
  102. package/dist/packages/core/src/helpers/getMarkType.d.ts +2 -0
  103. package/dist/packages/core/src/helpers/getMarksBetween.d.ts +3 -0
  104. package/dist/packages/core/src/helpers/getNodeAtPosition.d.ts +11 -0
  105. package/dist/packages/core/src/helpers/getNodeAttributes.d.ts +3 -0
  106. package/dist/packages/core/src/helpers/getNodeType.d.ts +2 -0
  107. package/dist/packages/core/src/helpers/getRenderedAttributes.d.ts +3 -0
  108. package/dist/packages/core/src/helpers/getSchema.d.ts +4 -0
  109. package/dist/packages/core/src/helpers/getSchemaByResolvedExtensions.d.ts +10 -0
  110. package/dist/packages/core/src/helpers/getSchemaTypeByName.d.ts +8 -0
  111. package/dist/packages/core/src/helpers/getSchemaTypeNameByName.d.ts +8 -0
  112. package/dist/packages/core/src/helpers/getSplittedAttributes.d.ts +9 -0
  113. package/dist/packages/core/src/helpers/getText.d.ts +15 -0
  114. package/dist/packages/core/src/helpers/getTextBetween.d.ts +14 -0
  115. package/dist/packages/core/src/helpers/getTextContentFromNodes.d.ts +8 -0
  116. package/dist/packages/core/src/helpers/getTextSerializersFromSchema.d.ts +8 -0
  117. package/dist/packages/core/src/helpers/index.d.ts +50 -0
  118. package/dist/packages/core/src/helpers/injectExtensionAttributesToParseRule.d.ts +9 -0
  119. package/dist/packages/core/src/helpers/isActive.d.ts +2 -0
  120. package/dist/packages/core/src/helpers/isAtEndOfNode.d.ts +2 -0
  121. package/dist/packages/core/src/helpers/isAtStartOfNode.d.ts +2 -0
  122. package/dist/packages/core/src/helpers/isExtensionRulesEnabled.d.ts +2 -0
  123. package/dist/packages/core/src/helpers/isList.d.ts +2 -0
  124. package/dist/packages/core/src/helpers/isMarkActive.d.ts +3 -0
  125. package/dist/packages/core/src/helpers/isNodeActive.d.ts +3 -0
  126. package/dist/packages/core/src/helpers/isNodeEmpty.d.ts +2 -0
  127. package/dist/packages/core/src/helpers/isNodeSelection.d.ts +2 -0
  128. package/dist/packages/core/src/helpers/isTextSelection.d.ts +2 -0
  129. package/dist/packages/core/src/helpers/posToDOMRect.d.ts +2 -0
  130. package/dist/packages/core/src/helpers/resolveFocusPosition.d.ts +4 -0
  131. package/dist/packages/core/src/helpers/selectionToInsertionEnd.d.ts +2 -0
  132. package/dist/packages/core/src/helpers/splitExtensions.d.ts +9 -0
  133. package/dist/packages/core/src/index.d.ts +24 -0
  134. package/dist/packages/core/src/inputRules/index.d.ts +5 -0
  135. package/dist/packages/core/src/inputRules/markInputRule.d.ts +13 -0
  136. package/dist/packages/core/src/inputRules/nodeInputRule.d.ts +23 -0
  137. package/dist/packages/core/src/inputRules/textInputRule.d.ts +10 -0
  138. package/dist/packages/core/src/inputRules/textblockTypeInputRule.d.ts +15 -0
  139. package/dist/packages/core/src/inputRules/wrappingInputRule.d.ts +28 -0
  140. package/dist/packages/core/src/pasteRules/index.d.ts +3 -0
  141. package/dist/packages/core/src/pasteRules/markPasteRule.d.ts +13 -0
  142. package/dist/packages/core/src/pasteRules/nodePasteRule.d.ts +13 -0
  143. package/dist/packages/core/src/pasteRules/textPasteRule.d.ts +10 -0
  144. package/dist/packages/core/src/style.d.ts +1 -0
  145. package/dist/packages/core/src/types.d.ts +250 -0
  146. package/dist/packages/core/src/utilities/callOrReturn.d.ts +9 -0
  147. package/dist/packages/core/src/utilities/createStyleTag.d.ts +1 -0
  148. package/dist/packages/core/src/utilities/deleteProps.d.ts +6 -0
  149. package/dist/packages/core/src/utilities/elementFromString.d.ts +1 -0
  150. package/dist/packages/core/src/utilities/escapeForRegEx.d.ts +1 -0
  151. package/dist/packages/core/src/utilities/findDuplicates.d.ts +1 -0
  152. package/dist/packages/core/src/utilities/fromString.d.ts +1 -0
  153. package/dist/packages/core/src/utilities/index.d.ts +20 -0
  154. package/dist/packages/core/src/utilities/isAndroid.d.ts +1 -0
  155. package/dist/packages/core/src/utilities/isEmptyObject.d.ts +1 -0
  156. package/dist/packages/core/src/utilities/isFunction.d.ts +1 -0
  157. package/dist/packages/core/src/utilities/isMacOS.d.ts +1 -0
  158. package/dist/packages/core/src/utilities/isNumber.d.ts +1 -0
  159. package/dist/packages/core/src/utilities/isPlainObject.d.ts +1 -0
  160. package/dist/packages/core/src/utilities/isRegExp.d.ts +1 -0
  161. package/dist/packages/core/src/utilities/isString.d.ts +1 -0
  162. package/dist/packages/core/src/utilities/isiOS.d.ts +1 -0
  163. package/dist/packages/core/src/utilities/mergeAttributes.d.ts +1 -0
  164. package/dist/packages/core/src/utilities/mergeDeep.d.ts +1 -0
  165. package/dist/packages/core/src/utilities/minMax.d.ts +1 -0
  166. package/dist/packages/core/src/utilities/objectIncludes.d.ts +8 -0
  167. package/dist/packages/core/src/utilities/removeDuplicates.d.ts +8 -0
  168. package/dist/packages/extension-bubble-menu/src/bubble-menu-plugin.d.ts +76 -0
  169. package/dist/packages/extension-bubble-menu/src/bubble-menu.d.ts +15 -0
  170. package/dist/packages/extension-bubble-menu/src/index.d.ts +4 -0
  171. package/dist/packages/extension-floating-menu/src/floating-menu-plugin.d.ts +66 -0
  172. package/dist/packages/extension-floating-menu/src/floating-menu.d.ts +15 -0
  173. package/dist/packages/extension-floating-menu/src/index.d.ts +4 -0
  174. package/dist/packages/react/src/BubbleMenu.d.ts +11 -11
  175. package/dist/packages/react/src/Context.d.ts +15 -15
  176. package/dist/packages/react/src/Editor.d.ts +12 -12
  177. package/dist/packages/react/src/EditorContent.d.ts +24 -24
  178. package/dist/packages/react/src/FloatingMenu.d.ts +10 -10
  179. package/dist/packages/react/src/NodeViewContent.d.ts +6 -6
  180. package/dist/packages/react/src/NodeViewWrapper.d.ts +6 -6
  181. package/dist/packages/react/src/ReactNodeViewRenderer.d.ts +16 -16
  182. package/dist/packages/react/src/ReactRenderer.d.ts +62 -62
  183. package/dist/packages/react/src/index.d.ts +12 -12
  184. package/dist/packages/react/src/useEditor.d.ts +11 -11
  185. package/dist/packages/react/src/useReactNodeView.d.ts +7 -7
  186. package/package.json +5 -5
@@ -1,24 +1,24 @@
1
- import React, { ForwardedRef, HTMLProps } from 'react';
2
- import { Editor } from './Editor.js';
3
- import { ReactRenderer } from './ReactRenderer.js';
4
- export interface EditorContentProps extends HTMLProps<HTMLDivElement> {
5
- editor: Editor | null;
6
- innerRef?: ForwardedRef<HTMLDivElement | null>;
7
- }
8
- export interface EditorContentState {
9
- renderers: Record<string, ReactRenderer>;
10
- }
11
- export declare class PureEditorContent extends React.Component<EditorContentProps, EditorContentState> {
12
- editorContentRef: React.RefObject<any>;
13
- initialized: boolean;
14
- constructor(props: EditorContentProps);
15
- componentDidMount(): void;
16
- componentDidUpdate(): void;
17
- init(): void;
18
- maybeFlushSync(fn: () => void): void;
19
- setRenderer(id: string, renderer: ReactRenderer): void;
20
- removeRenderer(id: string): void;
21
- componentWillUnmount(): void;
22
- render(): React.JSX.Element;
23
- }
24
- export declare const EditorContent: React.MemoExoticComponent<React.ForwardRefExoticComponent<Omit<EditorContentProps, "ref"> & React.RefAttributes<HTMLDivElement>>>;
1
+ import React, { ForwardedRef, HTMLProps } from 'react';
2
+ import { Editor } from './Editor.js';
3
+ import { ReactRenderer } from './ReactRenderer.js';
4
+ export interface EditorContentProps extends HTMLProps<HTMLDivElement> {
5
+ editor: Editor | null;
6
+ innerRef?: ForwardedRef<HTMLDivElement | null>;
7
+ }
8
+ export interface EditorContentState {
9
+ renderers: Record<string, ReactRenderer>;
10
+ }
11
+ export declare class PureEditorContent extends React.Component<EditorContentProps, EditorContentState> {
12
+ editorContentRef: React.RefObject<any>;
13
+ initialized: boolean;
14
+ constructor(props: EditorContentProps);
15
+ componentDidMount(): void;
16
+ componentDidUpdate(): void;
17
+ init(): void;
18
+ maybeFlushSync(fn: () => void): void;
19
+ setRenderer(id: string, renderer: ReactRenderer): void;
20
+ removeRenderer(id: string): void;
21
+ componentWillUnmount(): void;
22
+ render(): React.JSX.Element;
23
+ }
24
+ export declare const EditorContent: React.MemoExoticComponent<React.ForwardRefExoticComponent<Omit<EditorContentProps, "ref"> & React.RefAttributes<HTMLDivElement>>>;
@@ -1,10 +1,10 @@
1
- import { FloatingMenuPluginProps } from '@tiptap/extension-floating-menu';
2
- import React from 'react';
3
- declare type Optional<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>;
4
- export declare type FloatingMenuProps = Omit<Optional<FloatingMenuPluginProps, 'pluginKey'>, 'element' | 'editor'> & {
5
- editor: FloatingMenuPluginProps['editor'] | null;
6
- className?: string;
7
- children: React.ReactNode;
8
- };
9
- export declare const FloatingMenu: (props: FloatingMenuProps) => React.JSX.Element;
10
- export {};
1
+ import { FloatingMenuPluginProps } from '@tiptap/extension-floating-menu';
2
+ import React from 'react';
3
+ type Optional<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>;
4
+ export type FloatingMenuProps = Omit<Optional<FloatingMenuPluginProps, 'pluginKey'>, 'element' | 'editor'> & {
5
+ editor: FloatingMenuPluginProps['editor'] | null;
6
+ className?: string;
7
+ children: React.ReactNode;
8
+ };
9
+ export declare const FloatingMenu: (props: FloatingMenuProps) => React.JSX.Element;
10
+ export {};
@@ -1,6 +1,6 @@
1
- import React from 'react';
2
- export interface NodeViewContentProps {
3
- [key: string]: any;
4
- as?: React.ElementType;
5
- }
6
- export declare const NodeViewContent: React.FC<NodeViewContentProps>;
1
+ import React from 'react';
2
+ export interface NodeViewContentProps {
3
+ [key: string]: any;
4
+ as?: React.ElementType;
5
+ }
6
+ export declare const NodeViewContent: React.FC<NodeViewContentProps>;
@@ -1,6 +1,6 @@
1
- import React from 'react';
2
- export interface NodeViewWrapperProps {
3
- [key: string]: any;
4
- as?: React.ElementType;
5
- }
6
- export declare const NodeViewWrapper: React.FC<NodeViewWrapperProps>;
1
+ import React from 'react';
2
+ export interface NodeViewWrapperProps {
3
+ [key: string]: any;
4
+ as?: React.ElementType;
5
+ }
6
+ export declare const NodeViewWrapper: React.FC<NodeViewWrapperProps>;
@@ -1,16 +1,16 @@
1
- import { NodeViewRenderer, NodeViewRendererOptions } from '@tiptap/core';
2
- import { Node as ProseMirrorNode } from '@tiptap/pm/model';
3
- import { Decoration } from '@tiptap/pm/view';
4
- export interface ReactNodeViewRendererOptions extends NodeViewRendererOptions {
5
- update: ((props: {
6
- oldNode: ProseMirrorNode;
7
- oldDecorations: Decoration[];
8
- newNode: ProseMirrorNode;
9
- newDecorations: Decoration[];
10
- updateProps: () => void;
11
- }) => boolean) | null;
12
- as?: string;
13
- className?: string;
14
- attrs?: Record<string, string>;
15
- }
16
- export declare function ReactNodeViewRenderer(component: any, options?: Partial<ReactNodeViewRendererOptions>): NodeViewRenderer;
1
+ import { NodeViewRenderer, NodeViewRendererOptions } from '@tiptap/core';
2
+ import { Node as ProseMirrorNode } from '@tiptap/pm/model';
3
+ import { Decoration } from '@tiptap/pm/view';
4
+ export interface ReactNodeViewRendererOptions extends NodeViewRendererOptions {
5
+ update: ((props: {
6
+ oldNode: ProseMirrorNode;
7
+ oldDecorations: Decoration[];
8
+ newNode: ProseMirrorNode;
9
+ newDecorations: Decoration[];
10
+ updateProps: () => void;
11
+ }) => boolean) | null;
12
+ as?: string;
13
+ className?: string;
14
+ attrs?: Record<string, string>;
15
+ }
16
+ export declare function ReactNodeViewRenderer(component: any, options?: Partial<ReactNodeViewRendererOptions>): NodeViewRenderer;
@@ -1,62 +1,62 @@
1
- import { Editor } from '@tiptap/core';
2
- import React from 'react';
3
- import { Editor as ExtendedEditor } from './Editor.js';
4
- export interface ReactRendererOptions {
5
- /**
6
- * The editor instance.
7
- * @type {Editor}
8
- */
9
- editor: Editor;
10
- /**
11
- * The props for the component.
12
- * @type {Record<string, any>}
13
- * @default {}
14
- */
15
- props?: Record<string, any>;
16
- /**
17
- * The tag name of the element.
18
- * @type {string}
19
- * @default 'div'
20
- */
21
- as?: string;
22
- /**
23
- * The class name of the element.
24
- * @type {string}
25
- * @default ''
26
- * @example 'foo bar'
27
- */
28
- className?: string;
29
- /**
30
- * The attributes of the element.
31
- * @type {Record<string, string>}
32
- * @default {}
33
- * @example { 'data-foo': 'bar' }
34
- */
35
- attrs?: Record<string, string>;
36
- }
37
- declare type ComponentType<R, P> = React.ComponentClass<P> | React.FunctionComponent<P> | React.ForwardRefExoticComponent<React.PropsWithoutRef<P> & React.RefAttributes<R>>;
38
- /**
39
- * The ReactRenderer class. It's responsible for rendering React components inside the editor.
40
- * @example
41
- * new ReactRenderer(MyComponent, {
42
- * editor,
43
- * props: {
44
- * foo: 'bar',
45
- * },
46
- * as: 'span',
47
- * })
48
- */
49
- export declare class ReactRenderer<R = unknown, P = unknown> {
50
- id: string;
51
- editor: ExtendedEditor;
52
- component: any;
53
- element: Element;
54
- props: Record<string, any>;
55
- reactElement: React.ReactNode;
56
- ref: R | null;
57
- constructor(component: ComponentType<R, P>, { editor, props, as, className, attrs, }: ReactRendererOptions);
58
- render(): void;
59
- updateProps(props?: Record<string, any>): void;
60
- destroy(): void;
61
- }
62
- export {};
1
+ import { Editor } from '@tiptap/core';
2
+ import React from 'react';
3
+ import { Editor as ExtendedEditor } from './Editor.js';
4
+ export interface ReactRendererOptions {
5
+ /**
6
+ * The editor instance.
7
+ * @type {Editor}
8
+ */
9
+ editor: Editor;
10
+ /**
11
+ * The props for the component.
12
+ * @type {Record<string, any>}
13
+ * @default {}
14
+ */
15
+ props?: Record<string, any>;
16
+ /**
17
+ * The tag name of the element.
18
+ * @type {string}
19
+ * @default 'div'
20
+ */
21
+ as?: string;
22
+ /**
23
+ * The class name of the element.
24
+ * @type {string}
25
+ * @default ''
26
+ * @example 'foo bar'
27
+ */
28
+ className?: string;
29
+ /**
30
+ * The attributes of the element.
31
+ * @type {Record<string, string>}
32
+ * @default {}
33
+ * @example { 'data-foo': 'bar' }
34
+ */
35
+ attrs?: Record<string, string>;
36
+ }
37
+ type ComponentType<R, P> = React.ComponentClass<P> | React.FunctionComponent<P> | React.ForwardRefExoticComponent<React.PropsWithoutRef<P> & React.RefAttributes<R>>;
38
+ /**
39
+ * The ReactRenderer class. It's responsible for rendering React components inside the editor.
40
+ * @example
41
+ * new ReactRenderer(MyComponent, {
42
+ * editor,
43
+ * props: {
44
+ * foo: 'bar',
45
+ * },
46
+ * as: 'span',
47
+ * })
48
+ */
49
+ export declare class ReactRenderer<R = unknown, P = unknown> {
50
+ id: string;
51
+ editor: ExtendedEditor;
52
+ component: any;
53
+ element: Element;
54
+ props: Record<string, any>;
55
+ reactElement: React.ReactNode;
56
+ ref: R | null;
57
+ constructor(component: ComponentType<R, P>, { editor, props, as, className, attrs, }: ReactRendererOptions);
58
+ render(): void;
59
+ updateProps(props?: Record<string, any>): void;
60
+ destroy(): void;
61
+ }
62
+ export {};
@@ -1,12 +1,12 @@
1
- export * from './BubbleMenu.js';
2
- export * from './Context.js';
3
- export { Editor } from './Editor.js';
4
- export * from './EditorContent.js';
5
- export * from './FloatingMenu.js';
6
- export * from './NodeViewContent.js';
7
- export * from './NodeViewWrapper.js';
8
- export * from './ReactNodeViewRenderer.js';
9
- export * from './ReactRenderer.js';
10
- export * from './useEditor.js';
11
- export * from './useReactNodeView.js';
12
- export * from '@tiptap/core';
1
+ export * from './BubbleMenu.js';
2
+ export * from './Context.js';
3
+ export { Editor } from './Editor.js';
4
+ export * from './EditorContent.js';
5
+ export * from './FloatingMenu.js';
6
+ export * from './NodeViewContent.js';
7
+ export * from './NodeViewWrapper.js';
8
+ export * from './ReactNodeViewRenderer.js';
9
+ export * from './ReactRenderer.js';
10
+ export * from './useEditor.js';
11
+ export * from './useReactNodeView.js';
12
+ export * from '@tiptap/core';
@@ -1,11 +1,11 @@
1
- import { EditorOptions } from '@tiptap/core';
2
- import { DependencyList } from 'react';
3
- import { Editor } from './Editor.js';
4
- /**
5
- * This hook allows you to create an 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
- */
11
- export declare const useEditor: (options?: Partial<EditorOptions>, deps?: DependencyList) => Editor | null;
1
+ import { EditorOptions } from '@tiptap/core';
2
+ import { DependencyList } from 'react';
3
+ import { Editor } from './Editor.js';
4
+ /**
5
+ * This hook allows you to create an 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
+ */
11
+ export declare const useEditor: (options?: Partial<EditorOptions>, deps?: DependencyList) => Editor | null;
@@ -1,7 +1,7 @@
1
- /// <reference types="react" />
2
- export interface ReactNodeViewContextProps {
3
- onDragStart: (event: DragEvent) => void;
4
- nodeViewContentRef: (element: HTMLElement | null) => void;
5
- }
6
- export declare const ReactNodeViewContext: import("react").Context<Partial<ReactNodeViewContextProps>>;
7
- export declare const useReactNodeView: () => Partial<ReactNodeViewContextProps>;
1
+ /// <reference types="react" />
2
+ export interface ReactNodeViewContextProps {
3
+ onDragStart: (event: DragEvent) => void;
4
+ nodeViewContentRef: (element: HTMLElement | null) => void;
5
+ }
6
+ export declare const ReactNodeViewContext: import("react").Context<Partial<ReactNodeViewContextProps>>;
7
+ export declare const useReactNodeView: () => Partial<ReactNodeViewContextProps>;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@tiptap/react",
3
3
  "description": "React components for tiptap",
4
- "version": "2.5.0-beta.2",
4
+ "version": "2.5.0-beta.4",
5
5
  "homepage": "https://tiptap.dev",
6
6
  "keywords": [
7
7
  "tiptap",
@@ -29,12 +29,12 @@
29
29
  "dist"
30
30
  ],
31
31
  "dependencies": {
32
- "@tiptap/extension-bubble-menu": "^2.5.0-beta.2",
33
- "@tiptap/extension-floating-menu": "^2.5.0-beta.2"
32
+ "@tiptap/extension-bubble-menu": "^2.5.0-beta.4",
33
+ "@tiptap/extension-floating-menu": "^2.5.0-beta.4"
34
34
  },
35
35
  "devDependencies": {
36
- "@tiptap/core": "^2.5.0-beta.2",
37
- "@tiptap/pm": "^2.5.0-beta.2",
36
+ "@tiptap/core": "^2.5.0-beta.4",
37
+ "@tiptap/pm": "^2.5.0-beta.4",
38
38
  "@types/react": "^18.2.14",
39
39
  "@types/react-dom": "^18.2.6",
40
40
  "react": "^18.0.0",