@embedpdf-editor/chapter-snippet 0.3.4 → 0.3.6

package/README.md

@@ -14,7 +14,7 @@ pnpm add @embedpdf-editor/chapter-snippet
 
 ## Vite
 
-`chapterSnippetViteResolve()` 用于 Vue2/snippet 场景：
+`chapterSnippetViteResolve()` 用于 Vite + Vue2/snippet 场景：
 
 ```ts
 // vite.config.ts
@@ -33,6 +33,22 @@ export default defineConfig({
 | `server.headers` | 开发环境添加 COOP/COEP，满足 worker/wasm 常见要求 |
 | `optimizeDeps.exclude` | 避免 Vite 二次预构建 snippet 和 PDFium 引擎 |
 
+## Vue CLI / Webpack
+
+**无需修改 `vue.config.js`。** 安装后直接：
+
+```js
+import ChapterEmbedPDF from '@embedpdf-editor/chapter-snippet';
+```
+
+发包构建会对 `dist/embedpdf-chapter.js` 做语法降级（去掉 `??` 等 ES2020 语法），Webpack / Vue CLI 默认可 parse。默认 `wasmUrl` 指向 jsDelivr 上的 `pdfium.wasm`，无需复制到 `public/`。
+
+离线或内网部署时，可传 `wasmUrl: '/pdfium.wasm'`（自行把 `node_modules/@embedpdf-editor/chapter-snippet/dist/pdfium.wasm` 放到静态目录）。
+
+`@embedpdf-editor/chapter-snippet/webpack` 为**可选**辅助（仅 monorepo Vue 2.6 解析、或自定义 devServer COOP/COEP），普通用户不必使用。
+
+完整示例见 `examples/chapter-viewer-demo-vue2`。
+
 ## 快速开始
 
 不需要把 `pdfium.wasm` 手动放到宿主项目的 `public/`。默认会从 `@embedpdf-editor/chapter-snippet/dist/pdfium.wasm` 加载。只有当你要走 CDN 或自定义静态域名时，才需要传 `wasmUrl`。
@@ -111,10 +127,10 @@ viewer?.addEventListener(CHAPTER_SNIPPET_EVENTS.ready, (event) => {
 | `worker` | `true` | 是否启用 PDFium worker |
 | `fallbackToDirectEngine` | `true` | 首章 worker 加载超时后自动降级到 direct engine |
 | `workerOpenTimeoutMs` | `8000` | 首章加载超时时间 |
-| `features` | - | 兼容旧写法；会覆盖 `options.features` 中同名项 |
+| `features` | - | 与 `options.features` **深度合并**；顶层同名字段优先。勿放进 `createChapterViewerEditorOptions()` |
 | `className` / `viewportClassName` | - | 传给内部阅读器容器 |
 
-旧版本的 `editorInput` 仍可使用，但新代码应改为 `options`。`options.features` 会参与合并，顶层 `features` 仅作为兼容覆盖保留。
+旧版本的 `editorInput` 仍可使用，但新代码应改为 `options`，并把 `features` 写在 `options.features` 或顶层 `features`。
 
 ### `ChapterViewerOptions`（与 React / Vue3 一致）
 
@@ -137,7 +153,8 @@ viewer?.addEventListener(CHAPTER_SNIPPET_EVENTS.ready, (event) => {
 | `markup` | `styles` 四类划线；`annotationMenu` 默认选中后在下方显示「删除」；`squiggly.offsetY` 默认 **4** |
 | `bookmarks` | `marker` / `hover` 自定义图标 |
 | `notes` | `marker.renderIcon`、`renderMenuActions`、`highlightColor` |
-| `zoom` | `pageWidth`、`min` / `max` / `enabled` |
+| `zoom` | `pageWidth`、`min` / `max` / `enabled`；实际上限不超过 `[data-chapter-scroll-viewport]` 宽度，resize 时自动 clamp |
+| `scrollViewport` | `background`（默认 `#f1f5f9`），`[data-chapter-scroll-viewport]` 背景 |
 | `selectionToolbar` | `hiddenBuiltinActions`、`extraActions`；扩展动作监听 `selectionExtraAction` 事件 |
 
 ```js

package/dist/embedpdf-chapter.d.ts

@@ -330,6 +330,8 @@ export declare type ChapterViewerConfig = {
         marker?: NoteMarkerUiConfig;
     };
     zoom?: boolean | ChapterViewerZoomConfig;
+    /** 滚动视口（`[data-chapter-scroll-viewport]`）样式 */
+    scrollViewport?: ChapterViewerScrollViewportConfig;
     /** 默认随划线/笔记开启；仅在有扩展按钮或需隐藏内置按钮时配置 */
     selectionToolbar?: boolean | SelectionToolbarConfig;
 };
@@ -359,6 +361,8 @@ export declare interface ChapterViewerFeaturesConfig {
     selectionToolbar?: SelectionToolbarConfig;
     /** 缩放 */
     zoom?: ChapterViewerZoomConfig;
+    /** 滚动视口（`[data-chapter-scroll-viewport]`） */
+    scrollViewport?: ChapterViewerScrollViewportConfig;
 }
 
 /** 章节阅读器统一配置（推荐入口） */
@@ -380,6 +384,12 @@ export declare interface ChapterViewerOptions {
     features?: ChapterViewerConfig;
 }
 
+/** `[data-chapter-scroll-viewport]` 滚动容器样式 */
+declare interface ChapterViewerScrollViewportConfig {
+    /** 背景色，默认 {@link DEFAULT_CHAPTER_SCROLL_VIEWPORT_BACKGROUND} */
+    background?: string;
+}
+
 export declare type ChapterViewerSnippetConfig = {
     /** PDFium wasm 地址；默认使用 chapter-snippet/dist/pdfium.wasm */
     wasmUrl?: string;
@@ -393,8 +403,8 @@ export declare type ChapterViewerSnippetConfig = {
     options?: ChapterViewerOptions;
     /** @deprecated 请改用 options */
     editorInput?: CreateChapterViewerEditorOptionsInput;
-    /** 阅读器功能开关，默认与 DEFAULT_CHAPTER_VIEWER_FEATURES 合并 */
-    features?: ChapterViewerFeaturesConfig;
+    /** 阅读器功能开关；与 `options.features` 深度合并，顶层字段优先 */
+    features?: ChapterViewerConfig;
     className?: string;
     viewportClassName?: string;
 };
@@ -403,6 +413,7 @@ declare interface ChapterViewerZoomConfig {
     /** 是否启用 Ctrl+滚轮 / 双指捏合等交互缩放，默认 true；为 false 时仍可用 pageWidth / initial 设置版面宽度 */
     enabled?: boolean;
     min?: number;
+    /** 配置上限；实际不会超过视口宽度（fit-width scale） */
     max?: number;
     /** 文档 scale 初始值；未设置且配置了 pageWidth 时由 pageWidth 按首页宽度推导 */
     initial?: number;
@@ -425,7 +436,7 @@ export declare function createChapterViewerBundle(input: ChapterViewerOptions |
     editorOptions: CreatePdfChapterEditorOptions;
 };
 
-/** 进阶用法：仅生成 editor 配置（不含 features，需自行传给 PdfChapterViewport） */
+/** 进阶用法：仅生成 editor 配置（不含 features，需通过 snippet `features` 或 `options.features` 传入） */
 export declare function createChapterViewerEditorOptions(input: ChapterViewerOptions | CreateChapterViewerEditorOptionsInput): Omit<CreatePdfChapterEditorOptions, 'features'>;
 
 /** @deprecated 旧版嵌套 `callbacks` 写法，仍兼容 */