-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Open
Labels
documentationEverything documentation relatedEverything documentation related
Description
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:
navigate()documentation says it accepts aNavigateOptionsNavigateOptionsdocumentation doesn't showmaskbut says it extendsToOptionsToOptionsdocumentation doesn't showmaskeither (and everything it extends is also defined there)
Your Example Website or App
n/a
Steps to Reproduce the Bug or Issue
- Go to the documentation
- Look for the
maskoption
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
maskoption available on the<Link>andnavigate()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
Metadata
Metadata
Assignees
Labels
documentationEverything documentation relatedEverything documentation related