basic-file-preview 1.0.0

package/dist/types/auto-imports.d.ts

@@ -0,0 +1,75 @@
+/* eslint-disable */
+/* prettier-ignore */
+// @ts-nocheck
+// noinspection JSUnusedGlobalSymbols
+// Generated by unplugin-auto-import
+// biome-ignore lint: disable
+export {}
+declare global {
+  const EffectScope: typeof import('vue').EffectScope
+  const ElMessage: typeof import('element-plus/es').ElMessage
+  const ElMessageBox: typeof import('element-plus/es').ElMessageBox
+  const computed: typeof import('vue').computed
+  const createApp: typeof import('vue').createApp
+  const customRef: typeof import('vue').customRef
+  const defineAsyncComponent: typeof import('vue').defineAsyncComponent
+  const defineComponent: typeof import('vue').defineComponent
+  const effectScope: typeof import('vue').effectScope
+  const getCurrentInstance: typeof import('vue').getCurrentInstance
+  const getCurrentScope: typeof import('vue').getCurrentScope
+  const getCurrentWatcher: typeof import('vue').getCurrentWatcher
+  const h: typeof import('vue').h
+  const inject: typeof import('vue').inject
+  const isProxy: typeof import('vue').isProxy
+  const isReactive: typeof import('vue').isReactive
+  const isReadonly: typeof import('vue').isReadonly
+  const isRef: typeof import('vue').isRef
+  const isShallow: typeof import('vue').isShallow
+  const markRaw: typeof import('vue').markRaw
+  const nextTick: typeof import('vue').nextTick
+  const onActivated: typeof import('vue').onActivated
+  const onBeforeMount: typeof import('vue').onBeforeMount
+  const onBeforeUnmount: typeof import('vue').onBeforeUnmount
+  const onBeforeUpdate: typeof import('vue').onBeforeUpdate
+  const onDeactivated: typeof import('vue').onDeactivated
+  const onErrorCaptured: typeof import('vue').onErrorCaptured
+  const onMounted: typeof import('vue').onMounted
+  const onRenderTracked: typeof import('vue').onRenderTracked
+  const onRenderTriggered: typeof import('vue').onRenderTriggered
+  const onScopeDispose: typeof import('vue').onScopeDispose
+  const onServerPrefetch: typeof import('vue').onServerPrefetch
+  const onUnmounted: typeof import('vue').onUnmounted
+  const onUpdated: typeof import('vue').onUpdated
+  const onWatcherCleanup: typeof import('vue').onWatcherCleanup
+  const provide: typeof import('vue').provide
+  const reactive: typeof import('vue').reactive
+  const readonly: typeof import('vue').readonly
+  const ref: typeof import('vue').ref
+  const resolveComponent: typeof import('vue').resolveComponent
+  const shallowReactive: typeof import('vue').shallowReactive
+  const shallowReadonly: typeof import('vue').shallowReadonly
+  const shallowRef: typeof import('vue').shallowRef
+  const toRaw: typeof import('vue').toRaw
+  const toRef: typeof import('vue').toRef
+  const toRefs: typeof import('vue').toRefs
+  const toValue: typeof import('vue').toValue
+  const triggerRef: typeof import('vue').triggerRef
+  const unref: typeof import('vue').unref
+  const useAttrs: typeof import('vue').useAttrs
+  const useCssModule: typeof import('vue').useCssModule
+  const useCssVars: typeof import('vue').useCssVars
+  const useId: typeof import('vue').useId
+  const useModel: typeof import('vue').useModel
+  const useSlots: typeof import('vue').useSlots
+  const useTemplateRef: typeof import('vue').useTemplateRef
+  const watch: typeof import('vue').watch
+  const watchEffect: typeof import('vue').watchEffect
+  const watchPostEffect: typeof import('vue').watchPostEffect
+  const watchSyncEffect: typeof import('vue').watchSyncEffect
+}
+// for type re-export
+declare global {
+  // @ts-ignore
+  export type { Component, Slot, Slots, ComponentPublicInstance, ComputedRef, DirectiveBinding, ExtractDefaultPropTypes, ExtractPropTypes, ExtractPublicPropTypes, InjectionKey, PropType, Ref, ShallowRef, MaybeRef, MaybeRefOrGetter, VNode, WritableComputedRef } from 'vue'
+  import('vue')
+}

package/dist/types/components/FilePreview/core/DocxPreview.d.ts

@@ -0,0 +1,7 @@
+interface Props {
+    url: string;
+}
+declare const _default: import('vue').DefineComponent<Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {
+    docxRef: unknown;
+}, any>;
+export default _default;

package/dist/types/components/FilePreview/core/ExcelPreview.d.ts

@@ -0,0 +1,5 @@
+interface Props {
+    url: string;
+}
+declare const _default: import('vue').DefineComponent<Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+export default _default;

package/dist/types/components/FilePreview/core/ImagePreview.d.ts

@@ -0,0 +1,5 @@
+interface Props {
+    url: string;
+}
+declare const _default: import('vue').DefineComponent<Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+export default _default;

