Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

navigate property doesn't exist on ClerkProvider requires documentation update #991

Open
4 tasks done
gautamgiri-dev opened this issue May 4, 2024 · 0 comments
Open
4 tasks done

Comments

@gautamgiri-dev
Copy link

gautamgiri-dev commented May 4, 2024

Preliminary Checks

Reproduction

https://clerk.com/docs/references/react/add-react-router

Publishable key

pk_test_not_required

Description

I was following the react router dom documentation available on the website and figured out that it is outdated and is not consistent with the current version of clerk-react. Specifically on the documentation page of react-router-dom the documentation states that we can pass navigate function from react-router-dom's useNavigate hook as the navigate property of the ClerkProvider.
But the IDE states correctly that the property navigate doesn't exist on the component ClerkProvider which is consistent with the latest version of clerk-react.
However, using the exampels/demos available on the github repo, it can be observed the the ClerkProvider component doesn't require the navigate property.
Kindly update the documentation on the webiste. I have included the link of the documentation where the issue can be found.

Clerk + React Router Documentation

Screenshot of the issue from the website's documentation:
Issue

Screenshot of the implementation from Github Repo:
Example from Github Repo

Environment

Not Required
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant