@cloudtower/eagle 490.0.5 → 490.0.7

package/docs/core/SearchInput/guide.md

@@ -0,0 +1,125 @@
+# SearchInput
+
+## 简介
+
+搜索输入框组件，基于 Input 封装，提供防抖搜索、结果导航（上一个/下一个/计数器）和最近搜索历史功能。支持受控和非受控两种模式，宽度默认 276px。
+
+## 何时使用
+
+- 表格内搜索高亮匹配结果，需要上下翻页定位
+- 页面全局搜索，需要防抖避免频繁请求
+- 需要保留最近搜索记录的搜索场景
+
+不要使用：
+
+- 仅需要简单输入框 --> 请用 `Input`
+- 下拉选择过滤 --> 请用 `Select` 的搜索模式
+- 级联选择中的搜索 --> `Cascader` 已内置 SearchInput
+
+## 基础用法
+
+最简单的搜索框，仅响应输入变化并防抖处理：
+
+```tsx
+import React, { useState } from "react";
+import { SearchInput } from "@cloudtower/eagle";
+
+const App = () => {
+  const [keyword, setKeyword] = useState("");
+
+  return (
+    <SearchInput
+      debounceWait={300}
+      onChange={(value) => setKeyword(value)}
+    />
+  );
+};
+```
+
+## 常见模式
+
+### 模式一：带结果导航
+
+适用于搜索后需要在匹配结果之间上下翻页的场景（如表格内搜索高亮）。同时提供 `onSearchNext` 和 `onSearchPrev` 后，输入框后缀会显示 "current/total" 计数器和上下翻页按钮。按 Enter 键等同于点击"下一个"。
+
+```tsx
+import React, { useState } from "react";
+import { SearchInput } from "@cloudtower/eagle";
+
+const VmTableSearch = () => {
+  const [matchedVms, setMatchedVms] = useState<string[]>([]);
+
+  return (
+    <SearchInput
+      total={matchedVms.length}
+      onChange={(value) => {
+        // 根据关键词过滤匹配的虚拟机列表
+        const matched = allVms.filter((vm) => vm.name.includes(value));
+        setMatchedVms(matched);
+      }}
+      onSearchNext={(value, current) => {
+        // 滚动到第 current 个匹配结果
+        scrollToVm(matchedVms[current - 1]);
+      }}
+      onSearchPrev={(value, current) => {
+        scrollToVm(matchedVms[current - 1]);
+      }}
+    />
+  );
+};
+```
+
+### 模式二：受控模式（外部控制当前索引）
+
+适用于需要从组件外部控制当前高亮索引的场景，例如同步多个搜索结果视图。通过 `current` prop 传入索引值，组件不再内部管理位置状态。
+
+```tsx
+import React, { useState } from "react";
+import { SearchInput, Button } from "@cloudtower/eagle";
+
+const App = () => {
+  const [value, setValue] = useState("");
+  const [current, setCurrent] = useState(1);
+  const total = 10;
+
+  return (
+    <div>
+      <SearchInput
+        value={value}
+        current={current}
+        total={total}
+        debounceWait={0}
+        onChange={(v) => setValue(v)}
+        onSearchNext={(v, nextCurrent) => setCurrent(nextCurrent)}
+        onSearchPrev={(v, prevCurrent) => setCurrent(prevCurrent)}
+      />
+      <Button onClick={() => setCurrent(1)}>回到第一个</Button>
+    </div>
+  );
+};
+```
+
+注意：使用受控模式（传入 `value`）时，需把 `debounceWait` 设置为 0，否则输入时会有卡顿。
+
+### 模式三：最近搜索历史
+
+启用 `enableRecentSearch` 后，搜索记录会通过 localStorage 持久化存储。聚焦空输入框时自动显示最近搜索记录的下拉菜单，点击记录项可直接填入搜索。不同业务场景应使用不同的 `recentSearchLocalStorageKey` 以隔离数据。
+
+```tsx
+import React from "react";
+import { SearchInput } from "@cloudtower/eagle";
+
+const App = () => (
+  <SearchInput
+    enableRecentSearch
+    recentSearchLocalStorageKey="host-search"
+    maxRecentCount={5}
+    onChange={(value) => console.log("搜索:", value)}
+  />
+);
+```
+
+## 相关组件
+
+- `Input`：基础输入框，SearchInput 基于它封装
+- `Cascader`：级联选择器，内置了 SearchInput 作为搜索区域

package/docs/core/SmallDialog/guide.md

