@file-viewer/jquery 2.1.0 → 2.1.2
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.
- package/README.en.md +12 -1
- package/README.md +12 -1
- package/package.json +2 -2
package/README.en.md
CHANGED
|
@@ -106,7 +106,7 @@ The shared format matrix currently covers 24 preview pipelines and 206 file exte
|
|
|
106
106
|
|
|
107
107
|
## Engineering-Grade On-Demand Renderer Assembly
|
|
108
108
|
|
|
109
|
-
One component, one line of code, fast integration; renderer assembly is what controls install size and first-screen bundle weight. Prefer a product-shaped preset first: `@file-viewer/preset-lite`, `@file-viewer/preset-office`, `@file-viewer/preset-engineering`, or `@file-viewer/preset-all`. Install individual renderer packages only when you need the smallest possible custom cut. The Vite plugin
|
|
109
|
+
One component, one line of code, fast integration; renderer assembly is what controls install size and first-screen bundle weight. Prefer a product-shaped preset first: `@file-viewer/preset-lite`, `@file-viewer/preset-office`, `@file-viewer/preset-engineering`, or `@file-viewer/preset-all`. Install individual renderer packages only when you need the smallest possible custom cut. The Vite plugin auto-discovers and injects installed presets, so regular application code does not need to pass `renderers` manually.
|
|
110
110
|
|
|
111
111
|
```bash
|
|
112
112
|
npm i @file-viewer/vue3 @file-viewer/core @file-viewer/vite-plugin @file-viewer/preset-office
|
|
@@ -121,11 +121,21 @@ export default {
|
|
|
121
121
|
preset: 'office',
|
|
122
122
|
scan: true,
|
|
123
123
|
copyAssets: true
|
|
124
|
+
// inject:true by default; components receive office preview capability automatically.
|
|
124
125
|
})
|
|
125
126
|
]
|
|
126
127
|
}
|
|
127
128
|
```
|
|
128
129
|
|
|
130
|
+
```ts
|
|
131
|
+
const options = {
|
|
132
|
+
// Optional: set false when a product needs total manual control.
|
|
133
|
+
autoRenderers: true
|
|
134
|
+
}
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
For strict custom cuts or component-library tests, disable injection and pass the virtual module explicitly:
|
|
138
|
+
|
|
129
139
|
```ts
|
|
130
140
|
import { configuredFileViewerRenderers } from 'virtual:file-viewer-renderers'
|
|
131
141
|
|
|
@@ -141,6 +151,7 @@ const options = {
|
|
|
141
151
|
- For the smallest custom bundle, skip presets, install individual renderers such as `@file-viewer/renderer-pdf` or `@file-viewer/renderer-word`, and let `formats` generate exact imports.
|
|
142
152
|
- `scan:true` detects `fileViewerFormats`, `data-file-viewer-formats`, and upload `accept` hints so development and production builds select matching renderers automatically.
|
|
143
153
|
- `copyAssets:true` copies PDF/CAD/Typst/Archive/Data workers, WASM, and vendor assets for offline and enterprise intranet deployment.
|
|
154
|
+
- If a file is in the supported matrix but its renderer is not assembled, the viewer shows the recommended preset / renderer package. Truly unknown extensions still show an unsupported-format state.
|
|
144
155
|
- If you want the complete official demo capability matrix, install `@file-viewer/preset-all` and pass `allRenderers` to `renderers`; this is ideal for demos and internal admin tools, but should not be every product default.
|
|
145
156
|
|
|
146
157
|
## Shared Options And Events
|
package/README.md
CHANGED
|
@@ -106,7 +106,7 @@ English README: [README.en.md](./README.en.md)。
|
|
|
106
106
|
|
|
107
107
|
## 工程级按需 renderer 装配
|
|
108
108
|
|
|
109
|
-
一个组件,一行代码,快速集成;真正影响安装体积和首屏包体的是 renderer 装配。推荐优先按产品形态选择 `@file-viewer/preset-lite`、`@file-viewer/preset-office`、`@file-viewer/preset-engineering` 或 `@file-viewer/preset-all`,需要极致裁剪时再安装单个 renderer 包。Vite
|
|
109
|
+
一个组件,一行代码,快速集成;真正影响安装体积和首屏包体的是 renderer 装配。推荐优先按产品形态选择 `@file-viewer/preset-lite`、`@file-viewer/preset-office`、`@file-viewer/preset-engineering` 或 `@file-viewer/preset-all`,需要极致裁剪时再安装单个 renderer 包。Vite 插件会自动发现并注入已安装的 preset,常规业务无需再手写 `renderers`。
|
|
110
110
|
|
|
111
111
|
```bash
|
|
112
112
|
npm i @file-viewer/vue3 @file-viewer/core @file-viewer/vite-plugin @file-viewer/preset-office
|
|
@@ -121,11 +121,21 @@ export default {
|
|
|
121
121
|
preset: 'office',
|
|
122
122
|
scan: true,
|
|
123
123
|
copyAssets: true
|
|
124
|
+
// 默认 inject:true,组件会自动获得 office 预览能力。
|
|
124
125
|
})
|
|
125
126
|
]
|
|
126
127
|
}
|
|
127
128
|
```
|
|
128
129
|
|
|
130
|
+
```ts
|
|
131
|
+
const options = {
|
|
132
|
+
// 可选:需要完全手动控制时设为 false。
|
|
133
|
+
autoRenderers: true
|
|
134
|
+
}
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
严格裁剪或组件库内部测试时,也可以关闭自动注入并显式传入 virtual module:
|
|
138
|
+
|
|
129
139
|
```ts
|
|
130
140
|
import { configuredFileViewerRenderers } from 'virtual:file-viewer-renderers'
|
|
131
141
|
|
|
@@ -141,6 +151,7 @@ const options = {
|
|
|
141
151
|
- 想要最小包体时,可以不用 preset,直接安装 `@file-viewer/renderer-pdf`、`@file-viewer/renderer-word` 等单个 renderer,并用 `formats` 精确生成 import。
|
|
142
152
|
- `scan:true` 会识别 `fileViewerFormats`、`data-file-viewer-formats` 和上传控件 `accept`,调试与打包时自动选择 renderer。
|
|
143
153
|
- `copyAssets:true` 会复制 PDF/CAD/Typst/Archive/Data 等 worker、WASM 和 vendor 资源,满足离线和企业内网部署。
|
|
154
|
+
- 如果打开的是支持矩阵内但未装配的格式,预览器会提示应安装的 preset / renderer;只有真正不在矩阵中的扩展名才提示不支持。
|
|
144
155
|
- 想一次性拥有官方 Demo 的完整能力时,可以安装 `@file-viewer/preset-all` 并把 `allRenderers` 传给 `renderers`;这适合 demo 和后台运维工具,不建议作为所有业务默认入口。
|
|
145
156
|
|
|
146
157
|
## 统一参数与事件
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@file-viewer/jquery",
|
|
3
|
-
"version": "2.1.
|
|
3
|
+
"version": "2.1.2",
|
|
4
4
|
"private": false,
|
|
5
5
|
"type": "module",
|
|
6
6
|
"description": "Standard jQuery component package for Flyfish File Viewer",
|
|
@@ -55,7 +55,7 @@
|
|
|
55
55
|
"jquery": ">=3 <5"
|
|
56
56
|
},
|
|
57
57
|
"dependencies": {
|
|
58
|
-
"@file-viewer/core": "^2.1.
|
|
58
|
+
"@file-viewer/core": "^2.1.2"
|
|
59
59
|
},
|
|
60
60
|
"devDependencies": {
|
|
61
61
|
"@types/jquery": "^4.0.1",
|