Skip to content

docs: fix useLinkClickHandler defaultShouldRevalidate default description#15322

Open
dfedoryshchev wants to merge 1 commit into
remix-run:mainfrom
dfedoryshchev:docs/uselinkclickhandler-revalidate-default
Open

docs: fix useLinkClickHandler defaultShouldRevalidate default description#15322
dfedoryshchev wants to merge 1 commit into
remix-run:mainfrom
dfedoryshchev:docs/uselinkclickhandler-revalidate-default

Conversation

@dfedoryshchev

Copy link
Copy Markdown
Contributor

The useLinkClickHandler JSDoc documents defaultShouldRevalidate as "Defaults to true", but the hook applies no default: when the option is omitted it is passed through as undefined and the router falls back to its standard revalidation behavior, which is not unconditional revalidation.

Updated the @param description to describe the actual default behavior.

@github-actions

Copy link
Copy Markdown
Contributor

✅ CLA Signed

Thanks for signing the Contributor License Agreement.

@github-actions

Copy link
Copy Markdown
Contributor

⚠️ No Change File Found

This PR doesn't include a change file which is used for automated release notes.
If your change affects users, please add one (or more) change files and commit the generated file(s).

pnpm run changes:add

This script requires Node 24+. If you are on a lower version, please add a file manually

Not every PR needs a change file — you can skip this step if the change is internal-only
(tests, tooling, docs)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant