@flatbiz/antd
Version:
104 lines (101 loc) • 3.75 kB
TypeScript
import { TAny, TPlainObject } from '@flatbiz/utils';
import { FormItemProps } from 'antd';
import { CSSProperties, ReactElement, ReactNode } from 'react';
export type TFormItemLayoutPreClassNameProps = {
/**
* label宽度，Form内部所有FormItem label都生效
* ```
* 1. 可设置数值
* 2. 可设置`auto`自适应
* ```
*/
labelWidth?: "auto" | "70" | "80" | "90" | "100" | "110" | "120" | "130" | "140" | "150" | "160" | "170" | "180" | "190" | "200";
/** labelItem 竖直布局 */
labelItemVertical?: boolean;
/** label 对齐方式 */
labelAlign?: "left" | "right";
/**
* className 中可能会包含 preDefinedClassName.formItem.xx，优先级大于 labelWidth、labelItemVertical、labelAlign
*/
className?: string;
};
export type FormItemWrapperProps = Omit<FormItemProps, "hidden" | "children" | "noStyle"> & TFormItemLayoutPreClassNameProps & {
wrapper?: (children: ReactNode) => ReactElement;
/** 设置wrapper后，before、after失效 */
before?: ReactNode;
/** 设置wrapper后，before、after失效 */
after?: ReactNode;
/** 设置 before、after 属性的包装结构style */
beforeAfterStyle?: CSSProperties;
/** value 序列化处理 */
inputNormalize?: (value?: TAny) => TAny;
/**
* onChange 参数序列化处理
* 如果设置 normalize 属性，outputNormalize将失效
*/
outputNormalize?: (value?: TAny) => TAny;
/**
* 隐藏 Form.Item，同时清除 Form.Item 值
* ```
* 1.与 dependencies 属性配合使用，可实现当前FormItemWrapper的显示隐藏
* 2.提交不校验rules
* ```
*/
isClear?: boolean | ((formValues: TPlainObject) => boolean);
/**
* 隐藏 Form.Item，不会清除 Form.Item 值
* ```
* 1.与 dependencies 属性配合使用，可实现当前FormItemWrapper的显示隐藏
* 2.提交会校验rules
* ```
*/
hidden?: boolean | ((formValues: TPlainObject) => boolean);
/**
* 栅格占位格数，最大值：24
* ```
* 1. 当前FormItemWrapper处在 EasyForm 直接子节点中有效，即FormItemWrapper在EasyForm栅格中的占位格数；
* 2. 父节点使用属性值，当前节点不使用属性值
* ```
*/
span?: number;
/** 不支持函数式写法，如果需要使用dependencies获取表单值，可使用FormItemWrapperDependencies 组件 */
children?: ReactNode;
/**
* ```
* 1. 设置noStyle后，可能会导致 FromItemWrapper 在 EasyFrom 内部渲染网格布局时出现异常
* 2. 在FormItemWrapper中使用 dependencies 逻辑不需要设置 noStyle
* ```
*/
noStyle?: boolean;
};
/**
* 对 Form.Item 包装处理
* ```
* 1. 为 children 增加 before、after
* 2. 对输入、输出数据进行序列化处理
* 3. 内置布局样式使用 preDefinedClassName.formItem
* 4. 设置隐藏域（不清除字段值） 使用hidden，存在依赖逻辑，可与dependencies属性配合使用
* 5. 设置隐藏域（清除字段值）使用isClear，存在依赖逻辑，可与dependencies属性配合使用
* 6. 不支持noStyle属性、children不支持函数写法、如果需要获取依赖字段值，可使用 FormItemWrapperDependencies 组件
* 7. 设置noStyle后，可能会导致 FromItemWrapper 在 EasyFrom 内部渲染网格布局时出现异常
*
*
* ** 依赖其他字段 自身切换显示隐藏 **
* <FormItemWrapper
* label="label"
* name="xx1"
* dependencies={['type']}
* isClear={(values) => {
* return values.type == 1
* }}>
* <Input placeholder="请输入" />
* </FormItemWrapper>
*
* 如果只是想获取依赖字段值，可使用 FormItemWrapperDependencies 组件
* ```
*/
export declare const FormItemWrapper: {
(props: FormItemWrapperProps): import("react").JSX.Element;
domTypeName: string;
};
export {};