@tiptap/vue-3 2.0.0-beta.20 → 2.0.0-beta.201

package/README.md

@@ -7,8 +7,8 @@
 ## Introduction
 tiptap is a headless wrapper around [ProseMirror](https://ProseMirror.net) – a toolkit for building rich text WYSIWYG editors, which is already in use at many well-known companies such as *New York Times*, *The Guardian* or *Atlassian*.
 
-## Offical Documentation
+## Official Documentation
 Documentation can be found on the [tiptap website](https://tiptap.dev).
 
 ## License
-tiptap is open-sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md).
+tiptap is open sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap/blob/main/LICENSE.md).

package/dist/packages/vue-3/src/BubbleMenu.d.ts

@@ -1,18 +1,72 @@
 import { PropType } from 'vue';
 export declare const BubbleMenu: import("vue").DefineComponent<{
+    pluginKey: {
+        type: null;
+        default: string;
+    };
     editor: {
         type: PropType<import("@tiptap/core").Editor>;
         required: true;
     };
-    keepInBounds: {
-        type: PropType<boolean>;
-        default: boolean;
+    delay: {
+        type: PropType<number | undefined>;
+        default: undefined;
+    };
+    tippyOptions: {
+        type: PropType<Partial<import("tippy.js").Props> | undefined>;
+        default: () => {};
+    };
+    shouldShow: {
+        type: PropType<(props: {
+            editor: import("@tiptap/core").Editor;
+            view: import("prosemirror-view").EditorView;
+            state: import("prosemirror-state").EditorState;
+            oldState?: import("prosemirror-state").EditorState | undefined;
+            from: number;
+            to: number;
+        }) => boolean>;
+        default: null;
     };
 }, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
     [key: string]: any;
-}>, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<{
-    editor: import("@tiptap/core").Editor;
-    keepInBounds: boolean;
-} & {}>, {
-    keepInBounds: boolean;
+}>, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    pluginKey: {
+        type: null;
+        default: string;
+    };
+    editor: {
+        type: PropType<import("@tiptap/core").Editor>;
+        required: true;
+    };
+    delay: {
+        type: PropType<number | undefined>;
+        default: undefined;
+    };
+    tippyOptions: {
+        type: PropType<Partial<import("tippy.js").Props> | undefined>;
+        default: () => {};
+    };
+    shouldShow: {
+        type: PropType<(props: {
+            editor: import("@tiptap/core").Editor;
+            view: import("prosemirror-view").EditorView;
+            state: import("prosemirror-state").EditorState;
+            oldState?: import("prosemirror-state").EditorState | undefined;
+            from: number;
+            to: number;
+        }) => boolean>;
+        default: null;
+    };
+}>>, {
+    delay: number | undefined;
+    tippyOptions: Partial<import("tippy.js").Props> | undefined;
+    shouldShow: (props: {
+        editor: import("@tiptap/core").Editor;
+        view: import("prosemirror-view").EditorView;
+        state: import("prosemirror-state").EditorState;
+        oldState?: import("prosemirror-state").EditorState | undefined;
+        from: number;
+        to: number;
+    }) => boolean;
+    pluginKey: any;
 }>;

package/dist/packages/vue-3/src/Editor.d.ts

@@ -1,5 +1,5 @@
-import { EditorState, Plugin, PluginKey } from 'prosemirror-state';
 import { Editor as CoreEditor, EditorOptions } from '@tiptap/core';
