useRoutes should be able to return null when passing locationArg

[danielberndt]

The docs for useRoutes claim the following:

The return value of useRoutes is either a valid React element you can use to render the route tree, or null if nothing matched.

This is not true in case a custom locationArg is passed. In that situation useRoutes will always return a <LocationContext.Provider> with a potentially empty child.

This PR ensures that a <LocationContext.Provider> is only returned if renderedMatches is not empty.

[changeset-bot]

🦋 Changeset detected

Latest commit: 3efe421

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 5 packages

Name	Type
react-router-dom	Patch
@remix-run/router	Patch
react-router	Patch
react-router-dom-v5-compat	Patch
react-router-native	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[remix-cla-bot]

Hi @danielberndt,

Welcome, and thank you for contributing to React Router!

Before we consider your pull request, we ask that you sign our Contributor License Agreement (CLA). We require this only once.

You may review the CLA and sign it by adding your name to contributors.yml.

Once the CLA is signed, the CLA Signed label will be added to the pull request.

If you have already signed the CLA and received this response in error, or if you have any questions, please contact us at [email protected].

Thanks!

- The Remix team

[remix-cla-bot]

Thank you for signing the Contributor License Agreement. Let's get this merged! 🥳

[timdorr]

Do you mind adding a test as well?

[danielberndt]

Alright, just added tests to ensure useRoutes returns null. One with a custom location prop, and one without

[brophdawg11]

@danielberndt this is looking good! Do you mind rebasing this and pointing to dev since it has code changes in it?

[danielberndt]

Alright @brophdawg11, done!