package/dist/types/components/FilePreview/core/JsonPreview.d.ts

@@ -0,0 +1,5 @@
+interface Props {
+    url: string;
+}
+declare const _default: import('vue').DefineComponent<Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+export default _default;

package/dist/types/components/FilePreview/core/MarkdownPreview.d.ts

@@ -0,0 +1,6 @@
+import { Viewer } from '@bytemd/vue-next';
+interface Props {
+    url: string;
+}
+declare const _default: Viewer<Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+export default _default;

package/dist/types/components/FilePreview/core/PdfPreview.d.ts

@@ -0,0 +1,84 @@
+interface Props {
+    url: string;
+}
+declare const _default: import('vue').DefineComponent<Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {
+    pdfRef: import('vue').CreateComponentPublicInstanceWithMixins<Readonly<globalThis.ExtractPropTypes<{
+        config: {
+            default: () => ToolbarConfig;
+            type: PropType<ToolbarConfig>;
+        };
+        title: {
+            type: BooleanConstructor;
+            default: () => boolean;
+        };
+        pdf: {
+            type: (StringConstructor | ArrayBufferConstructor)[];
+        };
+        theme: PropType<Theme>;
+        fileName: StringConstructor;
+        idConfig: {
+            type: PropType<ToolbarIdConfig>;
+        };
+        pageScale: PropType<PageScale>;
+        pageNumber: NumberConstructor;
+    }>>, {
+        showElem: (defaultToolbarPath: string, customToolbarElem?: string | number | symbol) => boolean;
+        getScale: (value: number) => string;
+        slotProps: import('vue').ComputedRef<{
+            toggleTheme: () => void;
+            isSidebarHidden: boolean;
+            isFindbarHidden: boolean;
+        }>;
+        isToolbarHidden: import('vue').ComputedRef<"zero-top" | "">;
+        isSidebarToolbarHidden: import('vue').ComputedRef<string | boolean>;
+        localTheme: import('vue').ComputedRef<Theme>;
+        defaultLocale: import('vue').Ref<string>;
+        bindOpenHandler: () => void;
+    }, unknown, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, import('vue').VNodeProps & import('vue').AllowedComponentProps & import('vue').ComponentCustomProps, {
+        title: boolean;
+        config: ToolbarConfig;
+    }, true, {}, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, {}, any, import('vue').ComponentProvideOptions, {
+        P: {};
+        B: {};
+        D: {};
+        C: {};
+        M: {};
+        Defaults: {};
+    }, Readonly<globalThis.ExtractPropTypes<{
+        config: {
+            default: () => ToolbarConfig;
+            type: PropType<ToolbarConfig>;
+        };
+        title: {
+            type: BooleanConstructor;
+            default: () => boolean;
+        };
+        pdf: {
+            type: (StringConstructor | ArrayBufferConstructor)[];
+        };
+        theme: PropType<Theme>;
+        fileName: StringConstructor;
+        idConfig: {
+            type: PropType<ToolbarIdConfig>;
+        };
+        pageScale: PropType<PageScale>;
+        pageNumber: NumberConstructor;
+    }>>, {
+        showElem: (defaultToolbarPath: string, customToolbarElem?: string | number | symbol) => boolean;
+        getScale: (value: number) => string;
+        slotProps: import('vue').ComputedRef<{
+            toggleTheme: () => void;
+            isSidebarHidden: boolean;
+            isFindbarHidden: boolean;
+        }>;
+        isToolbarHidden: import('vue').ComputedRef<"zero-top" | "">;
+        isSidebarToolbarHidden: import('vue').ComputedRef<string | boolean>;
+        localTheme: import('vue').ComputedRef<Theme>;
+        defaultLocale: import('vue').Ref<string>;
+        bindOpenHandler: () => void;
+    }, {}, {}, {}, {
+        title: boolean;
+        config: ToolbarConfig;
+    }> | null;
+}, HTMLDivElement>;
+export default _default;

package/dist/types/components/FilePreview/core/PptPreview.d.ts

@@ -0,0 +1,5 @@
+interface Props {
+    url: string;
+}
+declare const _default: import('vue').DefineComponent<Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+export default _default;

package/dist/types/components/FilePreview/core/TxtPreview.d.ts

@@ -0,0 +1,7 @@
+interface Props {
+    url: string;
+}
+declare const _default: import('vue').DefineComponent<Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {
+    contentRef: HTMLPreElement;
+}, HTMLDivElement>;
+export default _default;

package/dist/types/components/FilePreview/core/index.d.ts

@@ -0,0 +1,2 @@
+export declare const supportFileSuffix: string[];
+export declare const componentMap: Record<string, any>;

package/dist/types/components/FilePreview/index.d.ts

@@ -0,0 +1,12 @@
+import { FilePreviewProps, ShowParams } from './types/index';
+declare const _default: import('vue').DefineComponent<FilePreviewProps, {
+    show: (options: ShowParams) => void;
+    close: () => void;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    "update:visible": (...args: any[]) => void;
+    close: (...args: any[]) => void;
+}, string, import('vue').PublicProps, Readonly<FilePreviewProps> & Readonly<{
+    "onUpdate:visible"?: ((...args: any[]) => any) | undefined;
+    onClose?: ((...args: any[]) => any) | undefined;
+}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+export default _default;

