formik icon indicating copy to clipboard operation
formik copied to clipboard

Fix: Prevent Formik form submission if native validation fails

Open Cherryga opened this issue 6 months ago β€’ 4 comments

What does this PR do?

This PR improves the Formik form behavior by integrating native HTML5 validation and ensuring handleSubmit only proceeds when all form inputs are valid.


πŸ› οΈ Key Changes

  1. handleSubmit update:

    • Wrapped in useEventCallback.
    • Explicitly runs form.reportValidity() before Formik submission.
    • Prevents default/propagation when necessary.
    • Added dev-time invariant check for missing button type.
  2. Updated <Form /> component:

    • Ensures native HTML validation runs before handleSubmit.
    • Defaults the action attribute to # to support iOS autofill UX.
    • Safely spreads rest props and supports forwarded refs.

πŸ“‹ Why is this needed?

Without this patch, Formik may bypass HTML5 validation rules and submit forms with invalid values, leading to poor UX and unintended backend requests. This change ensures validation is respected before triggering Formik's logic.


πŸ”¬ Manual Testing Done

  • βœ… Invalid inputs now block submission via browser-native validation.
  • βœ… Valid inputs allow normal Formik handleSubmit.
  • βœ… Button without type="submit" warns in dev mode.

πŸ§ͺ TODO

  • Add unit tests for <Form /> to assert reportValidity() integration.

Summary by CodeRabbit

  • New Features

    • Added a new sample form page with email and age fields, inline validation, and real-time error messages.
    • The form includes a debug section showing validation state and errors.
    • Integrated native HTML5 validation support into form submission for immediate input feedback.
  • Bug Fixes

    • Improved form submission to respect native HTML5 validation, preventing submission if required fields are invalid.
  • Style

    • Enhanced styling for form layout, inputs, error messages, and buttons for better user experience.

Cherryga avatar Jul 19 '25 10:07 Cherryga

πŸ¦‹ Changeset detected

Latest commit: 684a9bcf0afc143a20f56d9e85af324f9285c467

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 3 packages
Name Type
formik Minor
fdocs3 Patch
formik-native Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

changeset-bot[bot] avatar Jul 19 '25 10:07 changeset-bot[bot]

The latest updates on your projects. Learn more about Vercel for Git β†—οΈŽ

Name Status Preview Comments Updated (UTC)
formik-docs ❌ Failed (Inspect) Jul 19, 2025 2:28pm

vercel[bot] avatar Jul 19 '25 10:07 vercel[bot]

Walkthrough

The changes introduce native HTML5 form validation to Formik's submission flow by enhancing the Form and handleSubmit logic. A new test page demonstrates a Formik-powered form with Yup validation, styled components, and inline error messages, providing a practical example of the updated validation and submission behavior.

Changes

File(s) Change Summary
packages/formik/src/Form.tsx Updated onSubmit handler to perform native HTML5 validation via form.reportValidity() before invoking Formik's handleSubmit. Added comments for type alias and display name.
packages/formik/src/Formik.tsx Modified handleSubmit to call reportValidity() and abort submission if form is invalid. Improved error handling and developer warnings.
website/src/pages/testsubmit.tsx Added new TestSubmit component: a styled Formik form with Yup validation, inline errors, and a debug section.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Browser
    participant Form (Formik)
    participant Formik Logic

    User->>Browser: Fill form fields
    User->>Form: Submit form
    Form->>Browser: Call form.reportValidity()
    alt Form is invalid
        Browser-->>User: Show native validation errors
        Form-->>User: Abort submission
    else Form is valid
        Form->>Formik Logic: Call handleSubmit
        Formik Logic->>Formik Logic: Run Formik/Yup validation
        alt Formik validation passes
            Formik Logic->>User: Submit data, reset form, show alert
        else Formik validation fails
            Formik Logic-->>User: Show inline Formik errors
        end
    end

Poem

In fields of forms where data flows,
Native checks now gently pose.
If HTML5 says "not quite right,"
The bunny halts with gentle might.
But if all's well, Formik hops aheadβ€”
With Yup and style, your form is led!
πŸ‡βœ¨

✨ Finishing Touches
  • [ ] πŸ“ Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❀️ Share
πŸͺ§ Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot] avatar Jul 19 '25 10:07 coderabbitai[bot]

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

codesandbox-ci[bot] avatar Jul 19 '25 10:07 codesandbox-ci[bot]