Function Form

  • Form(props): ReactNode

  • Parameters

    • props: Pick<FormProps<any>, "form" | "name" | "children" | "preserve" | "validateTrigger" | "initialValues" | "validateMessages" | "onValuesChange" | "onFieldsChange" | "onFinish" | "onFinishFailed"> & {
          className?: string;
          style?: CSSProperties & Partial<Record<"--border-bottom" | "--border-inner" | "--border-top" | "--prefix-width", string>>;
          tabIndex?: number;
      } & AriaAttributes & Partial<FormContextType> & {
          footer?: ReactNode;
          mode?: "default" | "card";
      } & RefAttributes<FormInstance>

    Returns ReactNode

Properties

$$typeof Array Header Item Subscribe defaultProps? displayName? propTypes? useForm useWatch

Properties

Readonly $$typeof

$$typeof: symbol

Array

Array: FC<FormArrayProps>

Header

Header: FC<{
    children?: ReactNode;
}>

Type declaration

  • Optional children?: ReactNode

Item

Item: FC<Antdm.FormItemProps>

Subscribe

Subscribe: FC<FormSubscribeProps>

Optional defaultProps

defaultProps?: Partial<Pick<FormProps<any>, "form" | "name" | "children" | "preserve" | "validateTrigger" | "initialValues" | "validateMessages" | "onValuesChange" | "onFieldsChange" | "onFinish" | "onFinishFailed"> & {
    className?: string;
    style?: CSSProperties & Partial<Record<"--border-bottom" | "--border-inner" | "--border-top" | "--prefix-width", string>>;
    tabIndex?: number;
} & AriaAttributes & Partial<FormContextType> & {
    footer?: ReactNode;
    mode?: "default" | "card";
} & RefAttributes<FormInstance>>

Optional displayName

displayName?: string

Used in debugging messages. You might want to set it explicitly if you want to display a different name for debugging purposes.

See

Legacy React Docs

Optional propTypes

propTypes?: WeakValidationMap<Pick<FormProps<any>, "form" | "name" | "children" | "preserve" | "validateTrigger" | "initialValues" | "validateMessages" | "onValuesChange" | "onFieldsChange" | "onFinish" | "onFinishFailed"> & {
    className?: string;
    style?: CSSProperties & Partial<Record<"--border-bottom" | "--border-inner" | "--border-top" | "--prefix-width", string>>;
    tabIndex?: number;
} & AriaAttributes & Partial<FormContextType> & {
    footer?: ReactNode;
    mode?: "default" | "card";
} & RefAttributes<FormInstance>>

useForm

useForm: (<Values>(form?) => [FormInstance<Values>])

Type declaration

    • <Values>(form?): [FormInstance<Values>]

    • Type Parameters

      • Values = any

      Parameters

      • Optional form: FormInstance<Values>

      Returns [FormInstance<Values>]

useWatch

useWatch: {
    <TDependencies1, TForm, TDependencies2, TDependencies3, TDependencies4>(dependencies, form?): GetGeneric<TForm>[TDependencies1][TDependencies2][TDependencies3][TDependencies4];
    <TDependencies1, TForm, TDependencies2, TDependencies3>(dependencies, form?): GetGeneric<TForm>[TDependencies1][TDependencies2][TDependencies3];
    <TDependencies1, TForm, TDependencies2>(dependencies, form?): GetGeneric<TForm>[TDependencies1][TDependencies2];
    <TDependencies, TForm>(dependencies, form?): GetGeneric<TForm>[TDependencies];
    <TForm>(dependencies, form?): GetGeneric<TForm>;
    <TForm>(dependencies, form?): any;
    <ValueType>(dependencies, form?): ValueType;
}

Type declaration

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc