@para-ui/core 5.0.0-beta.9 → 5.0.0

package/es/RadioGroup/component.json

@@ -0,0 +1,149 @@
+{
+    "name": "RadioGroup",
+    "category": "Data Entry",
+    "description": "单选框组，统一管理一组 Radio 的受控选中态，支持泛型约束和二维布局",
+    "semantic": {
+        "intent": [
+            "单选",
+            "互斥选择"
+        ],
+        "useCases": [
+            "选项切换",
+            "模式选择",
+            "单选配置"
+        ],
+        "riskLevel": "low"
+    },
+    "variants": {
+        "default": {
+            "meaning": "默认样式"
+        }
+    },
+    "states": [
+        "default",
+        "disabled"
+    ],
+    "idealProps": {
+        "list": {
+            "type": "RadioListProps[] | RadioListProps[][]",
+            "description": "选项数据（必填）。**RadioListProps extends RadioProps**（可含 label/disabled 等 Radio prop）。⚠️ 默认以 `item[id]` 取值（id prop 默认 'name'），list 每项必须有对应字段；传二维数组 `RadioListProps[][]` 时按行分组渲染"
+        },
+        "value": {
+            "type": "T",
+            "description": "当前选中值（受控）；类型 T 由泛型推断（默认 unknown）；与 list 项的 item[id] 字段值对比决定哪项选中"
+        },
+        "defaultValue": {
+            "type": "T",
+            "description": "默认选中值（非受控初始态）；与 value 互斥——传 value 则受控"
+        },
+        "onChange": {
+            "type": "(val: T, item?: RadioListProps) => void",
+            "description": "值变化回调；val = item[id]（即 list 项中 id 字段对应的值）；item 是被点击的完整 list 项对象"
+        },
+        "id": {
+            "type": "string",
+            "default": "name",
+            "description": "**list 每项的取值字段名**（默认 'name'，不是 'value'）——RadioGroup 内部取 item[id] 作为选中值；⚠️ 这是常见混淆点：字段名是 'name' 不是 'value'"
+        },
+        "label": {
+            "type": "ReactNode",
+            "description": "组标题"
+        },
+        "labelTooltip": {
+            "type": "LabelTooltipProps",
+            "description": "组标题旁的帮助图标 tooltip"
+        },
+        "required": {
+            "type": "boolean",
+            "default": false,
+            "description": "是否必填（显示红色星号）"
+        },
+        "row": {
+            "type": "boolean",
+            "default": true,
+            "description": "布局方式；true=横向排列；false=纵向排列"
+        },
+        "spacing": {
+            "type": "string",
+            "default": "32px",
+            "description": "横向布局时每项之间的间距（CSS 值，如 '16px'）；row=false 时不生效"
+        },
+        "itemWidth": {
+            "type": "string",
+            "description": "每项的固定宽度（CSS 值，如 '120px'）；配合 row=false 的栅格对齐"
+        },
+        "size": {
+            "type": "enum",
+            "values": ["small", "medium", "large"],
+            "default": "large",
+            "description": "尺寸，透传给每个 Radio（src/RadioGroup/index.tsx:65 实证，default='large'）"
+        },
+        "disabled": {
+            "type": "boolean",
+            "default": false,
+            "description": "全局禁用所有选项（优先于 list 每项的 disabled）"
+        },
+        "error": {
+            "type": "boolean",
+            "default": false,
+            "description": "错误状态（显示红色边框 + helperText 错误样式，来自 HelperTextDetailProps 继承）"
+        },
+        "helperText": {
+            "type": "ReactNode",
+            "default": "",
+            "description": "错误或提示文字（error=true 时红色显示，error=false 时灰色显示）"
+        },
+        "hideErrorDom": {
+            "type": "boolean",
+            "description": "是否隐藏错误文字 DOM（表单布局固定高度时防止错误文字撑开布局）"
+        }
+    },
+    "do": [
+        "配合 Radio 使用——RadioGroup 统一管理 checked 状态，无需每个 Radio 手动维护",
+        "选项数量适中（2-5），超出 5 个考虑 Select",
+        "list 项必须有 id 对应字段（默认 'name'）作为选中值，如 `list={[{ name: 'a', label: '选项A' }]}` 且不传 id prop",
+        "支持泛型收窄类型：`<RadioGroup<'male' | 'female'>>` 让 value/onChange 类型推断更精确"
+    ],
+    "dont": [
+        "选项过多（应使用 Select）",
+        "忽略默认选中——至少通过 defaultValue 或 value 提供初始状态，否则所有项均未选中",
+        "以为 list 项的取值字段是 'value'——RadioGroup 默认取 item['name']，需要用 'value' 字段时需传 id='value'"
+    ],
+    "events": {
+        "onChange": {
+            "signature": "(val: T, item?: RadioListProps) => void",
+            "asyncSupported": false,
+            "examples": [
+                "受控写法：value={selected} onChange={(val) => setSelected(val)}",
+                "获取完整 item：onChange={(val, item) => { setSelected(val); logItem(item); }}",
+                "泛型收窄：<RadioGroup<'a' | 'b'> list={...} value={v} onChange={(val) => setV(val)}>"
+            ],
+            "commonMistakes": [
+                "假设 val 是 item.value——RadioGroup 取 item[id]（默认 item.name），不是 item.value",
+                "不回写 value prop 导致选中态不更新——RadioGroup 是受控组件，onChange 后必须 setState 回写 value",
+                "list 项缺少 id 字段——id 默认 'name'，list 项无 name 字段时 val 会是 undefined"
+            ]
+        }
+    },
+    "typescriptPitfalls": [
+        {
+            "issue": "id prop 指定取值字段名，默认是 'name' 不是 'value'，混淆导致 onChange 收到 undefined",
+            "wrong": "// list 每项有 value 字段，但不传 id：\nlist={[{ value: 'male', label: '男' }]}  // onChange 收到 undefined，因为取的是 item['name']",
+            "right": "// 方案A：list 项用 name 字段\nlist={[{ name: 'male', label: '男' }]}\n// 方案B：显式传 id='value'\n<RadioGroup id='value' list={[{ value: 'male', label: '男' }]} />"
+        },
+        {
+            "issue": "RadioGroup 泛型参数 T 默认 unknown，value/onChange 类型过宽，建议显式传泛型",
+            "wrong": "// T=unknown，onChange val 类型 unknown，需 as 强转：\nconst [v, setV] = useState<string>(); onChange={(val) => setV(val as string)}",
+            "right": "const [v, setV] = useState<string>(); <RadioGroup<string> value={v} onChange={(val) => setV(val)} />"
+        },
+        {
+            "issue": "list 支持二维数组分行，但每行内项的 onChange 逻辑相同——误以为二维数组需要特殊处理",
+            "wrong": "// 二维数组时自己实现 checked 逻辑\nlist={[[...], [...]]} value={v} onChange不传  // 组件已内部处理，不需要额外逻辑",
+            "right": "<RadioGroup list={[[item1, item2], [item3, item4]]} value={v} onChange={(val) => setV(val)} />"
+        }
+    ],
+    "mapping": {
+        "realComponent": "RadioGroup",
+        "adapter": null
+    }
+}

