Skip to content

Ability to imperatively parse the path params, at clientside runtime #1871

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

Closed
wants to merge 1 commit into from
Closed

Ability to imperatively parse the path params, at clientside runtime #1871

wants to merge 1 commit into from

Conversation

johnnysprinkles
Copy link
Contributor

Normally, client-side code would get the path params from $page.params. For pre-rendered pages however, those values are the values as they were at pre-render time, which isn't useful if you're using a single pre-rendered HTML artifact to handle an entire parameterized route with path params which vary at runtime.

In such case, you'd want look at the details of the particular request, by inspecting window.location. This is fine for path and query string, but not currently possible for path params because we don't have the information about its pattern or param names.

This simply adds that ability, and should be considered in conjunction with just-now submitted #1870.

Before submitting the PR, please make sure you do the following

  • It's really useful if your PR references an issue where it is discussed ahead of time. In many cases, features are absent for a reason. For large changes, please create an RFC: https://github.com/sveltejs/rfcs
  • This message body should clearly illustrate what problems it solves.
  • Ideally, include a test that fails without this PR but passes with it.

Tests

  • Run the tests with pnpm test and lint the project with pnpm lint and pnpm check

Changesets

  • If your PR makes a change that should be noted in one or more packages' changelogs, generate a changeset by running pnpx changeset and following the prompts. All changesets should be patch until SvelteKit 1.0

@changeset-bot
Copy link

changeset-bot bot commented Jul 10, 2021

⚠️ No Changeset found

Latest commit: aeb5fe0

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

function routeParams_() {
const { routes } = router.parse(new URL(location.href));
if (routes.length === 0) return {};
const match = routes[0][0].exec(location.pathname);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This could use a comment as to why this line and the next are routes[0]. It seems like it's only checking the first route? Why is that?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's a really good comment. I think if there's multiple ambiguous matching routes it gives them all, we'd probably want the first or the last, I'll need to investigate. The order comes from whatever order they're in generated/manifest.js.

Also I don't love the magic indices after that. I should cast it as a CSRPage type and destructure it instead.

I'll have an update soon.

@johnnysprinkles
Copy link
Contributor Author

I should probably close this, since the main reason to do this is in support of general-case static prerendering, which we're not doing now or perhaps ever. See #1870.

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

Successfully merging this pull request may close these issues.

2 participants