vdc-editor 0.0.1

package/lib/src/hooks/useStore.d.ts

@@ -0,0 +1,160 @@
+import { AnyExtension } from '@tiptap/core';
+import { PageOption } from '../type';
+import { Editor } from '@tiptap/vue-3';
+
+export type EditorState = {
+    text: string;
+    html: string;
+    json: Object | null;
+};
+/**
+ * Interface representing an tiptap editor instance.
+ */
+interface Instance {
+    /**
+     * List of extensions
+     *
+     * @default []
+     */
+    extensions: AnyExtension[];
+    /**
+     * Default language setting
+     *
+     * @default DEFAULT_LANG_VALUE
+     */
+    defaultLang?: string;
+    /**
+     * Whether it is in fullscreen mode
+     *
+     * @default false
+     */
+    /** Text color */
+    color?: string;
+    /** Highlight color */
+    highlight?: string;
+    zoom?: number[];
+    editor: EditorState;
+    fontFamily: string;
+    fontSize: string;
+    viewSuperText?: boolean;
+    /** Preview visibility */
+    showPreview: boolean;
+    /** SpellCheck */
+    spellCheck: boolean;
+    /** FindAndReplace */
+    findAndReplace: boolean;
+    /** Printer */
+    printer: boolean;
+}
+export declare const useTiptapStore: () => {
+    state: Instance;
+    page: globalThis.Ref<{
+        defaultMargin?: {
+            left: number;
+            right: number;
+            top: number;
+            bottom: number;
+        } | undefined;
+        defaultOrientation?: string | undefined;
+        defaultBackground?: string | undefined;
+        nodesComputedOption?: {
+            types: string[];
+            nodesComputed: import('../type').NodesComputed;
+        } | undefined;
+        size?: {
+            width: number;
+            height: number;
+            label?: string | undefined;
+        } | undefined;
+        margin?: {
+            right: string;
+            left: string;
+            bottom: string;
+            top: string;
+            layout?: "narrow" | "moderate" | "wide" | "custom" | undefined;
+        } | undefined;
+        orientation?: string | undefined;
+        background?: string | undefined;
+        header?: boolean | undefined;
+        footer?: boolean | undefined;
+        showLineNumber?: boolean | undefined;
+        showToc?: boolean | undefined;
+        pagination?: boolean | undefined;
+        zoomLevel?: number | undefined;
+        bodyHeight?: number | undefined;
+        autoWidth?: boolean | undefined;
+        preview?: {
+            enabled?: boolean | undefined;
+            laserPointer?: boolean | undefined;
+        } | undefined;
+    }, PageOption | {
+        defaultMargin?: {
+            left: number;
+            right: number;
+            top: number;
+            bottom: number;
+        } | undefined;
+        defaultOrientation?: string | undefined;
+        defaultBackground?: string | undefined;
+        nodesComputedOption?: {
+            types: string[];
+            nodesComputed: import('../type').NodesComputed;
+        } | undefined;
+        size?: {
+            width: number;
+            height: number;
+            label?: string | undefined;
+        } | undefined;
+        margin?: {
+            right: string;
+            left: string;
+            bottom: string;
+            top: string;
+            layout?: "narrow" | "moderate" | "wide" | "custom" | undefined;
+        } | undefined;
+        orientation?: string | undefined;
+        background?: string | undefined;
+        header?: boolean | undefined;
+        footer?: boolean | undefined;
+        showLineNumber?: boolean | undefined;
+        showToc?: boolean | undefined;
+        pagination?: boolean | undefined;
+        zoomLevel?: number | undefined;
+        bodyHeight?: number | undefined;
+        autoWidth?: boolean | undefined;
+        preview?: {
+            enabled?: boolean | undefined;
+            laserPointer?: boolean | undefined;
+        } | undefined;
+    }>;
+    isFullscreen: globalThis.Ref<boolean, boolean>;
+    toggleFullscreen: () => Promise<void>;
+    updateEditorState: (e: Editor) => void;
+    setEditor: (editorInstance: Editor) => void;
+    isReady: globalThis.Ref<boolean, boolean>;
+    container: string;
+    editor: globalThis.Ref<Editor | undefined, Editor | undefined>;
+    changeZoom: (zoom: number) => void;
+    changePageOption: (_otp: PageOption) => void;
+    changeFontFamily: (font: string) => void;
+    changeFontSize: (size: string) => void;
+    toggleSuperText: () => void;
+    superTextStore: {
+        removeSuperText: (state: Pick<import('./useSuperTextStore').ModalState, "id">) => void;
+        superText: import('vue').Reactive<import('./useSuperTextStore').ModalState[]>;
+        updateSuperText: (state: import('./useSuperTextStore').ModalState) => void;
+        updatePositionSuperText: (state: Pick<import('./useSuperTextStore').ModalState, "position" | "id">) => void;
+        addMoreSuperText: (text: string, position?: DOMRect) => string;
+        addSuperText: (state: import('./useSuperTextStore').ModalState) => void;
+        onUpdatePositionEvent: import('@vueuse/shared').EventHookOn<any>;
+        onUpdatePositionTrigger: import('@vueuse/shared').EventHookTrigger<any>;
+        onHoverEvent: import('@vueuse/shared').EventHookOn<any>;
+        onHoverEventTrigger: import('@vueuse/shared').EventHookTrigger<any>;
+    };
+    checkSpellStore: {
+        languages: "ko" | "en";
+        update: (payload: Partial<import('./useCheckSpellStore').SpellCheckState>) => void;
+        limit: number;
+    };
+};
+export {};

