1.0.17 • Published 2 months ago

@lukasniessenesentri/react-zod-form v1.0.17

Weekly downloads
-
License
MIT
Repository
github
Last release
2 months ago

Form validation with Zod: ZERO boilerplate code.

Unfinished test version.


Installation: npm i @lukasniessenesentri/react-zod-form

Uses monkey patching for defining attributes on all form related elements and thereby allows writing form validaiton with zero-boilerplate code.


Properties you can add:

  • ZodSchema: zod schema that must pass
  • Required: Must be non empty, trims the string for check
  • IsValid: Custom validation function (input: string) -> boolean

How it works: onSubmit method you specified is only called if all input fields pass all properties you assigned to it. If none specified, it passes always. If multiple on one input, all of them must pass. If one does not pass, "onError" is called. All inputs that fail have their onErrors called, not only the first fail.

But: For multiple on one input, only the first one will trigger the error message to be shown. --> Order of checking: Required 1st, zodSchema 2nd, isValid 3rd


Working example:

import React, { useState } from 'react';
import { ZodForm } from 'react-zod-form';
import { z } from 'zod';
import { Input as MuiInput } from '@mui/material';
import { Input as ChakraInput } from '@chakra-ui/react'

export const VanillaForm = () => {

  const mailSchema = z.string().email("Invalid email");
  const min10 = z.string().min(10, "Too short");
  const min20 = z.string().min(20, "Too short bro");

  const [errorName, setErrorName] = useState("");
  const [errorMail, setErrorMail] = useState("");
  const [errorSuperLong, setErrorSuperLong] = useState("");
  const [errorRnd4, setErrorRnd4] = useState("");
  const [success, setSuccess] = useState("");

  function onErrorMail(msg: string | null) {
    if (msg) {
      setErrorMail(msg);
    } else {
      setErrorMail("");
    }
  }

  function onErrorName(msg: string | null) {
    if (msg) {
      setErrorName(msg);
    } else {
      setErrorName("");
    }
  }

  function onErrorLong(msg: string | null) {
    if (msg) {
      setErrorSuperLong(msg);
    } else {
      setErrorSuperLong("");
    }
  }

  function onErrorRnd4(msg: string | null) {
    if (msg) {
        setErrorRnd4(msg);
    } else {
        setErrorRnd4("");
    }
  }

  function handleSubmit(formData: any) {
    setSuccess(JSON.stringify(formData));
    console.log(formData);
  }

  function customValidator(input: string) {
    return {
        success: input.includes("cool"),
        errorMessage: "Must include word 'cool'"
    };
  }

    return (
        <>
            <ZodForm onSubmit={handleSubmit}>

                <MuiInput 
                    name="name1" 
                    placeholder="Name..."
                    ZodSchema={min10} 
                    HandleError={onErrorName}
                />
                <p>{errorName}</p>

                <ChakraInput 
                    name="name99" 
                    placeholder="chakra name..."
                    ZodSchema={min10} 
                    HandleError={onErrorName}
                />
                <p>{errorName}</p>

                <input 
                    name="mail2" 
                    placeholder="Email bruva..."
                    ZodSchema={mailSchema}
                    HandleError={onErrorMail}
                />
                <p>{errorMail}</p>

                <textarea 
                    name="long" 
                    placeholder="Longer..."
                    ZodSchema={min20}
                    HandleError={onErrorLong}
                />
                <p>{errorSuperLong}</p>

                <input 
                    name="rnd4" 
                    placeholder="Random things man..."
                    IsRequired="value required"
                    IsValid={customValidator}
                    HandleError={onErrorRnd4}
                />
                <p>{errorRnd4}</p>

            </ZodForm>

            {success && (
                <>
                    <h1>Passed:</h1>
                    <p>
                        {success}
                    </p>
                </>
            )}
        </>
    );
};

Note: our monkey patched attribute all start with Capital letters. That is to avoid confusion and collusion with other libraries. It marks them and avoids problems.

1.0.17

2 months ago

1.0.16

2 months ago

1.0.15

2 months ago

1.0.14

2 months ago

1.0.13

2 months ago

1.0.11

2 months ago

1.0.12

2 months ago

1.0.10

2 months ago

1.0.9

2 months ago

1.0.8

2 months ago

1.0.7

2 months ago

1.0.6

2 months ago

1.0.5

2 months ago

1.0.4

2 months ago

1.0.3

2 months ago

1.0.2

2 months ago

1.0.1

2 months ago

1.0.0

2 months ago