package/es/RangeInput/component.json

@@ -0,0 +1,198 @@
+{
+    "name": "RangeInput",
+    "category": "Data Entry",
+    "description": "范围输入框，两个 InputNumber 组成数值区间，自动 swap 防止 min>max",
+    "semantic": {
+        "intent": [
+            "范围输入",
+            "区间选择"
+        ],
+        "useCases": [
+            "价格区间",
+            "数量范围",
+            "时间范围"
+        ],
+        "riskLevel": "normal"
+    },
+    "variants": {
+        "default": {
+            "meaning": "默认样式"
+        }
+    },
+    "states": [
+        "default",
+        "disabled",
+        "error"
+    ],
+    "idealProps": {
+        "value": {
+            "type": "Clearable extends true ? [number | null, number | null] : [number | undefined, number | undefined]",
+            "description": "当前值（受控）。**类型随 clearable 泛型条件切换**（协议 RI1）：clearable=true → `[number | null, number | null]`（任一端可 null 表示清空）；clearable=false（默认）→ `[number | undefined, number | undefined]`（直接传 null TS 报错）"
+        },
+        "defaultValue": {
+            "type": "Clearable extends true ? [number | null, number | null] : [number | undefined, number | undefined]",
+            "description": "默认值（非受控）；类型规则同 value（随 clearable 切换）"
+        },
+        "onChange": {
+            "type": "(val, index) => void",
+            "description": "值变化回调。**val 类型**：clearable=true → `[number | null, number | null]`；clearable=false → `[number, number]`。**index** 是触发输入框下标（0/1），index=-1 表示内部 swap 触发（min>max 自动交换）。**业务 [number, number] 桥接**：`(val) => onChange([val[0] ?? 0, val[1] ?? 0])`（协议 RI2）"
+        },
+        "clearable": {
+            "type": "boolean",
+            "default": false,
+            "description": "是否允许清空（协议 RI1）。**默认 false**；true 时全链路类型放宽到 `number | null`，清空后 onChange 回传含 null 的二元组（不是 null 本体）；false 时类型收窄。**业务需要清空必须显式 `clearable={true}`**"
+        },
+        "size": {
+            "type": "enum",
+            "values": [
+                "small",
+                "medium",
+                "large"
+            ],
+            "default": "large",
+            "description": "控件大小（三档全部支持）"
+        },
+        "label": {
+            "type": "ReactNode",
+            "description": "组标题"
+        },
+        "labelTooltip": {
+            "type": "LabelTooltipProps",
+            "description": "标题旁帮助图标 tooltip"
+        },
+        "required": {
+            "type": "boolean",
+            "default": false,
+            "description": "是否必填（显示红色星号）"
+        },
+        "disabled": {
+            "type": "boolean | [boolean, boolean]",
+            "default": false,
+            "description": "禁用；boolean=两侧都禁；[boolean, boolean]=分别控制左右"
+        },
+        "disabledTooltip": {
+            "type": "TooltipProps | [TooltipProps, TooltipProps]",
+            "description": "禁用状态 tooltip；单值=两侧共享；数组=分别控制左右（src/RangeInput/index.tsx:34 interface 实证）"
+        },
+        "separator": {
+            "type": "ReactNode",
+            "default": "~",
+            "description": "中间分隔符"
+        },
+        "unit": {
+            "type": "ReactNode",
+            "description": "单位文本（显示在右侧）"
+        },
+        "placeholder": {
+            "type": "ReactNode | [ReactNode, ReactNode]",
+            "description": "占位文本；单值=两侧共享；数组=分别控制左右"
+        },
+        "warningMessage": {
+            "type": "ReactNode",
+            "description": "min>max 自动 swap 后展示的警告文案（swap 发生后显示 warnTime 毫秒）"
+        },
+        "warnTime": {
+            "type": "number",
+            "default": 2000,
+            "description": "warningMessage 自动消失时间（毫秒）"
+        },
+        "otherProps": {
+            "type": "[InputNumberProps, InputNumberProps]",
+            "description": "左右两个 InputNumber 的额外 props，分别透传（src/RangeInput/index.tsx:60 interface 实证）"
+        },
+        "error": {
+            "type": "boolean",
+            "default": false,
+            "description": "错误状态"
+        },
+        "helperText": {
+            "type": "ReactNode",
+            "description": "错误/提示文字"
+        },
+        "onBlur": {
+            "type": "(event: React.FocusEvent<HTMLInputElement>, index: number) => void",
+            "description": "失去焦点回调；index=0/1 区分左右；swap 逻辑在整体失焦后触发（rAF 延后）"
+        },
+        "onFocus": {
+            "type": "(event: React.FocusEvent<HTMLInputElement>, index: number) => void",
+            "description": "获得焦点回调；index=0/1 区分左右"
+        },
+        "onEnter": {
+            "type": "(event: React.KeyboardEvent<HTMLInputElement>, index: number) => void",
+            "description": "回车回调；index=0/1 区分左右"
+        }
+    },
+    "crossPropInteractions": [
+        "clearable=true + value 类型 = 全链路放宽 [number | null, number | null]",
+        "clearable=false（默认）+ value 类型 = 收窄 [number | undefined, number | undefined]",
+        "onChange val + index = index=0/1 触发位，-1 表示内部 swap（min>max 自动交换）",
+        "disabled [boolean, boolean] + disabledTooltip [TooltipProps, TooltipProps] = 分别控制左右",
+        "size + 三档全部支持 = small / medium / large（api.ts 与 component.json 已对齐）"
+    ],
+    "commonMisconceptions": [
+        "❌ 默认就能传 [null, null] 清空 — 必须显式 clearable={true}",
+        "❌ clearable=true 清空回传 null 本体 — 实际回传 [null, null] 二元组",
+        "❌ onChange 永远是 [number | null, number | null] — clearable=false 时实为 [number, number]",
+        "❌ size 只支持 small/large — 三档全部支持（api.ts 已修正）",
+        "❌ value desc 说「默认值 受控」— 历史 typo，实际是「当前值 受控」"
+    ],
+    "do": [
+        "校验最小值不能大于最大值——组件会在整体失焦后自动 swap，配合 warningMessage 提示用户",
+        "提供清晰的分隔符（默认 '~'，可自定义如 ' 至 '）",
+        "业务需要清空功能时显式传 clearable={true}（类型全链路放宽）",
+        "业务 [number, number] 严格非 null 时不传 clearable（类型收窄保护，onChange 回参直接是 [number, number]）"
+    ],
+    "dont": [
+        "忽略边界校验——min>max 时组件虽自动 swap，但最好在 onChange 里加业务层校验",
+        "不提示输入错误——配合 error + helperText 展示校验失败原因",
+        "默认 clearable=false 时传 [null, null]（TS 报错）"
+    ],
+    "events": {
+        "onChange": {
+            "signature": "(val: [number | null, number | null] | [number, number], index: number) => void",
+            "asyncSupported": false,
+            "examples": [
+                "受控写法：value={range} onChange={(val, index) => setRange(val)}",
+                "区分触发位：onChange={(val, index) => { if (index === 0) validateMin(val[0]); else if (index === 1) validateMax(val[1]); else console.log('swap 触发'); }}",
+                "clearable=false 桥接：onChange={(val) => setBizRange([val[0] ?? 0, val[1] ?? 0])}"
+            ],
+            "commonMistakes": [
+                "index=-1 时 val 两端都变化（swap）——不能只看 val[index]，index=-1 时应同时处理两端",
+                "clearable=false 时 onChange val 里出现 null——理论上不会，但渐进过渡期需兼容",
+                "忘记回写 value prop——RangeInput 是受控组件，onChange 后必须 setState 回写，否则页面回弹"
+            ]
+        },
+        "onBlur": {
+            "signature": "(event: React.FocusEvent<HTMLInputElement>, index: number) => void",
+            "asyncSupported": false,
+            "examples": [
+                "整体失焦时才触发 swap——左右切焦时 onBlur 会被调但 swap 不触发（rAF 检测 activeElement 仍在组件内）",
+                "onBlur={(e, index) => { if (!rootRef.current?.contains(document.activeElement)) doValidation(); }}"
+            ],
+            "commonMistakes": [
+                "在 onBlur 里立即读 value 期望拿到 swap 后的值——swap 是通过 rAF 异步触发，onBlur 调用时 swap 尚未执行"
+            ]
+        }
+    },
+    "typescriptPitfalls": [
+        {
+            "issue": "clearable=false（默认）时 value 类型是 [number | undefined, number | undefined]，直接传 [null, null] TS 报错",
+            "wrong": "value={[null, null]}  // clearable=false 时类型不允许 null",
+            "right": "<RangeInput<true> clearable value={[null, null]} />  // 显式泛型 true 或 clearable={true}"
+        },
+        {
+            "issue": "onChange val 类型随 clearable 泛型变化，不显式传泛型时 val 类型推断可能宽泛",
+            "wrong": "// clearable=false 但 onChange handler 写成接受 null：\nonChange={(val: [number | null, number | null]) => ...}  // 与 clearable=false 合约不符",
+            "right": "// clearable=false（默认）\nonChange={(val: [number, number]) => setRange(val)}"
+        },
+        {
+            "issue": "disabled 支持 [boolean, boolean] 元组，但传普通 boolean[] 数组类型不精确",
+            "wrong": "const flags: boolean[] = [true, false]; <RangeInput disabled={flags} />  // 类型报错",
+            "right": "const flags: [boolean, boolean] = [true, false]; <RangeInput disabled={flags} />"
+        }
+    ],
+    "mapping": {
+        "realComponent": "RangeInput",
+        "adapter": null
+    }
+}

