@yiitap/vue 0.4.0

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

@@ -0,0 +1,701 @@
+import { type PropType } from 'vue';
+import type { FocusPosition } from '@tiptap/core';
+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: string[];
+}>;
+declare const bubbleMenuOptions: import("vue").ComputedRef<{
+    editor: import("@tiptap/vue-3").Editor;
+    menu: string[];
+}>;
+declare const floatingMenuOptions: import("vue").ComputedRef<{
+    editor: import("@tiptap/vue-3").Editor;
+    menu: string[];
+}>;
+declare const sideMenuOptions: import("vue").ComputedRef<{
+    editor: import("@tiptap/vue-3").Editor;
+    menu: any[];
+}>;
+declare const __VLS_ctx: InstanceType<__VLS_PickNotAny<typeof __VLS_self, new () => {}>>;
+declare var __VLS_4: {}, __VLS_6: {};
+type __VLS_Slots = __VLS_PrettifyGlobal<__VLS_OmitStringIndex<typeof __VLS_ctx.$slots> & {
+    'toolbar-left'?: (props: typeof __VLS_4) => any;
+} & {
+    '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;
+    };
+    /**
+     * Set first block as title.
+     */
+    title: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Determines if users can write into the editor.
+     */
+    editable: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Force the cursor to jump in the editor on initialization.
+     */
+    autofocus: {
+        type: PropType<FocusPosition>;
+        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;
+    };
+    /**
+     * 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: () => 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: () => 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: () => 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: () => string[];
+        default: () => any[];
+    };
+    /**
+     * Set the page view of the editor.
+     */
+    pageView: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: string) => boolean;
+    };
+    aiOption: {
+        type: PropType<AiOption>;
+        default: () => void;
+    };
+}>, {
+    EditorContent: typeof EditorContent;
+    OMainMenu: typeof OMainMenu;
+    OBubbleMenu: typeof OBubbleMenu;
+    OFloatingMenu: typeof OFloatingMenu;
+    OSideMenu: typeof OSideMenu;
+    darkModeAlt: typeof darkModeAlt;
+    editor: typeof editor;
+    mainMenuOptions: typeof mainMenuOptions;
+    bubbleMenuOptions: typeof bubbleMenuOptions;
+    floatingMenuOptions: typeof floatingMenuOptions;
+    sideMenuOptions: typeof sideMenuOptions;
+}, {}, {}, {}, 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;
+    };
+    /**
+     * Set first block as title.
+     */
+    title: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Determines if users can write into the editor.
+     */
+    editable: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Force the cursor to jump in the editor on initialization.
+     */
+    autofocus: {
+        type: PropType<FocusPosition>;
+        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;
+    };
+    /**
+     * 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: () => 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: () => 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: () => 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: () => string[];
+        default: () => any[];
+    };
+    /**
+     * Set the page view of the editor.
+     */
+    pageView: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: string) => boolean;
+    };
+    aiOption: {
+        type: PropType<AiOption>;
+        default: () => void;
+    };
+}>> & Readonly<{
+    onUpdate?: (payload: {
+        json: Object;
+        html: string;
+    }) => any;
+    onTransaction?: (payload: {
+        editor: Editor;
+        transaction: Object;
+    }) => any;
+}>, {
+    title: boolean;
+    aiOption: AiOption;
+    locale: string;
+    darkMode: boolean;
+    content: string | Record<string, any>;
+    extensions: string[];
+    autofocus: FocusPosition;
+    editable: boolean;
+    bubbleMenu: string[];
+    floatingMenu: string[];
+    showMainMenu: boolean;
+    showBubbleMenu: boolean;
+    showFloatingMenu: boolean;
+    showSideMenu: boolean;
+    showSideNode: boolean;
+    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;
+    };
+    /**
+     * Set first block as title.
+     */
+    title: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Determines if users can write into the editor.
+     */
+    editable: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Force the cursor to jump in the editor on initialization.
+     */
+    autofocus: {
+        type: PropType<FocusPosition>;
+        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;
+    };
+    /**
+     * 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: () => 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: () => 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: () => 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: () => string[];
+        default: () => any[];
+    };
+    /**
+     * Set the page view of the editor.
+     */
+    pageView: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: string) => boolean;
+    };
+    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>;
+    /**
+     * 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;
+    };
+    /**
+     * Set first block as title.
+     */
+    title: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Determines if users can write into the editor.
+     */
+    editable: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Force the cursor to jump in the editor on initialization.
+     */
+    autofocus: {
+        type: PropType<FocusPosition>;
+        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;
+    };
+    /**
+     * 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: () => 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: () => 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: () => 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: () => string[];
+        default: () => any[];
+    };
+    /**
+     * Set the page view of the editor.
+     */
+    pageView: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: string) => boolean;
+    };
+    aiOption: {
+        type: PropType<AiOption>;
+        default: () => void;
+    };
+}>> & Readonly<{
+    onUpdate?: (payload: {
+        json: Object;
+        html: string;
+    }) => any;
+    onTransaction?: (payload: {
+        editor: Editor;
+        transaction: Object;
+    }) => any;
+}>, {
+    title: boolean;
+    aiOption: AiOption;
+    locale: string;
+    darkMode: boolean;
+    content: string | Record<string, any>;
+    extensions: string[];
+    autofocus: FocusPosition;
+    editable: boolean;
+    bubbleMenu: string[];
+    floatingMenu: string[];
+    showMainMenu: boolean;
+    showBubbleMenu: boolean;
+    showFloatingMenu: boolean;
+    showSideMenu: boolean;
+    showSideNode: boolean;
+    mainMenu: string[];
+    tableMenu: string[];
+    pageView: string;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+declare const _default: __VLS_WithSlots<typeof __VLS_component, __VLS_Slots>;
+export default _default;
+type __VLS_WithSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/types/components/buttons/OAiBtn.vue.d.ts

@@ -0,0 +1,20 @@
+declare const _default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+    name: {
+        type: StringConstructor;
+        default: string;
+    };
+    editor: {
+        type: ObjectConstructor;
+    };
+}>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    name: {
+        type: StringConstructor;
+        default: string;
+    };
+    editor: {
+        type: ObjectConstructor;
+    };
+}>> & Readonly<{}>, {
+    name: string;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+export default _default;