formik-error-focus

Scroll to the first error in your Formik form and set focus

Table of Contents

• formik-error-focus
  • Table of Contents
  • 👀 Background
  • ⚙️ Install
  • 📖 Usage
  • 📚 API
  • 💬 Contributing
  • 🪪 License

👀 Background

Wrapper around scroll-to-element that scrolls to the first error element in Formik.

⚙️ Install

Install the package locally within you project folder with your package manager:

With npm:

1npm install formik-error-focus

With yarn:

1yarn add formik-error-focus

With pnpm:

1pnpm add formik-error-focus

📖 Usage

1import React from "react";
2import { Formik, Field, Form } from "formik";
3import FormikErrorFocus from "formik-error-focus";
4
5export const Signup = () => (
6  <div>
7    <h1>My Uncool Persisted Form</h1>
8    <Formik
9      onSubmit={(values) => console.log(values)}
10      initialValues={{ firstName: "", lastName: "", email: "" }}
11      render={(props) => (
12        <Form className="whatever">
13          <Field name="firstName" placeholder="First Name" />
14          <Field name="lastName" placeholder="Last Name" />
15          <Field name="email" type="email" placeholder="Email Address" />
16          <button type="submit">Submit</button>
17          <FormikErrorFocus
18            // See scroll-to-element for configuration options: https://www.npmjs.com/package/scroll-to-element
19            offset={0}
20            align={"top"}
21            focusDelay={200}
22            ease={"linear"}
23            duration={1000}
24          />
25        </Form>
26      )}
27    />
28  </div>
29);

📚 API

For all configuration options, please see the API docs.

💬 Contributing

Got an idea for a new feature? Found a bug? Contributions are welcome! Please open up an issue or make a pull request.

🪪 License

MIT © Tiaan du Plessis