/
index.tsx
209 lines (198 loc) · 5.69 KB
/
index.tsx
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
import React, { useMemo } from "react";
import {
FetcherWithComponents,
SubmitFunction,
useActionData,
useSubmit,
useNavigation,
} from "@remix-run/react";
import {
SubmitErrorHandler,
SubmitHandler,
useFormContext,
} from "react-hook-form";
import { useForm, FormProvider } from "react-hook-form";
import type {
DefaultValues,
FieldValues,
FormState,
KeepStateOptions,
Path,
RegisterOptions,
UseFormHandleSubmit,
UseFormProps,
UseFormReturn,
} from "react-hook-form";
import { createFormData } from "../utilities";
export type SubmitFunctionOptions = Parameters<SubmitFunction>[1];
export interface UseRemixFormOptions<T extends FieldValues>
extends UseFormProps<T> {
submitHandlers?: {
onValid?: SubmitHandler<T>;
onInvalid?: SubmitErrorHandler<T>;
};
submitConfig?: SubmitFunctionOptions;
submitData?: FieldValues;
fetcher?: FetcherWithComponents<unknown>;
/**
* If true, all values will be stringified before being sent to the server, otherwise everything but strings will be stringified (default: true)
*/
stringifyAllValues?: boolean;
}
export const useRemixForm = <T extends FieldValues>({
submitHandlers,
submitConfig,
submitData,
fetcher,
stringifyAllValues = true,
...formProps
}: UseRemixFormOptions<T>) => {
const [isSubmittedSuccessfully, setIsSubmittedSuccessfully] =
React.useState(false);
const actionSubmit = useSubmit();
const actionData = useActionData();
const submit = fetcher?.submit ?? actionSubmit;
const data: any = fetcher?.data ?? actionData;
const methods = useForm<T>({ ...formProps, errors: data?.errors });
const navigation = useNavigation();
// Either it's submitted to an action or submitted to a fetcher (or neither)
const isSubmittingForm = useMemo(
() =>
(navigation.state !== "idle" && navigation.formData !== undefined) ||
(fetcher && fetcher.state !== "idle" && fetcher.formData !== undefined),
[navigation.state, navigation.formData, fetcher?.state, fetcher?.formData],
);
// Submits the data to the server when form is valid
const onSubmit = useMemo(
() => (data: T) => {
setIsSubmittedSuccessfully(true);
const formData = createFormData(
{ ...data, ...submitData },
stringifyAllValues,
);
submit(formData, {
method: "post",
...submitConfig,
});
},
[submit, submitConfig, submitData, stringifyAllValues],
);
// eslint-disable-next-line @typescript-eslint/no-empty-function
const onInvalid = useMemo(() => () => {}, []);
// React-hook-form uses lazy property getters to avoid re-rendering when properties
// that aren't being used change. Using getters here preservers that lazy behavior.
const formState: FormState<T> = useMemo(
() => ({
get isDirty() {
return methods.formState.isDirty;
},
get isLoading() {
return methods.formState.isLoading;
},
get isSubmitted() {
return methods.formState.isSubmitted;
},
get isSubmitSuccessful() {
return isSubmittedSuccessfully || methods.formState.isSubmitSuccessful;
},
get isSubmitting() {
return isSubmittingForm || methods.formState.isSubmitting;
},
get isValidating() {
return methods.formState.isValidating;
},
get isValid() {
return methods.formState.isValid;
},
get disabled() {
return methods.formState.disabled;
},
get submitCount() {
return methods.formState.submitCount;
},
get defaultValues() {
return methods.formState.defaultValues;
},
get dirtyFields() {
return methods.formState.dirtyFields;
},
get touchedFields() {
return methods.formState.touchedFields;
},
get validatingFields() {
return methods.formState.validatingFields;
},
get errors() {
return methods.formState.errors;
},
}),
[methods.formState, isSubmittedSuccessfully, isSubmittingForm],
);
const reset = useMemo(
() =>
(
values?: T | DefaultValues<T> | undefined,
options?: KeepStateOptions,
) => {
setIsSubmittedSuccessfully(false);
methods.reset(values, options);
},
[methods.reset],
);
const register = useMemo(
() =>
(
name: Path<T>,
options?: RegisterOptions<T> & {
disableProgressiveEnhancement?: boolean;
},
) => ({
...methods.register(name, options),
...(!options?.disableProgressiveEnhancement && {
defaultValue: data?.defaultValues?.[name] ?? "",
}),
}),
[methods.register, data?.defaultValues],
);
const handleSubmit = useMemo(
() =>
methods.handleSubmit(
submitHandlers?.onValid ?? onSubmit,
submitHandlers?.onInvalid ?? onInvalid,
),
[methods.handleSubmit, submitHandlers, onSubmit, onInvalid],
);
const hookReturn = useMemo(
() => ({
...methods,
handleSubmit,
reset,
register,
formState,
}),
[methods, handleSubmit, reset, register, formState],
);
return hookReturn;
};
interface RemixFormProviderProps<T extends FieldValues>
extends Omit<UseFormReturn<T>, "handleSubmit" | "reset"> {
children: React.ReactNode;
handleSubmit: any;
register: any;
reset: any;
}
export const RemixFormProvider = <T extends FieldValues>({
children,
...props
}: RemixFormProviderProps<T>) => {
return <FormProvider {...props}>{children}</FormProvider>;
};
export const useRemixFormContext = <T extends FieldValues>() => {
const methods = useFormContext<T>();
return {
...methods,
handleSubmit: methods.handleSubmit as any as ReturnType<
UseFormHandleSubmit<T>
>,
};
};