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.

Sign up for GitHub

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

Feature/router query params #246

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

Feature/router query params #246

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0aec9af
Added functionality to use query string parameters in router hash.
michielvandergeest Dec 20, 2024
35f9fa6
Added documentation about route query params.
michielvandergeest Dec 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions docs/router/basics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,19 @@ Each route in this array, is an Object literal that includes the following key p

Besides static routes such as `/account` and `/settings/wifi/advanced`, the Blits router also supports dynamic routes where URI parts can contain params.

To define a param in a route path prefix a string with a colon (`:`), followed by the name of the param, e.g. `/movies/:genre/:id`. This route path will match a URI hash such as `#/movies/sci-fi/65281918`. The router will take the params and inject them as a `prop` into the Page that's being navigated to.
To define a param in a route path, prefix a string with a colon (`:`), followed by the name of the param, e.g. `/movies/:genre/:id`. This route path will match a URI hash such as `#/movies/sci-fi/65281918`. The router will take the params and inject them as a `prop` into the Page that's being navigated to.

To access these props in the Page component, they must first be defined in the Component first (i.e. `props: ['genre', 'id']`). Once defined, the values (`sci-fi` and `65281918`) in this case, will be available on the `this` scope, as with any regular Component.
To access these props in the Page component, they must first be defined in the Page component as _props_ first (i.e. `props: ['genre', 'id']`). Once defined, the values (`sci-fi` and `65281918`) in this case, will be available on the `this` scope as `this.genre` and `this.id` (or as `$genre` and `$id` when used in the template), as with any regular Component.

#### Using query parameters in routes

According to the browser specifications, query parameters are not part of a URL hash. This means that query parameters should be placed _before_ the URL hash (i.e. `http://localhost:5173?id=100&name=john#/my/page/hash`) and implies that "real" query parameters are _not_ part of the route paths.

In this case `id` and `name` won't automatically be made available as props inside a Blits component. They can however be retrieved using `document.location.search` in combination with `new URLSearchParams`, and can be used in an App's `index.js` to set dynamic launch settings for example.

Sometimes you may actually want pass custom data into a Blits component, without it being part of the dynamic route path or `data`-object during navigation. For these cases Blits allows you to use query parameters as part of a route (i.e. `#/series/simpsons/5/10?id=100&name=john`).

This URL hash will match the route `/series/:show/:season/:episode` and it will pass `id` and `name` as additional props into the Page component. Note: similar to dynamic path params, route query params should also be be defined in the Page component as _props_ first (i.e. `props: ['id', 'name']`) in order to be accessed on the `this`-scope.

## Router view

Expand Down
19 changes: 16 additions & 3 deletions src/router/router.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,11 @@ let navigatingBack = false
let previousFocus

export const getHash = () => {
return (document.location.hash || '/').replace(/^#/, '')
const hashParts = (document.location.hash || '/').replace(/^#/, '').split('?')
return {
hash: hashParts[0],
queryParams: new URLSearchParams(hashParts[1]),
}
}

const normalizePath = (path) => {
Expand Down Expand Up @@ -113,7 +117,7 @@ export const navigate = async function () {
navigating = true
if (this.parent[symbols.routes]) {
const previousRoute = currentRoute
const hash = getHash()
const { hash, queryParams } = getHash()
let route = matchHash(hash, this.parent[symbols.routes])
let beforeHookOutput
if (route) {
Expand Down Expand Up @@ -153,7 +157,16 @@ export const navigate = async function () {
holder.set('w', '100%')
holder.set('h', '100%')
// merge props with potential route params, navigation data and route data to be injected into the component instance
const props = { ...this[symbols.props], ...route.params, ...navigationData, ...route.data }
const props = {
...this[symbols.props],
...route.params,
...navigationData,
...route.data,
...queryParams.entries().reduce((obj, item) => {
obj[item[0]] = item[1]
return obj
}, {}),
}

view = await route.component({ props }, holder, this)
if (view[Symbol.toStringTag] === 'Module') {
Expand Down