feat(useForm): add redirectOnSuccess to disable auto-redirect #6934

[gmpaliwal07]

PR Checklist

Please check if your PR fulfills the following requirements:

The commit message follows our guidelines: https://refine.dev/docs/guides-concepts/contributing/#commit-convention

Bugs / Features

• Related issue(s) linked
• Changesets have been added: https://refine.dev/docs/guides-concepts/contributing/#creating-a-changeset

• What is the current behavior?

• useForm always redirects after a successful mutation — even when used in modals, drawers, or inline forms — breaking the intended UX.
• Users previously had to pass: redirect: false
• but it was inconsistent and still required redirectOnSuccess in some cases.

Issue: #6934

What is the new behavior?
Now, you can disable redirect with a single, clear prop:
useForm({
redirectOnSuccess: false
})

Benefits:
✅ No redirect after success
✅ Works in modals, drawers, inline forms
✅ redirect?: RedirectAction still works (for custom targets)
✅ redirectOnSuccess?: boolean defaults to true → no breaking changes

Notes for Reviewers

Optional prop — safe for all existing code
Fully typed
Manually tested in examples/base-antd:

redirectOnSuccess: false → stays on page
Default → redirects to list

Fixes #6934

[changeset-bot]

🦋 Changeset detected

Latest commit: 7715077

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

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

[netlify]

✅ Deploy Preview for refine-doc-live-previews ready!

Built without sensitive environment variables

Name	Link
🔨 Latest commit	7715077
🔍 Latest deploy log	https://app.netlify.com/projects/refine-doc-live-previews/deploys/6900d37f60d13d000820070d
😎 Deploy Preview	https://deploy-preview-7096--refine-doc-live-previews.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify project configuration.

[alicanerdurmaz]

Hello @gmpaliwal07, I left comment to the issue. What do you think?

[gmpaliwal07]

Hello @alicanerdurmaz ,

As per my understanding redirect: false only changes the target - it does not prevent the internal redirect() call.
Even with redirect: false, navigation is triggered in useRedirectionAfterSubmission.

redirect: false -> still goes to list (default fallback)

redirectOnSuccess: false adds an early return in the redirect hook -> fully stopping navigation.

This is required for modals, drawers, and inline forms where any redirect breaks UX.

Without it, users must fight the framework. With it: one clean prop.

(Alternative - removing default fallback would break existing apps. Not safe.)

Looking forward to feedback.