package/dist/types/components/FilePreview/types/index.d.ts

@@ -0,0 +1,11 @@
+export interface FilePreviewProps {
+    visible: boolean;
+    url: string;
+    name: string;
+    watermark?: string | string[];
+}
+export interface ShowParams {
+    url: string;
+    name: string;
+    watermark?: string | string[];
+}

package/dist/types/components/FilePreview/utils.d.ts

@@ -0,0 +1,3 @@
+import { ShowParams } from './types';
+export declare const getFileSuffix: (fileName: string) => string;
+export declare const validatePreviewOptions: (options: ShowParams) => boolean;

package/dist/types/components/index.d.ts

@@ -0,0 +1 @@
+export * from './FilePreview';

package/dist/types/element-ui.d.ts

@@ -0,0 +1,21 @@
+/* eslint-disable */
+// @ts-nocheck
+// biome-ignore lint: disable
+// oxlint-disable
+// ------
+// Generated by unplugin-vue-components
+// Read more: https://github.com/vuejs/core/pull/3399
+
+export {}
+
+/* prettier-ignore */
+declare module 'vue' {
+  export interface GlobalComponents {
+    ElDrawer: typeof import('element-plus/es')['ElDrawer']
+    ElImage: typeof import('element-plus/es')['ElImage']
+    ElWatermark: typeof import('element-plus/es')['ElWatermark']
+  }
+  export interface GlobalDirectives {
+    vLoading: typeof import('element-plus/es')['ElLoadingDirective']
+  }
+}

package/dist/types/index.d.ts

@@ -0,0 +1 @@
+export * from './components';

package/dist/types/utils/index.d.ts

@@ -0,0 +1,2 @@
+import { Component } from 'vue';
+export declare const withInstall: <T extends Component>(component: T) => T;

package/package.json

@@ -0,0 +1,85 @@
+{
+  "name": "basic-file-preview",
+  "private": false,
+  "version": "1.0.0",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.es.js",
+  "types": "./dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/index.es.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "author": "balabilibo",
+  "license": "MIT",
+  "description": "这是一个基于 vue3、element-plus 封装的文件预览组件，目前仅支持预览以（pdf、docx、xlsx、pptx、txt、json、md）格式结尾的文件以及常规格式的图片，并提供水印功能",
+  "keywords": [
+    "vue3",
+    "basic-file-preview",
+    "file-preview",
+    "office",
+    "txt",
+    "json",
+    "markdown"
+  ],
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "dev": "vite",
+    "build": "vue-tsc -b && vite build",
+    "preview": "vite preview"
+  },
+  "dependencies": {
+    "@bytemd/plugin-breaks": "^1.22.0",
+    "@bytemd/plugin-frontmatter": "^1.22.0",
+    "@bytemd/plugin-gemoji": "^1.22.0",
+    "@bytemd/plugin-gfm": "^1.22.0",
+    "@bytemd/plugin-highlight": "^1.22.0",
+    "@bytemd/plugin-math": "^1.22.0",
+    "@bytemd/plugin-medium-zoom": "^1.22.0",
+    "@bytemd/plugin-mermaid": "^1.22.0",
+    "@bytemd/vue-next": "^1.22.0",
+    "@rollup/plugin-commonjs": "^29.0.0",
+    "@vue-office/docx": "^1.6.3",
+    "@vue-office/excel": "^1.7.14",
+    "@vue-office/pptx": "^1.0.1",
+    "axios": "^1.13.5",
+    "bytemd": "^1.22.0",
+    "element-plus": "^2.13.2",
+    "juejin-markdown-themes": "^1.34.0",
+    "sass": "^1.97.3",
+    "unocss": "66.5.12",
+    "vue": "^3.5.25",
+    "vue-demi": "0.14.6",
+    "vue-json-viewer": "^3.0.4",
+    "vue3-pdf-app": "^1.0.3"
+  },
+  "devDependencies": {
+    "@types/node": "^24.10.1",
+    "@vitejs/plugin-vue": "^6.0.2",
+    "@vue/tsconfig": "^0.8.1",
+    "typescript": "~5.9.3",
+    "unplugin-auto-import": "^21.0.0",
+    "unplugin-vue-components": "^31.0.0",
+    "vite": "^7.3.1",
+    "vite-plugin-css-injected-by-js": "^4.0.1",
+    "vite-plugin-dts": "^4.5.4",
+    "vue-tsc": "^3.1.5"
+  },
+  "pnpm": {
+    "ignoredBuiltDependencies": [
+      "@parcel/watcher",
+      "esbuild"
+    ],
+    "onlyBuiltDependencies": [
+      "@vue-office/docx",
+      "@vue-office/excel",
+      "@vue-office/pptx",
+      "vue-demi"
+    ]
+  }
+}