@para-ui/core 5.0.0-beta.11 → 5.0.0-beta.13

package/es/Button/component.json

@@ -0,0 +1,168 @@
+{
+    "name": "Button",
+    "category": "Basic",
+    "description": "用于触发用户操作的按钮组件",
+    "semantic": {
+        "intent": [
+            "提交",
+            "确认",
+            "触发操作",
+            "导航"
+        ],
+        "useCases": [
+            "表单提交",
+            "弹窗确认",
+            "页面主操作",
+            "表格操作栏"
+        ],
+        "riskLevel": "normal"
+    },
+    "variants": {
+        "contained": {
+            "meaning": "主要操作，强调引导用户点击",
+            "constraints": [
+                "一个操作区域通常只放置一个 contained 按钮"
+            ]
+        },
+        "outlined": {
+            "meaning": "次要操作，作为一个替代选择"
+        },
+        "text": {
+            "meaning": "最轻量级的操作，通常用于表格行内或辅助位置"
+        }
+    },
+    "modifiers": {
+        "danger": {
+            "meaning": "高风险操作标识（如删除、重置），与 variant 正交——可与 contained/outlined/text 任一组合",
+            "constraints": [
+                "建议配合二次确认（如 PopConfirm）使用，但非强制"
+            ]
+        }
+    },
+    "states": [
+        "default",
+        "disabled",
+        "loading"
+    ],
+    "idealProps": {
+        "variant": {
+            "type": "enum",
+            "values": [
+                "contained",
+                "outlined",
+                "text"
+            ],
+            "default": "contained"
+        },
+        "size": {
+            "type": "enum",
+            "values": [
+                "small",
+                "medium",
+                "large"
+            ],
+            "default": "large",
+            "description": "按钮尺寸。**注意：默认 large**（与 antd/MUI 业界惯例 medium 不同——这是 para-ui 的设计选择，DEFECT-003 wont-fix 留设计评审）。如需业界默认尺寸请显式传 size='medium'"
+        },
+        "loading": {
+            "type": "boolean | { delay: number }",
+            "default": false,
+            "description": "载入状态。loading=true 时按钮显示 loading 图标 + 自动加 disabled 属性（**隐含 disabled，onClick 不触发**）——与 antd/MUI 惯例一致。`loading={delay: ms}`：loading spinner 最短可见时长（delay 毫秒），防止快速请求场景闪烁",
+            "behaviorNote": "v5.x DEFECT-001 修复：之前需要 `disabled={loading}` 双写防御，**现在 loading=true 已自动隐含 disabled（onClick 不触发），无需再写 disabled={loading}**——双写不造成 bug 但属于冗余代码。零破坏：src 业务 0 引用此 prop；docs 仅 1 处示例不受影响"
+        },
+        "disabled": {
+            "type": "boolean",
+            "default": false
+        },
+        "danger": {
+            "type": "boolean",
+            "default": false,
+            "description": "危险操作修饰符；与 variant 正交（可与 contained/outlined/text 任一组合）。详见顶层 modifiers.danger"
+        },
+        "startIcon": {
+            "type": "ReactNode",
+            "description": "前置图标"
+        },
+        "endIcon": {
+            "type": "ReactNode",
+            "description": "后置图标"
+        },
+        "href": {
+            "type": "string",
+            "description": "跳转链接，传入此属性时行为类似 a 标签"
+        },
+        "target": {
+            "type": "string",
+            "description": "链接打开方式"
+        },
+        "toolTipTitle": {
+            "type": "ReactNode",
+            "description": "**hover 悬停提示（最简快捷写法）——仅 disabled=false 时生效**。src 内 toolTipTitle 路径把 Tooltip `disabled={disabled}` 透传，因此按钮禁用时 Tooltip 同时被禁用（tooltip 不显示）。⚠️ Tooltip 相关共有 3 个 prop（toolTipTitle / TooltipProps / disabledTooltip），命名风格不一致 + 职责重叠是已知问题（DEFECT-002，独立 epic 评审中——src 内 134+ 处使用）。**优先级（src 实证）**：① disabled=true + disabledTooltip 有值 → 走 disabledTooltip 路径；② toolTipTitle 非空 → 显示 Tooltip（disabled=false 时）；③ TooltipProps 覆盖 toolTipTitle 的 arrow/placement 等样式参数。**结论：disabled 状态的悬停提示必须用 disabledTooltip，toolTipTitle 在 disabled=true 时不显示**。**传 undefined / null / false 时等价于不传，不渲染 Tooltip wrapper，不影响点击区域**"
+        },
+        "disabledTooltip": {
+            "type": "{ title: ReactNode; placement?: string; arrow?: boolean; [key: string]: any }",
+            "description": "**disabled=true 时的悬停提示**（toolTipTitle 在 disabled=true 时不生效，需用此 prop）。TooltipProps 核心字段：`title: ReactNode`（必填）/ `placement?`（弹出方向，默认 'top'）/ `arrow?: boolean`（箭头）。**最简写法**：`disabledTooltip={{ title: '不可操作原因' }}`"
+        },
+        "children": {
+            "type": "ReactNode",
+            "description": "**按钮文案或内容（正式 prop）**。通过 React 标准 children 传入；可传字符串或 ReactNode，与 startIcon/endIcon 可同时使用。ButtonProps extends ButtonOrAnchorAttributes（继承自 React.ButtonHTMLAttributes），children 是标准 React prop——不单独在此处列出不代表不支持"
+        }
+    },
+    "do": [
+        "主要操作使用 contained",
+        "重要但非主要操作使用 outlined",
+        "危险操作必须明确标识（danger 属性）",
+        "表单提交场景传 `type='submit'`（默认 `type='button'` 防意外表单提交；Button 通过 restProps 透传 HTML 原生 button 属性，`type='submit'` 会覆盖默认值生效）。⚠️ **type 是 HTML native attribute · 只接受 'button' / 'submit' / 'reset'。若你想用 antd 风格 `type='primary'` · paraui 对应是 `variant='contained'`；若你想 antd `type='default'` · paraui 用 `variant='outlined'`；若 antd `type='danger'` · paraui 用 `danger={true}`(modifier · 与 variant 正交)**",
+        "disabled 状态需要悬停提示时用 disabledTooltip（toolTipTitle 在 disabled=true 时不显示）",
+        "loading 状态无需额外写 disabled={loading}——loading=true 已自动隐含 disabled（DEFECT-001 修复）",
+        "**ButtonProps extends ButtonOrAnchorAttributes**（src/Button/index.tsx:21）：所有原生 button/a 属性均可安全透传，TypeScript 严格模式下不会类型报错——`type='submit'` / `name` / `form`（关联 form id）/ `disabled` / `aria-*` 等均可用"
+    ],
+    "dont": [
+        "在同一区域放置过多 contained 按钮",
+        "使用 disabled 按钮作为唯一的禁用反馈（应配合 Tooltip 解释原因）",
+        "❌ 不要用 `type='primary'` / `type='default'` / `type='danger'`（antd 风格）· paraui 用 `variant='contained'` / `variant='outlined'` / `danger={true}`(modifier 与 variant 正交)",
+        "❌ 不要用 `color='primary'`（MUI 风格）· paraui 用 variant + danger 拆分语义"
+    ],
+    "events": {
+        "onClick": {
+            "signature": "(event: React.MouseEvent<HTMLButtonElement | HTMLAnchorElement>) => void",
+            "asyncSupported": false,
+            "examples": [
+                "基本点击处理：onClick={() => handleSubmit()}",
+                "需要阻止冒泡：onClick={(e) => { e.stopPropagation(); doAction(); }}",
+                "loading 状态下 onClick 不触发（已自动隐含 disabled）：无需 onClick 里手动判断 isLoading"
+            ],
+            "commonMistakes": [
+                "loading=true 时期望 onClick 还触发——loading 自动隐含 disabled，onClick 被屏蔽；无需再写 disabled={loading}",
+                "disabled=true 时用 toolTipTitle 做禁用提示——disabled 状态下 toolTipTitle 不显示；需改用 disabledTooltip prop",
+                "在 href 模式（传了 href）下期望 onClick 阻止跳转——渲染为 <a>，onClick 里需 e.preventDefault() 才能阻止"
+            ]
+        }
+    },
+    "typescriptPitfalls": [
+        {
+            "issue": "variant 不是 antd 的 type，不接受 'primary'/'default'/'danger'，只接受 'contained'/'outlined'/'text'",
+            "wrong": "// antd 风格：\n<Button type='primary'>提交</Button>  // 这里 type 是 HTML button type，不是样式！",
+            "right": "// para-ui 风格：\n<Button variant='contained'>提交</Button>  // 主要操作用 contained\n<Button variant='outlined'>取消</Button>   // 次要操作用 outlined\n<Button danger>删除</Button>              // 危险操作加 danger modifier"
+        },
+        {
+            "issue": "type prop 是 HTML 原生 button type（'button'|'submit'|'reset'），不是样式 variant",
+            "wrong": "<Button type='primary'>提交</Button>  // TypeScript 报错：'primary' 不在 'button'|'submit'|'reset' 联合类型",
+            "right": "<Button variant='contained' type='submit'>提交</Button>  // type 只管 form 提交行为，默认 'button'"
+        },
+        {
+            "issue": "loading 的对象形式需要传 { delay: number }，不能传其他结构",
+            "wrong": "loading={{ duration: 300 }}  // TS 类型报错：对象形式只接受 { delay: number }",
+            "right": "loading={{ delay: 300 }}  // delay 是 loading spinner 最短可见毫秒数"
+        },
+        {
+            "issue": "disabledTooltip 的 title 字段必填，TooltipProps 的 disabled 字段含义是'禁用 tooltip 本身'——不要传 disabled",
+            "wrong": "disabledTooltip={{ disabled: true, title: '...' }}  // disabled 是 Tooltip 的开关，传 true 反而不显示",
+            "right": "disabledTooltip={{ title: '不可操作原因' }}  // 只需 title，Button disabled=true 时自动触发"
+        }
+    ],
+    "mapping": {
+        "realComponent": "Button",
+        "adapter": null
+    }
+}

