From 42f8431ba1c63a042e568695b99c441f02c04880 Mon Sep 17 00:00:00 2001 From: "Alessandro (Ale) Segala" <43508+ItalyPaleAle@users.noreply.github.com> Date: Thu, 17 Jun 2021 00:35:55 +0000 Subject: [PATCH] Updated docs and types --- Advanced Usage.md | 5 ++++- Router.d.ts | 3 +++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/Advanced Usage.md b/Advanced Usage.md index 886e937..cd6fcbe 100644 --- a/Advanced Usage.md +++ b/Advanced Usage.md @@ -360,6 +360,8 @@ event.detail = { location: '/book/343', // The "querystring" from the page's hash, equivalent to the value of the $querystring readable store querystring: 'foo=bar', + // Params matched from the route (such as :id from the route) + params: { id: '343' }, // User data passed with the wrap function; can be any kind of object/dictionary userData: {...} } @@ -405,10 +407,11 @@ function routeLoading(event) { function routeLoaded(event) { console.log('routeLoaded event') - // The first 4 properties are the same as for the routeLoading event + // The first 5 properties are the same as for the routeLoading event console.log('Route', event.detail.route) console.log('Location', event.detail.location) console.log('Querystring', event.detail.querystring) + console.log('Params', event.detail.params) console.log('User data', event.detail.userData) // The last two properties are unique to routeLoaded console.log('Component', event.detail.component) // This is a Svelte component, so a function diff --git a/Router.d.ts b/Router.d.ts index a8087d6..1c78760 100644 --- a/Router.d.ts +++ b/Router.d.ts @@ -14,6 +14,9 @@ export interface RouteDetail { /** Querystring from the hash */ querystring: string + /** Params matched in the route */ + params: Record | null + /** Custom data passed by the user */ userData?: object }