Which project does this relate to?#
Router
Describe the bug#
router.navigate() accepts a mask option. But the docs for navigate don't show it:
Your Example Website or App#
n/a
Steps to Reproduce the Bug or Issue#
- Go to the documentation
- Look for the
mask option
Expected behavior#
I expected every option passed to navigate() to be documented near that function but I am seeing that at least one is missing.
I'm aware that the documentation for masking mentions where it can be used:
Imperatively via the mask option available on the <Link> and navigate() APIs
But I think this also needs to be mentioned in the docs for <Link> and navigate() themselves.
Screenshots or Videos#
No response
Platform#
- Router / Start Version: Router 1.136.8
- OS: macOS
- Browser: Firefox
- Browser Version: 145.0.2
- Bundler: vite
- Bundler Version: 7.2.2
Additional context#
No response