@file-viewer/react 2.1.1 → 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
|
@@ -79,7 +79,7 @@ The shared format matrix currently covers 24 preview pipelines and 206 file exte
|
|
|
79
79
|
|
|
80
80
|
## Engineering-Grade On-Demand Renderer Assembly
|
|
81
81
|
|
|
82
|
-
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
|
|
82
|
+
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.
|
|
83
83
|
|
|
84
84
|
```bash
|
|
85
85
|
npm i @file-viewer/vue3 @file-viewer/core @file-viewer/vite-plugin @file-viewer/preset-office
|
|
@@ -94,11 +94,21 @@ export default {
|
|
|
94
94
|
preset: 'office',
|
|
95
95
|
scan: true,
|
|
96
96
|
copyAssets: true
|
|
97
|
+
// inject:true by default; components receive office preview capability automatically.
|
|
97
98
|
})
|
|
98
99
|
]
|
|
99
100
|
}
|
|
100
101
|
```
|
|
101
102
|
|
|
103
|
+
```ts
|
|
104
|
+
const options = {
|
|
105
|
+
// Optional: set false when a product needs total manual control.
|
|
106
|
+
autoRenderers: true
|
|
107
|
+
}
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
For strict custom cuts or component-library tests, disable injection and pass the virtual module explicitly:
|
|
111
|
+
|
|
102
112
|
```ts
|
|
103
113
|
import { configuredFileViewerRenderers } from 'virtual:file-viewer-renderers'
|
|
104
114
|
|
|
@@ -114,6 +124,7 @@ const options = {
|
|
|
114
124
|
- 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.
|
|
115
125
|
- `scan:true` detects `fileViewerFormats`, `data-file-viewer-formats`, and upload `accept` hints so development and production builds select matching renderers automatically.
|
|
116
126
|
- `copyAssets:true` copies PDF/CAD/Typst/Archive/Data workers, WASM, and vendor assets for offline and enterprise intranet deployment.
|
|
127
|
+
- 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.
|
|
117
128
|
- 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.
|
|
118
129
|
|
|
119
130
|
## Shared Options And Events
|
package/README.md
CHANGED
|
@@ -79,7 +79,7 @@ export function Preview() {
|
|
|
79
79
|
|
|
80
80
|
## 工程级按需 renderer 装配
|
|
81
81
|
|
|
82
|
-
一个组件,一行代码,快速集成;真正影响安装体积和首屏包体的是 renderer 装配。推荐优先按产品形态选择 `@file-viewer/preset-lite`、`@file-viewer/preset-office`、`@file-viewer/preset-engineering` 或 `@file-viewer/preset-all`,需要极致裁剪时再安装单个 renderer 包。Vite
|
|
82
|
+
一个组件,一行代码,快速集成;真正影响安装体积和首屏包体的是 renderer 装配。推荐优先按产品形态选择 `@file-viewer/preset-lite`、`@file-viewer/preset-office`、`@file-viewer/preset-engineering` 或 `@file-viewer/preset-all`,需要极致裁剪时再安装单个 renderer 包。Vite 插件会自动发现并注入已安装的 preset,常规业务无需再手写 `renderers`。
|
|
83
83
|
|
|
84
84
|
```bash
|
|
85
85
|
npm i @file-viewer/vue3 @file-viewer/core @file-viewer/vite-plugin @file-viewer/preset-office
|
|
@@ -94,11 +94,21 @@ export default {
|
|
|
94
94
|
preset: 'office',
|
|
95
95
|
scan: true,
|
|
96
96
|
copyAssets: true
|
|
97
|
+
// 默认 inject:true,组件会自动获得 office 预览能力。
|
|
97
98
|
})
|
|
98
99
|
]
|
|
99
100
|
}
|
|
100
101
|
```
|
|
101
102
|
|
|
103
|
+
```ts
|
|
104
|
+
const options = {
|
|
105
|
+
// 可选:需要完全手动控制时设为 false。
|
|
106
|
+
autoRenderers: true
|
|
107
|
+
}
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
严格裁剪或组件库内部测试时,也可以关闭自动注入并显式传入 virtual module:
|
|
111
|
+
|
|
102
112
|
```ts
|
|
103
113
|
import { configuredFileViewerRenderers } from 'virtual:file-viewer-renderers'
|
|
104
114
|
|
|
@@ -114,6 +124,7 @@ const options = {
|
|
|
114
124
|
- 想要最小包体时,可以不用 preset,直接安装 `@file-viewer/renderer-pdf`、`@file-viewer/renderer-word` 等单个 renderer,并用 `formats` 精确生成 import。
|
|
115
125
|
- `scan:true` 会识别 `fileViewerFormats`、`data-file-viewer-formats` 和上传控件 `accept`,调试与打包时自动选择 renderer。
|
|
116
126
|
- `copyAssets:true` 会复制 PDF/CAD/Typst/Archive/Data 等 worker、WASM 和 vendor 资源,满足离线和企业内网部署。
|
|
127
|
+
- 如果打开的是支持矩阵内但未装配的格式,预览器会提示应安装的 preset / renderer;只有真正不在矩阵中的扩展名才提示不支持。
|
|
117
128
|
- 想一次性拥有官方 Demo 的完整能力时,可以安装 `@file-viewer/preset-all` 并把 `allRenderers` 传给 `renderers`;这适合 demo 和后台运维工具,不建议作为所有业务默认入口。
|
|
118
129
|
|
|
119
130
|
## 统一参数与事件
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@file-viewer/react",
|
|
3
|
-
"version": "2.1.
|
|
3
|
+
"version": "2.1.2",
|
|
4
4
|
"private": false,
|
|
5
5
|
"type": "module",
|
|
6
6
|
"description": "Standard React component package for Flyfish File Viewer",
|
|
@@ -55,7 +55,7 @@
|
|
|
55
55
|
"react": ">=17 <20"
|
|
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/react": "^19.2.17",
|