@yiitap/vue 1.2.3 → 1.3.0

package/types/components/YiiEditor.vue.d.ts

@@ -1,21 +1,23 @@
+import { type PropType } from 'vue';
 import { EditorContent } from '@tiptap/vue-3';
 import OMainMenu from './menus/OMainMenu.vue';
 import OBubbleMenu from './menus/OBubbleMenu.vue';
 import OFloatingMenu from './menus/OFloatingMenu.vue';
 import OSideMenu from './menus/OSideMenu.vue';
+import type { Editor } from '@tiptap/core';
 declare const darkModeAlt: import("vue").Ref<boolean, boolean>;
 declare const editor: import("vue").ShallowRef<import("@tiptap/vue-3").Editor, import("@tiptap/vue-3").Editor>;
 declare const mainMenuOptions: import("vue").ComputedRef<{
     editor: import("@tiptap/vue-3").Editor;
-    menu: unknown[];
+    menu: string[];
 }>;
 declare const bubbleMenuOptions: import("vue").ComputedRef<{
     editor: import("@tiptap/vue-3").Editor;
-    menu: unknown[];
+    menu: string[];
 }>;
 declare const floatingMenuOptions: import("vue").ComputedRef<{
     editor: import("@tiptap/vue-3").Editor;
-    menu: unknown[];
+    menu: string[];
 }>;
 declare const sideMenuOptions: import("vue").ComputedRef<{
     editor: import("@tiptap/vue-3").Editor;
@@ -29,85 +31,130 @@ type __VLS_Slots = __VLS_PrettifyGlobal<__VLS_OmitStringIndex<typeof __VLS_ctx.$
     'toolbar-right'?: (props: typeof __VLS_6) => any;
 }>;
 declare const __VLS_self: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+    /**
+     * Initial content. This can be HTML or JSON.
+     */
     content: {
         type: (StringConstructor | ObjectConstructor)[];
         default: string;
     };
+    /**
+     * Determines if users can write into the editor.
+     */
     editable: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * Set the locale of the editor
+     */
     locale: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * By default, Yiitap is in light mode, you can set it to dark mode.
+     */
     darkMode: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * Show main menu or not.
+     */
     showMainMenu: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * Show bubble menu or not.
+     */
     showBubbleMenu: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * Show floating menu or not.
+     */
     showFloatingMenu: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * Show side menu or not.
+     */
     showSideMenu: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * Show side node or not.
+     */
     showSideNode: {
         type: BooleanConstructor;
         default: boolean;
     };
-    showContent: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    showGuide: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    scrollable: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    editorProps: {
-        type: ObjectConstructor;
-        default: () => {};
-    };
+    /**
+     * Configure the list of extensions you want to enable.
+     *
+     * By default, Yiitap enables
+     * <a href="https://github.com/yiitap/yiitap/blob/main/packages/vue/src/extensions/index.ts" target="_blank">BuiltinExtensions</a>.
+     */
     extensions: {
         type: () => string[];
         default: () => any[];
     };
+    /**
+     * Configure the list of menu items you want to enable in main menu.
+     *
+     * By default, Yiitap uses
+     * <a href="https://github.com/yiitap/yiitap/blob/main/packages/vue/src/constants/menu.ts" target="_blank">DefaultMenu</a>.
+     */
     mainMenu: {
-        type: ArrayConstructor;
+        type: () => string[];
         default: () => any[];
     };
+    /**
+     * Configure the list of menu items you want to enable in table menu.
+     *
+     * By default, Yiitap uses
+     * <a href="https://github.com/yiitap/yiitap/blob/main/packages/vue/src/constants/menu.ts" target="_blank">TableMenu</a>.
+     */
     tableMenu: {
-        type: ArrayConstructor;
+        type: () => string[];
         default: () => any[];
     };
+    /**
+     * Configure the list of menu items you want to enable in bubble menu.
+     *
+     * By default, Yiitap uses
+     * <a href="https://github.com/yiitap/yiitap/blob/main/packages/vue/src/constants/menu.ts" target="_blank">DefaultBubble</a>.
+     */
     bubbleMenu: {
-        type: ArrayConstructor;
+        type: () => string[];
         default: () => any[];
     };
+    /**
+     * Configure the list of menu items you want to enable in floating menu.
+     *
+     * By default, Yiitap uses
+     * <a href="https://github.com/yiitap/yiitap/blob/main/packages/vue/src/constants/menu.ts" target="_blank">DefaultFloating</a>.
+     */
     floatingMenu: {
-        type: ArrayConstructor;
+        type: () => string[];
         default: () => any[];
     };
