react-hook-form
Version:
Performant, flexible and extensible forms library for React Hooks
1,355 lines (1,297 loc) • 130 kB
JavaScript
import React from 'react';
var isCheckBoxInput = (element) => element.type === 'checkbox';
var isFileInput = (element) => element.type === 'file';
var isDateObject = (value) => value instanceof Date;
var isNullOrUndefined = (value) => value == null;
const isObjectType = (value) => typeof value === 'object';
var isObject = (value) => !isNullOrUndefined(value) &&
!Array.isArray(value) &&
isObjectType(value) &&
!isDateObject(value);
var getEventValue = (event) => isObject(event) && event.target
? isCheckBoxInput(event.target)
? event.target.checked
: isFileInput(event.target)
? event.target.files
: event.target.value
: event;
var isNameInFieldArray = (names, name) => name
.split('.')
.some((part, index, arr) => !isNaN(Number(part)) && names.has(arr.slice(0, index).join('.')));
var isPlainObject = (tempObject) => {
const prototypeCopy = tempObject.constructor && tempObject.constructor.prototype;
return (isObject(prototypeCopy) && prototypeCopy.hasOwnProperty('isPrototypeOf'));
};
var isWeb = typeof window !== 'undefined' &&
typeof window.HTMLElement !== 'undefined' &&
typeof document !== 'undefined';
function cloneObject(data) {
if (data instanceof Date) {
return new Date(data);
}
const isFileListInstance = typeof FileList !== 'undefined' && data instanceof FileList;
if (isWeb && (data instanceof Blob || isFileListInstance)) {
return data;
}
const isArray = Array.isArray(data);
if (!isArray && !(isObject(data) && isPlainObject(data))) {
return data;
}
const copy = isArray ? [] : Object.create(Object.getPrototypeOf(data));
for (const key in data) {
if (Object.prototype.hasOwnProperty.call(data, key)) {
copy[key] = cloneObject(data[key]);
}
}
return copy;
}
const EVENTS = {
BLUR: 'blur',
FOCUS_OUT: 'focusout',
CHANGE: 'change',
SUBMIT: 'submit',
TRIGGER: 'trigger',
VALID: 'valid',
};
const VALIDATION_MODE = {
onBlur: 'onBlur',
onChange: 'onChange',
onSubmit: 'onSubmit',
onTouched: 'onTouched',
all: 'all',
};
const INPUT_VALIDATION_RULES = {
max: 'max',
min: 'min',
maxLength: 'maxLength',
minLength: 'minLength',
pattern: 'pattern',
required: 'required',
validate: 'validate',
};
const ROOT_ERROR_TYPE = 'root';
const PROTOTYPE_KEYWORDS = ['__proto__', 'constructor', 'prototype'];
const IS_KEY_RE = /^\w*$/;
var isKey = (value) => IS_KEY_RE.test(value);
var isUndefined = (val) => val === undefined;
const FIELD_PATH_RE = /[.[\]'"]/;
var stringToPath = (input) => input.split(FIELD_PATH_RE).filter(Boolean);
var get = (object, path, defaultValue) => {
if (!path || !isObject(object)) {
return defaultValue;
}
const paths = isKey(path) ? [path] : stringToPath(path);
if (paths.some((key) => PROTOTYPE_KEYWORDS.includes(key))) {
return defaultValue;
}
const result = paths.reduce((result, key) => {
return isNullOrUndefined(result) ? undefined : result[key];
}, object);
return isUndefined(result) || result === object
? isUndefined(object[path])
? defaultValue
: object[path]
: result;
};
var isBoolean = (value) => typeof value === 'boolean';
var isFunction = (value) => typeof value === 'function';
var set = (object, path, value) => {
let index = -1;
const tempPath = isKey(path) ? [path] : stringToPath(path);
const length = tempPath.length;
const lastIndex = length - 1;
while (++index < length) {
const key = tempPath[index];
let newValue = value;
if (index !== lastIndex) {
const objValue = object[key];
newValue =
isObject(objValue) || Array.isArray(objValue)
? objValue
: !isNaN(+tempPath[index + 1])
? []
: {};
}
if (PROTOTYPE_KEYWORDS.includes(key)) {
return;
}
object[key] = newValue;
object = object[key];
}
};
/**
* Separate context for `control` to prevent unnecessary rerenders.
* Internal hooks that only need control use this instead of full form context.
*/
const HookFormControlContext = React.createContext(null);
HookFormControlContext.displayName = 'HookFormControlContext';
/**
* @internal Internal hook to access only control from context.
*/
const useFormControlContext = () => React.useContext(HookFormControlContext);
var getProxyFormState = (formState, control, localProxyFormState, isRoot = true) => {
const result = {};
for (const key in formState) {
Object.defineProperty(result, key, {
get: () => {
const _key = key;
if (control._proxyFormState[_key] !== VALIDATION_MODE.all) {
control._proxyFormState[_key] = !isRoot || VALIDATION_MODE.all;
}
localProxyFormState && (localProxyFormState[_key] = true);
return formState[_key];
},
});
}
return result;
};
const useIsomorphicLayoutEffect = isWeb
? React.useLayoutEffect
: React.useEffect;
/**
* Subscribes to each form state and isolates re-renders at the custom hook level. It has its own scope for form state subscriptions, so it will not affect other useFormState or useForm instances. Using this hook can reduce the re-render impact on large and complex form applications.
*
* @remarks
* [API](https://react-hook-form.com/docs/useformstate) • [Demo](https://codesandbox.io/s/useformstate-75xly)
*
* @param props - Include options to specify fields to subscribe to. {@link UseFormStateReturn}
*
* @example
* ```tsx
* function App() {
* const { register, handleSubmit, control } = useForm({
* defaultValues: {
* firstName: "firstName"
* }});
* const { dirtyFields } = useFormState({
* control
* });
* const onSubmit = (data) => console.log(data);
*
* return (
* <form onSubmit={handleSubmit(onSubmit)}>
* <input {...register("firstName")} placeholder="First Name" />
* {dirtyFields.firstName && <p>Field is dirty.</p>}
* <input type="submit" />
* </form>
* );
* }
* ```
*/
function useFormState(props) {
const formControl = useFormControlContext();
const { control = formControl, disabled, name, exact } = props || {};
const [formState, updateFormState] = React.useState(() => ({
...control._formState,
defaultValues: control._defaultValues,
}));
const _localProxyFormState = React.useRef({
isDirty: false,
isLoading: false,
dirtyFields: false,
touchedFields: false,
validatingFields: false,
isValidating: false,
isValid: false,
errors: false,
});
useIsomorphicLayoutEffect(() => control._subscribe({
name,
formState: _localProxyFormState.current,
exact,
callback: (formState) => {
!disabled &&
updateFormState({
...control._formState,
...formState,
defaultValues: control._defaultValues,
});
},
}), [name, disabled, exact]);
React.useEffect(() => {
_localProxyFormState.current.isValid && control._setValid(true);
}, [control]);
return React.useMemo(() => getProxyFormState(formState, control, _localProxyFormState.current, false), [formState, control]);
}
var isString = (value) => typeof value === 'string';
var generateWatchOutput = (names, _names, formValues, isGlobal, defaultValue) => {
if (isString(names)) {
isGlobal && _names.watch.add(names);
return get(formValues, names, defaultValue);
}
if (Array.isArray(names)) {
return names.map((fieldName) => (isGlobal && _names.watch.add(fieldName),
get(formValues, fieldName)));
}
isGlobal && (_names.watchAll = true);
return formValues;
};
var isPrimitive = (value) => isNullOrUndefined(value) || !isObjectType(value);
const isEmptyObjectWithCustomPrototype = (object, keys) => keys.length === 0 && !Array.isArray(object) && !isPlainObject(object);
function deepEqual(object1, object2, visited = new WeakMap()) {
if (object1 === object2) {
return true;
}
if (isPrimitive(object1) || isPrimitive(object2)) {
return Object.is(object1, object2);
}
if (isDateObject(object1) && isDateObject(object2)) {
return Object.is(object1.getTime(), object2.getTime());
}
const keys1 = Object.keys(object1);
const keys2 = Object.keys(object2);
if (keys1.length !== keys2.length) {
return false;
}
if (isEmptyObjectWithCustomPrototype(object1, keys1) ||
isEmptyObjectWithCustomPrototype(object2, keys2)) {
return Object.is(object1, object2);
}
if (!keys1.length && Array.isArray(object1) !== Array.isArray(object2)) {
return false;
}
const visitedPairs = visited.get(object1);
if (visitedPairs && visitedPairs.has(object2)) {
return true;
}
if (visitedPairs) {
visitedPairs.add(object2);
}
else {
const ws = new WeakSet();
ws.add(object2);
visited.set(object1, ws);
}
for (const key of keys1) {
const val1 = object1[key];
if (!(key in object2)) {
return false;
}
if (key !== 'ref') {
const val2 = object2[key];
if ((isDateObject(val1) && isDateObject(val2)) ||
((isObject(val1) || Array.isArray(val1)) &&
(isObject(val2) || Array.isArray(val2)))
? !deepEqual(val1, val2, visited)
: !Object.is(val1, val2)) {
return false;
}
}
}
return true;
}
/**
* Custom hook to subscribe to field changes and isolate re-rendering at the component level.
*
* @remarks
*
* [API](https://react-hook-form.com/docs/usewatch) • [Demo](https://codesandbox.io/s/react-hook-form-v7-ts-usewatch-h9i5e)
*
* @example
* ```tsx
* const { control } = useForm();
* const values = useWatch({
* name: "fieldName",
* control,
* })
* ```
*/
function useWatch(props) {
const formControl = useFormControlContext();
const { control = formControl, name, defaultValue, disabled, exact, compute, } = props || {};
const _defaultValue = React.useRef(defaultValue);
const _compute = React.useRef(compute);
const _computeFormValues = React.useRef(undefined);
const _prevControl = React.useRef(control);
const _prevName = React.useRef(name);
_compute.current = compute;
const [value, updateValue] = React.useState(() => {
const defaultValue = control._getWatch(name, _defaultValue.current);
return _compute.current ? _compute.current(defaultValue) : defaultValue;
});
const getCurrentOutput = React.useCallback((values) => {
const formValues = generateWatchOutput(name, control._names, values || control._formValues, false, _defaultValue.current);
return _compute.current ? _compute.current(formValues) : formValues;
}, [control._formValues, control._names, name]);
const refreshValue = React.useCallback((values) => {
if (!disabled) {
const formValues = generateWatchOutput(name, control._names, values || control._formValues, false, _defaultValue.current);
if (_compute.current) {
const computedFormValues = _compute.current(formValues);
if (!deepEqual(computedFormValues, _computeFormValues.current)) {
updateValue(computedFormValues);
_computeFormValues.current = computedFormValues;
}
}
else {
updateValue(formValues);
}
}
}, [control._formValues, control._names, disabled, name]);
useIsomorphicLayoutEffect(() => {
if (_prevControl.current !== control ||
!deepEqual(_prevName.current, name)) {
_prevControl.current = control;
_prevName.current = name;
refreshValue();
}
return control._subscribe({
name,
formState: {
values: true,
},
exact,
callback: (formState) => {
refreshValue(formState.values);
},
});
}, [control, exact, name, refreshValue]);
React.useEffect(() => control._removeUnmounted());
// If name or control changed for this render, synchronously reflect the
// latest value so callers (like useController) see the correct value
// immediately on the same render.
// Optimize: Check control reference first before expensive deepEqual
const controlChanged = _prevControl.current !== control;
const prevName = _prevName.current;
// Cache the computed output to avoid duplicate calls within the same render
// We include shouldReturnImmediate in deps to ensure proper recomputation
const computedOutput = React.useMemo(() => {
if (disabled) {
return null;
}
const nameChanged = !controlChanged && !deepEqual(prevName, name);
const shouldReturnImmediate = controlChanged || nameChanged;
return shouldReturnImmediate ? getCurrentOutput() : null;
}, [disabled, controlChanged, name, prevName, getCurrentOutput]);
return computedOutput !== null ? computedOutput : value;
}
/**
* Custom hook to work with controlled component, this function provide you with both form and field level state. Re-render is isolated at the hook level.
*
* @remarks
* [API](https://react-hook-form.com/docs/usecontroller) • [Demo](https://codesandbox.io/s/usecontroller-0o8px)
*
* @param props - the path name to the form field value, and validation rules.
*
* @returns field properties, field and form state. {@link UseControllerReturn}
*
* @example
* ```tsx
* function Input(props) {
* const { field, fieldState, formState } = useController(props);
* return (
* <div>
* <input {...field} placeholder={props.name} />
* <p>{fieldState.isTouched && "Touched"}</p>
* <p>{formState.isSubmitted ? "submitted" : ""}</p>
* </div>
* );
* }
* ```
*/
function useController(props) {
const formControl = useFormControlContext();
const { name, disabled, control = formControl, shouldUnregister, defaultValue, exact = true, } = props;
const isArrayField = isNameInFieldArray(control._names.array, name);
const defaultValueMemo = React.useMemo(() => get(control._formValues, name, get(control._defaultValues, name, defaultValue)), [control, name, defaultValue]);
const value = useWatch({
control,
name,
defaultValue: defaultValueMemo,
exact,
});
const formState = useFormState({
control,
name,
exact,
});
const _props = React.useRef(props);
const _proxyRef = React.useRef(null);
const _registerProps = React.useRef(control.register(name, {
...props.rules,
value,
...(isBoolean(props.disabled) ? { disabled: props.disabled } : {}),
}));
_props.current = props;
const fieldState = React.useMemo(() => Object.defineProperties({}, {
invalid: {
enumerable: true,
get: () => !!get(formState.errors, name),
},
isDirty: {
enumerable: true,
get: () => !!get(formState.dirtyFields, name),
},
isTouched: {
enumerable: true,
get: () => !!get(formState.touchedFields, name),
},
isValidating: {
enumerable: true,
get: () => !!get(formState.validatingFields, name),
},
error: {
enumerable: true,
get: () => get(formState.errors, name),
},
}), [formState, name]);
const onChange = React.useCallback((event) => {
const value = getEventValue(event);
if (!get(control._fields, name)) {
_registerProps.current = control.register(name, {
..._props.current.rules,
value,
});
}
return _registerProps.current.onChange({
target: {
value: getEventValue(event),
name: name,
},
type: EVENTS.CHANGE,
});
}, [name, control]);
const onBlur = React.useCallback(() => _registerProps.current.onBlur({
target: {
value: get(control._formValues, name),
name: name,
},
type: EVENTS.BLUR,
}), [name, control._formValues]);
const ref = React.useCallback((elm) => {
if (elm) {
_proxyRef.current = {
focus: () => isFunction(elm.focus) && elm.focus(),
select: () => isFunction(elm.select) && elm.select(),
setCustomValidity: (message) => isFunction(elm.setCustomValidity) && elm.setCustomValidity(message),
reportValidity: () => isFunction(elm.reportValidity) && elm.reportValidity(),
};
}
const field = get(control._fields, name);
if (field && field._f && elm) {
field._f.ref = _proxyRef.current;
}
}, [control._fields, name]);
const field = React.useMemo(() => ({
name,
value,
...(isBoolean(disabled) || formState.disabled
? { disabled: formState.disabled || disabled }
: {}),
onChange,
onBlur,
ref,
}), [name, disabled, formState.disabled, onChange, onBlur, ref, value]);
React.useEffect(() => {
const _shouldUnregisterField = control._options.shouldUnregister || shouldUnregister;
_registerProps.current = control.register(name, {
..._props.current.rules,
...(isBoolean(_props.current.disabled)
? { disabled: _props.current.disabled }
: {}),
});
const updateMounted = (name, value) => {
const field = get(control._fields, name);
if (field && field._f) {
field._f.mount = value;
}
};
updateMounted(name, true);
if (_shouldUnregisterField) {
const value = cloneObject(get(shouldUnregister
? control._defaultValues
: control._options.values || control._defaultValues, name, get(control._options.defaultValues, name, _props.current.defaultValue)));
set(control._defaultValues, name, value);
if (isUndefined(get(control._formValues, name))) {
set(control._formValues, name, value);
}
}
!isArrayField && control.register(name);
if (_proxyRef.current) {
const field = get(control._fields, name);
if (field && field._f) {
field._f.ref = _proxyRef.current;
}
}
return () => {
(isArrayField
? _shouldUnregisterField && !control._state.action
: _shouldUnregisterField)
? control.unregister(name)
: updateMounted(name, false);
};
}, [name, control, isArrayField, shouldUnregister]);
React.useEffect(() => {
control._setDisabledField({
disabled,
name,
});
}, [disabled, name, control]);
return React.useMemo(() => ({
field,
formState,
fieldState,
}), [field, formState, fieldState]);
}
/**
* Component based on `useController` hook to work with controlled component.
*
* @remarks
* [API](https://react-hook-form.com/docs/usecontroller/controller) • [Demo](https://codesandbox.io/s/react-hook-form-v6-controller-ts-jwyzw) • [Video](https://www.youtube.com/watch?v=N2UNk_UCVyA)
*
* @param props - the path name to the form field value, and validation rules.
*
* @returns provide field handler functions, field and form state.
*
* @example
* ```tsx
* function App() {
* const { control } = useForm<FormValues>({
* defaultValues: {
* test: ""
* }
* });
*
* return (
* <form>
* <Controller
* control={control}
* name="test"
* render={({ field: { onChange, onBlur, value, ref }, formState, fieldState }) => (
* <>
* <input
* onChange={onChange} // send value to hook form
* onBlur={onBlur} // notify when input is touched
* value={value} // return updated value
* ref={ref} // set ref for focus management
* />
* <p>{formState.isSubmitted ? "submitted" : ""}</p>
* <p>{fieldState.isTouched ? "touched" : ""}</p>
* </>
* )}
* />
* </form>
* );
* }
* ```
*/
const Controller = (props) => props.render(useController(props));
var generateId = () => {
if (typeof crypto !== 'undefined' && crypto.randomUUID) {
return crypto.randomUUID();
}
const d = typeof performance === 'undefined' ? Date.now() : performance.now() * 1000;
return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, (c) => {
const r = ((Math.random() * 16 + d) % 16) | 0;
return (c == 'x' ? r : (r & 0x3) | 0x8).toString(16);
});
};
var getFocusFieldName = (name, index, options = {}) => options.shouldFocus || isUndefined(options.shouldFocus)
? options.focusName ||
`${name}.${isUndefined(options.focusIndex) ? index : options.focusIndex}.`
: '';
var getValidationModes = (mode) => ({
isOnSubmit: !mode || mode === VALIDATION_MODE.onSubmit,
isOnBlur: mode === VALIDATION_MODE.onBlur,
isOnChange: mode === VALIDATION_MODE.onChange,
isOnAll: mode === VALIDATION_MODE.all,
isOnTouch: mode === VALIDATION_MODE.onTouched,
});
var isWatched = (name, _names, isBlurEvent) => {
if (isBlurEvent)
return false;
if (_names.watchAll || _names.watch.has(name))
return true;
for (const watchName of _names.watch) {
if (name.startsWith(watchName) && name.charAt(watchName.length) === '.')
return true;
}
return false;
};
const iterateFieldsByAction = (fields, action, fieldsNames, abortEarly) => {
for (const key of fieldsNames || Object.keys(fields)) {
const field = get(fields, key);
if (field) {
const { _f, ...currentField } = field;
if (_f) {
if (_f.refs && _f.refs[0] && action(_f.refs[0], key) && !abortEarly) {
return true;
}
else if (_f.ref && action(_f.ref, _f.name) && !abortEarly) {
return true;
}
else {
if (iterateFieldsByAction(currentField, action)) {
break;
}
}
}
else if (isObject(currentField)) {
if (iterateFieldsByAction(currentField, action)) {
break;
}
}
}
}
return;
};
var updateFieldArrayRootError = (errors, error, name) => {
const existingErrors = get(errors, name);
const fieldArrayErrors = Array.isArray(existingErrors) ? existingErrors : [];
set(fieldArrayErrors, ROOT_ERROR_TYPE, error[name]);
set(errors, name, fieldArrayErrors);
return errors;
};
var isEmptyObject = (value) => isObject(value) && !Object.keys(value).length;
var isHTMLElement = (value) => {
if (!isWeb) {
return false;
}
const owner = value ? value.ownerDocument : 0;
return (value instanceof
(owner && owner.defaultView ? owner.defaultView.HTMLElement : HTMLElement));
};
var isRadioInput = (element) => element.type === 'radio';
var isRegex = (value) => value instanceof RegExp;
var appendErrors = (name, validateAllFieldCriteria, errors, type, message) => validateAllFieldCriteria
? {
...errors[name],
types: {
...(errors[name] && errors[name].types ? errors[name].types : {}),
[type]: message || true,
},
}
: {};
const defaultResult = {
value: false,
isValid: false,
};
const validResult = { value: true, isValid: true };
var getCheckboxValue = (options) => {
if (Array.isArray(options)) {
if (options.length > 1) {
const values = options
.filter((option) => option && option.checked && !option.disabled)
.map((option) => option.value);
return { value: values, isValid: !!values.length };
}
return options[0].checked && !options[0].disabled
? // @ts-expect-error expected to work in the browser
options[0].attributes && !isUndefined(options[0].attributes.value)
? isUndefined(options[0].value) || options[0].value === ''
? validResult
: { value: options[0].value, isValid: true }
: validResult
: defaultResult;
}
return defaultResult;
};
const defaultReturn = {
isValid: false,
value: null,
};
var getRadioValue = (options) => Array.isArray(options)
? options.reduce((previous, option) => option && option.checked && !option.disabled
? {
isValid: true,
value: option.value,
}
: previous, defaultReturn)
: defaultReturn;
function getValidateError(result, ref, type = 'validate') {
if (isString(result) ||
(Array.isArray(result) && result.every(isString)) ||
(isBoolean(result) && !result)) {
return {
type,
message: isString(result) ? result : '',
ref,
};
}
}
var getValueAndMessage = (validationData) => isObject(validationData) && !isRegex(validationData)
? validationData
: {
value: validationData,
message: '',
};
var validateField = async (field, disabledFieldNames, formValues, validateAllFieldCriteria, shouldUseNativeValidation, isFieldArray) => {
const { ref, refs, required, maxLength, minLength, min, max, pattern, validate, name, valueAsNumber, mount, } = field._f;
const inputValue = get(formValues, name);
if (!mount || disabledFieldNames.has(name)) {
return {};
}
const inputRef = refs ? refs[0] : ref;
const setCustomValidity = (message) => {
if (shouldUseNativeValidation && inputRef.reportValidity) {
const validityMessage = isBoolean(message) ? '' : message || '';
if (refs) {
refs.forEach((ref) => ref.setCustomValidity(validityMessage));
}
else {
inputRef.setCustomValidity(validityMessage);
}
inputRef.reportValidity();
}
};
const error = {};
const isRadio = isRadioInput(ref);
const isCheckBox = isCheckBoxInput(ref);
const isRadioOrCheckbox = isRadio || isCheckBox;
const isEmpty = ((valueAsNumber || isFileInput(ref)) &&
isUndefined(ref.value) &&
isUndefined(inputValue)) ||
(isHTMLElement(ref) && ref.value === '') ||
inputValue === '' ||
(Array.isArray(inputValue) && !inputValue.length);
const appendErrorsCurry = appendErrors.bind(null, name, validateAllFieldCriteria, error);
const getMinMaxMessage = (exceedMax, maxLengthMessage, minLengthMessage, maxType = INPUT_VALIDATION_RULES.maxLength, minType = INPUT_VALIDATION_RULES.minLength) => {
const message = exceedMax ? maxLengthMessage : minLengthMessage;
error[name] = {
type: exceedMax ? maxType : minType,
message,
ref,
...appendErrorsCurry(exceedMax ? maxType : minType, message),
};
};
if (isFieldArray
? !Array.isArray(inputValue) || !inputValue.length
: required &&
((!isRadioOrCheckbox && (isEmpty || isNullOrUndefined(inputValue))) ||
(isBoolean(inputValue) && !inputValue) ||
(isCheckBox && !getCheckboxValue(refs).isValid) ||
(isRadio && !getRadioValue(refs).isValid))) {
const { value, message } = isString(required)
? { value: !!required, message: required }
: getValueAndMessage(required);
if (value) {
error[name] = {
type: INPUT_VALIDATION_RULES.required,
message,
ref: inputRef,
...appendErrorsCurry(INPUT_VALIDATION_RULES.required, message),
};
if (!validateAllFieldCriteria) {
setCustomValidity(message);
return error;
}
}
}
if (!isEmpty && (!isNullOrUndefined(min) || !isNullOrUndefined(max))) {
let exceedMax;
let exceedMin;
const maxOutput = getValueAndMessage(max);
const minOutput = getValueAndMessage(min);
if (!isNullOrUndefined(inputValue) && !isNaN(inputValue)) {
const valueNumber = ref.valueAsNumber ||
(inputValue ? +inputValue : inputValue);
if (!isNullOrUndefined(maxOutput.value)) {
exceedMax = valueNumber > maxOutput.value;
}
if (!isNullOrUndefined(minOutput.value)) {
exceedMin = valueNumber < minOutput.value;
}
}
else {
const valueDate = ref.valueAsDate || new Date(inputValue);
const convertTimeToDate = (time) => new Date(new Date().toDateString() + ' ' + time);
const isTime = ref.type == 'time';
const isWeek = ref.type == 'week';
if (isString(maxOutput.value) && inputValue) {
exceedMax = isTime
? convertTimeToDate(inputValue) > convertTimeToDate(maxOutput.value)
: isWeek
? inputValue > maxOutput.value
: valueDate > new Date(maxOutput.value);
}
if (isString(minOutput.value) && inputValue) {
exceedMin = isTime
? convertTimeToDate(inputValue) < convertTimeToDate(minOutput.value)
: isWeek
? inputValue < minOutput.value
: valueDate < new Date(minOutput.value);
}
}
if (exceedMax || exceedMin) {
getMinMaxMessage(!!exceedMax, maxOutput.message, minOutput.message, INPUT_VALIDATION_RULES.max, INPUT_VALIDATION_RULES.min);
if (!validateAllFieldCriteria) {
setCustomValidity(error[name].message);
return error;
}
}
}
if ((maxLength || minLength) &&
!isEmpty &&
(isString(inputValue) || (isFieldArray && Array.isArray(inputValue)))) {
const maxLengthOutput = getValueAndMessage(maxLength);
const minLengthOutput = getValueAndMessage(minLength);
const exceedMax = !isNullOrUndefined(maxLengthOutput.value) &&
inputValue.length > +maxLengthOutput.value;
const exceedMin = !isNullOrUndefined(minLengthOutput.value) &&
inputValue.length < +minLengthOutput.value;
if (exceedMax || exceedMin) {
getMinMaxMessage(exceedMax, maxLengthOutput.message, minLengthOutput.message);
if (!validateAllFieldCriteria) {
setCustomValidity(error[name].message);
return error;
}
}
}
if (pattern && !isEmpty && isString(inputValue)) {
const { value: patternValue, message } = getValueAndMessage(pattern);
if (isRegex(patternValue) && !inputValue.match(patternValue)) {
error[name] = {
type: INPUT_VALIDATION_RULES.pattern,
message,
ref,
...appendErrorsCurry(INPUT_VALIDATION_RULES.pattern, message),
};
if (!validateAllFieldCriteria) {
setCustomValidity(message);
return error;
}
}
}
if (validate) {
if (isFunction(validate)) {
const result = await validate(inputValue, formValues);
const validateError = getValidateError(result, inputRef);
if (validateError) {
error[name] = {
...validateError,
...appendErrorsCurry(INPUT_VALIDATION_RULES.validate, validateError.message),
};
if (!validateAllFieldCriteria) {
setCustomValidity(validateError.message);
return error;
}
}
}
else if (isObject(validate)) {
let validationResult = {};
for (const key in validate) {
if (!isEmptyObject(validationResult) && !validateAllFieldCriteria) {
break;
}
const validateError = getValidateError(await validate[key](inputValue, formValues), inputRef, key);
if (validateError) {
validationResult = {
...validateError,
...appendErrorsCurry(key, validateError.message),
};
setCustomValidity(validateError.message);
if (validateAllFieldCriteria) {
error[name] = validationResult;
}
}
}
if (!isEmptyObject(validationResult)) {
error[name] = {
ref: inputRef,
...validationResult,
};
if (!validateAllFieldCriteria) {
return error;
}
}
}
}
setCustomValidity(true);
return error;
};
var convertToArrayPayload = (value) => (Array.isArray(value) ? value : [value]);
var appendAt = (data, value) => [
...data,
...convertToArrayPayload(value),
];
var fillEmptyArray = (value) => Array.isArray(value) ? value.map(() => undefined) : undefined;
function insert(data, index, value) {
return [
...data.slice(0, index),
...convertToArrayPayload(value),
...data.slice(index),
];
}
var moveArrayAt = (data, from, to) => {
if (!Array.isArray(data)) {
return [];
}
if (isUndefined(data[to])) {
data[to] = undefined;
}
data.splice(to, 0, data.splice(from, 1)[0]);
return data;
};
var prependAt = (data, value) => [
...convertToArrayPayload(value),
...convertToArrayPayload(data),
];
var compact = (value) => Array.isArray(value) ? value.filter(Boolean) : [];
function removeAtIndexes(data, indexes) {
let i = 0;
const temp = [...data];
for (const index of indexes) {
temp.splice(index - i, 1);
i++;
}
return compact(temp).length ? temp : [];
}
var removeArrayAt = (data, index) => isUndefined(index)
? []
: removeAtIndexes(data, convertToArrayPayload(index).sort((a, b) => a - b));
var swapArrayAt = (data, indexA, indexB) => {
[data[indexA], data[indexB]] = [data[indexB], data[indexA]];
};
function baseGet(object, updatePath) {
const length = updatePath.slice(0, -1).length;
let index = 0;
while (index < length) {
if (isNullOrUndefined(object)) {
object = undefined;
break;
}
object = object[updatePath[index]];
index++;
}
return object;
}
function isEmptyArray(obj) {
for (const key in obj) {
if (obj.hasOwnProperty(key) && !isUndefined(obj[key])) {
return false;
}
}
return true;
}
function unset(object, path) {
if (isString(path) && Object.prototype.hasOwnProperty.call(object, path)) {
delete object[path];
return object;
}
const paths = Array.isArray(path)
? path
: isKey(path)
? [path]
: stringToPath(path);
if (paths.some((segment) => PROTOTYPE_KEYWORDS.includes(String(segment)))) {
return object;
}
const childObject = paths.length === 1 ? object : baseGet(object, paths);
const index = paths.length - 1;
const key = paths[index];
if (childObject) {
delete childObject[key];
}
if (index !== 0 &&
((isObject(childObject) && isEmptyObject(childObject)) ||
(Array.isArray(childObject) && isEmptyArray(childObject)))) {
unset(object, paths.slice(0, -1));
}
return object;
}
var updateAt = (fieldValues, index, value) => {
fieldValues[index] = value;
return fieldValues;
};
/**
* A custom hook that exposes convenient methods to perform operations with a list of dynamic inputs that need to be appended, updated, removed etc. • [Demo](https://codesandbox.io/s/react-hook-form-usefieldarray-ssugn) • [Video](https://youtu.be/4MrbfGSFY2A)
*
* @remarks
* [API](https://react-hook-form.com/docs/usefieldarray) • [Demo](https://codesandbox.io/s/react-hook-form-usefieldarray-ssugn)
*
* @param props - useFieldArray props
*
* @returns methods - functions to manipulate with the Field Arrays (dynamic inputs) {@link UseFieldArrayReturn}
*
* @example
* ```tsx
* function App() {
* const { register, control, handleSubmit, reset, trigger, setError } = useForm({
* defaultValues: {
* test: []
* }
* });
* const { fields, append } = useFieldArray({
* control,
* name: "test"
* });
*
* return (
* <form onSubmit={handleSubmit(data => console.log(data))}>
* {fields.map((item, index) => (
* <input key={item.id} {...register(`test.${index}.firstName`)} />
* ))}
* <button type="button" onClick={() => append({ firstName: "bill" })}>
* append
* </button>
* <input type="submit" />
* </form>
* );
* }
* ```
*/
function useFieldArray(props) {
const formControl = useFormControlContext();
const { control = formControl, name, keyName = 'id', disabled, shouldUnregister, rules, } = props;
const [fields, setFields] = React.useState(control._getFieldArray(name));
const ids = React.useRef(control._getFieldArray(name).map(generateId));
const _actioned = React.useRef(false);
if (!disabled) {
control._names.array.add(name);
}
React.useMemo(() => !disabled &&
rules &&
fields.length >= 0 &&
control.register(name, rules), [control, name, fields.length, rules, disabled]);
useIsomorphicLayoutEffect(() => {
if (disabled) {
return;
}
return control._subjects.array.subscribe({
next: ({ values, name: fieldArrayName, }) => {
if (fieldArrayName === name || !fieldArrayName) {
const fieldValues = get(values, name);
if (Array.isArray(fieldValues)) {
setFields(fieldValues);
ids.current = fieldValues.map(generateId);
}
else if (!fieldArrayName) {
setFields([]);
ids.current = [];
}
}
},
}).unsubscribe;
}, [control, name, disabled]);
const updateValues = React.useCallback((updatedFieldArrayValues) => {
_actioned.current = true;
control._setFieldArray(name, updatedFieldArrayValues);
}, [control, name]);
const append = (value, options) => {
if (disabled) {
return;
}
const appendValue = convertToArrayPayload(cloneObject(value));
const updatedFieldArrayValues = appendAt(control._getFieldArray(name), appendValue);
control._names.focus = getFocusFieldName(name, updatedFieldArrayValues.length - 1, options);
ids.current = appendAt(ids.current, appendValue.map(generateId));
updateValues(updatedFieldArrayValues);
setFields(updatedFieldArrayValues);
control._setFieldArray(name, updatedFieldArrayValues, appendAt, {
argA: fillEmptyArray(value),
});
};
const prepend = (value, options) => {
if (disabled) {
return;
}
const prependValue = convertToArrayPayload(cloneObject(value));
const updatedFieldArrayValues = prependAt(control._getFieldArray(name), prependValue);
control._names.focus = getFocusFieldName(name, 0, options);
ids.current = prependAt(ids.current, prependValue.map(generateId));
updateValues(updatedFieldArrayValues);
setFields(updatedFieldArrayValues);
control._setFieldArray(name, updatedFieldArrayValues, prependAt, {
argA: fillEmptyArray(value),
});
};
const remove = (index) => {
if (disabled) {
return;
}
const updatedFieldArrayValues = removeArrayAt(control._getFieldArray(name), index);
ids.current = removeArrayAt(ids.current, index);
updateValues(updatedFieldArrayValues);
setFields(updatedFieldArrayValues);
!Array.isArray(get(control._fields, name)) &&
set(control._fields, name, undefined);
control._setFieldArray(name, updatedFieldArrayValues, removeArrayAt, {
argA: index,
});
};
const insert$1 = (index, value, options) => {
if (disabled) {
return;
}
const insertValue = convertToArrayPayload(cloneObject(value));
const updatedFieldArrayValues = insert(control._getFieldArray(name), index, insertValue);
control._names.focus = getFocusFieldName(name, index, options);
ids.current = insert(ids.current, index, insertValue.map(generateId));
updateValues(updatedFieldArrayValues);
setFields(updatedFieldArrayValues);
control._setFieldArray(name, updatedFieldArrayValues, insert, {
argA: index,
argB: fillEmptyArray(value),
});
};
const swap = (indexA, indexB) => {
if (disabled) {
return;
}
const updatedFieldArrayValues = control._getFieldArray(name);
swapArrayAt(updatedFieldArrayValues, indexA, indexB);
swapArrayAt(ids.current, indexA, indexB);
updateValues(updatedFieldArrayValues);
setFields(updatedFieldArrayValues);
control._setFieldArray(name, updatedFieldArrayValues, swapArrayAt, {
argA: indexA,
argB: indexB,
}, false);
};
const move = (from, to) => {
if (disabled) {
return;
}
const updatedFieldArrayValues = control._getFieldArray(name);
moveArrayAt(updatedFieldArrayValues, from, to);
moveArrayAt(ids.current, from, to);
updateValues(updatedFieldArrayValues);
setFields(updatedFieldArrayValues);
control._setFieldArray(name, updatedFieldArrayValues, moveArrayAt, {
argA: from,
argB: to,
}, false);
};
const update = (index, value) => {
if (disabled) {
return;
}
const updateValue = cloneObject(value);
const updatedFieldArrayValues = updateAt(control._getFieldArray(name), index, updateValue);
ids.current = [...updatedFieldArrayValues].map((item, i) => !item || i === index ? generateId() : ids.current[i]);
updateValues(updatedFieldArrayValues);
setFields([...updatedFieldArrayValues]);
control._setFieldArray(name, updatedFieldArrayValues, updateAt, {
argA: index,
argB: updateValue,
}, true, false);
};
const replace = (value) => {
if (disabled) {
return;
}
const updatedFieldArrayValues = convertToArrayPayload(cloneObject(value));
ids.current = updatedFieldArrayValues.map(generateId);
updateValues([...updatedFieldArrayValues]);
setFields([...updatedFieldArrayValues]);
control._setFieldArray(name, [...updatedFieldArrayValues], (data) => data, {}, true, false);
};
React.useEffect(() => {
if (disabled) {
return;
}
control._state.action = false;
isWatched(name, control._names) &&
control._subjects.state.next({
...control._formState,
});
const validationModes = getValidationModes(control._options.mode);
if (_actioned.current &&
(!validationModes.isOnSubmit || control._formState.isSubmitted) &&
!getValidationModes(control._options.reValidateMode).isOnSubmit &&
!validationModes.isOnBlur) {
if (control._options.resolver) {
control._runSchema([name]).then((result) => {
var _a, _b;
control._updateIsValidating([name]);
const error = get(result.errors, name);
const existingError = get(control._formState.errors, name);
const existingErrorType = existingError && (existingError.type || ((_a = existingError.root) === null || _a === void 0 ? void 0 : _a.type));
const existingErrorMessage = existingError &&
(existingError.message || ((_b = existingError.root) === null || _b === void 0 ? void 0 : _b.message));
if (existingError
? (!error && existingErrorType) ||
(error &&
(existingErrorType !== error.type ||
existingErrorMessage !== error.message))
: error && error.type) {
if (error) {
isObject(error) &&
!Object.keys(error).some((key) => !Number.isNaN(+key))
? updateFieldArrayRootError(control._formState.errors, { [name]: error }, name)
: set(control._formState.errors, name, error);
}
else {
unset(control._formState.errors, name);
}
control._subjects.state.next({
errors: control._formState.errors,
});
}
});
}
else {
const field = get(control._fields, name);
if (field &&
field._f &&
!(getValidationModes(control._options.reValidateMode).isOnSubmit &&
getValidationModes(control._options.mode).isOnSubmit)) {
validateField(field, control._names.disabled, control._formValues, control._options.criteriaMode === VALIDATION_MODE.all, control._options.shouldUseNativeValidation, true).then((error) => !isEmptyObject(error) &&
control._subjects.state.next({
errors: updateFieldArrayRootError(control._formState.errors, error, name),
}));
}
}
}
// External updates that change `fields` (e.g. reset() or setValue() on
// the array) already notify subscribers with the up-to-date values
// themselves, so only re-broadcast here for genuine array method calls.
_actioned.current &&
control._subjects.state.next({
name,
values: cloneObject(control._formValues),
});
control._names.focus &&
iterateFieldsByAction(control._fields, (ref, key) => {
if (control._names.focus &&
key.startsWith(control._names.focus) &&
ref.focus) {
ref.focus();
return 1;
}
return;
});
control._names.focus = '';
control._setValid();
_actioned.current = false;
}, [fields, name, control, disabled]);
React.useEffect(() => {
if (!disabled) {
!get(control._formValues, name) && control._setFieldArray(name);
}
return () => {
if (disabled) {
return;
}
const shouldKeepFieldArrayValues = !(control._options.shouldUnregister || shouldUnregister);
const updateMounted = (name, value) => {
const field = get(control._fields, name);
if (field && field._f) {
field._f.mount = value;
}
};
if (_actioned.current && shouldKeepFieldArrayValues) {
control._subjects.state.next({
name,
values: cloneObject(control._formValues),
});
}
shouldKeepFieldArrayValues
? updateMounted(name, false)
: control.unregister(name);
};
}, [name, control, keyName, shouldUnregister, disabled]);
return {
swap: React.useCallback(swap, [updateValues, name, control, disabled]),
move: React.useCallback(move, [updateValues, name, control, disabled]),
prepend: React.useCallback(prepend, [
updateValues,
name,
control,
disabled,
]),
append: React.useCallback(append, [updateValues, name, control, disabled]),
remove: React.useCallback(remove, [updateValues, name, control, disabled]),
insert: React.useCallback(insert$1, [updateValues, name, control, disabled]),
update: React.useCallback(update, [updateValues, name, control, disabled]),
replace: React.useCallback(replace, [