import type { NamePath, RuleObject } from 'ant-design-vue/lib/form/interface';
|
import type { VNode } from 'vue';
|
import type { BasicButtonProps } from '/@/components/Button/types';
|
import type { FormItem } from './formItem';
|
import type { ColEx, ComponentType } from './index';
|
import { TableActionType } from '../../../Table/src/types/table';
|
|
export type FieldMapToTime = [string, [string, string], string?][];
|
|
export type Rule = RuleObject & {
|
trigger?: 'blur' | 'change' | ['change', 'blur'];
|
};
|
|
export interface RenderCallbackParams {
|
schema: FormSchema;
|
values: any;
|
model: any;
|
field: string;
|
}
|
|
export interface ButtonProps extends BasicButtonProps {
|
text?: string;
|
}
|
|
export interface FormActionType {
|
submit: () => Promise<void>;
|
setFieldsValue: <T>(values: T) => void;
|
resetFields: () => Promise<any>;
|
getFieldsValue: () => any;
|
clearValidate: (name?: string | string[]) => void;
|
updateSchema: (data: Partial<FormSchema> | Partial<FormSchema>[]) => void;
|
setProps: (formProps: Partial<FormProps>) => void;
|
removeSchemaByFiled: (field: string | string[]) => void;
|
appendSchemaByField: (schema: FormSchema, prefixField?: string) => void;
|
validateFields: (nameList?: NamePath[]) => Promise<any>;
|
validate: (nameList?: NamePath[]) => Promise<any>;
|
scrollToField: (name: NamePath, options?: ScrollOptions) => void;
|
}
|
export type RegisterFn = (formInstance: FormActionType) => void;
|
|
export type UseFormReturnType = [RegisterFn, FormActionType];
|
|
export interface FormProps {
|
// layout?: 'vertical' | 'inline' | 'horizontal';
|
// Form value
|
model?: any;
|
// The width of all items in the entire form
|
labelWidth?: number | string;
|
// Submit form on reset
|
submitOnReset?: boolean;
|
// Col configuration for the entire form
|
labelCol?: Partial<ColEx>;
|
// Col configuration for the entire form
|
wrapperCol?: Partial<ColEx>;
|
|
// General row style
|
baseRowStyle?: object;
|
|
// General col configuration
|
baseColProps?: Partial<ColEx>;
|
|
// Form configuration rules
|
schemas?: FormSchema[];
|
// Function values used to merge into dynamic control form items
|
mergeDynamicData?: any;
|
// Compact mode for search forms
|
compact?: boolean;
|
// Blank line span
|
emptySpan?: number | Partial<ColEx>;
|
// Internal component size of the form
|
size?: 'default' | 'small' | 'large';
|
// Whether to disable
|
disabled?: boolean;
|
// Time interval fields are mapped into multiple
|
fieldMapToTime?: FieldMapToTime;
|
// Placeholder is set automatically
|
autoSetPlaceHolder?: boolean;
|
// Check whether the information is added to the label
|
rulesMessageJoinLabel?: boolean;
|
// Whether to show collapse and expand buttons
|
showAdvancedButton?: boolean;
|
// Automatically collapse over the specified number of rows
|
autoAdvancedLine?: number;
|
// Whether to show the operation button
|
showActionButtonGroup?: boolean;
|
|
// Reset button configuration
|
resetButtonOptions?: Partial<ButtonProps>;
|
|
// Confirm button configuration
|
submitButtonOptions?: Partial<ButtonProps>;
|
|
// Operation column configuration
|
actionColOptions?: Partial<ColEx>;
|
|
// Show reset button
|
showResetButton?: boolean;
|
// Show confirmation button
|
showSubmitButton?: boolean;
|
|
resetFunc?: () => Promise<void>;
|
submitFunc?: () => Promise<void>;
|
transformDateFunc?: (date: any) => string;
|
colon?: boolean;
|
}
|
export interface FormSchema {
|
// Field name
|
field: string;
|
// Event name triggered by internal value change, default change
|
changeEvent?: string;
|
// Variable name bound to v-model Default value
|
valueField?: string;
|
// Label name
|
label: string;
|
// Auxiliary text
|
subLabel?: string;
|
// Help text on the right side of the text
|
helpMessage?: string | string[];
|
// BaseHelp component props
|
helpComponentProps?: Partial<HelpComponentProps>;
|
// Label width, if it is passed, the labelCol and WrapperCol configured by itemProps will be invalid
|
labelWidth?: string | number;
|
// Disable the adjustment of labelWidth with global settings of formModel, and manually set labelCol and wrapperCol by yourself
|
disabledLabelWidth?: boolean;
|
// render component
|
component: ComponentType;
|
// Component parameters
|
componentProps?:
|
| ((opt: {
|
schema: FormSchema;
|
tableAction: TableActionType;
|
formActionType: FormActionType;
|
formModel: any;
|
}) => any)
|
| object;
|
// Required
|
required?: boolean;
|
|
// Validation rules
|
rules?: Rule[];
|
// Check whether the information is added to the label
|
rulesMessageJoinLabel?: boolean;
|
|
// Reference formModelItem
|
itemProps?: Partial<FormItem>;
|
|
// col configuration outside formModelItem
|
colProps?: Partial<ColEx>;
|
|
// 默认值
|
defaultValue?: any;
|
isAdvanced?: boolean;
|
|
// Matching details components
|
span?: number;
|
|
ifShow?: boolean | ((renderCallbackParams: RenderCallbackParams) => boolean);
|
|
show?: boolean | ((renderCallbackParams: RenderCallbackParams) => boolean);
|
|
// Render the content in the form-item tag
|
render?: (renderCallbackParams: RenderCallbackParams) => VNode | VNode[] | string;
|
|
// Rendering col content requires outer wrapper form-item
|
renderColContent?: (renderCallbackParams: RenderCallbackParams) => VNode | VNode[] | string;
|
|
renderComponentContent?:
|
| ((renderCallbackParams: RenderCallbackParams) => any)
|
| VNode
|
| VNode[]
|
| string;
|
|
// Custom slot, in from-item
|
slot?: string;
|
|
// Custom slot, similar to renderColContent
|
colSlot?: string;
|
|
dynamicDisabled?: boolean | ((renderCallbackParams: RenderCallbackParams) => boolean);
|
|
dynamicRules?: (renderCallbackParams: RenderCallbackParams) => Rule[];
|
}
|
export interface HelpComponentProps {
|
maxWidth: string;
|
// Whether to display the serial number
|
showIndex: boolean;
|
// Text list
|
text: any;
|
// colour
|
color: string;
|
// font size
|
fontSize: string;
|
icon: string;
|
absolute: boolean;
|
// Positioning
|
position: any;
|
}
|