@@ -0,0 +1,224 @@
+# SmallDialog
+
+## 简介
+
+SmallDialog 是一个固定 492px 宽度的轻量级对话框组件，适用于简单确认、信息提示和自定义轻量弹窗场景。通过 `usePushModal` / `popModal` 管理弹窗生命周期，内置初始化加载态、错误信息展示和骨架屏等能力。
+
+## 何时使用
+
+- 简单确认操作（如"确认关闭虚拟机？"）
+- 纯信息提示（隐藏确认按钮，仅展示关闭按钮）
+- 需要异步提交并展示加载状态的轻量弹窗
+- 需要初始化加载数据后再展示内容的弹窗
+
+不要使用：
+
+- 包含表单的场景 --> 请用 `MediumDialog`
+- 多步骤向导流程 --> 请用 `WizardDialog`
+- 全屏沉浸式操作 --> 请用 `ImmersiveDialog`
+- 删除确认场景 --> 请用 `DeleteDialog`（已封装删除确认样式和交互）
+- 操作被拒绝 / 不可执行的反馈 --> 请用 `RejectDialog`（支持 Single / All / Part / Custom 四种模式）
+
+## 基础用法
+
+```tsx
+import React from "react";
+import { SmallDialog, Button, KitStoreProvider, ModalStack } from "@cloudtower/eagle";
+import { usePushModal } from "@cloudtower/eagle";
+
+const App = () => {
+  const pushModal = usePushModal();
+
+  const openDialog = () => {
+    pushModal({
+      component: () => (
+        <SmallDialog
+          title="关闭虚拟机"
+          onOk={(popModal) => {
+            console.log("确认关闭");
+            popModal();
+          }}
+          onCancel={(popModal) => {
+            popModal();
+          }}
+        >
+          <p>确定要关闭虚拟机 "vm-prod-01" 吗？</p>
+        </SmallDialog>
+      ),
+      props: {},
+    });
+  };
+
+  return (
+    <Button type="primary" onClick={openDialog}>
+      关闭虚拟机
+    </Button>
+  );
+};
+```
+
+## 常见模式
+
+### 模式一：异步提交弹窗
+
+适用于点击确认后需要执行异步操作（如 API 请求）的场景。通过 `confirmLoading` 控制按钮加载状态，操作完成后再关闭弹窗。
+
+```tsx
+import React, { useState } from "react";
+import { SmallDialog, Button } from "@cloudtower/eagle";
+import { usePushModal } from "@cloudtower/eagle";
+
+const ShutdownVmDialog: React.FC = () => {
+  const [loading, setLoading] = useState(false);
+  const [error, setError] = useState<string>();
+
+  return (
+    <SmallDialog
+      title="关闭虚拟机"
+      confirmLoading={loading}
+      error={error}
+      onOk={async (popModal) => {
+        setLoading(true);
+        setError(undefined);
+        try {
+          await shutdownVm("vm-prod-01");
+          popModal();
+        } catch (e) {
+          setError("关闭虚拟机失败，请重试");
+        } finally {
+          setLoading(false);
+        }
+      }}
+    >
+      <p>确定要关闭虚拟机 "vm-prod-01" 吗？</p>
+      <p>关闭后该虚拟机上运行的所有服务将停止。</p>
+    </SmallDialog>
+  );
+};
+
+// 使用方式
+const App = () => {
+  const pushModal = usePushModal();
+
+  return (
+    <Button
+      type="primary"
+      onClick={() =>
+        pushModal({ component: () => <ShutdownVmDialog />, props: {} })
+      }
+    >
+      关闭虚拟机
+    </Button>
+  );
+};
+```
+
+### 模式二：初始化加载弹窗
+
+适用于弹窗打开后需要先请求数据再展示内容的场景。利用 `initializing`、`initializingError` 和 `initializingSkeletonRows` 三个属性组合控制加载、失败、成功三种状态。
+
+```tsx
+import React, { useEffect, useMemo, useState } from "react";
+import { SmallDialog, Button } from "@cloudtower/eagle";
+import type { SmallDialogProps } from "@cloudtower/eagle";
+import { usePushModal } from "@cloudtower/eagle";
+
+const HostDetailDialog: React.FC = () => {
+  const [loading, setLoading] = useState(true);
+  const [error, setError] = useState<string>();
+  const [data, setData] = useState<{ name: string; ip: string }>();
+
+  const fetchData = async () => {
+    setLoading(true);
+    setError(undefined);
+    try {
+      const result = await fetchHostDetail("host-01");
+      setData(result);
+    } catch (e) {
+      setError("加载主机信息失败");
+    } finally {
+      setLoading(false);
+    }
+  };
+
+  useEffect(() => {
+    fetchData();
+  }, []);
+
+  const modalProps: SmallDialogProps = useMemo(() => {
+    if (loading) {
+      return { title: "", initializing: true, initializingSkeletonRows: 3 };
+    }
+    if (error) {
+      return { title: "", initializingError: error, onOk: fetchData };
+    }
+    return { title: `主机详情 - ${data?.name}` };
+  }, [loading, error, data]);
+
+  return (
+    <SmallDialog {...modalProps}>
+      <p>主机名称：{data?.name}</p>
+      <p>IP 地址：{data?.ip}</p>
+    </SmallDialog>
+  );
+};
+
+// 使用方式
+const App = () => {
+  const pushModal = usePushModal();
+
+  return (
+    <Button
+      onClick={() =>
+        pushModal({ component: () => <HostDetailDialog />, props: {} })
+      }
+    >
+      查看主机详情
+    </Button>
+  );
+};
+```
+
+### 模式三：自定义确认弹窗（纯信息提示）
+
+适用于仅需要展示信息，不需要用户做"确认/取消"选择的场景。通过 `showOk={false}` 隐藏确认按钮，将取消按钮文案改为"我知道了"。
+
+```tsx
+import React from "react";
+import { SmallDialog, Button } from "@cloudtower/eagle";
+import { usePushModal } from "@cloudtower/eagle";
+
+const App = () => {
+  const pushModal = usePushModal();
+
+  return (
+    <Button
+      onClick={() =>
+        pushModal({
+          component: () => (
+            <SmallDialog
+              title="集群升级完成"
+              showOk={false}
+              cancelText="我知道了"
+            >
+              <p>集群 "cluster-prod" 已成功升级到 v4.2.0。</p>
+              <p>所有节点均已完成滚动更新，当前运行状态正常。</p>
+            </SmallDialog>
+          ),
+          props: {},
+        })
+      }
+    >
+      查看升级结果
+    </Button>
+  );
+};
+```
+
+## 相关组件
+
+- `MediumDialog` — 中等尺寸对话框（720px），适用于包含表单输入的场景
+- `ImmersiveDialog` — 全屏沉浸式对话框，适用于需要大量操作空间的场景
+- `WizardDialog` — 向导式对话框，适用于多步骤流程
+- `DeleteDialog` — 删除确认对话框，封装了删除场景的标准样式和交互（位于 `@cloudtower/eagle` 的 coreX 模块）
+- `RejectDialog` — 操作拒绝反馈对话框，支持 Single（单条拒绝）、All（全部拒绝）、Part（部分拒绝）、Custom（自定义内容）四种模式（位于 `@cloudtower/eagle` 的 coreX 模块）

