-
Notifications
You must be signed in to change notification settings - Fork 1.4k
docs: Update Routing docs #793
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
Merged
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
4a70c6b
Update overview.mdx
isaac-mcfadyen 743d0d7
Update default-index.mdx
isaac-mcfadyen 6f2d057
Update slugs.mdx
isaac-mcfadyen 8e19e38
Rename slugs.mdx to path-parameters.mdx
isaac-mcfadyen 0b53a2e
Update pathless.mdx
isaac-mcfadyen fb4be8f
Update path-parameters.mdx
isaac-mcfadyen f6f1e43
Update and rename path-parameters.mdx to route-parameters.mdx
isaac-mcfadyen File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
45 changes: 45 additions & 0 deletions
45
packages/docs/src/pages/qwikcity/routing/route-parameters.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| --- | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. renaming this file requires a rename in |
||
| title: Qwik City - Route Parameters | ||
| --- | ||
|
|
||
| # Qwik City - Route Parameters | ||
|
|
||
| Route Parameters are parts of the URLs that are extracted into parameters. | ||
|
|
||
| Imagine that you have a page with the following URLs where `[skuId]` can be any of the thousands of products that you have in your database. It would be impractical to create a route for each product. Instead, we need to define a Route Parameter (a part of the URL) that will be used to extract the `[skuId]`. | ||
|
|
||
| - `https://example.com/sku/[skuId]` | ||
| - Will match: `https://example.com/sku/1234` | ||
| - Will match: `https://example.com/sku/xyz-567` | ||
| - `http://example.com/sku/[skuId]/details` | ||
| - Will match: `https://example.com/sku/1234/details` | ||
|
|
||
| ``` | ||
| - src/ | ||
| - routes/ | ||
| - sku/ | ||
| - [skuId]/ | ||
| - index.js # https://example.com/sku/1234 | ||
| - details.js # https://example.com/sku/1234/details | ||
| ``` | ||
|
|
||
|
|
||
| ## Retrieving the Route Parameter from the URL | ||
|
|
||
| Once we have `[skuId]` in the URL, we need a way to retrieve it. This can be done by using `useLocation()` API. | ||
|
|
||
| ```typescript | ||
| import { useLocation } from '@builder.io/qwik-city'; | ||
|
|
||
| export default component$(() => { | ||
| const location = useLocation(); | ||
|
|
||
| return ( | ||
| <Host> | ||
| <h1>SKU</h1> | ||
| <p>Pathname: {location.pathname}</p> | ||
| <p>Sku Id: {location.params.skuId}</p> | ||
| </Host> | ||
| ); | ||
| }); | ||
| ``` | ||
This file was deleted.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
missed one...