# switch-wrapper LLMs.txt

> 供 LLM 快速理解 `@flatbiz/antd/switch-wrapper` 的使用方式。

## 模块定位

解决Switch只能接收boolean的限制，与Form.Item结合使用最佳

## 导入方式

```ts
import { SwitchWrapper } from '@flatbiz/antd/switch-wrapper';
// 也可以从主入口导入：import { ... } from '@flatbiz/antd';
```

## 公开导出

- `* from ./switch-wrapper.jsx`
- `SwitchWrapper` - 解决Switch只能接收boolean的限制，与Form.Item结合使用最佳
- `SwitchWrapperValue`
- `SwitchWrapperProps`

## 依赖的 antd 能力

`message`、`Switch`、`SwitchProps`、`Tooltip`、`TooltipProps`

## Props / 配置要点

### SwitchWrapperProps

- `value`（可选）：: SwitchWrapperValue
- `checkedValue`（必填）：: SwitchWrapperValue
- `unCheckedValue`（必填）：: SwitchWrapperValue
- `onChange`（可选）：: (value: SwitchWrapperValue) => void
- `tooltipProps`（可选）：: Omit<TooltipProps, 'title'>
- `tooltipTitle`（可选）：: string | ((value?: SwitchWrapperValue) => string | undefined)
- `serviceConfig`（可选）：: { onRequest: (value: SwitchWrapperValue) => TAny; message?: { success?: string; defaultError?: string; }; }

## 使用规则与行为

- 解决Switch只能接收boolean的限制，与Form.Item结合使用最佳

## 基础示例

```tsx
import { SwitchWrapper, type SwitchWrapperProps } from '@flatbiz/antd/switch-wrapper';

const props: SwitchWrapperProps = {
  // 按业务传入必要参数
};

<SwitchWrapper {...props} />;
```

## 源码索引

- `src/switch-wrapper/index.ts`
- `src/switch-wrapper/switch-wrapper.tsx`

## 给 LLM 的注意事项

- 优先使用 `@flatbiz/antd/switch-wrapper` 或主入口 `@flatbiz/antd` 的公开导出，不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时，以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数，请读取上方源码索引中的类型定义和 JSDoc。