@basic-genomics/hivtrace-viz 1.4.0 → 1.5.0

package/README.md

@@ -23,22 +23,25 @@ yarn add @basic-genomics/hivtrace-viz
 ### React 组件
 
 ```tsx
-import { HivtraceViz } from '@basic-genomics/hivtrace-viz/react';
-import type { CustomContextMenuItem, ClusterInfo } from '@basic-genomics/hivtrace-viz/react';
+import { HivtraceViz } from "@basic-genomics/hivtrace-viz/react";
+import type {
+  CustomContextMenuItem,
+  ClusterInfo,
+} from "@basic-genomics/hivtrace-viz/react";
 
 function App() {
   // 自定义上下文菜单项
   const customMenuItems: CustomContextMenuItem[] = [
     {
-      id: 'track-cluster',
-      label: '追踪此簇',
-      icon: 'fa-crosshairs',
+      id: "track-cluster",
+      label: "追踪此簇",
+      icon: "fa-crosshairs",
     },
   ];
 
   const handleMenuClick = (itemId: string, clusterInfo: ClusterInfo) => {
-    if (itemId === 'track-cluster') {
-      console.log('追踪簇:', clusterInfo);
+    if (itemId === "track-cluster") {
+      console.log("追踪簇:", clusterInfo);
     }
   };
 
@@ -47,11 +50,11 @@ function App() {
       data={analysisData}
       options={{
         threshold: 0.015,
-        expand: ['cluster_1']
+        expand: ["cluster_1"],
       }}
       customContextMenuItems={customMenuItems}
       onCustomMenuItemClick={handleMenuClick}
-      onReady={() => console.log('可视化已就绪')}
+      onReady={() => console.log("可视化已就绪")}
       error={fetchError?.message}
     />
   );
@@ -62,23 +65,24 @@ function App() {
 
 ```ts
 // vite.config.ts
-import { hivtraceVizPlugin } from '@basic-genomics/hivtrace-viz/vite';
+import { hivtraceVizPlugin } from "@basic-genomics/hivtrace-viz/vite";
 
 export default defineConfig({
   plugins: [
     hivtraceVizPlugin({
-      base: '/hivtrace-viz' // 可选，默认 '/hivtrace-viz'
-    })
-  ]
+      base: "/hivtrace-viz", // 可选，默认 '/hivtrace-viz'
+    }),
+  ],
 });
 ```
 
 ### iframe 嵌入
 
 ```html
-<iframe 
-  src="/hivtrace-viz/index.html" 
-  style="width: 100%; height: 600px; border: none;">
+<iframe
+  src="/hivtrace-viz/index.html"
+  style="width: 100%; height: 600px; border: none;"
+>
 </iframe>
 ```
 
@@ -100,6 +104,7 @@ yarn dev
 ```
 
 开发服务器启动后：
+
 - 自动打开 `http://localhost:8080/preview.html`
 - 支持核心库热更新
 - 支持 embed 模板热更新
@@ -132,11 +137,13 @@ npm link @basic-genomics/hivtrace-viz
 **开发流程：**
 
 1. 修改 hivtrace-viz 代码后，运行相应的构建命令：
+
    - 修改 `src/react/*.tsx` → `npm run build:react`
    - 修改 `template/embed.html` → `npm run build:embed`
    - 修改 `src/*.js` → `npm run build:core`
 
 2. 清除宿主应用的 Vite 缓存并重启：
+
    ```bash
    rm -rf node_modules/.vite
    yarn dev
@@ -145,11 +152,13 @@ npm link @basic-genomics/hivtrace-viz
 3. 刷新浏览器
 
 **重要提示：**
+
 - npm link 创建的是 symlink，但 Vite 会缓存模块
 - 每次修改 hivtrace-viz 代码后需要**重新构建**对应部分
 - 需要**删除 Vite 缓存**或**重启 dev server**才能看到更新
 
 **验证 npm link 状态：**
+
 ```bash
 ls -la node_modules/@basic-genomics/hivtrace-viz
 # 应显示：xxx -> ../../../hivtrace-viz
@@ -202,12 +211,12 @@ release-please 自动创建 Release PR
 
 ### Commit 规范
 
-| 格式 | 版本变更 | 示例 |
-|------|----------|------|
-| `feat: xxx` | Minor (1.2.0 → 1.3.0) | `feat: 添加簇追踪功能` |
-| `fix: xxx` | Patch (1.2.0 → 1.2.1) | `fix: 修复上下文菜单定位` |
-| `feat!: xxx` | Major (1.2.0 → 2.0.0) | `feat!: 重构 API 接口` |
-| `chore/docs/style` | 不触发发布 | `docs: 更新 README` |
+| 格式               | 版本变更              | 示例                      |
+| ------------------ | --------------------- | ------------------------- |
+| `feat: xxx`        | Minor (1.2.0 → 1.3.0) | `feat: 添加簇追踪功能`    |
+| `fix: xxx`         | Patch (1.2.0 → 1.2.1) | `fix: 修复上下文菜单定位` |
+| `feat!: xxx`       | Major (1.2.0 → 2.0.0) | `feat!: 重构 API 接口`    |
+| `chore/docs/style` | 不触发发布            | `docs: 更新 README`       |
 
 ### 手动测试发布
 
@@ -239,16 +248,20 @@ hivtrace-viz/
 
 ## Props API
 
-| 属性 | 类型 | 说明 |
-|------|------|------|
-| `data` | `HivtraceVizData` | 分析数据 |
-| `options` | `HivtraceVizOptions` | 配置选项 |
-| `error` | `string` | 错误信息（API 错误时传入） |
-| `loadingState` | `ReactNode \| null` | 自定义加载态，`null` 禁用 |
-| `customContextMenuItems` | `CustomContextMenuItem[]` | 自定义上下文菜单项 |
-| `onCustomMenuItemClick` | `(itemId, clusterInfo) => void` | 自定义菜单项点击回调 |
-| `onReady` | `() => void` | 渲染完成回调 |
-| `onRetry` | `() => void` | 重试回调 |
+| 属性                     | 类型                            | 说明                                    |
+| ------------------------ | ------------------------------- | --------------------------------------- |
+| `data`                   | `HivtraceVizData`               | 分析数据                                |
+| `options`                | `HivtraceVizOptions`            | 配置选项                                |
+| `error`                  | `string`                        | 错误信息（API 错误时传入）              |
+| `loadingState`           | `ReactNode \| null`             | 自定义加载态，`null` 禁用               |
+| `customContextMenuItems` | `CustomContextMenuItem[]`       | 自定义上下文菜单项                      |
+| `onCustomMenuItemClick`  | `(itemId, clusterInfo) => void` | 自定义菜单项点击回调                    |
+| `onReady`                | `() => void`                    | 渲染完成回调                            |
+| `onRetry`                | `() => void`                    | 重试回调                                |
+| `treeData`               | `TreeData`                      | 进化树数据，传入时显示进化树 Tab        |
+| `treeDefaultClusterId`   | `string \| number`              | 进化树默认高亮的簇 ID                   |
+| `showTreeTab`            | `boolean`                       | 是否显示进化树 Tab（即使没有 treeData） |
+| `treeLoading`            | `boolean`                       | 进化树正在加载中，显示加载状态          |
 
 ## 国际化