book-index-ui 0.2.26 → 0.3.0

package/dist/index.d.ts

@@ -118,6 +118,55 @@ export declare interface BookDetailData extends BaseDetailData {
     lineage?: BookLineage;
 }
 
+export declare const BookDetailLayout: default_2.FC<BookDetailLayoutProps>;
+
+export declare interface BookDetailLayoutProps {
+    /** 要展示的条目 ID */
+    id: string;
+    /** 数据传输层 */
+    transport: IndexStorage;
+    activeTab: BookDetailTabKey;
+    onTabChange: (tab: BookDetailTabKey) => void;
+    activeJuan?: string | null;
+    onJuanChange?: (juan: string | null) => void;
+    lineageMode?: 'list' | 'graph';
+    onLineageModeChange?: (mode: 'list' | 'graph') => void;
+    lineageCollection?: string;
+    onLineageCollectionChange?: (key: string) => void;
+    /** 整理本初始页（透传给 extraTabs 的 digital 等） */
+    initialPage?: number;
+    selectedLineageNodeId?: string;
+    onNavigate?: (id: string) => void;
+    onBack?: () => void;
+    backLabel?: string;
+    renderLink?: (id: string, label?: string) => default_2.ReactNode;
+    /** 加载 detail 后的额外加工（如注入 digital_assets） */
+    enrichDetail?: (entry: IndexEntry, detail: IndexDetailData) => void;
+    /** 当前 tab 的源文件链接解析器 */
+    getSourceLink?: (ctx: SourceLinkContext) => {
+        href: string;
+        label: string;
+    } | null;
+    /** 注入额外 tab（如 kyg 的「数字化」） */
+    extraTabs?: ExtraTab[];
+    /** 是否显示内置反馈 tab，默认 true。设为 false 时调用方可用 extraTabs 自定义。 */
+    showFeedbackTab?: boolean;
+    /** 反馈 API 端点（默认 `/api/feedback`） */
+    feedbackApiUrl?: string | (() => string);
+    /** 整个组件的外层高度（默认 100vh） */
+    height?: string;
+    /** 桌面侧边栏宽度（默认 144 — 对应 Tailwind w-36） */
+    sideNavWidth?: number;
+    /** 内容区域最大宽度（默认 1024） */
+    contentMaxWidth?: number;
+    /** 是否在加载/未找到状态下隐藏整体导航（默认 false：仍显示返回链接） */
+    hideNavWhenLoading?: boolean;
+    className?: string;
+    style?: default_2.CSSProperties;
+}
+
+export declare type BookDetailTabKey = 'basic' | 'collated' | 'lineage' | 'emendated' | 'feedback' | string;
+
 /**
  * Exception classes for book-index-manager.
  * Port of Python book_index_manager.exceptions
@@ -756,6 +805,26 @@ export declare function extractStatus(encoded: string): IndexStatus;
 /** Extract type from an ID string */
 export declare function extractType(encoded: string): IndexType;
 
+export declare interface ExtraTab {
+    /** 唯一 key */
+    key: string;
+    /** 显示文案 */
+    label: string;
+    /** 是否在当前 detail 下显示该 tab */
+    shouldShow: (detail: IndexDetailData) => boolean;
+    /** tab 内容渲染 */
+    render: (ctx: ExtraTabContext) => default_2.ReactNode;
+    /** 插入位置（默认 before-feedback） */
+    position?: 'before-feedback' | 'after-feedback';
+}
+
+export declare interface ExtraTabContext {
+    detail: IndexDetailData;
+    entry: IndexEntry;
+    transport: IndexStorage;
+    onNavigate?: (id: string) => void;
+}
+
 export declare const FeedbackButton: default_2.FC<FeedbackButtonProps>;
 
 export declare interface FeedbackButtonProps {
@@ -807,6 +876,26 @@ export declare interface FeedbackListProps {
     loading?: boolean;
 }
 
+/**
+ * 反馈 tab 内容：列出已有反馈 + 提交新反馈。
+ * 与 FeedbackList/FeedbackForm 不同，FeedbackTab 自带数据加载和提交逻辑，
+ * 适合直接作为详情页的 tab 内容使用。
+ */
+export declare const FeedbackTab: default_2.FC<FeedbackTabProps>;
+
+export declare interface FeedbackTabProps {
+    /** 该资源的 ID（用于过滤反馈条目） */
+    resourceId: string;
+    /**
+     * 反馈 API 端点。
+     * GET   `${apiUrl}?resourceId=...` 返回 `{ success: boolean, items: FeedbackItem[] }`
+     * POST  `${apiUrl}` body `{ type, content, pageUrl, resourceId }` 返回 2xx
+     * 默认 `/api/feedback`。
+     * 也支持函数形式：根据当前 hostname 动态决定（如 localhost → 远程，生产 → 同源）。
+     */
+    apiUrl?: string | (() => string);
+}
+
 export declare type FeedbackType = 'bug' | 'resource';
 
 /**
@@ -2191,6 +2280,13 @@ export declare interface SourceItem {
     processor_version: string;
 }
 
+export declare interface SourceLinkContext {
+    activeTab: string;
+    activeJuan: string | null;
+    entry: IndexEntry;
+    detail: IndexDetailData;
+}
+
 export declare class StorageError extends BookIndexError {
     constructor(message?: string);
 }