+import { EditorState, Plugin, PluginKey } from 'prosemirror-state';
 import { ComponentInternalInstance, ComponentPublicInstance } from 'vue';
 import { VueRenderer } from './VueRenderer';
 export declare type ContentComponent = ComponentInternalInstance & {
@@ -7,10 +7,12 @@ export declare type ContentComponent = ComponentInternalInstance & {
 };
 export declare class Editor extends CoreEditor {
     private reactiveState;
+    private reactiveExtensionStorage;
     vueRenderers: Map<string, VueRenderer>;
     contentComponent: ContentComponent | null;
     constructor(options?: Partial<EditorOptions>);
-    get state(): EditorState<any>;
+    get state(): EditorState;
+    get storage(): Record<string, any>;
     /**
      * Register a ProseMirror plugin.
      */

package/dist/packages/vue-3/src/EditorContent.d.ts

@@ -1,4 +1,4 @@
-import { Ref, PropType, DefineComponent } from 'vue';
+import { DefineComponent, PropType, Ref } from 'vue';
 import { Editor } from './Editor';
 export declare const EditorContent: DefineComponent<{
     editor: {
@@ -7,8 +7,11 @@ export declare const EditorContent: DefineComponent<{
     };
 }, {
     rootEl: Ref<Element | undefined>;
-}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<{
-    editor: Editor;
-} & {}>, {
+}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    editor: {
+        default: null;
+        type: PropType<Editor>;
+    };
+}>>, {
     editor: Editor;
 }>;

package/dist/packages/vue-3/src/FloatingMenu.d.ts

@@ -1,11 +1,57 @@
 import { PropType } from 'vue';
 export declare const FloatingMenu: import("vue").DefineComponent<{
+    pluginKey: {
+        type: null;
+        default: string;
+    };
     editor: {
         type: PropType<import("@tiptap/core").Editor>;
         required: true;
     };
+    tippyOptions: {
+        type: PropType<Partial<import("tippy.js").Props> | undefined>;
+        default: () => {};
+    };
+    shouldShow: {
+        type: PropType<(props: {
+            editor: import("@tiptap/core").Editor;
+            view: import("prosemirror-view").EditorView;
+            state: import("prosemirror-state").EditorState;
+            oldState?: import("prosemirror-state").EditorState | undefined;
+        }) => boolean>;
+        default: null;
+    };
 }, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
     [key: string]: any;
-}>, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<{
-    editor: import("@tiptap/core").Editor;
-} & {}>, {}>;
+}>, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    pluginKey: {
+        type: null;
+        default: string;
+    };
+    editor: {
+        type: PropType<import("@tiptap/core").Editor>;
+        required: true;
+    };
+    tippyOptions: {
+        type: PropType<Partial<import("tippy.js").Props> | undefined>;
+        default: () => {};
+    };
+    shouldShow: {
+        type: PropType<(props: {
+            editor: import("@tiptap/core").Editor;
+            view: import("prosemirror-view").EditorView;
+            state: import("prosemirror-state").EditorState;
+            oldState?: import("prosemirror-state").EditorState | undefined;
+        }) => boolean>;
+        default: null;
+    };
+}>>, {
+    tippyOptions: Partial<import("tippy.js").Props> | undefined;
+    shouldShow: (props: {
+        editor: import("@tiptap/core").Editor;
+        view: import("prosemirror-view").EditorView;
+        state: import("prosemirror-state").EditorState;
+        oldState?: import("prosemirror-state").EditorState | undefined;
+    }) => boolean;
+    pluginKey: any;
+}>;

package/dist/packages/vue-3/src/NodeViewContent.d.ts

@@ -3,8 +3,11 @@ export declare const NodeViewContent: import("vue").DefineComponent<{
         type: StringConstructor;
         default: string;
     };
-}, unknown, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<{
-    as: string;
-} & {}>, {
+}, unknown, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    as: {
+        type: StringConstructor;
+        default: string;
+    };
+}>>, {
     as: string;
 }>;

package/dist/packages/vue-3/src/NodeViewWrapper.d.ts

@@ -3,8 +3,11 @@ export declare const NodeViewWrapper: import("vue").DefineComponent<{
         type: StringConstructor;
         default: string;
     };
-}, unknown, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<{
-    as: string;
-} & {}>, {
+}, unknown, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    as: {
+        type: StringConstructor;
+        default: string;
+    };
+}>>, {
     as: string;
 }>;

package/dist/packages/vue-3/src/VueNodeViewRenderer.d.ts

@@ -1,42 +1,48 @@
-import { NodeViewRenderer } from '@tiptap/core';
-import { PropType, Component } from 'vue';
-import { Decoration } from 'prosemirror-view';
+import { NodeViewRenderer, NodeViewRendererOptions } from '@tiptap/core';
 import { Node as ProseMirrorNode } from 'prosemirror-model';
