What does useNavigate replace option do?

Question

The docs say:

Either pass a To value (same type as <Link to>) with an optional second { replace, state } arg or

without saying what it does. So does it replace the whole history stack or just the current route? I have no idea.

Answer 1

The replace options property is a REPLACE navigation action. It's a redirect, replacing the current entry in the history stack versus PUSHing a new entry onto the top like a regular navigation.

navigate(path); // PUSH, navigate
navigate(path, { replace: true }); // REPLACE, redirect

useNavigate

The useNavigate hook returns a function that lets you navigate programmatically, for example after a form is submitted. If using replace: true, the navigation will replace the current entry in the history stack instead of adding a new one.