+    /**
+     * Set the page view of the editor.
+     */
     pageView: {
         type: StringConstructor;
         default: string;
+        validator: (value: string) => boolean;
     };
-    options: {
-        type: ObjectConstructor;
-        default: () => {};
+    aiOption: {
+        type: PropType<AiOption>;
+        default: () => void;
     };
 }>, {
     EditorContent: typeof EditorContent;
@@ -121,307 +168,467 @@ declare const __VLS_self: import("vue").DefineComponent<import("vue").ExtractPro
     bubbleMenuOptions: typeof bubbleMenuOptions;
     floatingMenuOptions: typeof floatingMenuOptions;
     sideMenuOptions: typeof sideMenuOptions;
-}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
-    update: (...args: any[]) => void;
-    transaction: (...args: any[]) => void;
+}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {} & {
+    update: (payload: {
+        json: Object;
+        html: string;
+    }) => any;
+    transaction: (payload: {
+        editor: Editor;
+        transaction: Object;
+    }) => any;
 }, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * Initial content. This can be HTML or JSON.
+     */
     content: {
         type: (StringConstructor | ObjectConstructor)[];
         default: string;
     };
+    /**
+     * Determines if users can write into the editor.
+     */
     editable: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * Set the locale of the editor
+     */
     locale: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * By default, Yiitap is in light mode, you can set it to dark mode.
+     */
     darkMode: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * Show main menu or not.
+     */
     showMainMenu: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * Show bubble menu or not.
+     */
     showBubbleMenu: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * Show floating menu or not.
+     */
     showFloatingMenu: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * Show side menu or not.
+     */
     showSideMenu: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * Show side node or not.
+     */
     showSideNode: {
         type: BooleanConstructor;
         default: boolean;
     };
-    showContent: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    showGuide: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    scrollable: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    editorProps: {
-        type: ObjectConstructor;
-        default: () => {};
-    };
+    /**
+     * Configure the list of extensions you want to enable.
+     *
+     * By default, Yiitap enables
+     * <a href="https://github.com/yiitap/yiitap/blob/main/packages/vue/src/extensions/index.ts" target="_blank">BuiltinExtensions</a>.
+     */
     extensions: {
         type: () => string[];
         default: () => any[];
     };
+    /**
+     * Configure the list of menu items you want to enable in main menu.
+     *
+     * By default, Yiitap uses
+     * <a href="https://github.com/yiitap/yiitap/blob/main/packages/vue/src/constants/menu.ts" target="_blank">DefaultMenu</a>.
+     */
     mainMenu: {
-        type: ArrayConstructor;
+        type: () => string[];
         default: () => any[];
     };
+    /**
+     * Configure the list of menu items you want to enable in table menu.
+     *
+     * By default, Yiitap uses
+     * <a href="https://github.com/yiitap/yiitap/blob/main/packages/vue/src/constants/menu.ts" target="_blank">TableMenu</a>.
+     */
     tableMenu: {
-        type: ArrayConstructor;
+        type: () => string[];
         default: () => any[];
     };
+    /**
+     * Configure the list of menu items you want to enable in bubble menu.
+     *
+     * By default, Yiitap uses
+     * <a href="https://github.com/yiitap/yiitap/blob/main/packages/vue/src/constants/menu.ts" target="_blank">DefaultBubble</a>.
+     */
     bubbleMenu: {
-        type: ArrayConstructor;
+        type: () => string[];
         default: () => any[];
     };
+    /**
+     * Configure the list of menu items you want to enable in floating menu.
+     *
+     * By default, Yiitap uses
+     * <a href="https://github.com/yiitap/yiitap/blob/main/packages/vue/src/constants/menu.ts" target="_blank">DefaultFloating</a>.
+     */
     floatingMenu: {
-        type: ArrayConstructor;
+        type: () => string[];
         default: () => any[];
     };
+    /**
+     * Set the page view of the editor.
+     */
     pageView: {
         type: StringConstructor;
         default: string;
+        validator: (value: string) => boolean;
     };