package/es/RangeInput/index.d.ts

@@ -1,9 +1,9 @@
-import { default as React, FunctionComponent, ReactNode } from 'react';
+import { default as React, ReactNode } from 'react';
 import { LabelTooltipProps } from '../Label';
 import { InputNumberProps } from '../InputNumber';
 import { HelperTextDetailProps } from '../HelperText';
 import { TooltipProps } from '../Tooltip';
-export interface RangeInputProps extends HelperTextDetailProps {
+export interface RangeInputProps<Clearable extends boolean = false> extends HelperTextDetailProps {
     /** 样式class */
     className?: string;
     /** style */
@@ -22,10 +22,16 @@ export interface RangeInputProps extends HelperTextDetailProps {
      * 禁用提示
      */
     disabledTooltip?: TooltipProps | [TooltipProps, TooltipProps];
+    /**
+     * 是否允许清空（清空后 onChange 回传 null）；
+     * 默认 false 时 value/defaultValue/onChange 入参收敛为 number，子 InputNumber 由 RangeInput 内部以 clearable 模式承载临时 null 状态；
+     * 显式 true 时全链路类型放宽到 number | null，沿用历史行为
+     */
+    clearable?: Clearable;
     /** 默认值 不受控 */
-    defaultValue?: [number | null, number | null];
+    defaultValue?: Clearable extends true ? [number | null, number | null] : [number | undefined, number | undefined];
     /** 默认值 */
-    value?: [number | null, number | null];
+    value?: Clearable extends true ? [number | null, number | null] : [number | undefined, number | undefined];
     /** 中间符号 */
     separator?: ReactNode;
     /** 单位 */
@@ -40,8 +46,10 @@ export interface RangeInputProps extends HelperTextDetailProps {
     otherProps?: [InputNumberProps, InputNumberProps];
     /**
      * 改变值
-     * */
-    onChange?: (val: [number | null, number | null], index: number) => void;
+     * @param val 当前 value 数组
+     * @param index 触发改变的输入框下标；index === -1 表示由 RangeInput 内部 swap 触发，[0]/[1] 同时变化
+     */
+    onChange?: (val: Clearable extends true ? [number | null, number | null] : [number, number], index: number) => void;
     /** 失去焦点 */
     onBlur?: (event: React.FocusEvent<HTMLInputElement>, index: number) => void;
     /** 得到焦点 */
@@ -49,5 +57,5 @@ export interface RangeInputProps extends HelperTextDetailProps {
     /** 回车事件 */
     onEnter?: (event: React.KeyboardEvent<HTMLInputElement>, index: number) => void;
 }
-export declare const RangeInput: FunctionComponent<RangeInputProps>;
+export declare function RangeInput<C extends boolean = false>(props: RangeInputProps<C>): JSX.Element;
 export default RangeInput;