package/es/Button/index.js

@@ -11,32 +11,32 @@ const z = (b) => {
     variant: N = "contained",
     size: T = "large",
     className: p,
-    disabled: o = !1,
-    children: r,
+    disabled: s = !1,
+    children: l,
     startIcon: e,
-    endIcon: s,
-    loading: i = !1,
+    endIcon: o,
+    loading: c = !1,
     toolTipTitle: x = "",
     TooltipProps: B,
     danger: L = !1,
     href: h,
     target: j,
-    disabledTooltip: l,
+    disabledTooltip: a,
     ...f
-  } = b, [c, m] = y(!1), d = "href" in b, a = () => P(
+  } = b, [r, m] = y(!1), d = "href" in b, i = () => P(
     `${n}-button`,
     p,
     `${n}-button-${N}`,
     `${n}-button-${T}`,
-    c && `${n}-button-loading`,
-    L && !o && `${n}-button-dangerous`,
+    r && `${n}-button-loading`,
+    L && !s && `${n}-button-dangerous`,
     d && `${n}-button-link`,
-    d && o && `${n}-button-link-disabled`
+    d && s && `${n}-button-link-disabled`
   ), u = (k) => {
-    if (!c)
-      return k === "start" && e ? /* @__PURE__ */ t.jsx("span", { className: "button-icon", children: e }) : k === "end" && s ? /* @__PURE__ */ t.jsx("span", { className: "button-icon button-icon-end", children: s }) : null;
-    if (typeof i == "object") {
-      const v = i.delay || 0;
+    if (!r)
+      return k === "start" && e ? /* @__PURE__ */ t.jsx("span", { className: "button-icon", children: e }) : k === "end" && o ? /* @__PURE__ */ t.jsx("span", { className: "button-icon button-icon-end", children: o }) : null;
+    if (typeof c == "object") {
+      const v = c.delay || 0;
       setTimeout(() => m(!1), v);
     }
     return k === "start" ? /* @__PURE__ */ t.jsx("span", { className: "button-icon button-icon-loading", children: /* @__PURE__ */ t.jsx(C, {}) }) : null;
@@ -46,34 +46,34 @@ const z = (b) => {
       ...f,
       href: h,
       target: j,
-      className: a(),
+      className: i(),
       children: [
         u("start"),
-        r && /* @__PURE__ */ t.jsx("span", { className: "button-label", children: r }),
+        l && /* @__PURE__ */ t.jsx("span", { className: "button-label", children: l }),
         u("end")
       ]
     }
   ) : /* @__PURE__ */ t.jsxs(
     "button",
     {
-      disabled: o,
+      disabled: s || r,
       type: "button",
-      className: a(),
+      className: i(),
       ...f,
       children: [
         u("start"),
-        r && /* @__PURE__ */ t.jsx("span", { className: "button-label", children: r }),
+        l && /* @__PURE__ */ t.jsx("span", { className: "button-label", children: l }),
         u("end")
       ]
     }
   );
   return I(() => {
-    m(!!i);
-  }, [i]), o && l ? /* @__PURE__ */ t.jsx(
+    m(!!c);
+  }, [c]), s && a ? /* @__PURE__ */ t.jsx(
     g,
     {
       disabled: !0,
-      ...l,
+      ...a,
       children: /* @__PURE__ */ t.jsx("span", { className: `${n}-button--disabled`, children: $() })
     }
   ) : x ? /* @__PURE__ */ t.jsx(
@@ -82,9 +82,9 @@ const z = (b) => {
       arrow: !1,
       placement: "bottomLeft",
       ...B,
-      disabled: o,
+      disabled: s,
       title: x,
-      children: o ? /* @__PURE__ */ t.jsx("span", { className: `${n}-button--disabled`, children: $() }) : $()
+      children: s ? /* @__PURE__ */ t.jsx("span", { className: `${n}-button--disabled`, children: $() }) : $()
     }
   ) : $();
 }, E = (b) => {
@@ -92,33 +92,33 @@ const z = (b) => {
     variant: N = "contained",
     size: T = "large",
     toolTipTitle: p = "",
-    children: o,
-    className: r,
+    children: s,
+    className: l,
     disabled: e = !1,
-    loading: s = !1,
-    TooltipProps: i,
+    loading: o = !1,
+    TooltipProps: c,
     danger: x = !1,
     href: B,
     target: L,
     disabledTooltip: h,
     ...j
-  } = b, [l, f] = y(!1), c = "href" in b, m = () => P(
+  } = b, [a, f] = y(!1), r = "href" in b, m = () => P(
     `${n}-button ${n}-icon-button`,
-    r,
+    l,
     `${n}-icon-button-${N}`,
     `${n}-icon-button-${T}`,
-    l && `${n}-icon-button-loading`,
+    a && `${n}-icon-button-loading`,
     x && !e && `${n}-icon-button-dangerous`,
-    c && `${n}-button-link`,
-    c && e && `${n}-button-link-disabled`
+    r && `${n}-button-link`,
+    r && e && `${n}-button-link-disabled`
   ), d = () => {
-    if (!l) return o;
-    if (typeof s == "object") {
-      const u = s.delay || 0;
+    if (!a) return s;
+    if (typeof o == "object") {
+      const u = o.delay || 0;
       setTimeout(() => f(!1), u);
     }
     return /* @__PURE__ */ t.jsx("span", { className: "button-loading-icon", children: /* @__PURE__ */ t.jsx(C, {}) });
-  }, a = () => c ? /* @__PURE__ */ t.jsx(
+  }, i = () => r ? /* @__PURE__ */ t.jsx(
     "a",
     {
       ...j,
@@ -131,33 +131,33 @@ const z = (b) => {
     "button",
     {
       ...j,
-      disabled: e,
+      disabled: e || a,
       type: "button",
       className: m(),
       children: d()
     }
   );
   return I(() => {
-    f(!!s);
-  }, [s]), e && h ? /* @__PURE__ */ t.jsx(
+    f(!!o);
+  }, [o]), e && h ? /* @__PURE__ */ t.jsx(
     g,
     {
       disabled: !0,
       ...h,
-      children: /* @__PURE__ */ t.jsx("span", { className: `${n}-button--disabled`, children: a() })
+      children: /* @__PURE__ */ t.jsx("span", { className: `${n}-button--disabled`, children: i() })
     }
   ) : p ? /* @__PURE__ */ t.jsx(
     g,
     {
       arrow: !1,
       placement: "bottomLeft",
-      ...i,
+      ...c,
       disabled: e,
       title: p,
-      children: e ? /* @__PURE__ */ t.jsx("span", { className: `${n}-button--disabled`, children: a() }) : a()
+      children: e ? /* @__PURE__ */ t.jsx("span", { className: `${n}-button--disabled`, children: i() }) : i()
     },
-    +l
-  ) : a();
+    +a
+  ) : i();
 }, S = z;
 S.IconButton = E;
 S.SplitButton = w;

package/es/ButtonGroup/component.json

@@ -0,0 +1,132 @@
+{
+    "name": "ButtonGroup",
+    "category": "General",
+    "description": "按钮组，将多个按钮组合在一起",
+    "semantic": {
+        "intent": [
+            "操作分组",
+            "互斥选择"
+        ],
+        "useCases": [
+            "视图切换",
+            "格式化工具栏",
+            "分段控制"
+        ],
+        "riskLevel": "low"
+    },
+    "variants": {
+        "icon": {
+            "meaning": "图标模式"
+        },
+        "iconSplit": {
+            "meaning": "图标分割模式"
+        },
+        "text": {
+            "meaning": "文本模式"
+        }
+    },
+    "states": [
+        "default",
+        "disabled"
+    ],
+    "idealProps": {
+        "data": {
+            "type": "ButtonItem[]",
+            "itemSchema": {
+                "icon": { "type": "ReactNode", "description": "按钮图标" },
+                "text": { "type": "ReactNode", "description": "按钮文本（icon/iconSplit 模式下仅作 tooltip 默认值；text 模式下为显示文字）" },
+                "disabled": { "type": "boolean", "description": "单项禁用（覆盖组件级 disabled）" },
+                "toolTipTitle": { "type": "ReactNode", "description": "该项 tooltip 文案（优先级高于 text）" },
+                "variant": { "type": "'contained' | 'outlined' | 'text'", "description": "继承自 ButtonProps，text 模式下用于标识激活态" }
+            },
+            "description": "按钮组数据数组,每项 ButtonItem extends ButtonProps(来自 src/Button — 可用 variant / size / loading / type 等全部 Button 字段),额外含 ButtonGroup 专用字段 icon? / text? / toolTipTitle? + 索引签名透传业务字段;src/ButtonGroup/index.tsx:15。**text 字段双语义**:icon/iconSplit 模式下 text 仅作 tooltip 默认值(不显示为按钮文字),text 模式下 text 才是按钮显示文字。**ButtonItem.value 字段冲突**:继承自 Button 类型为 `string | number | readonly string[] | undefined`,**不是单纯 string** — 业务标识请用 viewId / actionKey / menuKey 等独有名避免 tsc 报错(R22 ButtonGroup-004 实证)。**data[].disabled** 是单项独立覆盖字段(boolean,非字符串)"
+        },
+        "mode": {
+            "type": "enum",
+            "values": [
+                "icon",
+                "iconSplit",
+                "text"
+            ],
+            "default": "icon",
+            "description": "按钮组模式(icon=纯图标 / iconSplit=分割可见 / text=纯文字)。**text 模式下 variant 切换有效**:variant='contained' 实心高亮 / variant='outlined' 描边弱化 — 配合外部 activeKey state 实现 tabs 视觉切换(组件无内置 active 状态)"
+        },
+        "layout": {
+            "type": "enum",
+            "values": [
+                "horizontal",
+                "vertical"
+            ],
+            "default": "horizontal",
+            "description": "布局方向"
+        },
+        "showToolTip": {
+            "type": "boolean",
+            "default": "false",
+            "description": "对每按钮显示 tooltip,未设 toolTipTitle 时自动用 text 作为提示;单项 toolTipTitle 优先级高于此自动逻辑"
+        },
+        "showIcon": {
+            "type": "boolean",
+            "default": "false",
+            "description": "text 模式下文字前显示 icon(icon/iconSplit 模式无效)"
+        },
+        "disabled": {
+            "type": "boolean",
+            "default": "false",
+            "description": "整组禁用;单项可通过 data[].disabled(**boolean,不是字符串 'true'**)单独覆盖;src/ButtonGroup/index.tsx:88 单项若未设则继承顶层"
+        },
+        "onClick": {
+            "type": "(item: ButtonItem, event?: React.MouseEvent) => void",
+            "description": "点击回调;**item 是被点击的整个 ButtonItem 对象**(含 data 项里的所有自定义字段,如业务 id / viewId 等)— 推荐做法:在 data 每项上挂 value / viewId 等业务字段,onClick 内 item.viewId 直取(不必维护 index → 业务 id 的映射)"
+        }
+    },
+    "do": [
+        "用于互斥或相关操作的分组",
+        "保持按钮数量适中(2-5)",
+        "在 data 每项透传业务字段(如 value / viewId / actionKey),onClick 内 item.业务字段 取值"
+    ],
+    "dont": [
+        "ButtonGroup 内放置不相关的操作",
+        "按钮过多导致布局拥挤",
+        "把 data[].disabled 传字符串 'true'(必须 boolean — runtime 行为不可信)",
+        "假设 ButtonGroup 有内置 active/selected 状态(无此 prop — tabs 切换需外部 state 维护 activeKey,根据 activeKey 在 data 项里切 variant: 'contained' | 'outlined')",
+        "把业务标识透传到 ButtonItem.value 字段(value 继承自 Button 是宽类型 `string | number | readonly string[] | undefined` — tsc 会报错;业务标识用 viewId / actionKey / menuKey 等独有名)"
+    ],
+    "events": {
+        "onClick": {
+            "signature": "(item: ButtonItem, event?: React.MouseEvent) => void",
+            "asyncSupported": false,
+            "examples": [
+                "通用点击入口：onClick={(item) => dispatch({ type: item.actionKey })}",
+                "获取被点击项的业务标识：onClick={(item) => navigate(item.viewId)}",
+                "需要事件对象：onClick={(item, event) => { event?.stopPropagation(); handleItem(item); }}"
+            ],
+            "commonMistakes": [
+                "期望 item 只是 index 或 key——item 是被点击的完整 ButtonItem 对象，含 data[] 中该项的所有字段",
+                "在 data 里用 ButtonItem.value 存业务 id——value 继承自 Button 是宽类型 string|number|readonly string[]|undefined，建议用 viewId/actionKey 等独有字段名",
+                "event 参数是可选的（签名 event?），回调内直接访问 event.target 前需检查 event 非 undefined"
+            ]
+        }
+    },
+    "typescriptPitfalls": [
+        {
+            "issue": "ButtonItem 继承自 ButtonProps，value 字段类型是 string|number|readonly string[]|undefined，不是单纯 string",
+            "wrong": "const items: ButtonItem[] = [{ icon: <Icon/>, text: '编辑', value: 'edit' }];\n// onClick 中：const id: string = item.value;  // TS 报错：不可分配给 string",
+            "right": "// 使用自定义字段名避免冲突\nconst items: ButtonItem[] = [{ icon: <Icon/>, text: '编辑', actionKey: 'edit' }];\n// onClick 中：const key = (item as any).actionKey;"
+        },
+        {
+            "issue": "ButtonGroup 没有内置 active/selected 状态，需要外部 state 维护并通过 variant 切换视觉",
+            "wrong": "// 期望有 activeKey prop 自动高亮\n<ButtonGroup data={tabs} activeKey='tab1' />  // activeKey 不在 ButtonGroupProps，静默失效",
+            "right": "// 外部维护 activeKey，按需设置 variant\nconst [active, setActive] = useState('tab1');\n<ButtonGroup\n  mode='text'\n  data={tabs.map(t => ({ ...t, variant: t.id === active ? 'contained' : 'outlined' }))}\n  onClick={(item) => setActive((item as any).id)}\n/>"
+        },
+        {
+            "issue": "data[].disabled 必须是 boolean，不能是字符串 'true'，因为 ButtonGroup src 用 typeof _disabled === 'undefined' 做判断",
+            "wrong": "const items: ButtonItem[] = [{ text: '删除', disabled: 'true' as any }];  // 字符串 'true' 是 truthy，不是 boolean true",
+            "right": "const items: ButtonItem[] = [{ text: '删除', disabled: true }];  // 明确传 boolean"
+        }
+    ],
+    "mapping": {
+        "realComponent": "ButtonGroup",
+        "adapter": null
+    }
+}

package/es/ButtonGroup/index.d.ts

@@ -5,7 +5,7 @@ export interface ButtonItem extends ButtonProps {
     icon?: ReactNode;
     /** 文本*/
     text?: ReactNode;
-    [key: string]: any;
+    [key: string]: unknown;
 }
 export interface ButtonGroupProps {
     /** 按钮组模式 */