-    options: {
-        type: ObjectConstructor;
-        default: () => {};
+    aiOption: {
+        type: PropType<AiOption>;
+        default: () => void;
     };
 }>> & Readonly<{
-    onUpdate?: (...args: any[]) => any;
-    onTransaction?: (...args: any[]) => any;
+    onUpdate?: (payload: {
+        json: Object;
+        html: string;
+    }) => any;
+    onTransaction?: (payload: {
+        editor: Editor;
+        transaction: Object;
+    }) => any;
 }>, {
+    aiOption: AiOption;
     locale: string;
     darkMode: boolean;
-    options: Record<string, any>;
     content: string | Record<string, any>;
     extensions: string[];
     editable: boolean;
-    editorProps: Record<string, any>;
-    bubbleMenu: unknown[];
-    floatingMenu: unknown[];
+    bubbleMenu: string[];
+    floatingMenu: string[];
     showMainMenu: boolean;
     showBubbleMenu: boolean;
     showFloatingMenu: boolean;
     showSideMenu: boolean;
     showSideNode: boolean;
-    showContent: boolean;
-    showGuide: boolean;
-    scrollable: boolean;
-    mainMenu: unknown[];
-    tableMenu: unknown[];
+    mainMenu: string[];
+    tableMenu: string[];
     pageView: string;
 }, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
 declare const __VLS_component: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+    /**
+     * Initial content. This can be HTML or JSON.
+     */
     content: {
         type: (StringConstructor | ObjectConstructor)[];
         default: string;
     };
+    /**
+     * Determines if users can write into the editor.
+     */
     editable: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * Set the locale of the editor
+     */
     locale: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * By default, Yiitap is in light mode, you can set it to dark mode.
+     */
     darkMode: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * Show main menu or not.
+     */
     showMainMenu: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * Show bubble menu or not.
+     */
     showBubbleMenu: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * Show floating menu or not.
+     */
     showFloatingMenu: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * Show side menu or not.
+     */
     showSideMenu: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * Show side node or not.
+     */
     showSideNode: {
         type: BooleanConstructor;
         default: boolean;
     };
-    showContent: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    showGuide: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    scrollable: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    editorProps: {
-        type: ObjectConstructor;
-        default: () => {};
-    };
+    /**
+     * Configure the list of extensions you want to enable.
+     *
+     * By default, Yiitap enables
+     * <a href="https://github.com/yiitap/yiitap/blob/main/packages/vue/src/extensions/index.ts" target="_blank">BuiltinExtensions</a>.
+     */
     extensions: {
         type: () => string[];
         default: () => any[];
     };
+    /**
+     * Configure the list of menu items you want to enable in main menu.
+     *
+     * By default, Yiitap uses
+     * <a href="https://github.com/yiitap/yiitap/blob/main/packages/vue/src/constants/menu.ts" target="_blank">DefaultMenu</a>.
+     */
     mainMenu: {
-        type: ArrayConstructor;
+        type: () => string[];
         default: () => any[];
     };
+    /**
+     * Configure the list of menu items you want to enable in table menu.
+     *
+     * By default, Yiitap uses
+     * <a href="https://github.com/yiitap/yiitap/blob/main/packages/vue/src/constants/menu.ts" target="_blank">TableMenu</a>.
+     */
     tableMenu: {
-        type: ArrayConstructor;
+        type: () => string[];
         default: () => any[];
     };
+    /**
+     * Configure the list of menu items you want to enable in bubble menu.
+     *
+     * By default, Yiitap uses
+     * <a href="https://github.com/yiitap/yiitap/blob/main/packages/vue/src/constants/menu.ts" target="_blank">DefaultBubble</a>.
+     */
     bubbleMenu: {
-        type: ArrayConstructor;
+        type: () => string[];
         default: () => any[];
     };
+    /**
+     * Configure the list of menu items you want to enable in floating menu.
+     *
+     * By default, Yiitap uses
+     * <a href="https://github.com/yiitap/yiitap/blob/main/packages/vue/src/constants/menu.ts" target="_blank">DefaultFloating</a>.
+     */
     floatingMenu: {
-        type: ArrayConstructor;
+        type: () => string[];
         default: () => any[];
     };
+    /**
+     * Set the page view of the editor.
+     */
     pageView: {
         type: StringConstructor;
         default: string;
+        validator: (value: string) => boolean;
     };
-    options: {
-        type: ObjectConstructor;
-        default: () => {};
+    aiOption: {
+        type: PropType<AiOption>;
+        default: () => void;
     };
 }>, {
+    /**
+     * Editor instance. More about <a href="https://tiptap.dev/docs/editor/api/editor" target="_blank">editor api</a>.
+     */
     editor: import("vue").ShallowRef<import("@tiptap/vue-3").Editor, import("@tiptap/vue-3").Editor>;
+    /**
+     * Whether in dark mode
+     */
     darkMode: import("vue").Ref<boolean, boolean>;
-    local: import("vue").Ref<string, string>;
-}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
-    update: (...args: any[]) => void;
-    transaction: (...args: any[]) => void;
+    /**
+     * Current locale
+     */
+    locale: import("vue").Ref<string, string>;
+}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {} & {
+    update: (payload: {
+        json: Object;
+        html: string;
+    }) => any;
+    transaction: (payload: {
+        editor: Editor;
+        transaction: Object;
+    }) => any;
 }, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * Initial content. This can be HTML or JSON.
