From 4e00d84ba28c6e332748ed140603ccdb13cb9f54 Mon Sep 17 00:00:00 2001 From: Tobias Date: Sun, 19 May 2024 07:53:54 +0200 Subject: [PATCH 1/2] Docs: Extend search params section --- README.md | 26 +++++++++++++++----------- 1 file changed, 15 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 671ff5d..7b82347 100644 --- a/README.md +++ b/README.md @@ -114,30 +114,34 @@ createRouter({ ### Search Query Routing -Router value contains parsed `?a=1&b=2` search values: +Router value contains parsed url search params: ```js +createRouter({ home: '/posts/:category?sort=name' }) + location.href = '/posts/general?sort=name' router.get() //=> { -// path: '/posts/category', +// path: '/posts/general', // route: 'list', // params: { category: 'general' }, // search: { sort: 'name' } // } ``` -To use search query like `?a=1&b=2` in routes you need to set `search` option: +To disable the automatic parsing of search params in routes you need to set `search` option. +Router will now treat search query like `?a=1&b=2` as a string. Parameters order will be critical. ```js -createRouter({ - home: '/p/?page=home' -}, { - search: true -}) -``` +createRouter({ home: '/posts?page=general' }, { search: true }) -Router will work with `?search` part as a string. Parameters order will -be critical. +location.href = '/posts/?page=general' +router.get() //=> { +// path: '/posts?page=general', +// route: 'list', +// params: { }, +// search: { } +// } +``` ### Clicks Tracking From eea6d6b18c96ce1bab2ab374910453137b2835e7 Mon Sep 17 00:00:00 2001 From: Tobias Date: Sun, 19 May 2024 08:06:16 +0200 Subject: [PATCH 2/2] Docs: Fix example --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7b82347..d1cd50e 100644 --- a/README.md +++ b/README.md @@ -117,7 +117,7 @@ createRouter({ Router value contains parsed url search params: ```js -createRouter({ home: '/posts/:category?sort=name' }) +createRouter({ home: '/posts/:category' }) location.href = '/posts/general?sort=name' router.get() //=> {