react-hook-form
Version:
Performant, flexible and extensible forms library for React Hooks
1,398 lines (1,330 loc) • 96.2 kB
JavaScript
import React from 'react';
var isCheckBoxInput = (element) => element.type === 'checkbox';
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
: event.target.value
: event;
var getNodeParentName = (name) => name.substring(0, name.search(/\.\d+(\.|$)/)) || name;
var isNameInFieldArray = (names, name) => names.has(getNodeParentName(name));
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) {
let copy;
const isArray = Array.isArray(data);
if (data instanceof Date) {
copy = new Date(data);
}
else if (data instanceof Set) {
copy = new Set(data);
}
else if (!(isWeb && (data instanceof Blob || data instanceof FileList)) &&
(isArray || isObject(data))) {
copy = isArray ? [] : {};
if (!isArray && !isPlainObject(data)) {
copy = data;
}
else {
for (const key in data) {
if (data.hasOwnProperty(key)) {
copy[key] = cloneObject(data[key]);
}
}
}
}
else {
return data;
}
return copy;
}
var compact = (value) => Array.isArray(value) ? value.filter(Boolean) : [];
var isUndefined = (val) => val === undefined;
var get = (object, path, defaultValue) => {
if (!path || !isObject(object)) {
return defaultValue;
}
const result = compact(path.split(/[,[\].]+?/)).reduce((result, key) => isNullOrUndefined(result) ? result : result[key], object);
return isUndefined(result) || result === object
? isUndefined(object[path])
? defaultValue
: object[path]
: result;
};
var isBoolean = (value) => typeof value === 'boolean';
var isKey = (value) => /^\w*$/.test(value);
var stringToPath = (input) => compact(input.replace(/["|']|\]/g, '').split(/\.|\[/));
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 (key === '__proto__') {
return;
}
object[key] = newValue;
object = object[key];
}
return object;
};
const EVENTS = {
BLUR: 'blur',
FOCUS_OUT: 'focusout',
CHANGE: 'change',
};
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 HookFormContext = React.createContext(null);
/**
* This custom hook allows you to access the form context. useFormContext is intended to be used in deeply nested structures, where it would become inconvenient to pass the context as a prop. To be used with {@link FormProvider}.
*
* @remarks
* [API](https://react-hook-form.com/docs/useformcontext) • [Demo](https://codesandbox.io/s/react-hook-form-v7-form-context-ytudi)
*
* @returns return all useForm methods
*
* @example
* ```tsx
* function App() {
* const methods = useForm();
* const onSubmit = data => console.log(data);
*
* return (
* <FormProvider {...methods} >
* <form onSubmit={methods.handleSubmit(onSubmit)}>
* <NestedInput />
* <input type="submit" />
* </form>
* </FormProvider>
* );
* }
*
* function NestedInput() {
* const { register } = useFormContext(); // retrieve all hook methods
* return <input {...register("test")} />;
* }
* ```
*/
const useFormContext = () => React.useContext(HookFormContext);
/**
* A provider component that propagates the `useForm` methods to all children components via [React Context](https://reactjs.org/docs/context.html) API. To be used with {@link useFormContext}.
*
* @remarks
* [API](https://react-hook-form.com/docs/useformcontext) • [Demo](https://codesandbox.io/s/react-hook-form-v7-form-context-ytudi)
*
* @param props - all useForm methods
*
* @example
* ```tsx
* function App() {
* const methods = useForm();
* const onSubmit = data => console.log(data);
*
* return (
* <FormProvider {...methods} >
* <form onSubmit={methods.handleSubmit(onSubmit)}>
* <NestedInput />
* <input type="submit" />
* </form>
* </FormProvider>
* );
* }
*
* function NestedInput() {
* const { register } = useFormContext(); // retrieve all hook methods
* return <input {...register("test")} />;
* }
* ```
*/
const FormProvider = (props) => {
const { children, ...data } = props;
return (React.createElement(HookFormContext.Provider, { value: data }, children));
};
var getProxyFormState = (formState, control, localProxyFormState, isRoot = true) => {
const result = {
defaultValues: control._defaultValues,
};
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;
};
var isEmptyObject = (value) => isObject(value) && !Object.keys(value).length;
var shouldRenderFormState = (formStateData, _proxyFormState, updateFormState, isRoot) => {
updateFormState(formStateData);
const { name, ...formState } = formStateData;
return (isEmptyObject(formState) ||
Object.keys(formState).length >= Object.keys(_proxyFormState).length ||
Object.keys(formState).find((key) => _proxyFormState[key] ===
(!isRoot || VALIDATION_MODE.all)));
};
var convertToArrayPayload = (value) => (Array.isArray(value) ? value : [value]);
var shouldSubscribeByName = (name, signalName, exact) => !name ||
!signalName ||
name === signalName ||
convertToArrayPayload(name).some((currentName) => currentName &&
(exact
? currentName === signalName
: currentName.startsWith(signalName) ||
signalName.startsWith(currentName)));
function useSubscribe(props) {
const _props = React.useRef(props);
_props.current = props;
React.useEffect(() => {
const subscription = !props.disabled &&
_props.current.subject &&
_props.current.subject.subscribe({
next: _props.current.next,
});
return () => {
subscription && subscription.unsubscribe();
};
}, [props.disabled]);
}
/**
* This custom hook allows you to subscribe to each form state, and isolate the re-render at the custom hook level. It has its scope in terms of form state subscription, so it would not affect other useFormState and useForm. Using this hook can reduce the re-render impact on large and complex form application.
*
* @remarks
* [API](https://react-hook-form.com/docs/useformstate) • [Demo](https://codesandbox.io/s/useformstate-75xly)
*
* @param props - include options on specify fields to subscribe. {@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 methods = useFormContext();
const { control = methods.control, disabled, name, exact } = props || {};
const [formState, updateFormState] = React.useState(control._formState);
const _mounted = React.useRef(true);
const _localProxyFormState = React.useRef({
isDirty: false,
isLoading: false,
dirtyFields: false,
touchedFields: false,
validatingFields: false,
isValidating: false,
isValid: false,
errors: false,
});
const _name = React.useRef(name);
_name.current = name;
useSubscribe({
disabled,
next: (value) => _mounted.current &&
shouldSubscribeByName(_name.current, value.name, exact) &&
shouldRenderFormState(value, _localProxyFormState.current, control._updateFormState) &&
updateFormState({
...control._formState,
...value,
}),
subject: control._subjects.state,
});
React.useEffect(() => {
_mounted.current = true;
_localProxyFormState.current.isValid && control._updateValid(true);
return () => {
_mounted.current = false;
};
}, [control]);
return getProxyFormState(formState, control, _localProxyFormState.current, false);
}
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;
};
/**
* Custom hook to subscribe to field change 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 methods = useFormContext();
const { control = methods.control, name, defaultValue, disabled, exact, } = props || {};
const _name = React.useRef(name);
_name.current = name;
useSubscribe({
disabled,
subject: control._subjects.values,
next: (formState) => {
if (shouldSubscribeByName(_name.current, formState.name, exact)) {
updateValue(cloneObject(generateWatchOutput(_name.current, control._names, formState.values || control._formValues, false, defaultValue)));
}
},
});
const [value, updateValue] = React.useState(control._getWatch(name, defaultValue));
React.useEffect(() => control._removeUnmounted());
return 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 methods = useFormContext();
const { name, disabled, control = methods.control, shouldUnregister } = props;
const isArrayField = isNameInFieldArray(control._names.array, name);
const value = useWatch({
control,
name,
defaultValue: get(control._formValues, name, get(control._defaultValues, name, props.defaultValue)),
exact: true,
});
const formState = useFormState({
control,
name,
});
const _registerProps = React.useRef(control.register(name, {
...props.rules,
value,
...(isBoolean(props.disabled) ? { disabled: props.disabled } : {}),
}));
React.useEffect(() => {
const _shouldUnregisterField = control._options.shouldUnregister || shouldUnregister;
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(control._options.defaultValues, name));
set(control._defaultValues, name, value);
if (isUndefined(get(control._formValues, name))) {
set(control._formValues, name, value);
}
}
return () => {
(isArrayField
? _shouldUnregisterField && !control._state.action
: _shouldUnregisterField)
? control.unregister(name)
: updateMounted(name, false);
};
}, [name, control, isArrayField, shouldUnregister]);
React.useEffect(() => {
if (get(control._fields, name)) {
control._updateDisabledField({
disabled,
fields: control._fields,
name,
value: get(control._fields, name)._f.value,
});
}
}, [disabled, name, control]);
return {
field: {
name,
value,
...(isBoolean(disabled) || formState.disabled
? { disabled: formState.disabled || disabled }
: {}),
onChange: React.useCallback((event) => _registerProps.current.onChange({
target: {
value: getEventValue(event),
name: name,
},
type: EVENTS.CHANGE,
}), [name]),
onBlur: React.useCallback(() => _registerProps.current.onBlur({
target: {
value: get(control._formValues, name),
name: name,
},
type: EVENTS.BLUR,
}), [name, control]),
ref: (elm) => {
const field = get(control._fields, name);
if (field && elm) {
field._f.ref = {
focus: () => elm.focus(),
select: () => elm.select(),
setCustomValidity: (message) => elm.setCustomValidity(message),
reportValidity: () => elm.reportValidity(),
};
}
},
},
formState,
fieldState: 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),
},
}),
};
}
/**
* 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));
const POST_REQUEST = 'post';
/**
* Form component to manage submission.
*
* @param props - to setup submission detail. {@link FormProps}
*
* @returns form component or headless render prop.
*
* @example
* ```tsx
* function App() {
* const { control, formState: { errors } } = useForm();
*
* return (
* <Form action="/api" control={control}>
* <input {...register("name")} />
* <p>{errors?.root?.server && 'Server error'}</p>
* <button>Submit</button>
* </Form>
* );
* }
* ```
*/
function Form(props) {
const methods = useFormContext();
const [mounted, setMounted] = React.useState(false);
const { control = methods.control, onSubmit, children, action, method = POST_REQUEST, headers, encType, onError, render, onSuccess, validateStatus, ...rest } = props;
const submit = async (event) => {
let hasError = false;
let type = '';
await control.handleSubmit(async (data) => {
const formData = new FormData();
let formDataJson = '';
try {
formDataJson = JSON.stringify(data);
}
catch (_a) { }
for (const name of control._names.mount) {
formData.append(name, get(data, name));
}
if (onSubmit) {
await onSubmit({
data,
event,
method,
formData,
formDataJson,
});
}
if (action) {
try {
const shouldStringifySubmissionData = [
headers && headers['Content-Type'],
encType,
].some((value) => value && value.includes('json'));
const response = await fetch(action, {
method,
headers: {
...headers,
...(encType ? { 'Content-Type': encType } : {}),
},
body: shouldStringifySubmissionData ? formDataJson : formData,
});
if (response &&
(validateStatus
? !validateStatus(response.status)
: response.status < 200 || response.status >= 300)) {
hasError = true;
onError && onError({ response });
type = String(response.status);
}
else {
onSuccess && onSuccess({ response });
}
}
catch (error) {
hasError = true;
onError && onError({ error });
}
}
})(event);
if (hasError && props.control) {
props.control._subjects.state.next({
isSubmitSuccessful: false,
});
props.control.setError('root.server', {
type,
});
}
};
React.useEffect(() => {
setMounted(true);
}, []);
return render ? (React.createElement(React.Fragment, null, render({
submit,
}))) : (React.createElement("form", { noValidate: mounted, action: action, method: method, encType: encType, onSubmit: submit, ...rest }, children));
}
var appendErrors = (name, validateAllFieldCriteria, errors, type, message) => validateAllFieldCriteria
? {
...errors[name],
types: {
...(errors[name] && errors[name].types ? errors[name].types : {}),
[type]: message || true,
},
}
: {};
var generateId = () => {
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) => !isBlurEvent &&
(_names.watchAll ||
_names.watch.has(name) ||
[..._names.watch].some((watchName) => name.startsWith(watchName) &&
/^\.\w+/.test(name.slice(watchName.length))));
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) {
break;
}
else if (_f.ref && action(_f.ref, _f.name) && !abortEarly) {
break;
}
else {
iterateFieldsByAction(currentField, action);
}
}
else if (isObject(currentField)) {
iterateFieldsByAction(currentField, action);
}
}
}
};
var updateFieldArrayRootError = (errors, error, name) => {
const fieldArrayErrors = compact(get(errors, name));
set(fieldArrayErrors, 'root', error[name]);
set(errors, name, fieldArrayErrors);
return errors;
};
var isFileInput = (element) => element.type === 'file';
var isFunction = (value) => typeof value === 'function';
var isHTMLElement = (value) => {
if (!isWeb) {
return false;
}
const owner = value ? value.ownerDocument : 0;
return (value instanceof
(owner && owner.defaultView ? owner.defaultView.HTMLElement : HTMLElement));
};
var isMessage = (value) => isString(value);
var isRadioInput = (element) => element.type === 'radio';
var isRegex = (value) => value instanceof RegExp;
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 (isMessage(result) ||
(Array.isArray(result) && result.every(isMessage)) ||
(isBoolean(result) && !result)) {
return {
type,
message: isMessage(result) ? result : '',
ref,
};
}
}
var getValueAndMessage = (validationData) => isObject(validationData) && !isRegex(validationData)
? validationData
: {
value: validationData,
message: '',
};
var validateField = async (field, formValues, validateAllFieldCriteria, shouldUseNativeValidation, isFieldArray) => {
const { ref, refs, required, maxLength, minLength, min, max, pattern, validate, name, valueAsNumber, mount, disabled, } = field._f;
const inputValue = get(formValues, name);
if (!mount || disabled) {
return {};
}
const inputRef = refs ? refs[0] : ref;
const setCustomValidity = (message) => {
if (shouldUseNativeValidation && inputRef.reportValidity) {
inputRef.setCustomValidity(isBoolean(message) ? '' : message || '');
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 } = isMessage(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 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),
];
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) {
object = isUndefined(object) ? index++ : object[updatePath[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) {
const paths = Array.isArray(path)
? path
: isKey(path)
? [path]
: stringToPath(path);
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 methods = useFormContext();
const { control = methods.control, name, keyName = 'id', shouldUnregister, } = props;
const [fields, setFields] = React.useState(control._getFieldArray(name));
const ids = React.useRef(control._getFieldArray(name).map(generateId));
const _fieldIds = React.useRef(fields);
const _name = React.useRef(name);
const _actioned = React.useRef(false);
_name.current = name;
_fieldIds.current = fields;
control._names.array.add(name);
props.rules &&
control.register(name, props.rules);
useSubscribe({
next: ({ values, name: fieldArrayName, }) => {
if (fieldArrayName === _name.current || !fieldArrayName) {
const fieldValues = get(values, _name.current);
if (Array.isArray(fieldValues)) {
setFields(fieldValues);
ids.current = fieldValues.map(generateId);
}
}
},
subject: control._subjects.array,
});
const updateValues = React.useCallback((updatedFieldArrayValues) => {
_actioned.current = true;
control._updateFieldArray(name, updatedFieldArrayValues);
}, [control, name]);
const append = (value, options) => {
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._updateFieldArray(name, updatedFieldArrayValues, appendAt, {
argA: fillEmptyArray(value),
});
};
const prepend = (value, options) => {
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._updateFieldArray(name, updatedFieldArrayValues, prependAt, {
argA: fillEmptyArray(value),
});
};
const remove = (index) => {
const updatedFieldArrayValues = removeArrayAt(control._getFieldArray(name), index);
ids.current = removeArrayAt(ids.current, index);
updateValues(updatedFieldArrayValues);
setFields(updatedFieldArrayValues);
control._updateFieldArray(name, updatedFieldArrayValues, removeArrayAt, {
argA: index,
});
};
const insert$1 = (index, value, options) => {
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._updateFieldArray(name, updatedFieldArrayValues, insert, {
argA: index,
argB: fillEmptyArray(value),
});
};
const swap = (indexA, indexB) => {
const updatedFieldArrayValues = control._getFieldArray(name);
swapArrayAt(updatedFieldArrayValues, indexA, indexB);
swapArrayAt(ids.current, indexA, indexB);
updateValues(updatedFieldArrayValues);
setFields(updatedFieldArrayValues);
control._updateFieldArray(name, updatedFieldArrayValues, swapArrayAt, {
argA: indexA,
argB: indexB,
}, false);
};
const move = (from, to) => {
const updatedFieldArrayValues = control._getFieldArray(name);
moveArrayAt(updatedFieldArrayValues, from, to);
moveArrayAt(ids.current, from, to);
updateValues(updatedFieldArrayValues);
setFields(updatedFieldArrayValues);
control._updateFieldArray(name, updatedFieldArrayValues, moveArrayAt, {
argA: from,
argB: to,
}, false);
};
const update = (index, value) => {
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._updateFieldArray(name, updatedFieldArrayValues, updateAt, {
argA: index,
argB: updateValue,
}, true, false);
};
const replace = (value) => {
const updatedFieldArrayValues = convertToArrayPayload(cloneObject(value));
ids.current = updatedFieldArrayValues.map(generateId);
updateValues([...updatedFieldArrayValues]);
setFields([...updatedFieldArrayValues]);
control._updateFieldArray(name, [...updatedFieldArrayValues], (data) => data, {}, true, false);
};
React.useEffect(() => {
control._state.action = false;
isWatched(name, control._names) &&
control._subjects.state.next({
...control._formState,
});
if (_actioned.current &&
(!getValidationModes(control._options.mode).isOnSubmit ||
control._formState.isSubmitted)) {
if (control._options.resolver) {
control._executeSchema([name]).then((result) => {
const error = get(result.errors, name);
const existingError = get(control._formState.errors, name);
if (existingError
? (!error && existingError.type) ||
(error &&
(existingError.type !== error.type ||
existingError.message !== error.message))
: error && error.type) {
error
? set(control._formState.errors, name, error)
: 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._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),
}));
}
}
}
control._subjects.values.next({
name,
values: { ...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._updateValid();
_actioned.current = false;
}, [fields, name, control]);
React.useEffect(() => {
!get(control._formValues, name) && control._updateFieldArray(name);
return () => {
(control._options.shouldUnregister || shouldUnregister) &&
control.unregister(name);
};
}, [name, control, keyName, shouldUnregister]);
return {
swap: React.useCallback(swap, [updateValues, name, control]),
move: React.useCallback(move, [updateValues, name, control]),
prepend: React.useCallback(prepend, [updateValues, name, control]),
append: React.useCallback(append, [updateValues, name, control]),
remove: React.useCallback(remove, [updateValues, name, control]),
insert: React.useCallback(insert$1, [updateValues, name, control]),
update: React.useCallback(update, [updateValues, name, control]),
replace: React.useCallback(replace, [updateValues, name, control]),
fields: React.useMemo(() => fields.map((field, index) => ({
...field,
[keyName]: ids.current[index] || generateId(),
})), [fields, keyName]),
};
}
var createSubject = () => {
let _observers = [];
const next = (value) => {
for (const observer of _observers) {
observer.next && observer.next(value);
}
};
const subscribe = (observer) => {
_observers.push(observer);
return {
unsubscribe: () => {
_observers = _observers.filter((o) => o !== observer);
},
};
};
const unsubscribe = () => {
_observers = [];
};
return {
get observers() {
return _observers;
},
next,
subscribe,
unsubscribe,
};
};
var isPrimitive = (value) => isNullOrUndefined(value) || !isObjectType(value);
function deepEqual(object1, object2) {
if (isPrimitive(object1) || isPrimitive(object2)) {
return object1 === object2;
}
if (isDateObject(object1) && isDateObject(object2)) {
return object1.getTime() === object2.getTime();
}
const keys1 = Object.keys(object1);
const keys2 = Object.keys(object2);
if (keys1.length !== keys2.length) {
return false;
}
for (const key of keys1) {
const val1 = object1[key];
if (!keys2.includes(key)) {
return false;
}
if (key !== 'ref') {
const val2 = object2[key];
if ((isDateObject(val1) && isDateObject(val2)) ||
(isObject(val1) && isObject(val2)) ||
(Array.isArray(val1) && Array.isArray(val2))
? !deepEqual(val1, val2)
: val1 !== val2) {
return false;
}
}
}
return true;
}
var isMultipleSelect = (element) => element.type === `select-multiple`;
var isRadioOrCheckbox = (ref) => isRadioInput(ref) || isCheckBoxInput(ref);
var live = (ref) => isHTMLElement(ref) && ref.isConnected;
var objectHasFunction = (data) => {
for (const key in data) {
if (isFunction(data[key])) {
return true;
}
}
return false;
};
function markFieldsDirty(data, fields = {}) {
const isParentNodeArray = Array.isArray(data);
if (isObject(data) || isParentNodeArray) {
for (const key in data) {
if (Array.isArray(data[key]) ||
(isObject(data[key]) && !objectHasFunction(data[key]))) {
fields[key] = Array.isArray(data[key]) ? [] : {};
markFieldsDirty(data[key], fields[key]);
}
else if (!isNullOrUndefined(data[key])) {
fields[key] = true;
}
}
}
return fields;
}
function getDirtyFieldsFromDefaultValues(data, formValues, dirtyFieldsFromValues) {
const isParentNodeArray = Array.isArray(data);
if (isObject(data) || isParentNodeArray) {
for (const key in data) {
if (Array.isArray(data[key]) ||
(isObject(data[key]) && !objectHasFunction(data[key]))) {
if (isUndefined(formValues) ||
isPrimitive(dirtyFieldsFromValues[key])) {
dirtyFieldsFromValues[key] = Array.isArray(data[key])
? markFieldsDirty(data[key], [])
: { ...markFieldsDirty(data[key]) };
}
else {
getDirtyFieldsFromDefaultValues(data[key]