package/lib/src/hooks/useSuperTextStore.d.ts

@@ -0,0 +1,20 @@
+export type ModalState = {
+    id: number | string;
+    text: string;
+    position?: {
+        top?: number | string;
+        left?: number | string;
+    };
+};
+export declare const useSuperTextStore: () => {
+    removeSuperText: (state: Pick<ModalState, "id">) => void;
+    superText: import('vue').Reactive<ModalState[]>;
+    updateSuperText: (state: ModalState) => void;
+    updatePositionSuperText: (state: Pick<ModalState, "position" | "id">) => void;
+    addMoreSuperText: (text: string, position?: DOMRect) => string;
+    addSuperText: (state: ModalState) => void;
+    onUpdatePositionEvent: import('@vueuse/shared').EventHookOn<any>;
+    onUpdatePositionTrigger: import('@vueuse/shared').EventHookTrigger<any>;
+    onHoverEvent: import('@vueuse/shared').EventHookOn<any>;
+    onHoverEventTrigger: import('@vueuse/shared').EventHookTrigger<any>;
+};

package/lib/src/i18n.d.ts

@@ -0,0 +1,337 @@
+declare const _default: import('vue-i18n').I18n<{
+    en: {
+        "editor.remove": string;
+        "editor.copy": string;
+        "editor.words": string;
+        "editor.characters": string;
+        "editor.default": string;
+        "editor.recent": string;
+        "editor.nofill": string;
+        "editor.format": string;
+        "editor.close": string;
+        "editor.modify": string;
+        "editor.preview.tooltip": string;
+        "editor.draghandle.tooltip": string;
+        "editor.copyToClipboard": string;
+        "editor.importWord.tooltip": string;
+        "editor.importWord.success": string;
+        "editor.importWord.fileTooLarge": string;
+        "editor.importWord.error": string;
+        "editor.slash": string;
+        "editor.slash.empty": string;
+        "editor.slash.format": string;
+        "editor.slash.insert": string;
+        "editor.slash.embed": string;
+        "editor.content": string;
+        "editor.moremark": string;
+        "editor.size.small.tooltip": string;
+        "editor.size.medium.tooltip": string;
+        "editor.size.large.tooltip": string;
+        "editor.bold.tooltip": string;
+        "editor.italic.tooltip": string;
+        "editor.underline.tooltip": string;
+        "editor.strike.tooltip": string;
+        "editor.color.tooltip": string;
+        "editor.color.more": string;
+        "editor.highlight.tooltip": string;
+        "editor.lineheight.tooltip": string;
+        "editor.heading.tooltip": string;
+        "editor.heading.h1.tooltip": string;
+        "editor.heading.h2.tooltip": string;
+        "editor.heading.h3.tooltip": string;
+        "editor.heading.h4.tooltip": string;
+        "editor.heading.h5.tooltip": string;
+        "editor.heading.h6.tooltip": string;
+        "editor.paragraph.tooltip": string;
+        "editor.textalign.tooltip": string;
+        "editor.textalign.left.tooltip": string;
+        "editor.textalign.center.tooltip": string;
+        "editor.textalign.right.tooltip": string;
+        "editor.textalign.justify.tooltip": string;
+        "editor.indent": string;
+        "editor.indent.indent": string;
+        "editor.indent.outdent": string;
+        "editor.fontFamily.tooltip": string;
+        "editor.fontFamily.default": string;
+        "editor.fontSize.tooltip": string;
+        "editor.fontSize.default.tooltip": string;
+        "editor.superscript.tooltip": string;
+        "editor.subscript.tooltip": string;
+        "editor.bulletlist.tooltip": string;
+        "editor.bulletlist.disc.tooltip": string;
+        "editor.bulletlist.circle.tooltip": string;
+        "editor.bulletlist.square.tooltip": string;
+        "editor.orderedlist.tooltip": string;
+        "editor.orderedlist.decimal.tooltip": string;
+        "editor.orderedlist.decimalLeadingZero.tooltip": string;
+        "editor.orderedlist.lowerRoman.tooltip": string;
+        "editor.orderedlist.upperRoman.tooltip": string;
+        "editor.orderedlist.lowerLatin.tooltip": string;
+        "editor.orderedlist.upperLatin.tooltip": string;
+        "editor.orderedlist.tradChineseInformal.tooltip": string;
+        "editor.orderedlist.simpChineseFormal.tooltip": string;
+        "editor.tasklist.tooltip": string;
+        "editor.indent.tooltip": string;
+        "editor.outdent.tooltip": string;
+        "editor.columns.tooltip": string;
+        "editor.link.tooltip": string;
+        "editor.link.unlink.tooltip": string;
+        "editor.link.open.tooltip": string;
+        "editor.link.edit.tooltip": string;
+        "editor.link.dialog.title": string;
+        "editor.link.dialog.link": string;
+        "editor.link.dialog.text": string;
+        "editor.link.dialog.openInNewTab": string;
+        "editor.link.dialog.link.placeholder": string;
+        "editor.link.dialog.text.placeholder": string;
+        "editor.link.dialog.button.apply": string;
+        "editor.image.tooltip": string;
+        "editor.image.menu.flipX": string;
+        "editor.image.menu.flipY": string;
+        "editor.image.menu.size": string;
+        "editor.image.menu.size.width": string;
+        "editor.image.menu.size.height": string;
+        "editor.image.dragger.tooltip": string;
+        "editor.image.float.left.tooltip": string;
+        "editor.image.float.none.tooltip": string;
+        "editor.image.float.right.tooltip": string;
+        "editor.image.dialog.title": string;
+        "editor.image.dialog.tab.url": string;
+        "editor.image.dialog.tab.upload": string;
+        "editor.image.dialog.uploading": string;
+        "editor.image.dialog.form.link": string;
+        "editor.image.dialog.placeholder": string;
+        "editor.image.dialog.form.alt": string;
+        "editor.image.dialog.form.aspectRatio": string;
+        "editor.image.dialog.form.file": string;
+        "editor.image.dialog.button.apply": string;
+        "editor.video.tooltip": string;
+        "editor.video.dialog.tab.upload": string;
+        "editor.video.dialog.uploading": string;
+        "editor.video.dialog.title": string;
+        "editor.video.dialog.link": string;
+        "editor.video.dialog.placeholder": string;
+        "editor.video.dialog.button.apply": string;
+        "editor.table.tooltip": string;
+        "editor.table.menu.insert_table": string;
+        "editor.table.menu.insert_table.with_header_row": string;
+        "editor.table.menu.insertColumnBefore": string;
+        "editor.table.menu.insertColumnAfter": string;
+        "editor.table.menu.deleteColumn": string;
+        "editor.table.menu.insertRowAbove": string;
+        "editor.table.menu.insertRowBelow": string;
+        "editor.table.menu.deleteRow": string;
+        "editor.table.menu.mergeCells": string;
+        "editor.table.menu.splitCells": string;
+        "editor.table.menu.deleteTable": string;
+        "editor.table.menu.setCellsBgColor": string;
+        "editor.blockquote.tooltip": string;
+        "editor.horizontalrule.tooltip": string;
+        "editor.code.tooltip": string;
+        "editor.codeblock.tooltip": string;
+        "editor.clear.tooltip": string;
+        "editor.undo.tooltip": string;
+        "editor.redo.tooltip": string;
+        "editor.fullscreen.tooltip.fullscreen": string;
+        "editor.fullscreen.tooltip.exit": string;
+        "editor.imageUpload.fileTypeNotSupported": string;
+        "editor.imageUpload.fileSizeTooBig": string;
+        "editor.AI.placeholder": string;
+        "editor.AI.generating": string;
+        "editor.AI.insert": string;
+        "editor.AI.replace": string;
+        "editor.AI.regenerate": string;
+        "editor.AI.close": string;
+        "editor.AI.stop": string;
+        "editor.AI.ask": string;
+        "editor.menubar.file": string;
+        "editor.menubar.edit": string;
+        "editor.menubar.view": string;
+        "editor.menubar.insert": string;
+        "editor.menubar.format": string;
+        "editor.menubar.menu.newDoc": string;
+        "editor.menubar.menu.restoreLastDraft": string;
+        "editor.menubar.menu.print": string;
+        "editor.menubar.menu.cut": string;
+        "editor.menubar.menu.copy": string;
+        "editor.menubar.menu.paste": string;
+        "editor.menubar.menu.pasteAsText": string;
+        "editor.menubar.menu.selectAll": string;
+        "editor.menubar.menu.preview": string;
+        "editor.menubar.menu.spellCheck": string;
+        "editor.findAndReplace.tooltip": string;
+        "editor.findAndReplace.find": string;
+        "editor.findAndReplace.replace": string;
+        "editor.findAndReplace.replaceAll": string;
+        "editor.findAndReplace.caseSensitive": string;
+        "editor.printer.tooltip": string;
+    };
+    ko: {
+        "editor.remove": string;
+        "editor.copy": string;
+        "editor.words": string;
+        "editor.characters": string;
+        "editor.default": string;
+        "editor.recent": string;
+        "editor.nofill": string;
+        "editor.format": string;
+        "editor.close": string;
+        "editor.modify": string;
+        "editor.preview.tooltip": string;
+        "editor.draghandle.tooltip": string;
+        "editor.copyToClipboard": string;
+        "editor.importWord.tooltip": string;
+        "editor.importWord.success": string;
+        "editor.importWord.fileTooLarge": string;
+        "editor.importWord.error": string;
+        "editor.slash": string;
+        "editor.slash.empty": string;
+        "editor.slash.format": string;
+        "editor.slash.insert": string;
+        "editor.slash.embed": string;
+        "editor.content": string;
+        "editor.moremark": string;
+        "editor.size.small.tooltip": string;
+        "editor.size.medium.tooltip": string;
+        "editor.size.large.tooltip": string;
+        "editor.bold.tooltip": string;
+        "editor.italic.tooltip": string;
+        "editor.underline.tooltip": string;
+        "editor.strike.tooltip": string;
+        "editor.color.tooltip": string;
+        "editor.color.more": string;
+        "editor.highlight.tooltip": string;
+        "editor.lineheight.tooltip": string;
+        "editor.heading.tooltip": string;
+        "editor.heading.h1.tooltip": string;
+        "editor.heading.h2.tooltip": string;
+        "editor.heading.h3.tooltip": string;
+        "editor.heading.h4.tooltip": string;
+        "editor.heading.h5.tooltip": string;
+        "editor.heading.h6.tooltip": string;
+        "editor.paragraph.tooltip": string;
+        "editor.textalign.tooltip": string;
+        "editor.textalign.left.tooltip": string;
+        "editor.textalign.center.tooltip": string;
+        "editor.textalign.right.tooltip": string;
+        "editor.textalign.justify.tooltip": string;
+        "editor.indent": string;
+        "editor.indent.indent": string;
+        "editor.indent.outdent": string;
+        "editor.fontFamily.tooltip": string;
+        "editor.fontFamily.default": string;
+        "editor.fontSize.tooltip": string;
+        "editor.fontSize.default.tooltip": string;
+        "editor.superscript.tooltip": string;
+        "editor.subscript.tooltip": string;
+        "editor.bulletlist.tooltip": string;
+        "editor.bulletlist.disc.tooltip": string;
+        "editor.bulletlist.circle.tooltip": string;
+        "editor.bulletlist.square.tooltip": string;
+        "editor.orderedlist.tooltip": string;
+        "editor.orderedlist.decimal.tooltip": string;
+        "editor.orderedlist.decimalLeadingZero.tooltip": string;
+        "editor.orderedlist.lowerRoman.tooltip": string;
+        "editor.orderedlist.upperRoman.tooltip": string;
+        "editor.orderedlist.lowerLatin.tooltip": string;
+        "editor.orderedlist.upperLatin.tooltip": string;
+        "editor.orderedlist.tradChinaInformal.tooltip": string;
+        "editor.orderedlist.simpChinaFormal.tooltip": string;
+        "editor.tasklist.tooltip": string;
+        "editor.indent.tooltip": string;
+        "editor.outdent.tooltip": string;
+        "editor.columns.tooltip": string;
+        "editor.link.tooltip": string;
+        "editor.link.unlink.tooltip": string;
+        "editor.link.open.tooltip": string;
+        "editor.link.edit.tooltip": string;
+        "editor.link.dialog.title": string;
+        "editor.link.dialog.link": string;
+        "editor.link.dialog.text": string;
+        "editor.link.dialog.openInNewTab": string;
+        "editor.link.dialog.link.placeholder": string;
+        "editor.link.dialog.text.placeholder": string;
+        "editor.link.dialog.button.apply": string;
+        "editor.image.tooltip": string;
+        "editor.image.menu.flipX": string;
+        "editor.image.menu.flipY": string;
+        "editor.image.menu.size": string;
+        "editor.image.menu.size.width": string;
+        "editor.image.menu.size.height": string;
+        "editor.image.dragger.tooltip": string;
+        "editor.image.float.left.tooltip": string;
+        "editor.image.float.none.tooltip": string;
+        "editor.image.float.right.tooltip": string;
+        "editor.image.dialog.title": string;
+        "editor.image.dialog.tab.url": string;
+        "editor.image.dialog.tab.upload": string;
+        "editor.image.dialog.uploading": string;
+        "editor.image.dialog.form.link": string;
+        "editor.image.dialog.placeholder": string;
+        "editor.image.dialog.form.alt": string;
+        "editor.image.dialog.form.aspectRatio": string;
+        "editor.image.dialog.form.file": string;
+        "editor.image.dialog.button.apply": string;
+        "editor.video.tooltip": string;
+        "editor.video.dialog.tab.upload": string;
+        "editor.video.dialog.uploading": string;
+        "editor.video.dialog.title": string;
+        "editor.video.dialog.link": string;
+        "editor.video.dialog.placeholder": string;
+        "editor.video.dialog.button.apply": string;
+        "editor.table.tooltip": string;
+        "editor.table.menu.insert_table": string;
+        "editor.table.menu.insert_table.with_header_row": string;
+        "editor.table.menu.insertColumnBefore": string;
+        "editor.table.menu.insertColumnAfter": string;
+        "editor.table.menu.deleteColumn": string;
+        "editor.table.menu.insertRowAbove": string;
+        "editor.table.menu.insertRowBelow": string;
+        "editor.table.menu.deleteRow": string;
+        "editor.table.menu.mergeCells": string;
+        "editor.table.menu.splitCells": string;
+        "editor.table.menu.deleteTable": string;
+        "editor.table.menu.setCellsBgColor": string;
+        "editor.blockquote.tooltip": string;
+        "editor.horizontalrule.tooltip": string;
+        "editor.code.tooltip": string;
+        "editor.codeblock.tooltip": string;
+        "editor.clear.tooltip": string;
+        "editor.undo.tooltip": string;
+        "editor.redo.tooltip": string;
+        "editor.fullscreen.tooltip.fullscreen": string;
+        "editor.fullscreen.tooltip.exit": string;
+        "editor.imageUpload.fileTypeNotSupported": string;
+        "editor.imageUpload.fileSizeTooBig": string;
+        "editor.AI.placeholder": string;
+        "editor.AI.geneating": string;
+        "editor.AI.insert": string;
+        "editor.AI.replace": string;
+        "editor.AI.regenerate": string;
+        "editor.AI.close": string;
+        "editor.AI.stop": string;
+        "editor.AI.ask": string;
+        "editor.menubar.file": string;
+        "editor.menubar.edit": string;
+        "editor.menubar.view": string;
+        "editor.menubar.insert": string;
+        "editor.menubar.format": string;
+        "editor.menubar.menu.newDoc": string;
+        "editor.menubar.menu.restoreLastDraft": string;
+        "editor.menubar.menu.print": string;
+        "editor.menubar.menu.cut": string;
+        "editor.menubar.menu.copy": string;
+        "editor.menubar.menu.paste": string;
+        "editor.menubar.menu.pasteAsText": string;
+        "editor.menubar.menu.selectAll": string;
+        "editor.menubar.menu.preview": string;
+        "editor.menubar.menu.spellCheck": string;
+        "editor.findAndReplace.tooltip": string;
+        "editor.findAndReplace.find": string;
+        "editor.findAndReplace.replace": string;
+        "editor.findAndReplace.replaceAll": string;
+        "editor.findAndReplace.caseSensitive": string;
+        "editor.printer.tooltip": string;
+    };
+}, {}, {}, string, false>;
+export default _default;

