0.3.0 • Published 3 years ago

@yapyeeqiang/react-validator v0.3.0

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
3 years ago

React Validator

Steps to integrate Validator

  1. Define form schema
import * as Yup from "yup";

const schema = Yup.object({
  email: Yup.string().email().required(),
  password: Yup.string().required(),
});
  1. Initialize the useValidation hook
import { useValidation } from "./hooks/validation";

const { fields, errors, useField, validateForm } = useValidation(schema);

Definitions:

  • fields - Form inputs value object
  • errors - Errors detected when submitting the form
  • useField - Method that defines a form field
  • validateForm - Method that checks if validation passed
  1. Define form fields
// Format: <KEY>field, set<KEY>Field = useField("<KEY>")
const { emailField, setEmailField } = useField("email");
  1. Define custom form submit action
const submitForm = () => {
  const isFormValid = validateForm();

  if (isFormValid) {
    // Do something (API call, etc.)
  }
};
  1. Use custom FormField component

For example, let's define a email field:

<FormField
  value={emailField}
  setValue={setEmailField}
  error={errors.email}
  labelText="Email"
  fieldType="email"
  inputType="email"
/>