fan-standard-comp 4.1.50 → 4.1.52

package/README.md

@@ -19,4 +19,13 @@ $ yarn add fan-standard-comp
 ### 打包文档站点
  ```
 $ yarn docs:build:dumi
- ```
+ ```
+
+构建完成后，除 Dumi 文档站外，还会在产物中保留可直接访问的 Markdown 源文档和 AI 索引：
+
+```text
+doc-v4/docs/components/ButtonGroup.md
+doc-v4/llms.txt
+doc-v4/llms-full.txt
+doc-v4/ai/component-index.json
+```

package/ai/component-index.json

@@ -0,0 +1,269 @@
+{
+  "schemaVersion": "1.0.0",
+  "package": {
+    "name": "fan-standard-comp",
+    "majorVersion": 4,
+    "framework": "React",
+    "baseLibrary": "antd@5",
+    "importPattern": "import { ComponentName } from 'fan-standard-comp'"
+  },
+  "components": [
+    {
+      "name": "FanProvider",
+      "category": "global-config",
+      "summary": "为组件库提供语言、表单、筛选、表格和弹窗的全局默认配置。",
+      "source": "src/ConfigContext/index.ts",
+      "docs": "docs/components/FanProvider.md",
+      "relatedExports": ["FanContext", "FanDefaultConfig"]
+    },
+    {
+      "name": "Field",
+      "aliases": ["FieldComponent"],
+      "category": "form-control",
+      "summary": "通过 type 配置渲染输入、选择、日期、树选择、上传等基础控件。",
+      "source": "src/FormComp/FieldComponent/index.tsx",
+      "docs": "docs/components/Field.md",
+      "demos": ["src/FormComp/FieldComponent/demos/basic.tsx", "src/FormComp/FieldComponent/demos/fieldStatus.tsx", "src/FormComp/FieldComponent/demos/date.tsx", "src/FormComp/FieldComponent/demos/select.tsx", "src/FormComp/FieldComponent/demos/tree-select.tsx", "src/FormComp/FieldComponent/demos/custom.tsx", "src/FormComp/FieldComponent/demos/extend.tsx"]
+    },
+    {
+      "name": "ItemGroup",
+      "aliases": ["RenderItemGroup"],
+      "category": "form-layout",
+      "summary": "根据配置批量渲染表单项，并管理栅格、标签、尺寸和只读布局。",
+      "source": "src/FormComp/RenderItemGroup/index.tsx",
+      "docs": "docs/components/ItemGroup.md",
+      "demos": ["src/FormComp/RenderItemGroup/demos/basic.tsx", "src/FormComp/RenderItemGroup/demos/size.tsx", "src/FormComp/RenderItemGroup/demos/layout.tsx", "src/FormComp/RenderItemGroup/demos/formList.tsx"]
+    },
+    {
+      "name": "StandardForm",
+      "category": "form",
+      "summary": "通用配置化表单，提供表单项、操作按钮、校验和实例访问。",
+      "source": "src/StandardForm/index.tsx",
+      "docs": "docs/components/StandardForm.md",
+      "demos": ["src/StandardForm/demos/basic.tsx", "src/StandardForm/demos/fields.tsx"],
+      "relatedExports": ["StepForm", "TabForm"]
+    },
+    {
+      "name": "StepForm",
+      "category": "form",
+      "summary": "StandardForm 体系的分步表单。",
+      "source": "src/StandardForm/StepForm.tsx",
+      "docs": "docs/components/StandardForm.md",
+      "demos": ["src/StandardForm/demos/stepFormBasic.tsx"]
+    },
+    {
+      "name": "TabForm",
+      "category": "form",
+      "summary": "StandardForm 体系的分页签表单。",
+      "source": "src/StandardForm/TabForm.tsx",
+      "docs": "docs/components/StandardForm.md",
+      "demos": ["src/StandardForm/demos/tabFormBasic.tsx"]
+    },
+    {
+      "name": "StandardFilter",
+      "category": "filter",
+      "summary": "用于表格上方的配置化筛选栏，支持按钮组、展开折叠、布局和值转换。",
+      "source": "src/StandardFilter/index.tsx",
+      "docs": "docs/components/StandardFilter.md",
+      "demos": ["src/StandardFilter/demos/basic.tsx", "src/StandardFilter/demos/buttons.tsx", "src/StandardFilter/demos/layout.tsx", "src/StandardFilter/demos/collapseable.tsx", "src/StandardFilter/demos/transform.tsx"]
+    },
+    {
+      "name": "StandardTable",
+      "category": "data-display",
+      "summary": "封装操作列、行选择、按钮组和分页策略的通用表格。",
+      "source": "src/StandardTable/index.tsx",
+      "docs": "docs/components/StandardTable.md",
+      "demos": ["src/StandardTable/demos/basic.tsx", "src/StandardTable/demos/action.tsx", "src/StandardTable/demos/checkbox.tsx", "src/StandardTable/demos/config.tsx"]
+    },
+    {
+      "name": "StandardTablePro",
+      "category": "data-display",
+      "summary": "带接口请求、查询表单和 ref 操作的高阶表格。",
+      "source": "src/StandardTablePro/index.tsx",
+      "docs": "docs/components/StandardTablePro.md",
+      "demos": ["src/StandardTablePro/demos/basic.tsx", "src/StandardTablePro/demos/fetchData.tsx"]
+    },
+    {
+      "name": "StandardModal",
+      "category": "overlay",
+      "summary": "页面操作弹窗，可组合配置化表单、步骤表单、Tab 表单和自定义按钮。",
+      "source": "src/StandardModal/index.tsx",
+      "docs": "docs/components/StandardModal.md",
+      "demos": ["src/StandardModal/demos/basic.tsx", "src/StandardModal/demos/form.tsx", "src/StandardModal/demos/footer.tsx", "src/StandardModal/demos/stepForm.tsx", "src/StandardModal/demos/tabForm.tsx"]
+    },
+    {
+      "name": "StandardDrawer",
+      "category": "overlay",
+      "summary": "支持配置化表单、栅格布局和底部按钮的通用抽屉。",
+      "source": "src/StandardDrawer/index.tsx",
+      "docs": "docs/components/StandardDrawer.md",
+      "demos": ["src/StandardDrawer/demos/basic.tsx", "src/StandardDrawer/demos/form.tsx"]
+    },
+    {
+      "name": "StandardDragModal",
+      "category": "overlay",
+      "summary": "可拖拽弹窗；当前文档注明升级 Ant Design 后存在待修复问题。",
+      "status": "experimental",
+      "source": "src/StandardDragModal/Modal.tsx",
+      "docs": "docs/components/StandardDragModal.md",
+      "demos": ["src/StandardDragModal/demos/basic.tsx"]
+    },
+    {
+      "name": "ButtonGroup",
+      "category": "action",
+      "summary": "支持普通按钮、文本操作和表格操作列的权限按钮组。",
+      "source": "src/ButtonGroup/index.tsx",
+      "docs": "docs/components/ButtonGroup.md",
+      "demos": ["src/ButtonGroup/demos/basic.tsx", "src/ButtonGroup/demos/text.tsx", "src/ButtonGroup/demos/action.tsx"]
+    },
+    {
+      "name": "EditButton",
+      "category": "form-control",
+      "summary": "在按钮和输入保存状态间切换的编辑控件。",
+      "source": "src/FormComp/EditButton/index.tsx",
+      "docs": "docs/components/EditButton.md",
+      "demos": ["src/FormComp/EditButton/demos/basic.tsx"]
+    },
+    {
+      "name": "JsonInput",
+      "category": "form-control",
+      "summary": "JSON 输入和编辑控件，支持实时校验、格式化、压缩和只读预览。",
+      "source": "src/FormComp/JsonInput/index.tsx",
+      "docs": "docs/components/JsonInput.md",
+      "demos": ["src/FormComp/JsonInput/demos/basic.tsx"]
+    },
+    {
+      "name": "Uploader",
+      "category": "form-control",
+      "summary": "文件和图片上传控件，支持预览、数量限制、尺寸限制和裁剪。",
+      "source": "src/FormComp/Uploader/index.tsx",
+      "docs": "docs/components/Uploader.md",
+      "demos": ["src/FormComp/Uploader/demos/basic.tsx", "src/FormComp/Uploader/demos/image.tsx", "src/FormComp/Uploader/demos/limit.tsx", "src/FormComp/Uploader/demos/crop.tsx"]
+    },
+    {
+      "name": "VarTemplate",
+      "category": "form-control",
+      "summary": "用于编辑包含变量的模板内容。",
+      "source": "src/FormComp/VarTemplate/index.tsx",
+      "docs": "docs/components/VarTemplate.md",
+      "demos": ["src/FormComp/VarTemplate/demos/basic.tsx"]
+    },
+    {
+      "name": "StandardList",
+      "category": "data-display",
+      "summary": "通用列表，支持勾选和基于 dnd-kit 的拖拽排序。",
+      "source": "src/StandardList/index.tsx",
+      "docs": "docs/components/StandardList.md",
+      "demos": ["src/StandardList/demos/basic.tsx", "src/StandardList/demos/checkable.tsx", "src/StandardList/demos/dragSorting.tsx"]
+    },
+    {
+      "name": "RefactorTree",
+      "category": "navigation",
+      "summary": "常用于页面左侧的树形导航，支持搜索、根节点、禁用和选择限制。",
+      "source": "src/RefactorTree/index.tsx",
+      "docs": "docs/components/RefactortTree.md",
+      "demos": ["src/RefactorTree/demos/basic.tsx", "src/RefactorTree/demos/search.tsx", "src/RefactorTree/demos/disabled.tsx"]
+    },
+    {
+      "name": "NavLeafScroll",
+      "category": "navigation",
+      "summary": "可横向或纵向翻页滚动的菜单或列表。",
+      "source": "src/NavLeafScroll/index.tsx",
+      "docs": "docs/components/NavLeafScroll.md",
+      "demos": ["src/NavLeafScroll/demos/basic.tsx"]
+    },
+    {
+      "name": "WrapperContent",
+      "category": "layout",
+      "summary": "包含可选页头和页脚的页面外层内容容器。",
+      "source": "src/StandardContent/WrapperContent.tsx",
+      "docs": "docs/components/WrapperContent.md",
+      "demos": ["src/StandardContent/demos/wrapper.tsx", "src/StandardContent/demos/wrapperPage.tsx", "src/StandardContent/demos/wrapperFooter.tsx"]
+    },
+    {
+      "name": "SubfieldContent",
+      "category": "layout",
+      "summary": "包含可选标题区和底部区的分区内容容器。",
+      "source": "src/StandardContent/SubfieldContent.tsx",
+      "docs": "docs/components/SubfieldContent.md",
+      "demos": ["src/StandardContent/demos/subfield.tsx", "src/StandardContent/demos/subfieldFooter.tsx", "src/StandardContent/demos/subfieldTable.tsx"]
+    },
+    {
+      "name": "SideCard",
+      "category": "layout",
+      "summary": "用于 SubfieldContent 布局的侧边卡片。",
+      "source": "src/StandardContent/SideCard.tsx",
+      "docs": "docs/components/SideCard.md",
+      "demos": ["src/StandardContent/demos/sideCard.tsx"]
+    },
+    {
+      "name": "SplitterLayout",
+      "category": "layout",
+      "summary": "用于创建可分割的多区域布局。",
+      "source": "src/StandardContent/SplitterLayout/index.jsx",
+      "docs": "docs/components/SplitterLayout.md",
+      "demos": ["src/StandardContent/demos/splitter.tsx"]
+    },
+    {
+      "name": "DragContent",
+      "category": "layout",
+      "summary": "可从指定方向拉伸的内容容器；功能仍在完善中。",
+      "status": "experimental",
+      "source": "src/DragContent/index.tsx",
+      "docs": "docs/components/DragContent.md",
+      "demos": ["src/DragContent/demos/basic.tsx"]
+    },
+    {
+      "name": "StandardPanel",
+      "category": "layout",
+      "summary": "可组合标题、按钮、类别和标签的标准面板。",
+      "source": "src/StandardPanel/index.tsx",
+      "docs": "docs/components/StandardPanel.md",
+      "demos": ["src/StandardPanel/demos/basic.tsx", "src/StandardPanel/demos/buttons.tsx", "src/StandardPanel/demos/cates.tsx", "src/StandardPanel/demos/badges.tsx"]
+    },
+    {
+      "name": "StandardTitle",
+      "category": "typography",
+      "summary": "统一页面与内容区域标题样式的组件。",
+      "source": "src/StandardTitle/index.tsx",
+      "docs": "docs/components/StandardTitle.md",
+      "demos": ["src/StandardTitle/demos/basic.tsx"]
+    },
+    {
+      "name": "SpecIcon",
+      "category": "media",
+      "summary": "渲染组件库内置或业务扩展图标，支持前缀、尺寸和状态色。",
+      "source": "src/SpecIcon/index.tsx",
+      "docs": "docs/components/SpecIcon.md",
+      "demos": ["src/SpecIcon/demos/basic.tsx", "src/SpecIcon/demos/prefix.tsx", "src/SpecIcon/demos/status.tsx"]
+    },
+    {
+      "name": "ImageGallery",
+      "category": "media",
+      "summary": "基于 lightgallery 的图片画廊，可使用 children 或 items 提供图片。",
+      "source": "src/ImageGallery/index.tsx",
+      "docs": "docs/components/ImageGallery.md",
+      "relatedExports": ["ImagePreview"]
+    },
+    {
+      "name": "ImagePreview",
+      "category": "media",
+      "summary": "支持 body 浮层或行内模式的图集预览。",
+      "source": "src/ImageGallery/ImagePreview.tsx",
+      "docs": "docs/components/ImageGallery.md",
+      "demos": ["src/ImageGallery/demos/images.tsx", "src/ImageGallery/demos/preview.tsx"]
+    },
+    {
+      "name": "IconNode",
+      "category": "internal-primitive",
+      "summary": "将图标配置转换为可渲染节点的基础组件。",
+      "source": "src/components/IconNode/index.tsx",
+      "docs": null
+    }
+  ],
+  "notes": [
+    "components 仅收录 src/index.ts 通过包根路径公开导出的 React 组件与 Provider。",
+    "docs 为 null 表示当前没有独立使用文档。",
+    "公开组件的使用文档统一位于 docs/components，并随 npm 包发布。"
+  ]
+}

package/ai/templates/AGENTS.md

@@ -0,0 +1,83 @@
+# AGENTS.md
+
+## fan-standard-comp 使用规范
+
+本项目使用 `fan-standard-comp@4.x` 作为主要业务组件库。该组件库基于 React 18 和 Ant Design 5。
+
+开发或修改页面、表单、表格、筛选器、弹窗、抽屉以及页面布局时，应优先复用 `fan-standard-comp` 已提供的组件，不要重复实现相同能力。
+
+### 组件资料读取顺序
+
+优先读取当前安装版本中的资料：
+
+1. `node_modules/fan-standard-comp/llms.txt`
+2. `node_modules/fan-standard-comp/ai/component-index.json`
+3. 索引中 `docs` 字段指向的组件文档
+4. 必要时读取 `node_modules/fan-standard-comp/llms-full.txt`
+
+如果当前环境无法访问 `node_modules`，再读取在线文档：
+
+1. `http://47.113.227.251:1203/doc-v4/llms.txt`
+2. `http://47.113.227.251:1203/doc-v4/ai/component-index.json`
+3. `http://47.113.227.251:1203/doc-v4/llms-full.txt`
+
+使用在线资料时，应确认其内容与项目安装的 `fan-standard-comp` 版本一致；若版本不一致，以本地 npm 包内文档和类型声明为准。
+
+不要在任务开始时加载全部文档。先通过 `component-index.json` 按用途定位组件，再读取对应文档。
+
+### 组件选择原则
+
+- 基础表单控件优先使用 `Field`。
+- 配置化表单项和栅格布局优先使用 `ItemGroup`。
+- 普通表单优先使用 `StandardForm`。
+- 分步表单使用 `StepForm`，分页签表单使用 `TabForm`。
+- 查询条件区域优先使用 `StandardFilter`。
+- 普通业务表格优先使用 `StandardTable`。
+- 需要接口请求、查询条件或实例操作的表格优先使用 `StandardTablePro`。
+- 操作弹窗优先使用 `StandardModal`，侧边操作面板使用 `StandardDrawer`。
+- 页面内容结构优先复用 `WrapperContent`、`SubfieldContent`、`SideCard` 和 `SplitterLayout`。
+- 权限按钮组和表格操作列优先使用 `ButtonGroup`。
+- 文件或图片上传优先使用 `Uploader`。
+- 不要仅因为熟悉 Ant Design，就绕过组件库重新组合一套相同业务能力。
+
+### 导入规范
+
+组件统一从包根路径导入：
+
+```tsx
+import {
+  Field,
+  ItemGroup,
+  StandardFilter,
+  StandardTable,
+  StandardModal,
+} from 'fan-standard-comp';
+```
+
+除非包根路径没有公开导出，否则不要从 `fan-standard-comp/es/...` 或 `fan-standard-comp/lib/...` 深层导入。
+
+注意以下导出别名：
+
+- `FieldComponent` 与 `Field` 指向同一组件，新增代码优先使用 `Field`。
+- `RenderItemGroup` 与 `ItemGroup` 指向同一组件，新增代码优先使用 `ItemGroup`。
+
+### 实现要求
+
+使用组件前应检查对应文档中的：
+
+- API 参数和默认值
+- 示例代码
+- 与 Ant Design 原始属性的关系
+- 全局 `FanProvider` 配置
+- 已知问题和版本限制
+
+配置化表单应尽量复用项目中现有的字段结构和转换逻辑，不要自行发明另一套字段协议。
+
+当文档、类型声明和现有代码不一致时：
+
+1. 优先参考当前安装版本的 TypeScript 声明。
+2. 再检查项目中已经正常运行的同类用法。
+3. 必要时检查组件实现源码。
+4. 不确定的行为应明确说明，不要猜测不存在的属性。
+
+修改完成后，应执行项目已有的类型检查、测试或构建命令。