package/lib/src/index.d.ts

@@ -0,0 +1,12 @@
+import { Plugin } from 'vue';
+import { default as CoreEditor } from './components/CoreEditor.vue';
+import { default as ActionButton } from './components/ActionButton.vue';
+
+declare const SBSEditorPlugin: Plugin;
+export * from './extensions';
+export * from './hooks';
+export type * from './type';
+export { useEditor } from '@tiptap/vue-3';
+export { type Editor as EditorInstance } from '@tiptap/core';
+export { SBSEditorPlugin, CoreEditor, ActionButton };
+export default SBSEditorPlugin;

package/lib/src/plugins/image-upload.d.ts

@@ -0,0 +1,12 @@
+import { Plugin } from '@tiptap/pm/state';
+import { DecorationSet, EditorView } from '@tiptap/pm/view';
+
+export declare const UploadImagesPlugin: () => Plugin<DecorationSet>;
+export interface ImageUploadOptions {
+    validateFn?: (file: File) => boolean;
+    onUpload: (file: File) => Promise<string | object>;
+}
+export type UploadFn = (files: File[], view: EditorView, pos: number) => void;
+export declare const createImageUpload: ({ validateFn, onUpload }: ImageUploadOptions) => UploadFn;
+export declare const handleImagePaste: (view: EditorView, event: ClipboardEvent, uploadFn: UploadFn) => boolean;
+export declare const handleImageDrop: (view: EditorView, event: DragEvent, moved: boolean, uploadFn: UploadFn) => boolean;