@flatbiz/antd/dist/drag-form-list/index.d.ts

import { TPlainObject } from '@flatbiz/utils';
import { FormListFieldData, FormListOperation } from 'antd';
import { FormListProps } from 'antd/es/form';
import { CSSProperties, ReactElement } from 'react';

export type FormItemHorizontalUnionProps = {
	className?: string;
	style?: CSSProperties;
	label?: string | ReactElement;
	/** 水平布局元素 */
	groupConfigList: {
		hidden?: boolean;
		before?: ReactElement | string;
		/**
		 * 设置宽度
		 * ```
		 * 1. 自适应可设置：auto
		 * 2. 可设置具体数值
		 * 3. 不设置会在铺满flex剩余空间
		 * 4. 多个未设置会等分铺满剩余空间
		 * ```
		 */
		width?: number | string;
		mainItem: ReactElement;
		after?: ReactElement | string;
	}[];
	/** 水平布局原始之间的间距 */
	gap?: number;
	flexLayoutStyle?: CSSProperties;
	flexLayoutClassName?: string;
	hidden?: boolean;
	required?: boolean;
	colon?: boolean;
};
export type DragFormListContentProps = {
	/** Form.List item fieldData */
	formListFieldData: FormListFieldData;
	/**
	 * 当前阶段 完整 formItem name
	 * ```
	 * 1. 获取当前输入项Item数据
	 *    form.getFieldValue(props.formStageCompleteName);
	 * 2. 获取当前输入项Item指定字段数据
	 *    form.getFieldValue([...props.formStageCompleteName, 'key']);
	 * ```
	 */
	formStageCompleteName: (string | number)[];
	/**
	 * formList上一级 formItem完整name
	 */
	prevCompleteName: (string | number)[];
	/** Form.List 操作项 */
	operation: FormListOperation;
	/** 索引 */
	index: number;
	/** 获取当前FormList 内部 Form.Item name */
	getInsideFormItemName: (key: string | string[]) => Array<string | number>;
	/** 获取当前 FormList Item 数据 */
	getInsideFormItemData: () => TPlainObject;
	/** 唯一值字段Key */
	uidKey: string;
};
export type DragFormListProps = {
	className?: string;
	style?: CSSProperties;
	itemStyle?: CSSProperties;
	/** formList item 数据中的唯一值，默认值：uid */
	uidFieldName?: string;
	/** formList name */
	name: string | number | (string | number)[];
	/**
	 * formList上一级 formItem完整name
	 * ```
	 * 1. 如果没有传 []
	 * 2. FormList内部通过 Form.useWatch 取值需要完整 name
	 * ```
	 */
	prevCompleteName: (string | number)[];
	/** 拖拽回调 */
	onDropChange?: (items: TPlainObject[]) => void;
	/** 设置拖拽图标 */
	dragIcon?: ReactElement;
	/** 禁用拖拽，拖拽图标隐藏 */
	dragDisabled?: boolean;
	/** 设置item禁止拖拽   */
	getItemDragDisabled?: (uid: string | number, index: number) => boolean;
	/** 新增行默认值，自定义onTableAfterRender后失效 */
	getAddRowDefaultValues?: () => TPlainObject;
	/** 隐藏新增行按钮 */
	hiddenAddRowButton?: boolean;
	/** 自定义新增行按钮，getAddRowDefaultValues配置失效 */
	onCustomAddRowButton?: (operation: FormListOperation) => ReactElement;
	/** formListItem 内容 */
	children: (data: DragFormListContentProps) => ReactElement;
	/** 隐藏数据为空渲染 */
	hiddenEmptyRender?: boolean;
	/** formList内部渲染包装，多用于FormListWrapper嵌套布局 */
	formListChildrenWrapper?: (props: {
		children: ReactElement;
	}) => ReactElement;
	/**
	 * Form.List rules
	 * ```
	 rules={[
		{
		  validator: async (_, names) => {
			if (!names || names.length < 2) {
			  return Promise.reject(new Error('At least 2 passengers'));
			}
		  },
		},
	  ]}
	 * ```
	 */
	rules?: FormListProps["rules"];
	/**
	 * 设置FormList字段标题&必填标志
	 * ```
	 * demo: http://dev.flatjs.com:6007/pages/flat/oss-demo/main/form/list?env=me
	 * 1. 会根据数组顺序进行渲染
	 * 2. 未设置width的元素，参与等分剩余宽度
	 * 3. 设置width 要与FormList children中的item宽度相同，不然内容与标题无法对齐
	 * ```
	 */
	formListItemTitleList?: {
		title: string;
		required?: boolean;
		width?: number;
	}[];
	/** formListItemTitle HorizontalUnionProps 配置 */
	formListItemTitleHorizontalUnionProps?: Omit<FormItemHorizontalUnionProps, "groupConfigList">;
	/** FormList Item 之间间隙，默认值：16 */
	itemGap?: number;
};
/**
 * 可拖拽FormList
 * ```
 * Demo: https://fex.qa.tcshuke.com/docs/admin/main/form/list
 * 1. FormList数组中必须要有唯一值字段，默认值字段名称uid，可通过uidFieldName自定义设置
 * 2. 通过 itemGap 设置FormList Item 之间间隙
 * ```
 */
export declare const DragFormList: (props: DragFormListProps) => import("react").JSX.Element;

export {};