# search-form LLMs.txt

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

## 模块定位

搜索表单

## 导入方式

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

## 公开导出

- `* from ./search.jsx`
- `searchFormModel` - 
- `ModelState`
- `SearchForm` - 搜索表单
- `SearchFormProps`
- `SearchFormRefApi`

## 依赖的 antd 能力

`Form`、`FormInstance`

## Props / 配置要点

### SearchFormProps

- `children`（必填）：: | ReactElement | ReactElement[] | ((form: FormInstance) => ReactElement)
- `searchOperate`（可选）：: (form: FormInstance) => FormOperateColProps；isPure = true时无效
- `isPure`（可选）：: boolean；是否为纯净模式（查询条件布局是否自定义），
- `queryButtonProps`（可选）：: Omit<ButtonWrapperProps, 'onClick'> & { text?: string }；查询按钮配置
- `resetButtonProps`（可选）：: Omit<ButtonWrapperProps, 'onClick'> & { text?: string }；重置按钮配置
- `formClassName`（可选）：: string
- `formStyle`（可选）：: CSSProperties
- `formInitialValues`（可选）：: TPlainObject；form 初始值
- `formLabelWidth`（可选）：: FormWrapperProps['labelWidth']；label宽度，Form内部所有FormItem label都生效
- `formLabelItemVertical`（可选）：: FormWrapperProps['labelItemVertical']；labelItem 竖直布局
- `formLabelAlign`（可选）：: FormWrapperProps['labelAlign']；label 对齐方式
- `formFormItemGap`（可选）：: FormWrapperProps['formItemGap']；formItem之间竖直间距，默认值：24
- `rightOperateAreaAppendType`（可选）：: 'cover' | 'beforeAppend' | 'afterAppend'；自定义 searchOperate.rightList 后 默认【查询、重置】按钮处理逻辑 1. cover：覆盖内部查询重置按钮（默认值） 2. beforeAppend：添加到【查询重置】按钮前面 3. afterAppend：添加到【查询重置】按钮后面 如果想隐藏【查询、重置】按钮中的某一个，可设置 queryButtonProps.hidden、resetButtonProps.hidden
- `defaultResetButtonTriggerRequest`（可选）：: boolean；默认重启按钮触发请求，默认值：true
- `foldKeys`（可选）：: string[]；展开、收起key值列表（内容当前组件子组件key值）
- `onFormFinish`（可选）：: (values?: TPlainObject) => void；按钮提交事件 如果需要自定义回车提交事件，需要自定义提交按钮
- `onReset`（可选）：: () => void；重置按钮
- `onQuery`（可选）：: (values: TPlainObject) => void；查询按钮
- `cacheSwitch`（可选）：: boolean；是否缓存查询数据，默认值：true
- `initRequest`（可选）：: boolean；初始化是否请求，默认值：true
- `form`（可选）：: FormInstance

## 使用规则与行为

- isPure = true时无效
- 是否为纯净模式（查询条件布局是否自定义），
- 查询按钮配置
- 重置按钮配置
- 网格布局设置 default = { xs: 24, sm: 12, md: 12, lg: 8, xl: 8, xxl: 6 }; small = { xs: 24, sm: 8, md: 8, lg: 6, xl: 6, xxl: 6 };
- form 初始值
- label宽度，Form内部所有FormItem label都生效
- labelItem 竖直布局
- label 对齐方式
- formItem之间竖直间距，默认值：24

## 基础示例

```tsx
import { SearchForm, type SearchFormProps } from '@flatbiz/antd/search-form';

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

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

## 源码索引

- `src/search-form/index.ts`
- `src/search-form/model.ts`
- `src/search-form/search.tsx`

## 给 LLM 的注意事项

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