42 lines
1.6 KiB
TypeScript
42 lines
1.6 KiB
TypeScript
|
import { List, useWatch } from 'rc-field-form';
|
||
|
|
import type { FormProps as RcFormProps } from 'rc-field-form/lib/Form';
|
||
|
|
import * as React from 'react';
|
||
|
|
import type { Options } from 'scroll-into-view-if-needed';
|
||
|
|
import type { SizeType } from '../config-provider/SizeContext';
|
||
|
|
import type { ColProps } from '../grid/col';
|
||
|
|
import useForm, { type FormInstance } from './hooks/useForm';
|
||
|
|
import type { FormLabelAlign } from './interface';
|
||
|
|
import type { FeedbackIcons } from './FormItem';
|
||
|
|
export type RequiredMark = boolean | 'optional' | ((labelNode: React.ReactNode, info: {
|
||
|
|
required: boolean;
|
||
|
|
}) => React.ReactNode);
|
||
|
|
export type FormLayout = 'horizontal' | 'inline' | 'vertical';
|
||
|
|
export interface FormProps<Values = any> extends Omit<RcFormProps<Values>, 'form'> {
|
||
|
|
prefixCls?: string;
|
||
|
|
colon?: boolean;
|
||
|
|
name?: string;
|
||
|
|
layout?: FormLayout;
|
||
|
|
labelAlign?: FormLabelAlign;
|
||
|
|
labelWrap?: boolean;
|
||
|
|
labelCol?: ColProps;
|
||
|
|
wrapperCol?: ColProps;
|
||
|
|
form?: FormInstance<Values>;
|
||
|
|
feedbackIcons?: FeedbackIcons;
|
||
|
|
size?: SizeType;
|
||
|
|
disabled?: boolean;
|
||
|
|
scrollToFirstError?: Options | boolean;
|
||
|
|
requiredMark?: RequiredMark;
|
||
|
|
/** @deprecated Will warning in future branch. Pls use `requiredMark` instead. */
|
||
|
|
hideRequiredMark?: boolean;
|
||
|
|
rootClassName?: string;
|
||
|
|
}
|
||
|
|
declare const Form: (<Values = any>(props: FormProps<Values> & {
|
||
|
|
children?: React.ReactNode;
|
||
|
|
} & {
|
||
|
|
ref?: React.Ref<FormInstance<Values>> | undefined;
|
||
|
|
}) => React.ReactElement) & {
|
||
|
|
displayName?: string | undefined;
|
||
|
|
};
|
||
|
|
export { List, useForm, useWatch, type FormInstance };
|
||
|
|
export default Form;
|