]> git.ipfire.org Git - thirdparty/vuejs/router.git/commitdiff
docs: mention an edge case with mutliple optional params in the docs (#2192)
authorMatyáš Racek <panstromek@seznam.cz>
Tue, 9 Jul 2024 07:59:50 +0000 (09:59 +0200)
committerGitHub <noreply@github.com>
Tue, 9 Jul 2024 07:59:50 +0000 (09:59 +0200)
* docs: mention an edge case with mutliple optional params in the docs

See #2190 for more info.

* Update packages/docs/guide/essentials/route-matching-syntax.md

---------

Co-authored-by: Eduardo San Martin Morote <posva@users.noreply.github.com>
packages/docs/guide/essentials/route-matching-syntax.md

index e110f8f5b6b4b88fe5db5aafbf51185870ece2ba..7508993bfcfccd446564a586376b2d794cb9f8e6 100644 (file)
@@ -114,6 +114,13 @@ const routes = [
 
 Note that `*` technically also marks a parameter as optional but `?` parameters cannot be repeated.
 
+If the route segment contains more than **just an optional parameter**, it won't match a path **without the trailing slash**. For example:
+
+- `/users/:uid?-:name?` won't match `/users`, only `/users/-` or even `/users/-/`
+- `/users/:uid(\\d+)?:name? won't match `/users`, only `/users/`, `/users/2`, `/users/2/`, etc
+
+You can play around with the matching syntax [in the playground](https://paths.esm.dev/?p=AAMsIPQg4AoKzidgQFoEXAmw-IEBBRYYOE0SkABTASiz1qgBpgQA1QTsFjAb3h2onsmlAmGIFsCXjXh4AIA.&t=/users/2/#)
+
 ## Debugging
 
 If you need to dig how your routes are transformed into a regex to understand why a route isn't being matched or, to report a bug, you can use the [path ranker tool](https://paths.esm.dev/?p=AAMeJSyAwR4UbFDAFxAcAGAIJXMAAA..#). It supports sharing your routes through the URL.