+     */
     content: {
         type: (StringConstructor | ObjectConstructor)[];
         default: string;
     };
+    /**
+     * Determines if users can write into the editor.
+     */
     editable: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * Set the locale of the editor
+     */
     locale: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * By default, Yiitap is in light mode, you can set it to dark mode.
+     */
     darkMode: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * Show main menu or not.
+     */
     showMainMenu: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * Show bubble menu or not.
+     */
     showBubbleMenu: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * Show floating menu or not.
+     */
     showFloatingMenu: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * Show side menu or not.
+     */
     showSideMenu: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * Show side node or not.
+     */
     showSideNode: {
         type: BooleanConstructor;
         default: boolean;
     };
-    showContent: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    showGuide: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    scrollable: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    editorProps: {
-        type: ObjectConstructor;
-        default: () => {};
-    };
+    /**
+     * Configure the list of extensions you want to enable.
+     *
+     * By default, Yiitap enables
+     * <a href="https://github.com/yiitap/yiitap/blob/main/packages/vue/src/extensions/index.ts" target="_blank">BuiltinExtensions</a>.
+     */
     extensions: {
         type: () => string[];
         default: () => any[];
     };
+    /**
+     * Configure the list of menu items you want to enable in main menu.
+     *
+     * By default, Yiitap uses
+     * <a href="https://github.com/yiitap/yiitap/blob/main/packages/vue/src/constants/menu.ts" target="_blank">DefaultMenu</a>.
+     */
     mainMenu: {
-        type: ArrayConstructor;
+        type: () => string[];
         default: () => any[];
     };
+    /**
+     * Configure the list of menu items you want to enable in table menu.
+     *
+     * By default, Yiitap uses
+     * <a href="https://github.com/yiitap/yiitap/blob/main/packages/vue/src/constants/menu.ts" target="_blank">TableMenu</a>.
+     */
     tableMenu: {
-        type: ArrayConstructor;
+        type: () => string[];
         default: () => any[];
     };
+    /**
+     * Configure the list of menu items you want to enable in bubble menu.
+     *
+     * By default, Yiitap uses
+     * <a href="https://github.com/yiitap/yiitap/blob/main/packages/vue/src/constants/menu.ts" target="_blank">DefaultBubble</a>.
+     */
     bubbleMenu: {
-        type: ArrayConstructor;
+        type: () => string[];
         default: () => any[];
     };
+    /**
+     * Configure the list of menu items you want to enable in floating menu.
+     *
+     * By default, Yiitap uses
+     * <a href="https://github.com/yiitap/yiitap/blob/main/packages/vue/src/constants/menu.ts" target="_blank">DefaultFloating</a>.
+     */
     floatingMenu: {
-        type: ArrayConstructor;
+        type: () => string[];
         default: () => any[];
     };
+    /**
+     * Set the page view of the editor.
+     */
     pageView: {
         type: StringConstructor;
         default: string;
+        validator: (value: string) => boolean;
     };
-    options: {
-        type: ObjectConstructor;
-        default: () => {};
+    aiOption: {
+        type: PropType<AiOption>;
+        default: () => void;
     };
 }>> & Readonly<{
-    onUpdate?: (...args: any[]) => any;
-    onTransaction?: (...args: any[]) => any;
+    onUpdate?: (payload: {
+        json: Object;
+        html: string;
+    }) => any;
+    onTransaction?: (payload: {
+        editor: Editor;
+        transaction: Object;
+    }) => any;
 }>, {
+    aiOption: AiOption;
     locale: string;
     darkMode: boolean;
-    options: Record<string, any>;
     content: string | Record<string, any>;
     extensions: string[];
     editable: boolean;
-    editorProps: Record<string, any>;
-    bubbleMenu: unknown[];
-    floatingMenu: unknown[];
+    bubbleMenu: string[];
+    floatingMenu: string[];
     showMainMenu: boolean;
     showBubbleMenu: boolean;
     showFloatingMenu: boolean;
     showSideMenu: boolean;
     showSideNode: boolean;
-    showContent: boolean;
-    showGuide: boolean;
-    scrollable: boolean;
-    mainMenu: unknown[];
-    tableMenu: unknown[];
+    mainMenu: string[];
+    tableMenu: string[];
     pageView: string;
 }, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
 declare const _default: __VLS_WithSlots<typeof __VLS_component, __VLS_Slots>;