@uiw-admin/components/lib/ProForm/type.d.ts

业务组件集合

import React from 'react';
import { ButtonProps, DescriptionsProps, FormItemProps as UiwFormItemProps, CardProps, CollapseProps, CollapsePanelProps, FormState, ColProps } from 'uiw';
export interface ProFormProps {
    style?: React.CSSProperties;
    className?: string;
    formDatas?: FormItemsProps[];
    layout?: 'horizontal' | 'vertical';
    onSubmit?: (initial: Record<string, any>, current: Record<string, any>) => void;
    onChange?: (initial: Record<string, any>, current: Record<string, any>) => void;
    onSubmitError?: (error: any) => void;
    buttonsContainer?: React.CSSProperties;
    title?: React.ReactNode | string;
    formType?: 'collapse' | 'card' | 'pure';
    showSaveButton?: boolean;
    showResetButton?: boolean;
    saveButtonProps?: Omit<ButtonProps, 'ref'>;
    resetButtonProps?: Omit<ButtonProps, 'ref'>;
    /** 是否是只读模式模式 */
    readOnly?: boolean;
    /** 只读模式 参考Descriptions参数 */
    readOnlyProps?: DescriptionsProps;
    /** 自定义组件 */
    customWidgetsList?: FormFields;
    form?: UseFormProps;
    cardProps?: CardProps;
    collapseProps?: CollapseProps;
    collapsePanelProps?: CollapsePanelProps;
    colProps?: ColProps;
}
export interface FormItemsProps extends Omit<UiwFormItemProps<any>, 'initialValue' | 'validator'> {
    /** 表单元素标题 */
    label?: React.ReactNode;
    /** 表单元素字段名称 */
    key: string;
    /** 表单元素类型 */
    widget: string;
    /** 表单元素值，可以是默认值 */
    initialValue?: any | any[];
    /** 数据化选项内容, type为 radio、checkbox、select 生效 */
    option?: OptionsProps[];
    widgetProps?: any;
    /** 是否显示 */
    hide?: boolean;
    /** 可以通过指定 24 列中每列的宽度来创建基本网格系统 默认8 */
    span?: string;
    /** 只读模式下包含列的数量 参考Descriptions.Item	*/
    readSpan?: number;
    /** 是否必填 */
    required?: boolean;
    rules?: RulesProps[];
    colstyle?: React.CSSProperties;
}
export interface OptionsProps {
    label: string;
    value: string | number;
    disabled?: boolean;
}
export interface RulesProps {
    message?: string;
    pattern?: RegExp;
    validator?: (value: any | any[]) => boolean;
    required?: boolean;
}
export type FormFields = {
    [key: string]: any;
};
export interface UseFormProps {
    submitvalidate?: () => void;
    onSubmit?: (e: React.FormEvent) => any;
    resetForm?: () => void;
    getFieldValues?: () => void;
    getError?: () => void;
    setFields?: (fields: FormState['current']) => void;
    validateFieldsAndGetValue?: () => Promise<any>;
    setFormState?: (p: UseFormStateProps | any) => void;
}
export interface UseFormStateProps {
    onSubmit: () => (e: React.FormEvent) => any;
    getFieldValues: () => void;
    resetForm: () => void;
    getError: () => void;
    setFields: (fields: FormState['current']) => void;
}