@ibiz-template-plugin/ibiz-file-previewer 0.0.5 → 0.0.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/README.md +47 -21
  2. package/dist/index.cjs +1 -1
  3. package/dist/index.es.js +3 -0
  4. package/dist/index.umd.js +1 -1
  5. package/dist/style.css +1 -1
  6. package/package.json +1 -1
package/README.md CHANGED
@@ -25,7 +25,7 @@
25
25
  - 导出为 MD（非 MD 文件）
26
26
  6. 实现文件类型处理：
27
27
  - 基于文件后缀解析文件类型
28
- - 支持 html、md、txt、json、pdf 等类型
28
+ - 基于文件类型计算文件引擎
29
29
  - 动态分发至对应预览组件
30
30
  7. 逻辑与 UI 分离：
31
31
  - 预览壳组件负责界面绘制
@@ -35,11 +35,11 @@
35
35
 
36
36
  | 参数名称 | 类型 | 说明 | 默认值 |
37
37
  | --------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | ------ |
38
- | theme | `'light' | 'dark'` | 主题 | 'dark' |
38
+ | theme | `'light' \| 'dark'` | 主题 | 'dark' |
39
39
  | selector | string | 预览组件的挂载点（必填） | --- |
40
- | getContent | `(id: string,type: string,cat: string): Promise<string | object | undefined>` | 获取预览文件的内容，参数依次为：文件标识，文件类型，存储位置名称 | --- |
41
- | getImgContent | `(id: string, type: FileType, cat: string) => Promise<string>` | 获取预览图片内容，参数依次为：文件标识，文件类型，存储目录 | --- |
42
- | upLoadFileToOss | `(url: string): Promise<{ id: string; name: string; cat: string } | undefined>` | 上传文件至oss，参数为上传路径 | --- |
40
+ | getContent | `(id: string,type: string,cat: string): Promise<string \| object \| undefined>` | 获取预览文件的内容，参数依次为：文件标识，文件类型，存储位置名称 | --- |
41
+ | getImgContent | `(id: string, type: FileType, cat: string): Promise<string>` | 获取预览图片内容，参数依次为：文件标识，文件类型，存储目录，标准图片返回值必须为：图片url路径或者图片Base64内容，SVG图片必须为：图片html内容 | --- |
42
+ | upLoadFileToOss | `(url: string): Promise<{ id: string; name: string; cat: string } \| undefined>` | 上传文件至oss，参数为上传路径 | --- |
43
43
  | downLoadFile | `(id: string, name: string, cat: string): Promise<void>` | 下载文件，参数依次为：文件标识，文件名称，存储位置名称 | --- |
44
44
  | actionSuccessCallBack | `(type: string): Promise<void>` | 文件操作成功回调，参数为文件类型 | --- |
45
45
 
@@ -61,7 +61,7 @@
61
61
 
62
62
  PDF引擎类型：预览、缩略图、顺/逆时针旋转、上/下一页、引擎模式切换、显示模式切换、缩小/放大、重置、下载源文件
63
63
 
64
- 图片引擎类型：预览、顺/逆时针旋转、图片拖拽、显示模式切换、缩小/放大、重置、下载源文件、复制文本内容
64
+ IMG引擎类型：预览、顺/逆时针旋转、图片拖拽、显示模式切换、缩小/放大、重置、下载源文件、复制文本内容
65
65
 
66
66
  3. 逻辑与 UI 分离：
67
67
 
@@ -80,7 +80,46 @@
80
80
  - 使用 SCSS 实现响应式样式及组件主题
81
81
  - 确保 HTML 结构语义化且符合可访问性标准
82
82
 
83
- ## 文件预览支持
83
+ ## 文件引擎
84
+
85
+ ### MD引擎
86
+
87
+ | 文件扩展名 | 支持情况 |
88
+ | ---------- | -------- |
89
+ | html | 已支持 |
90
+ | md | 已支持 |
91
+
92
+ ### HTML引擎
93
+
94
+ | 文件扩展名 | 支持情况 |
95
+ | ---------- | -------- |
96
+ | xls | 已支持 |
97
+ | xlsx | 已支持 |
98
+ | et | 已支持 |
99
+ | doc | 已支持 |
100
+ | docx | 已支持 |
101
+ | wps | 已支持 |
102
+
103
+ ### TXT引擎
104
+
105
+ | 文件扩展名 | 支持情况 |
106
+ | ---------- | -------- |
107
+ | txt | 已支持 |
108
+ | xml | 已支持 |
109
+ | json | 已支持 |
110
+
111
+ ### PDF引擎
112
+
113
+ | 文件扩展名 | 支持情况 |
114
+ | ---------- | -------- |
115
+ | pdf | 已支持 |
116
+ | doc | 已支持 |
117
+ | docx | 已支持 |
118
+ | wps | 已支持 |
119
+ | ppt | 已支持 |
120
+ | pptx | 已支持 |
121
+
122
+ ### IMG引擎
84
123
 
85
124
  | 文件扩展名 | 支持情况 |
86
125
  | ---------- | -------- |
@@ -92,18 +131,5 @@
92
131
  | webp | 已支持 |
93
132
  | ico | 已支持 |
94
133
  | svg | 已支持 |
95
- | xls | 前端支持，后端未支持 |
96
- | xlsx | 前端支持，后端未支持 |
97
- | et | 前端支持，后端未支持（未找到该格式的文件） |
98
- | html | 已支持 |
99
- | md | 已支持 |
100
- | json | 前端支持，后端未支持 |
101
- | xml | 前端支持，后端未支持 |
102
- | txt | 前端支持，后端未支持 |
103
- | pdf | 已支持 |
104
- | doc | 已支持 |
105
- | docx | 已支持 |
106
- | wps | 已支持 |
107
- | ppt | 已支持 |
108
- | pptx | 已支持 |
109
134
 
135
+ **注意**：同一个文件扩展名可能有多个引擎，如：**doc**，**docx**，**wps** 等，这些文件均可通过切换引擎的方式更改预览内容