@embedpdf-editor/react-chapter-viewer 0.2.0 → 0.2.2

package/dist/index.d.ts

@@ -384,7 +384,29 @@ export declare type ChapterViewerCatalog = {
     manifest: ChapterManifest;
 };
 
-/** 章节渲染器集成功能开关（与 demo 默认样式对齐） */
+/**
+ * 用户侧功能配置（简化写法）：
+ * - 省略或 `true`：开启并使用默认样式
+ * - `false`：关闭
+ * - 对象：开启并覆盖对应字段
+ */
+export declare type ChapterViewerConfig = {
+    markup?: boolean | {
+        styles?: MarkupStylesConfig;
+    };
+    bookmarks?: boolean | {
+        marker?: BookmarkMarkerUiConfig_2;
+        hover?: HoverBookmarkUiConfig_2;
+    };
+    notes?: boolean | {
+        marker?: NoteMarkerUiConfig;
+    };
+    zoom?: boolean | ChapterViewerZoomConfig;
+    /** 默认随划线/笔记开启；仅在有扩展按钮或需隐藏内置按钮时配置 */
+    selectionToolbar?: boolean | SelectionToolbarConfig;
+};
+
+/** 渲染器内部使用的规范化功能配置 */
 export declare interface ChapterViewerFeaturesConfig {
     /** 划线/高亮 */
     markup?: {
@@ -408,27 +430,57 @@ export declare interface ChapterViewerFeaturesConfig {
     zoom?: ChapterViewerZoomConfig;
 }
 
+/** 章节阅读器统一配置（推荐入口） */
+export declare interface ChapterViewerOptions {
+    manifest: ChapterManifest;
+    /** 笔记持久化与弹窗回调 */
+    notes: NoteCallbacks;
+    /** 书签持久化与删除回调 */
+    bookmarks: ParagraphBookmarkCallbacks;
+    chapterPdfLoader?: IChapterPdfLoader;
+    /** 功能开关与样式；省略则全开 */
+    features?: ChapterViewerConfig;
+}
+
 declare interface ChapterViewerZoomConfig {
     /** 是否启用 pinch/滑块缩放容器，默认 true */
     enabled?: boolean;
     min?: number;
     max?: number;
+    /** 文档 scale 初始值；未设置且配置了 pageWidth 时由 pageWidth 按首页宽度推导 */
     initial?: number;
+    /**
+     * 页面布局目标宽度（CSS px）。
+     * 章节 PDF 加载后按 `pageWidth / pdfPageWidth` 设置 document scale，与 RenderLayer / 滚动占位一致。
+     */
+    pageWidth?: number;
 }
 
+/** 生成插件列表 + 规范化后的 features（供 EmbedPDF / PdfChapterViewport 使用） */
+export declare function createChapterViewerBundle(input: ChapterViewerOptions | CreateChapterViewerEditorOptionsInput): {
+    plugins: PluginBatchRegistration<any, any, any, any>[];
+    features: ChapterViewerFeaturesConfig;
+    editorOptions: CreatePdfChapterEditorOptions;
+};
+
 /**
  * 创建带默认划线/笔记/书签/选区 card 的章节编辑器插件包。
- * 传入的 `features` 与默认值浅合并。
  */
 export declare function createChapterViewerEditor(options: CreatePdfChapterEditorOptions): PdfChapterEditorBundle;
 
-export declare function createChapterViewerEditorOptions(input: CreateChapterViewerEditorOptionsInput): Omit<CreatePdfChapterEditorOptions, 'features'>;
+/** 进阶用法：仅生成 editor 配置（不含 features，需自行传给 PdfChapterViewport） */
+export declare function createChapterViewerEditorOptions(input: ChapterViewerOptions | CreateChapterViewerEditorOptionsInput): Omit<CreatePdfChapterEditorOptions, 'features'>;
 
+/** @deprecated 旧版嵌套 `callbacks` 写法，仍兼容 */
 export declare type CreateChapterViewerEditorOptionsInput = {
     manifest: ChapterManifest;
     chapterPdfLoader?: IChapterPdfLoader;
-    bookmarks: PdfChapterEditorBookmarksConfig;
-    notes: PdfChapterEditorNotesConfig;
+    bookmarks: {
+        callbacks: ParagraphBookmarkCallbacks;
+    };
+    notes: {
+        callbacks: NoteCallbacks;
+    };
 };
 
 declare interface CreateEditorUiSchemaOptions {
@@ -471,7 +523,10 @@ export declare interface CreatePdfChapterEditorOptions {
     features?: ChapterViewerFeaturesConfig;
 }
 
-/** 与 demo 对齐的默认集成功能 */
+/** 用户侧默认：省略 `options.features` 即等价于此空对象（全部功能开启） */
+export declare const DEFAULT_CHAPTER_VIEWER_CONFIG: ChapterViewerConfig;
+
+/** 默认全开的功能配置（内部规范化结果） */
 export declare const DEFAULT_CHAPTER_VIEWER_FEATURES: ChapterViewerFeaturesConfig;
 
 /** 与 snippet 主工具栏 mode tabs 对齐的编辑模式 */
@@ -530,6 +585,9 @@ export declare interface MarkupKindStyle {
 
 export declare type MarkupStylesConfig = Partial<Record<SelectionMarkupKind, MarkupKindStyle>>;
 
+/** 将用户侧简化配置规范为渲染器内部使用的结构 */
+export declare function normalizeChapterViewerConfig(config?: ChapterViewerConfig): ChapterViewerFeaturesConfig;
+
 /**
  * 一条附注（note）的位置锚点。
  * - `rectsPdfCoord` 来自 selection.getHighlightRectsForPage 的 PDF 坐标系

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,KAAK,qBAAqB,GAC3B,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EACL,kBAAkB,EAClB,KAAK,uBAAuB,GAC7B,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EACL,yBAAyB,EACzB,sBAAsB,EACtB,+BAA+B,GAChC,MAAM,gCAAgC,CAAC;AACxC,YAAY,EACV,2BAA2B,EAC3B,kBAAkB,EAClB,eAAe,EACf,2BAA2B,EAC3B,wBAAwB,GACzB,MAAM,iCAAiC,CAAC;AACzC,YAAY,EACV,6BAA6B,EAC7B,2BAA2B,EAC3B,+BAA+B,GAChC,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AACvE,YAAY,EAAE,aAAa,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AACzF,YAAY,EAAE,iBAAiB,EAAE,MAAM,4CAA4C,CAAC;AACpF,OAAO,EAAE,4BAA4B,EAAE,MAAM,4CAA4C,CAAC;AAC1F,OAAO,EACL,wBAAwB,EACxB,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACpB,KAAK,iBAAiB,EACtB,KAAK,aAAa,EAClB,KAAK,iBAAiB,EACtB,KAAK,iBAAiB,GACvB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAC1D,OAAO,EAAE,oBAAoB,EAAE,MAAM,yCAAyC,CAAC;AAC/E,OAAO,EAAE,mBAAmB,EAAE,MAAM,wCAAwC,CAAC;AAC7E,OAAO,EAAE,gBAAgB,EAAE,KAAK,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAClF,OAAO,EAAE,KAAK,eAAe,EAAE,KAAK,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AACjF,OAAO,EACL,gCAAgC,EAChC,KAAK,qCAAqC,GAC3C,MAAM,gCAAgC,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,KAAK,qBAAqB,GAC3B,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EACL,kBAAkB,EAClB,KAAK,uBAAuB,GAC7B,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EACL,yBAAyB,EACzB,yBAAyB,EACzB,gCAAgC,EAChC,sBAAsB,EACtB,+BAA+B,EAC/B,6BAA6B,GAC9B,MAAM,gCAAgC,CAAC;AACxC,YAAY,EAAE,oBAAoB,EAAE,qCAAqC,EAAE,MAAM,gCAAgC,CAAC;AAClH,YAAY,EACV,mBAAmB,EACnB,2BAA2B,EAC3B,kBAAkB,EAClB,eAAe,EACf,2BAA2B,EAC3B,wBAAwB,GACzB,MAAM,iCAAiC,CAAC;AACzC,YAAY,EACV,6BAA6B,EAC7B,2BAA2B,EAC3B,+BAA+B,GAChC,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAAE,oBAAoB,EAAE,4BAA4B,EAAE,MAAM,iCAAiC,CAAC;AACrG,YAAY,EAAE,aAAa,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AACzF,YAAY,EAAE,iBAAiB,EAAE,MAAM,4CAA4C,CAAC;AACpF,OAAO,EAAE,4BAA4B,EAAE,MAAM,4CAA4C,CAAC;AAC1F,OAAO,EACL,wBAAwB,EACxB,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACpB,KAAK,iBAAiB,EACtB,KAAK,aAAa,EAClB,KAAK,iBAAiB,EACtB,KAAK,iBAAiB,GACvB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAC1D,OAAO,EAAE,oBAAoB,EAAE,MAAM,yCAAyC,CAAC;AAC/E,OAAO,EAAE,mBAAmB,EAAE,MAAM,wCAAwC,CAAC;AAC7E,OAAO,EAAE,gBAAgB,EAAE,KAAK,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAClF,OAAO,EAAE,KAAK,eAAe,EAAE,KAAK,oBAAoB,EAAE,MAAM,gBAAgB,CAAC"}