forked from mantinedev/mantine
-
Notifications
You must be signed in to change notification settings - Fork 0
/
use-form.ts
274 lines (239 loc) · 7.56 KB
/
use-form.ts
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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
import { useState, useCallback, useRef } from 'react';
import isEqual from 'fast-deep-equal';
import { getInputOnChange } from './get-input-on-change';
import { setPath, reorderPath, insertPath, getPath, removePath } from './paths';
import { filterErrors } from './filter-errors';
import { validateValues, validateFieldValue, shouldValidateOnChange } from './validate';
import { getStatus } from './get-status';
import { clearListState } from './clear-list-state';
import {
UseFormReturnType,
UseFormInput,
SetErrors,
ClearErrors,
Reset,
SetFieldError,
SetFieldValue,
SetValues,
ReorderListItem,
RemoveListItem,
InsertListItem,
ClearFieldError,
Validate,
ValidateField,
GetInputProps,
OnSubmit,
OnReset,
GetFieldStatus,
ResetDirty,
IsValid,
_TransformValues,
ClearFieldDirty,
} from './types';
export function useForm<
Values = Record<string, unknown>,
TransformValues extends _TransformValues<Values> = (values: Values) => Values
>({
initialValues = {} as Values,
initialErrors = {},
initialDirty = {},
initialTouched = {},
clearInputErrorOnChange = true,
validateInputOnChange = false,
validateInputOnBlur = false,
transformValues = ((values: Values) => values) as any,
validate: rules,
}: UseFormInput<Values, TransformValues> = {}): UseFormReturnType<Values, TransformValues> {
const [touched, setTouched] = useState(initialTouched);
const [dirty, setDirty] = useState(initialDirty);
const [values, _setValues] = useState(initialValues);
const [errors, _setErrors] = useState(filterErrors(initialErrors));
const _dirtyValues = useRef<Values>(initialValues);
const _setDirtyValues = (_values: Values) => {
_dirtyValues.current = _values;
};
const resetTouched = useCallback(() => setTouched({}), []);
const resetDirty: ResetDirty<Values> = (_values) => {
_setDirtyValues(_values || values);
setDirty({});
};
const setErrors: SetErrors = useCallback(
(errs) =>
_setErrors((current) => filterErrors(typeof errs === 'function' ? errs(current) : errs)),
[]
);
const clearErrors: ClearErrors = useCallback(() => _setErrors({}), []);
const reset: Reset = useCallback(() => {
_setValues(initialValues);
clearErrors();
resetDirty(initialValues);
resetTouched();
}, []);
const setFieldError: SetFieldError<Values> = useCallback(
(path, error) => setErrors((current) => ({ ...current, [path]: error })),
[]
);
const clearFieldError: ClearFieldError = useCallback(
(path) =>
setErrors((current) => {
if (typeof path !== 'string') {
return current;
}
const clone = { ...current };
delete clone[path];
return clone;
}),
[]
);
const clearFieldDirty: ClearFieldDirty = useCallback(
(path) =>
setDirty((current) => {
if (typeof path !== 'string') {
return current;
}
const result = clearListState(path, current);
delete result[path];
return result;
}),
[]
);
const setFieldValue: SetFieldValue<Values> = useCallback((path, value) => {
const shouldValidate = shouldValidateOnChange(path, validateInputOnChange);
clearFieldDirty(path);
setTouched((currentTouched) => ({ ...currentTouched, [path]: true }));
_setValues((current) => {
const result = setPath(path, value, current);
if (shouldValidate) {
const validationResults = validateFieldValue(path, rules, result);
validationResults.hasError
? setFieldError(path, validationResults.error)
: clearFieldError(path);
}
return result;
});
!shouldValidate && clearInputErrorOnChange && setFieldError(path, null);
}, []);
const setValues: SetValues<Values> = useCallback((payload) => {
_setValues((currentValues) => {
const valuesPartial = typeof payload === 'function' ? payload(currentValues) : payload;
return { ...currentValues, ...valuesPartial };
});
clearInputErrorOnChange && clearErrors();
}, []);
const reorderListItem: ReorderListItem<Values> = useCallback((path, payload) => {
clearFieldDirty(path);
_setValues((current) => reorderPath(path, payload, current));
}, []);
const removeListItem: RemoveListItem<Values> = useCallback((path, index) => {
clearFieldDirty(path);
_setValues((current) => removePath(path, index, current));
_setErrors((errs) => clearListState(path, errs));
}, []);
const insertListItem: InsertListItem<Values> = useCallback((path, item, index) => {
clearFieldDirty(path);
_setValues((current) => insertPath(path, item, index, current));
}, []);
const validate: Validate = useCallback(() => {
const results = validateValues(rules, values);
_setErrors(results.errors);
return results;
}, [values, rules]);
const validateField: ValidateField<Values> = useCallback(
(path) => {
const results = validateFieldValue(path, rules, values);
results.hasError ? setFieldError(path, results.error) : clearFieldError(path);
return results;
},
[values, rules]
);
const getInputProps: GetInputProps<Values> = (
path,
{ type = 'input', withError = type === 'input', withFocus = true } = {}
) => {
const onChange = getInputOnChange((value) => setFieldValue(path, value as any));
const payload: Record<string, any> = { onChange };
if (withError) {
payload.error = errors[path];
}
if (type === 'checkbox') {
payload.checked = getPath(path, values);
} else {
payload.value = getPath(path, values);
}
if (withFocus) {
payload.onFocus = () => setTouched((current) => ({ ...current, [path]: true }));
payload.onBlur = () => {
if (shouldValidateOnChange(path, validateInputOnBlur)) {
const validationResults = validateFieldValue(path, rules, values);
validationResults.hasError
? setFieldError(path, validationResults.error)
: clearFieldError(path);
}
};
}
return payload;
};
const onSubmit: OnSubmit<Values, TransformValues> =
(handleSubmit, handleValidationFailure) => (event) => {
event?.preventDefault();
const results = validate();
if (results.hasErrors) {
handleValidationFailure?.(results.errors, values, event);
} else {
handleSubmit(transformValues(values) as any, event);
}
};
const onReset: OnReset = useCallback((event) => {
event.preventDefault();
reset();
}, []);
const isDirty: GetFieldStatus<Values> = (path) => {
const isOverridden = Object.keys(dirty).length > 0;
if (isOverridden) {
return getStatus(dirty, path);
}
if (path) {
const sliceOfValues = getPath(path, values);
const sliceOfInitialValues = getPath(path, _dirtyValues.current);
return !isEqual(sliceOfValues, sliceOfInitialValues);
}
return !isEqual(values, _dirtyValues.current);
};
const isTouched: GetFieldStatus<Values> = useCallback(
(path) => getStatus(touched, path),
[touched]
);
const isValid: IsValid<Values> = useCallback(
(path) =>
path
? !validateFieldValue(path, rules, values).hasError
: !validateValues(rules, values).hasErrors,
[values, rules]
);
return {
values,
errors,
setValues,
setErrors,
setFieldValue,
setFieldError,
clearFieldError,
clearErrors,
reset,
validate,
validateField,
reorderListItem,
removeListItem,
insertListItem,
getInputProps,
onSubmit,
onReset,
isDirty,
isTouched,
setTouched,
setDirty,
resetTouched,
resetDirty,
isValid,
};
}