package/docs/core/TableForm/guide.md

@@ -0,0 +1,195 @@
+# TableForm
+
+## 简介
+
+TableForm 是行内编辑的表格表单组件，适用于批量数据录入场景。支持多种内置列类型（text/input/password/checkbox/affix）和自定义列渲染，表头批量填充、行的增删和拖拽排序、三种校验触发模式（Normal/Aggressive/Lazy），以及通过 `errors` 属性注入外部错误信息。通过 `useRef<TableFormHandle>` 可命令式操作数据和校验。
+
+## 何时使用
+
+- 需要批量录入结构化数据（如添加多台主机、配置多个网络接口）
+- 每行数据结构相同，需要行内直接编辑
+- 需要表头批量填充功能（一次输入应用到所有行）
+- 需要行级别的增删和拖拽排序
+
+不要使用：
+
+- 只有单行数据录入 --> 请用 `Form`
+- 纯展示型表格（不需要编辑） --> 请用 `Table`
+- 仅需拖拽排序（不需要编辑） --> 请用 `SortableList`
+
+## 基础用法
+
+```tsx
+import React, { useRef } from "react";
+import { TableForm } from "@cloudtower/eagle";
+import type { TableFormColumn, TableFormHandle } from "@cloudtower/eagle";
+
+const columns: TableFormColumn[] = [
+  { key: "name", title: "主机名", type: "input", autoIncrease: true },
+  {
+    key: "ip",
+    title: "管理 IP",
+    type: "input",
+    validator: ({ value }) => (!value ? "IP 不能为空" : undefined),
+  },
+  { key: "password", title: "密码", type: "password" },
+];
+
+const App = () => {
+  const ref = useRef<TableFormHandle>(null);
+
+  return (
+    <TableForm
+      ref={ref}
+      columns={columns}
+      defaultData={[
+        { name: "host0", ip: "", password: "" },
+        { name: "host1", ip: "", password: "" },
+      ]}
+      rowAddConfig={{ addible: true, maximum: 10 }}
+      row={{ deletable: true }}
+      onBodyChange={(data) => console.log("数据变更:", data)}
+    />
+  );
+};
+```
+
+## 常见模式
+
+### 模式一：批量填充 + 自动递增
+
+适用于需要快速填入相似数据的场景。表头输入框的值会批量应用到所有行，配合 `autoIncrease` 可以自动递增末尾数字。
+
+```tsx
+import React from "react";
+import { TableForm } from "@cloudtower/eagle";
+import type { TableFormColumn } from "@cloudtower/eagle";
+
+const columns: TableFormColumn[] = [
+  {
+    key: "hostname",
+    title: "主机名",
+    type: "input",
+    autoIncrease: true,
+    defaultValue: "host0",
+  },
+  { key: "ip", title: "管理 IP", type: "input" },
+  { key: "enabled", title: "启用", type: "checkbox", align: "center" },
+];
+
+const App = () => (
+  <TableForm
+    columns={columns}
+    defaultData={[
+      { hostname: "host0", ip: "10.0.0.1", enabled: true },
+      { hostname: "host1", ip: "10.0.0.2", enabled: true },
+      { hostname: "host2", ip: "10.0.0.3", enabled: false },
+    ]}
+    onHeaderChange={(data, columnKey) =>
+      console.log("批量填充:", columnKey, data)
+    }
+  />
+);
+```
+
+### 模式二：自定义列渲染
+
+适用于内置列类型无法满足需求的场景。通过 `render` 函数可以渲染任意组件（如 Select、DatePicker 等）。
+
+```tsx
+import React from "react";
+import { TableForm, Select } from "@cloudtower/eagle";
+import type { TableFormColumn } from "@cloudtower/eagle";
+
+const columns: TableFormColumn[] = [
+  { key: "name", title: "名称", type: "input" },
+  {
+    key: "role",
+    title: "角色",
+    defaultValue: "worker",
+    render({ isHeader, value, onChange, placeholder }) {
+      return (
+        <Select
+          size="small"
+          value={value as string}
+          onChange={onChange}
+          placeholder={isHeader ? "批量选择" : "请选择"}
+          options={[
+            { label: "Master", value: "master" },
+            { label: "Worker", value: "worker" },
+          ]}
+        />
+      );
+    },
+    validator({ value }) {
+      if (!value) return "请选择角色";
+    },
+  },
+];
+
+const App = () => (
+  <TableForm
+    columns={columns}
+    defaultData={[{ name: "", role: "worker" }]}
+    rowAddConfig={{ addible: true }}
+    row={{ deletable: true }}
+  />
+);
+```
+
+### 模式三：行配置 + 外部错误注入
+
+适用于校验逻辑在外部（如服务端返回错误）的场景。通过 `row` 统一配置行行为，通过 `errors` 注入外部错误信息。
+
+```tsx
+import React, { useState } from "react";
+import { TableForm } from "@cloudtower/eagle";
+import type { TableFormColumn, TableFormErrorsType } from "@cloudtower/eagle";
+
+const columns: TableFormColumn[] = [
+  { key: "name", title: "名称", type: "input" },
+  { key: "value", title: "值", type: "input" },
+];
+
+const App = () => {
+  const [errors, setErrors] = useState<TableFormErrorsType>([null]);
+
+  return (
+    <TableForm
+      columns={columns}
+      defaultData={[{ name: "key1", value: "" }]}
+      row={{
+        deletable: true,
+        draggable: true,
+        splitType: "zebraMarking",
+        validator: (rowIndex, rowData) =>
+          !rowData.name ? "名称不能为空" : undefined,
+      }}
+      errors={errors}
+      onBodyChange={(data) => {
+        // 模拟服务端校验
+        const newErrors = data.map((row) =>
+          row.value === "error" ? { value: "该值不合法" } : null,
+        );
+        setErrors(newErrors);
+      }}
+    />
+  );
+};
+```
+
+## 废弃说明
+
+以下属性已废弃，请迁移至 `row` 配置：
+
+- `draggable` --> `row.draggable`
+- `deleteConfig` --> `row.deletable` + `row.disableActions`
+- `rowSplitType` --> `row.splitType`
+- `renderRowDescription` --> `row.customizedDescription`
+- `rowValidator` --> `row.validator`
+
+## 相关组件
+
+- `Form`: 标准表单容器，适用于非表格化的表单场景
+- `Table`: 数据展示表格，适用于只读场景
+- `SortableList`: 可拖拽排序列表，适用于纯排序（无编辑）场景