+import { Decoration } from 'prosemirror-view';
+import { Component, PropType } from 'vue';
 export declare const nodeViewProps: {
     editor: {
         type: PropType<import("@tiptap/core").Editor>;
-        required: boolean;
+        required: true;
     };
     node: {
-        type: PropType<ProseMirrorNode<any>>;
-        required: boolean;
+        type: PropType<ProseMirrorNode>;
+        required: true;
     };
     decorations: {
-        type: PropType<Decoration<{
-            [key: string]: any;
-        }>[]>;
-        required: boolean;
+        type: PropType<Decoration[]>;
+        required: true;
     };
     selected: {
         type: PropType<boolean>;
-        required: boolean;
+        required: true;
     };
     extension: {
-        type: PropType<import("@tiptap/core").Node<any>>;
-        required: boolean;
+        type: PropType<import("@tiptap/core").Node<any, any>>;
+        required: true;
     };
     getPos: {
         type: PropType<() => number>;
-        required: boolean;
+        required: true;
     };
     updateAttributes: {
-        type: PropType<(attributes: import("@tiptap/core").AnyObject) => void>;
-        required: boolean;
+        type: PropType<(attributes: Record<string, any>) => void>;
+        required: true;
+    };
+    deleteNode: {
+        type: PropType<() => void>;
+        required: true;
     };
 };
-interface VueNodeViewRendererOptions {
-    stopEvent: ((event: Event) => boolean) | null;
-    update: ((node: ProseMirrorNode, decorations: Decoration[]) => boolean) | null;
+export interface VueNodeViewRendererOptions extends NodeViewRendererOptions {
+    update: ((props: {
+        oldNode: ProseMirrorNode;
+        oldDecorations: Decoration[];
+        newNode: ProseMirrorNode;
+        newDecorations: Decoration[];
+        updateProps: () => void;
+    }) => boolean) | null;
 }
 export declare function VueNodeViewRenderer(component: Component, options?: Partial<VueNodeViewRendererOptions>): NodeViewRenderer;
-export {};

package/dist/packages/vue-3/src/VueRenderer.d.ts

@@ -1,19 +1,19 @@
+import { Editor } from '@tiptap/core';
 import { Component } from 'vue';
-import { AnyObject } from '@tiptap/core';
-import { Editor } from './Editor';
+import { Editor as ExtendedEditor } from './Editor';
 export interface VueRendererOptions {
     editor: Editor;
-    props?: AnyObject;
+    props?: Record<string, any>;
 }
 export declare class VueRenderer {
     id: string;
-    editor: Editor;
+    editor: ExtendedEditor;
     component: Component;
     teleportElement: Element;
     element: Element;
-    props: AnyObject;
+    props: Record<string, any>;
     constructor(component: Component, { props, editor }: VueRendererOptions);
     get ref(): any;
-    updateProps(props?: AnyObject): void;
+    updateProps(props?: Record<string, any>): void;
     destroy(): void;
 }

package/dist/packages/vue-3/src/index.d.ts

@@ -1,10 +1,10 @@
-export * from '@tiptap/core';
 export * from './BubbleMenu';
 export { Editor } from './Editor';
 export * from './EditorContent';
 export * from './FloatingMenu';
+export * from './NodeViewContent';
+export * from './NodeViewWrapper';
 export * from './useEditor';
-export * from './VueRenderer';
 export * from './VueNodeViewRenderer';
-export * from './NodeViewWrapper';
-export * from './NodeViewContent';
+export * from './VueRenderer';
+export * from '@tiptap/core';

package/dist/packages/vue-3/src/useEditor.d.ts

@@ -1,3 +1,3 @@
 import { EditorOptions } from '@tiptap/core';
 import { Editor } from './Editor';
-export declare const useEditor: (options?: Partial<EditorOptions>) => import("vue").Ref<Editor | undefined>;
+export declare const useEditor: (options?: Partial<EditorOptions>) => import("vue").ShallowRef<Editor | undefined>;