# check-list LLMs.txt

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

## 模块定位

CheckListItem：FlatBiz antd 扩展模块。

## 导入方式

```ts
import { CheckList } from '@flatbiz/antd/check-list';
// 也可以从主入口导入：import { ... } from '@flatbiz/antd';
```

## 公开导出

- `CheckListItem`
- `CheckListItemContentProps`
- `CheckListItemProps`
- `CheckListInner`
- `CheckListSelectedValue`
- `CheckListProps`
- `CheckList`
- `CheckListItemValue`
- `CheckListValue`
- `getValueList`

## Props / 配置要点

### CheckListItemContentProps

- `checked`（可选）：: boolean
- `disabled`（可选）：: boolean
- `onClick`（可选）：: (event) => void
- `className`（可选）：: string
- `readonly`（可选）：: boolean
- `style`（可选）：: CSSProperties

### CheckListItemProps

- `value`（必填）：: CheckListItemValue
- `disabled`（可选）：: boolean
- `readonly`（可选）：: boolean
- `children`（必填）：: (data: CheckListItemContentProps) => ReactElement
- `className`（可选）：: string
- `style`（可选）：: CSSProperties

### CheckListProps

- `multiple`（可选）：: boolean
- `onChange`（可选）：: ( value: CheckListSelectedValue<T>, operateValue: CheckListItemValue ) => void
- `onPreChange`（可选）：: (value: CheckListItemValue) => Promise<void>
- `value`（可选）：: CheckListSelectedValue<T>
- `defaultValue`（可选）：: CheckListSelectedValue<T>
- `beforeExtra`（可选）：: ReactNode
- `afterExtra`（可选）：: ReactNode
- `stopPropagation`（可选）：: boolean
- `required`（可选）：: boolean

### CheckListItemValue

- 声明：`export type CheckListItemValue = string | number;`

## 基础示例

```tsx
import { CheckList, type CheckListItemContentProps } from '@flatbiz/antd/check-list';

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

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

## 源码索引

- `src/check-list/check-list-item.tsx`
- `src/check-list/check-list.tsx`
- `src/check-list/context.ts`
- `src/check-list/index.ts`
- `src/check-list/types.ts`
- `src/check-list/utils.ts`

## 给 LLM 的注意事项

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