# drag-form-list LLMs.txt

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

## 模块定位

可拖拽FormList

## 导入方式

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

## 公开导出

- `DragFormList` - 可拖拽FormList
- `* from ./drag-form-list.jsx`
- `SortableItem`
- `SortableItemProps`
- `DragFormListContentProps`
- `DragFormListProps`

## 依赖的 antd 能力

`Empty`、`Form`

## Props / 配置要点

### FormListChildrenWrapperProps

- `wrapper`（可选）：: DragFormListProps['formListChildrenWrapper']
- `children`（必填）：: ReactElement

### SortableItemProps

- `formListFieldData`（必填）：: FormListFieldData
- `formListOperate`（必填）：: FormListOperation
- `dragIcon`（可选）：: DragFormListProps['dragIcon']
- `getItemDragDisabled`（可选）：: DragFormListProps['getItemDragDisabled']
- `dragDisabled`（可选）：: DragFormListProps['dragDisabled']
- `isGray`（可选）：: boolean
- `className`（可选）：: string
- `style`（可选）：: CSSProperties
- `uid`（必填）：: string | number
- `index`（必填）：: number
- `isOverlay`（可选）：: boolean
- `formStageCompleteName`（必填）：: (string | number)[]
- `children`（必填）：: (data: DragFormListContentProps) => ReactElement
- `prevCompleteName`（必填）：: (string | number)[]
- `uidFieldName`（必填）：: string

### DragFormListContentProps

- `formListFieldData`（必填）：: FormListFieldData；Form.List item fieldData
- `formStageCompleteName`（必填）：: (string | number)[]；当前阶段 完整 formItem name
- `prevCompleteName`（必填）：: (string | number)[]；formList上一级 formItem完整name
- `operation`（必填）：: FormListOperation；Form.List 操作项
- `index`（必填）：: number；索引
- `getInsideFormItemName`（必填）：: (key: string | string[]) => Array<string | number>；获取当前FormList 内部 Form.Item name
- `getInsideFormItemData`（必填）：: () => TPlainObject；获取当前 FormList Item 数据
- `uidKey`（必填）：: string；唯一值字段Key

### DragFormListProps

- `className`（可选）：: string
- `style`（可选）：: CSSProperties
- `itemStyle`（可选）：: CSSProperties
- `uidFieldName`（可选）：: string；formList item 数据中的唯一值，默认值：uid
- `name`（必填）：: string | number | (string | number)[]；formList name
- `prevCompleteName`（必填）：: (string | number)[]；formList上一级 formItem完整name
- `onDropChange`（可选）：: (items: TPlainObject[]) => void；拖拽回调
- `dragIcon`（可选）：: ReactElement；设置拖拽图标
- `dragDisabled`（可选）：: boolean；禁用拖拽，拖拽图标隐藏
- `getItemDragDisabled`（可选）：: (uid: string | number, index: number) => boolean；设置item禁止拖拽
- `getAddRowDefaultValues`（可选）：: () => TPlainObject；新增行默认值，自定义onTableAfterRender后失效
- `hiddenAddRowButton`（可选）：: boolean；隐藏新增行按钮
- `onCustomAddRowButton`（可选）：: (operation: FormListOperation) => ReactElement；自定义新增行按钮，getAddRowDefaultValues配置失效
- `children`（必填）：: (data: DragFormListContentProps) => ReactElement；formListItem 内容
- `hiddenEmptyRender`（可选）：: boolean；隐藏数据为空渲染
- `formListChildrenWrapper`（可选）：: (props: { children: ReactElement }) => ReactElement；formList内部渲染包装，多用于FormListWrapper嵌套布局
- `rules`（可选）：: FormListProps['rules']；Form.List rules
- `formListItemTitleList`（可选）：: { title: string; required?: boolean; width?: number; }[]；设置FormList字段标题&必填标志
- `formListItemTitleHorizontalUnionProps`（可选）：: Omit< FormItemHorizontalUnionProps, 'groupConfigList' >；formListItemTitle HorizontalUnionProps 配置
- `itemGap`（可选）：: number；FormList Item 之间间隙，默认值：16

## 使用规则与行为

- 可拖拽FormList
- 只能通过getFieldValue取值
- Form.List item fieldData
- 当前阶段 完整 formItem name
- formList上一级 formItem完整name
- Form.List 操作项
- 索引
- 获取当前FormList 内部 Form.Item name
- 获取当前 FormList Item 数据
- 唯一值字段Key

## 默认值线索

- `gap => -15`

## 基础示例

```tsx
import { DragFormList, type FormListChildrenWrapperProps } from '@flatbiz/antd/drag-form-list';

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

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

## 源码索引

- `src/drag-form-list/drag-form-list.tsx`
- `src/drag-form-list/index.ts`
- `src/drag-form-list/sortable-item.tsx`
- `src/drag-form-list/types.ts`

## 给 LLM 的注意事项

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