pdfjs-annotation-extension-for-react 0.1.4 → 0.2.0

package/dist/index.cjs.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./index-rsibqSCw.cjs");exports.PdfAnnotator=e.PdfAnnotator;exports.PdfViewer=e.PdfViewer;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./index-D3SubjD7.cjs");exports.PdfAnnotator=e.PdfAnnotator;exports.PdfViewer=e.PdfViewer;

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 import { default as default_2 } from 'react';
 import { EventBus } from 'pdfjs-dist/types/web/pdf_viewer';
 import { IRect } from 'konva/lib/types';
+import { PDFDocumentProxy } from 'pdfjs-dist/types/web/pdf_viewer';
 import { PDFViewer } from 'pdfjs-dist/types/web/pdf_viewer';
 
 declare enum AnnotationType {
@@ -257,6 +258,11 @@ export declare interface PdfAnnotatorProps extends PdfBaseProps {
      * 已有的批注列表，用于在初始化时显示已存在的批注
      */
     initialAnnotations?: IAnnotationStore[];
+    /**
+     * 是否默认显示批注侧边栏
+     * @default false
+     */
+    defaultShowAnnotationsSidebar?: boolean;
     /**
      * 自定义额外按钮区域组件
      * 可以是一个 React 组件或者 React 元素
@@ -340,10 +346,6 @@ export declare interface PdfBaseProps {
      * @default { width: '100vw', height: '100vh' }
      */
     layoutStyle?: React.CSSProperties;
-    /**
-     * 控制侧边栏是否折叠
-     */
-    isSidebarCollapsed?: boolean;
     /**
      * 是否开启流式加载模式, auto 为自动判断
      * @default auto
@@ -388,10 +390,25 @@ declare type PdfScale = 'auto' | 'page-actual' | 'page-fit' | 'page-width' | str
 
 export declare const PdfViewer: default_2.FC<PdfViewerProps>;
 
+/**
+ * 定义通过 Context 提供给所有子组件的值
+ */
 declare interface PdfViewerContextValue {
+    /** PDF 文档对象 */
+    pdfDocument: PDFDocumentProxy | null;
+    /** PDFViewer 实例 */
     pdfViewer: PDFViewer | null;
-    setSidebarCollapsed: (collapsed: boolean) => void;
+    /** EventBus 实例 */
+    eventBus: EventBus | null;
+    /** PDF 渲染容器的 DOM 引用，供扩展使用 */
+    viewerContainerRef: default_2.RefObject<HTMLDivElement>;
+    /** PDF 核心实例是否都已准备就绪，可以安全地进行交互 */
+    isReady: boolean;
+    activeSidebarPanel: SidebarPanelKey | null;
     toggleSidebar: () => void;
+    openSidebar: (key: SidebarPanelKey) => void;
+    closeSidebar: () => void;
+    isSidebarCollapsed: boolean;
 }
 
 export declare interface PdfViewerProps extends PdfBaseProps {
@@ -402,25 +419,23 @@ export declare interface PdfViewerProps extends PdfBaseProps {
     actions?: default_2.ReactNode | ((context: PdfViewerContextValue) => default_2.ReactNode);
     /**
      * 自定义侧边栏组件
-     * 可以是一个 React 组件或者 React 元素
      */
-    sidebar?: default_2.ReactNode | ((context: PdfViewerContextValue) => default_2.ReactNode);
+    sidebar?: SidebarPanel[];
     /**
      * 自定义工具栏组件
      * 可以是一个 React 组件或者 React 元素
      * 默认显示 ZoomTool 组件
      */
     toolbar?: default_2.ReactNode | ((context: PdfViewerContextValue) => default_2.ReactNode);
-    /**
-     * 是否显示侧边栏触发按钮
-     * @default false
-     */
-    showSidebarTrigger?: boolean;
     /**
      * 是否显示文本层（用于选择和搜索文本）
      * @default true
      */
     showTextLayer?: boolean;
+    /**
+     * 默认选中的侧边栏项 key
+     */
+    defaultActiveSidebarKey?: SidebarPanelKey | null;
     /**
      * 文档加载完成回调
      * @param pdfViewer
@@ -435,6 +450,15 @@ export declare interface PdfViewerProps extends PdfBaseProps {
     onEventBusReady?: (eventBus: EventBus | null) => void;
 }
 
+declare interface SidebarPanel {
+    key: string;
+    title: default_2.ReactNode;
+    icon: default_2.ReactNode;
+    render: (context: PdfViewerContextValue) => default_2.ReactNode;
+}
+
+declare type SidebarPanelKey = string;
+
 export declare interface User {
     id: string;
     name: string;

package/dist/index.es.js

@@ -1,4 +1,4 @@
-import { P as r, a as e } from "./index-CFQdWq34.js";
+import { P as r, a as e } from "./index-CzUW2GJH.js";
 export {
   r as PdfAnnotator,
   e as PdfViewer