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

feat: allow overriding matchPath function on Routes #11556

Open
wants to merge 8 commits into
base: dev
Choose a base branch
from

Conversation

modi98
Copy link

@modi98 modi98 commented May 12, 2024

This change allows users to override the base matchPath used by the Routes component. This will allow people to progressively migrate from the removal of validators and regex on paths that used to exist before v6.

This is a simple example of an implementation of a customMatchPath function (open to change the name) which could be further developed to use path-to-regexp or other library for path matching.

const customMatchPath = (pattern: PathPattern | string, pathname: string) => {
  if (pathname.length > 4) return matchPath(pattern, pathname);
  return null;
};

<BrowserRouter>
  <Routes
    customMatchPath={customMatchPath}
  >
    <Route path="/:slug" element={<>Hello</>} />
  </Routes>
</BrowserRouter>

#11546

Copy link

changeset-bot bot commented May 12, 2024

⚠️ No Changeset found

Latest commit: bbec356

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

@remix-cla-bot
Copy link
Contributor

remix-cla-bot bot commented May 12, 2024

Hi @modi98,

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 hello@remix.run.

Thanks!

- The Remix team

@remix-cla-bot
Copy link
Contributor

remix-cla-bot bot commented May 12, 2024

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

@modi98 modi98 changed the title feat: override matchPath logic on Routes feat: allow overriding matchPath function on Routes May 12, 2024
@modi98
Copy link
Author

modi98 commented May 20, 2024

Is it required to have all the bundles stay within the 5% range of current file size? I see it's failing because of a small bump on bundle size, which I'm not even sure could be removed.

I'm assuming the bundle size increades a few bytes through the added imports of ParamParseKey, PathMatch, and PathPattern.

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.

None yet

3 participants