@agilehub/vue-pdf-flipbook 0.1.0 → 0.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.md
CHANGED
|
@@ -5,15 +5,15 @@
|
|
|
5
5
|
## 安装与使用
|
|
6
6
|
|
|
7
7
|
```bash
|
|
8
|
-
npm install vue-pdf-flipbook
|
|
8
|
+
npm install @agilehub/vue-pdf-flipbook
|
|
9
9
|
```
|
|
10
10
|
|
|
11
11
|
```vue
|
|
12
12
|
<script setup lang="ts">
|
|
13
13
|
import { ref } from 'vue'
|
|
14
|
-
import { VuePdfFlipbook } from 'vue-pdf-flipbook
|
|
15
|
-
import type { PdfFlipbookExpose, PdfFlipbookState } from 'vue-pdf-flipbook
|
|
16
|
-
import 'vue-pdf-flipbook
|
|
14
|
+
import { VuePdfFlipbook } from '@agilehub/vue-pdf-flipbook'
|
|
15
|
+
import type { PdfFlipbookExpose, PdfFlipbookState } from '@agilehub/vue-pdf-flipbook'
|
|
16
|
+
import '@agilehub/vue-pdf-flipbook/style.css'
|
|
17
17
|
|
|
18
18
|
const reader = ref<PdfFlipbookExpose>()
|
|
19
19
|
const state = ref<PdfFlipbookState>()
|
|
@@ -36,6 +36,8 @@ const state = ref<PdfFlipbookState>()
|
|
|
36
36
|
|
|
37
37
|
也支持 `app.use(PdfFlipbook)` 全局注册,`PdfFlipbook` 为默认导出。
|
|
38
38
|
|
|
39
|
+
发布包名为 `@agilehub/vue-pdf-flipbook`,安装和导入必须使用相同名称;`vue-pdf-flipbook` 是另一个 npm 包名。
|
|
40
|
+
|
|
39
41
|
## Props
|
|
40
42
|
|
|
41
43
|
| 属性 | 类型 | 默认值 | 说明 |
|
|
@@ -50,6 +52,8 @@ const state = ref<PdfFlipbookState>()
|
|
|
50
52
|
|
|
51
53
|
双页模式在空间不足时自动显示单页。`visiblePages` 反映实际显示页,而 `mode` 表示选择的模式。
|
|
52
54
|
|
|
55
|
+
默认 Worker 以 data URL 内嵌在库中,与主线程 PDF.js 一起构建,不依赖业务项目的 `/assets` 路径或资源复制配置,支持 Vite 依赖预打包和子路径部署。代价是 JS 文件包含 Worker 内容。若业务 CSP 限制 data/blob 模块,可通过 `workerSrc` 指定同版本的外部 Worker 地址,并按业务 CSP 规则提供资源。
|
|
56
|
+
|
|
53
57
|
### 自适应父容器
|
|
54
58
|
|
|
55
59
|
父容器设置明确宽高后,组件默认占满父容器。书页按 PDF 比例等比缩放:宽度受限时铺满宽度,高度受限时铺满高度,另一方向居中留白,不裁剪或拉伸。双页按两页合计宽高比计算;可用宽度小于 520px 时自动退回单页。容器尺寸变化、全屏及缩略图显隐会自动重新计算。
|
|
@@ -186,15 +190,15 @@ npm run typecheck
|
|
|
186
190
|
npm test
|
|
187
191
|
npm run build
|
|
188
192
|
npm run pack:check
|
|
193
|
+
npm run test:package
|
|
189
194
|
```
|
|
190
195
|
|
|
191
196
|
`npm test` 使用 Node.js 原生测试运行器,需要 Node.js 22.15+,覆盖页面窗口、网络分段以及异步跳页的等待、替换、失败和取消场景。
|
|
192
197
|
|
|
198
|
+
`npm pack` 和 `npm publish` 会通过 `prepack` 自动重新构建,避免发布旧产物。`npm run test:package` 解包实际 tarball,验证发布入口文件、组件和类型导入以及样式入口。
|
|
199
|
+
|
|
193
200
|
## License
|
|
194
201
|
|
|
195
202
|
MIT
|
|
196
203
|
|
|
197
204
|
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
package/dist/index.d.ts
CHANGED
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
import type { Plugin } from 'vue';
|
|
2
2
|
import VuePdfFlipbook from './VuePdfFlipbook.vue';
|
|
3
|
-
import './style.css';
|
|
4
3
|
export type { PdfFlipbookExpose, PdfFlipbookProps, PdfFlipbookState, PdfThumbnailSlotProps, ReaderMode } from './types';
|
|
5
4
|
export { VuePdfFlipbook };
|
|
6
5
|
export { default as PdfCanvasPage } from './components/PdfCanvasPage.vue';
|