Работа с формами в React Native на новом уровне
Улучшаем работу с формами в React Native с помощью Zod и React Hook Form
Работа с формами является базовой частью любого приложения, где нужен пользовательский ввод, и с правильными инструментами и библиотеками она может быть простой и удобной. В этой статье я покажу, как обрабатывать формы в приложении на react-native с помощью react-hook-form и zod. Объединив их, мы получим эффективный механизм работы с формами. Для примера создадим простую форму регистрации.
Полный исходный код будет в конце статьи.
Объявление схемы с Zod
Сначала объявим схему с помощью zod. Эта схема описывает ожидаемую структуру данных формы и задаёт валидацию для каждого поля. Zod предоставляет множество мощных функций валидации для описания этих правил.
Вот полная схема zod:
Статья предполагает, что вы знакомы с основами zod.
import z from "zod";
const phoneNumberRegexp = new RegExp(
/^[\+]?([0-9][\s]?|[0-9]?)([(][0-9]{3}[)][\s]?|[0-9]{3}[-\s\.]?)[0-9]{3}[-\s\.]?[0-9]{4,6}$/im
);
const FIELD_REQUIRED_STR = "This field is required";
export const GENDER_OPTIONS = ["Male", "Female", "Other"] as const;
export const signUpFormSchema = z.object({
name: z
.string({
invalid_type_error: "Name must be a string",
required_error: FIELD_REQUIRED_STR,
})
.min(3, "Minimum 3 characters")
.max(20, "Maximum 20 characters")
.trim(),
surname: z
.string({
invalid_type_error: "Surname must be a string",
required_error: FIELD_REQUIRED_STR,
})
.min(3, "Minimum 3 characters")
.max(20, "Maximum 20 characters")
.trim(),
phoneNumber: z
.string({
invalid_type_error: "Phone number must be a number",
required_error: FIELD_REQUIRED_STR,
})
.regex(phoneNumberRegexp, "Invalid phone number"),
email: z
.string({
invalid_type_error: "Email must be a string",
required_error: FIELD_REQUIRED_STR,
})
.email("Email is invalid"),
gender: z.enum(GENDER_OPTIONS, {
required_error: FIELD_REQUIRED_STR,
invalid_type_error: `Invalid gender, must be one of the followings: ${GENDER_OPTIONS.join(
", "
)}`,
}),
birthDate: z
.date({
invalid_type_error: "Birth date must be a date",
required_error: FIELD_REQUIRED_STR,
})
.min(new Date("1900-01-01"), "Invalid date time, too old")
.max(new Date("2023-01-01"), "Invalid date time, too young")
.default(new Date()),
});
export type SignUpFormSchema = z.infer<typeof signUpFormSchema>;
В этой схеме мы с помощью zod указываем, что должно содержать каждое поле. Например, поля name и surname должны быть строками длиной от 3 до 20 символов, а поле phoneNumber должно быть числом.
Для некоторых полей правила сложнее. Например, поле email должно быть строкой и содержать только корректный адрес электронной почты. Поле gender должно принимать одно из заранее заданных значений ('Male', 'Female' или 'Other').
Наконец, поле birthDate имеет тип date и должно быть корректной датой в диапазоне от 1900-01-01 до 2023-01-01. Если дата не указана, по умолчанию берётся текущая.
С zod можно легко создавать сложные правила валидации. Так данные, которые мы получаем из формы, гарантированно соответствуют нашим ожиданиям.
Следующий шаг: вывести тип схемы. В zod есть метод infer, который выводит TypeScript тип для заданной схемы zod.
export type SignUpFormSchema = z.infer<typeof signUpFormSchema>;
Этот выведенный тип потом используется в useForm, чтобы данные формы соответствовали схеме.
Настройка формы с React Hook Form
Далее настраиваем форму с помощью хука useForm из 'react-hook-form'. Этот хук принимает нашу схему zod (через zodResolver) в качестве аргумента для валидации формы.
const methods = useForm<SignUpFormSchema>({
resolver: zodResolver(signUpFormSchema),
defaultValues: {
birthDate: new Date(),
},
mode: "onBlur",
});
В resolver мы передаём схему. Свойство defaultValues позволяет задать значения полей формы по умолчанию. В нашем случае по умолчанию birthDate равна текущей дате. Свойство mode определяет, когда должна происходить валидация. Здесь валидация срабатывает onBlur, то есть когда пользователь уходит с поля.
Рендеринг и валидация полей
Для управления каждым полем формы мы используем компонент Controller из react-hook-form. Он передаёт нам props field и fieldState, с помощью которых мы управляем значением поля, состоянием ошибки и валидацией.
Например, вот как настраивается поле name:
<Controller
control={methods.control}
name="name"
render={({ field: { onChange, onBlur, value }, fieldState: { error } }) => {
return (
<TextInput
label="Name"
onBlur={onBlur}
value={value}
onChangeText={onChange}
errorMessage={error?.message}
/>
);
}}
/>
Что делает каждый prop:
-
control: сюда передаётся prop control из хука useForm. Он нужен, чтобы Controller мог взаимодействовать с состоянием формы.
-
name: ключ, по которому значение поля доступно внутри формы. Когда вы получаете или задаёте значения формы, используется именно этот ключ. Он должен быть уникальным среди всех полей формы.
-
render: функция, которая возвращает элемент ввода. Она передаёт props field и fieldState.
-
field: содержит props onChange, onBlur и value. Их нужно напрямую связать с вашим контролируемым компонентом. В нашем случае onChange подключён к onChangeText у TextInput, который перехватывает ввод пользователя и сохраняет его в состоянии формы.
-
fieldState: включает prop error с информацией об ошибках валидации для этого поля.
Внутри prop render настраивается TextInput. onBlur и onChangeText привязаны к соответствующим методам из field, а prop value связан с текущим значением этого поля в форме. Prop errorMessage связан с сообщением об ошибке на случай, если валидация не прошла.
Таким образом, при отправке формы или валидации в реальном времени, если поле ‘name’ не удовлетворяет требованиям, описанным в схеме Zod, в этом поле TextInput появится сообщение об ошибке.
Ручной запуск валидации в React Hook Form
Особый случай возникает с полем birthDate, где используется компонент выбора даты (в нашем случае RNDateTimePicker). Здесь валидация требует особого подхода, потому что пользователь взаимодействует с выбором даты иначе, чем с обычными текстовыми полями.
<Controller
control={methods.control}
name="birthDate"
render={({ field: { onChange, onBlur, value }, fieldState: { error } }) => {
return (
<View>
<Text>Birth date</Text>
<RNDateTimePicker
value={value}
mode="date"
onChange={(e) => {
if (e.type === "set" && e.nativeEvent.timestamp) {
onChange(new Date(e.nativeEvent.timestamp));
methods.trigger("birthDate");
}
}}
/>
{!!error?.message && <Text>{error.message}</Text>}
</View>
);
}}
/>
Когда пользователь выбирает дату, срабатывает событие onChange. Внутри этого обработчика мы сначала проверяем, что тип события 'set', то есть пользователь установил дату. Затем проверяем, что есть timestamp, чтобы убедиться, что дата выбрана.
Убедившись в этом, мы преобразуем timestamp в объект Date из JavaScript с помощью new Date(e.nativeEvent.timestamp). Затем это новое значение передаётся в onChange, который обновляет значение поля birthDate в форме.
Однако, в отличие от обычных текстовых полей, которые автоматически запускают валидацию при изменениях, компоненты выбора даты так не делают. Поэтому валидацию нужно запустить вручную после обновления значения. Для этого мы вызываем methods.trigger('birthDate').
Метод trigger из react-hook-form запускает валидацию конкретного поля. Здесь он запускает валидацию поля birthDate сразу после установки даты, так что наши правила валидации применяются немедленно.
Наконец, если есть ошибки валидации, они отображаются через {!!error?.message &&
Отправка формы в React Hook Form
Пакет react-hook-form предоставляет эффективные методы для обработки отправки формы и ошибок.
const onSubmit: SubmitHandler<SignUpFormSchema> = (data) => {
console.log(JSON.stringify(data));
};
const onError: SubmitErrorHandler<SignUpFormSchema> = (errors, e) => {
console.log(JSON.stringify(errors));
};
<Button
onPress={methods.handleSubmit(onSubmit, onError)}
title="Submit Form"
color={"#007BFF"}
/>;
Разберём этот процесс:
Обработчик onSubmit получает данные формы в качестве аргумента. В нашем примере мы просто выводим их в лог, но в реальных приложениях их можно отправить на сервер или дополнительно обработать в зависимости от задач приложения.
Функция onError, напротив, вызывается, когда при отправке формы есть ошибки валидации. Объект errors содержит подробную информацию обо всех полях, которые не прошли валидацию. В этом примере мы просто выводим эти ошибки в лог.
Если ошибка есть в каждом поле, объект ошибок будет выглядеть так:
{
"name": {
"message": "This field is required",
"type": "invalid_type",
"ref": {
"name": "name"
}
},
"surname": {
"message": "This field is required",
"type": "invalid_type",
"ref": {
"name": "surname"
}
},
"phoneNumber": {
"message": "This field is required",
"type": "invalid_type",
"ref": {
"name": "phoneNumber"
}
},
"email": {
"message": "This field is required",
"type": "invalid_type",
"ref": {
"name": "email"
}
},
"gender": {
"message": "This field is required",
"type": "invalid_type",
"ref": {
"name": "gender"
}
},
"birthDate": {
"message": "Invalid date time, too young",
"type": "too_big",
"ref": {
"name": "birthDate"
}
}
}
Предварительная валидация с Zod
Блок кода ниже показывает подход, при котором данные формы вручную проверяются заранее с помощью метода safeParse из Zod до события отправки формы. Хотя валидацией формы уже занимается метод handleSubmit из React Hook Form, предварительная валидация даёт разработчикам больше контроля над процессом.
<Button
title="Submit Form"
onPress={() => {
// get current form values
const currFormValues = methods.getValues();
// Prevalidate using zod's safeParse
const result = signUpFormSchema.safeParse(currFormValues);
// If prevalidation is failed, display the error
if (!result.success) {
Alert.alert(JSON.stringify(result.error));
} else {
// If prevalidation is successful, notify the user
Alert.alert("Validation is successful with zod");
}
}}
/>
Разберём код выше:
-
Событие onPress у Button используется для вызова функции, которая выполняет предварительную валидацию перед отправкой формы.
-
Метод getValues из methods (его предоставляет React Hook Form) используется для получения текущих значений формы.
-
Эти значения затем передаются в метод safeParse схемы signUpFormSchema (схема zod, которую мы создали в начале). Именно на этом шаге происходит предварительная валидация через zod. В отличие от метода parse, safeParse не выбрасывает ошибку, если валидация не прошла. Вместо этого он возвращает объект с булевым полем success и, если валидация не прошла, объектом ошибки.
-
Условие проверяет, равно ли result.success false (то есть валидация не прошла). Если да, показывается alert с ошибкой валидации.
-
Если result.success равно true (валидация прошла успешно), показывается alert о том, что валидация с zod прошла успешно.
Хотя такой подход может показаться избыточным, ведь handleSubmit из React Hook Form уже валидирует форму по схеме zod, в отдельных сценариях он всё же полезен. Например, вы можете захотеть выполнить определённые действия только после ручной валидации или проверять поля формы в реальном времени, пока пользователь её заполняет. В таких случаях предварительная валидация через метод safeParse из zod может очень пригодиться.
А так выглядит объект ошибки zod:
{
"issues": [
{
"code": "invalid_type",
"expected": "string",
"received": "undefined",
"path": [
"name"
],
"message": "This field is required"
},
{
"code": "invalid_type",
"expected": "string",
"received": "undefined",
"path": [
"surname"
],
"message": "This field is required"
},
{
"code": "invalid_type",
"expected": "string",
"received": "undefined",
"path": [
"phoneNumber"
],
"message": "This field is required"
},
{
"code": "invalid_type",
"expected": "string",
"received": "undefined",
"path": [
"email"
],
"message": "This field is required"
},
{
"expected": "'Male' | 'Female' | 'Other'",
"received": "undefined",
"code": "invalid_type",
"path": [
"gender"
],
"message": "This field is required"
},
{
"code": "too_big",
"message": "Invalid date time, too young",
"inclusive": true,
"exact": false,
"maximum": 1672531200000,
"type": "date",
"path": [
"birthDate"
]
}
],
"name": "ZodError"
}
Объект действительно большой, и в нашем случае в нём могут быть даже лишние поля. К счастью, в zod есть метод для форматирования ошибок.
Достаточно вызвать result.error.format(), а остальное zod сделает сам.
if (!result.success) {
// Format errors using result.error.format()
const formattedError = result.error.format();
Alert.alert(JSON.stringify(formattedError));
} else {
Alert.alert("Validation is successful with zod");
}
Отформатированный объект ошибки будет выглядеть так:
{
"name": {
"_errors": [
"This field is required"
]
},
"surname": {
"_errors": [
"This field is required"
]
},
"phoneNumber": {
"_errors": [
"This field is required"
]
},
"email": {
"_errors": [
"This field is required"
]
},
"gender": {
"_errors": [
"This field is required"
]
},
"birthDate": {
"_errors": [
"Invalid date time, too young"
]
}
}
Итоговый код
Ниже приведён итоговый код (без импортов и стилей). Если хотите посмотреть полный исходный код, ссылка есть в конце статьи.
// imports...
export const SignupForm: React.FC = () => {
const [shouldValidateWithZod, setShouldValidateWithZod] =
React.useState<boolean>(false);
const [isCalendarOpenForAndroid, setIsCalendarOpenForAndroid] =
React.useState<boolean>(false);
const methods = useForm<SignUpFormSchema>({
resolver: zodResolver(signUpFormSchema),
defaultValues: {
birthDate: new Date(),
},
mode: "onBlur",
});
const onSubmit: SubmitHandler<SignUpFormSchema> = (data) => {
console.log(JSON.stringify(data));
};
const onError: SubmitErrorHandler<SignUpFormSchema> = (errors, e) => {
console.log(JSON.stringify(errors));
Alert.alert("Warning", getReadableValidationErrorMessage(errors));
};
return (
<SafeAreaView edges={["top", "bottom"]} style={styles.safeArea}>
<ScrollView>
<Text style={styles.title}>Sign Up Form</Text>
<View style={styles.root}>
<FormProvider {...methods}>
<Controller
control={methods.control}
name="name"
render={({
field: { onChange, onBlur, value },
fieldState: { error },
}) => {
return (
<TextInput
label="Name"
onBlur={onBlur}
value={value}
onChangeText={onChange}
errorMessage={error?.message}
/>
);
}}
/>
<View style={styles.spacing} />
<Controller
control={methods.control}
name="surname"
render={({
field: { onChange, onBlur, value },
fieldState: { error },
}) => {
return (
<TextInput
label="Surname"
onBlur={onBlur}
value={value}
onChangeText={onChange}
errorMessage={error?.message}
/>
);
}}
/>
<View style={styles.spacing} />
<Controller
control={methods.control}
name="email"
render={({
field: { onChange, onBlur, value },
fieldState: { error },
}) => {
return (
<TextInput
label="Email"
onBlur={onBlur}
value={value}
onChangeText={onChange}
errorMessage={error?.message}
/>
);
}}
/>
<View style={styles.spacing} />
<Controller
control={methods.control}
name="phoneNumber"
render={({
field: { onChange, onBlur, value },
fieldState: { error },
}) => {
return (
<TextInput
label="Phone number"
onBlur={onBlur}
keyboardType="decimal-pad"
value={value}
onChangeText={(val) => onChange(val.toString())}
errorMessage={error?.message}
/>
);
}}
/>
<View style={styles.spacing} />
<Controller
control={methods.control}
name="birthDate"
render={({
field: { onChange, value },
fieldState: { error },
}) => {
return (
<View style={styles.dateWrapper}>
<Text style={styles.label}>Birth date</Text>
{Platform.OS === "android" && (
<Button
onPress={() => {
setIsCalendarOpenForAndroid(true);
}}
title={value.toString()}
/>
)}
{(isCalendarOpenForAndroid ||
Platform.OS !== "android") && (
<RNDateTimePicker
value={value}
style={styles.dateTimePicker}
mode={"date"}
onChange={(e) => {
if (Platform.OS === "android") {
setIsCalendarOpenForAndroid(false);
}
if (e.type === "set" && e.nativeEvent.timestamp) {
onChange(new Date(e.nativeEvent.timestamp));
methods.trigger("birthDate");
}
}}
/>
)}
{!!error?.message && (
<Text style={styles.errorMessageText}>
{error.message}
</Text>
)}
</View>
);
}}
/>
<View style={styles.spacing} />
<Controller
control={methods.control}
name="gender"
render={({
field: { onChange, onBlur, value, ref },
fieldState: { error },
}) => {
return (
<View style={styles.genderWrapper}>
<Text style={styles.label}>Gender</Text>
<View style={styles.genderOptionsWrapper}>
{GENDER_OPTIONS.map((genderOption) => (
<Pressable
key={genderOption}
style={[
styles.genderOptionPressable,
{
backgroundColor:
value === genderOption ? "#007BFF" : "#F2F2F2",
},
]}
onPress={() => onChange(genderOption)}
>
<Text
style={[
styles.genderOptionText,
{
color: value === genderOption ? "#fff" : "#000",
},
]}
>
{genderOption}
</Text>
</Pressable>
))}
</View>
{!!error?.message && (
<Text style={styles.errorMessageText}>
{error.message}
</Text>
)}
</View>
);
}}
/>
<View style={styles.spacing} />
<Text style={styles.label}>Should validate with zod</Text>
<Switch
value={shouldValidateWithZod}
onChange={(e) => setShouldValidateWithZod(e.nativeEvent.value)}
/>
<View style={styles.spacing} />
<Button
onPress={
shouldValidateWithZod
? () => {
/** we could also prevalidate using zod like below */
// get current form values
const currFormValues = methods.getValues();
// https://zod.dev/?id=safeparse
const result = signUpFormSchema.safeParse(currFormValues);
if (!result.success) {
const formattedError = result.error.format();
Alert.alert(JSON.stringify(formattedError));
} else {
Alert.alert("Validation is successful with zod");
}
}
: methods.handleSubmit(onSubmit, onError)
}
title="Submit Form"
color={"#007BFF"}
/>
</FormProvider>
</View>
</ScrollView>
</SafeAreaView>
);
};
// styles...
Это демо приложение написано с использованием expo go. Это значит, что его легко протестировать по QR коду ниже! (если QR код не сработает, воспользуйтесь ссылкой на исходный код в конце статьи.)

Заключение
В этой статье мы разобрали, как эффективно использовать связку React Hook Form, Zod и TypeScript для надёжной валидации форм в приложении на React Native. Мы увидели, как гибкость и возможности этих библиотек позволяют писать чистый типобезопасный код, который справляется со сложными требованиями к валидации.
Связка React Hook Form и Zod позволяет получить преимущества обеих библиотек. React Hook Form упрощает работу с формами, оптимизирует повторные рендеры и включает такие возможности, как управление состоянием формы и обработка ошибок. Zod, в свою очередь, даёт дополнительный уровень безопасности: позволяет указать, какие данные допустимы для каждого поля формы, и следить за соблюдением этих правил.
Помните: хотя показанные здесь приёмы используются на примере простой формы регистрации, они применимы к любому пользовательскому вводу через формы в ваших приложениях на React Native. Используя эти подходы, вы сделаете формы удобными, надёжными и поддерживаемыми, а это ведёт к лучшему пользовательскому опыту и более надёжным приложениям.