Function useFormComponent

  • Description

    Implement by react-hook-form and Mui , for quick definition form.

    Description

    基于 react-hook-form 和 Mui 实现,可用于快速定义表单

    Description

    It inherits and extends react-hook-form.

    Description

    它继承并拓展了react-hook-form

    Date

    2023/4/1 - 17:06:57

    Returns

    Type Parameters

    • TForm extends FieldValues = FieldValues

    • TContext = any

    Parameters

    • Optional props: Partial<{
          context: TContext;
          criteriaMode: CriteriaMode;
          defaultValues: DeepPartial<TForm> | AsyncDefaultValues<TForm>;
          delayError: number;
          mode: keyof ValidationMode;
          reValidateMode: "onBlur" | "onChange" | "onSubmit";
          resetOptions: Partial<{
              keepDefaultValues: boolean;
              keepDirty: boolean;
              keepDirtyValues: boolean;
              keepErrors: boolean;
              keepIsSubmitted: boolean;
              keepIsValid: boolean;
              keepSubmitCount: boolean;
              keepTouched: boolean;
              keepValues: boolean;
          }>;
          resolver: Resolver<TForm, TContext>;
          shouldFocusError: boolean;
          shouldUnregister: boolean;
          shouldUseNativeValidation: boolean;
          values: TForm;
      }>

    Returns {
        FormCheckbox: ReturnComponent<TForm, Path<TForm>, (({: BaseFormCheckboxProps) => Element)>;
        FormRegion: ReturnComponent<TForm, Path<TForm>, (({: RegionProps) => Element)>;
        FormSearch: ReturnComponent<TForm, Path<TForm>, (<TV, TI>({: IBaseFormSearchProps<TV, TI>) => Element)>;
        FormSelect: ReturnComponent<TForm, Path<TForm>, (<T, V>({: BaseSelectProps<T, V, keyof T, keyof T>) => Element)>;
        FormSwitch: ReturnComponent<TForm, Path<TForm>, (({: BaseFormSwitchProps) => Element)>;
        FormText: ReturnComponent<TForm, Path<TForm>, ((props: TextFieldProps) => JSX.Element)>;
        clearErrors: UseFormClearErrors<TForm>;
        control: Control<TForm, TContext>;
        formProps: UseFormReturn<TForm, TContext>;
        formState: FormState<TForm>;
        getFieldState: UseFormGetFieldState<TForm>;
        getValues: UseFormGetValues<TForm>;
        handleSubmit: UseFormHandleSubmit<TForm>;
        register: UseFormRegister<TForm>;
        reset: UseFormReset<TForm>;
        resetField: UseFormResetField<TForm>;
        setError: UseFormSetError<TForm>;
        setFocus: UseFormSetFocus<TForm>;
        setValue: UseFormSetValue<TForm>;
        trigger: UseFormTrigger<TForm>;
        unregister: UseFormUnregister<TForm>;
        watch: UseFormWatch<TForm>;
    }

    • FormCheckbox: ReturnComponent<TForm, Path<TForm>, (({: BaseFormCheckboxProps) => Element)>
    • FormRegion: ReturnComponent<TForm, Path<TForm>, (({: RegionProps) => Element)>
    • FormSearch: ReturnComponent<TForm, Path<TForm>, (<TV, TI>({: IBaseFormSearchProps<TV, TI>) => Element)>
    • FormSelect: ReturnComponent<TForm, Path<TForm>, (<T, V>({: BaseSelectProps<T, V, keyof T, keyof T>) => Element)>
    • FormSwitch: ReturnComponent<TForm, Path<TForm>, (({: BaseFormSwitchProps) => Element)>
    • FormText: ReturnComponent<TForm, Path<TForm>, ((props: TextFieldProps) => JSX.Element)>
    • clearErrors: UseFormClearErrors<TForm>
    • control: Control<TForm, TContext>
    • formProps: UseFormReturn<TForm, TContext>
    • formState: FormState<TForm>
    • getFieldState: UseFormGetFieldState<TForm>
    • getValues: UseFormGetValues<TForm>
    • handleSubmit: UseFormHandleSubmit<TForm>
    • register: UseFormRegister<TForm>
    • reset: UseFormReset<TForm>
    • resetField: UseFormResetField<TForm>
    • setError: UseFormSetError<TForm>
    • setFocus: UseFormSetFocus<TForm>
    • setValue: UseFormSetValue<TForm>
    • trigger: UseFormTrigger<TForm>
    • unregister: UseFormUnregister<TForm>
    • watch: UseFormWatch<TForm>

Settings

Member Visibility

Theme

Generated using TypeDoc