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