From: Eduardo San Martin Morote <posva13@gmail.com>
Date: Tue, 6 Oct 2020 12:24:24 +0000 (+0200)
Subject: docs(migration): add notes about encoding
X-Git-Tag: v4.0.0-rc.1~39
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=3e324b3a675966ce0ff68c19c1f36139752fa988;p=thirdparty%2Fvuejs%2Frouter.git

docs(migration): add notes about encoding
---

diff --git a/docs/guide/migration/index.md b/docs/guide/migration/index.md
index ec94b462..3cf58629 100644
--- a/docs/guide/migration/index.md
+++ b/docs/guide/migration/index.md
@@ -91,15 +91,16 @@ Note this will work if `path` was `/parent/` as the relative location `home` to
 
 ### `$route` properties Encoding
 
-Decoded values are now consistent no matter where the navigation is initiated (older browsers will still produce unencoded `path` and `fullPath`). The initial navigation should yield the same results as in-app navigations.
+Decoded values in `params`, `query`, and `hash` are now consistent no matter where the navigation is initiated (older browsers will still produce unencoded `path` and `fullPath`). The initial navigation should yield the same results as in-app navigations.
 
 Given any [normalized route location](/api/#routelocationnormalized):
 
-- Values in `path`, `fullPath` are not decoded anymore. They will appear as provided by the browser (modern browsers provide them encoded). e.g. directly writing on the address bar `https://example.com/hello world` will yield the encoded version: `https://example.com/hello%20world` and both `path` and `fullPath` will be `/hello%20world`.
+- Values in `path`, `fullPath` are not decoded anymore. They will appear as provided by the browser (most browsers provide them encoded). e.g. directly writing on the address bar `https://example.com/hello world` will yield the encoded version: `https://example.com/hello%20world` and both `path` and `fullPath` will be `/hello%20world`.
 - `hash` is now decoded, that way it can be copied over: `router.push({ hash: $route.hash })` and be used directly in [scrollBehavior](/api/#scrollbehavior)'s `el` option.
-- When using `push`, `resolve` and `replace` and providing a `string` location or a `path` property in an object, **it must be encoded**. On the other hand, `params`, `query` and `hash` must be provided in its unencoded version.
+- When using `push`, `resolve`, and `replace` and providing a `string` location or a `path` property in an object, **it must be encoded** (like in the previous version). On the other hand, `params`, `query` and `hash` must be provided in its unencoded version.
+- The slash character (`/`) is now properly decoded inside `params` while still producing an encoded version on the URL: `%2F`.
 
-**Reason**: This allows to easily copy existing properties of a location when calling `router.push()` and `router.resolve()`, make it consistent across browsers.
+**Reason**: This allows to easily copy existing properties of a location when calling `router.push()` and `router.resolve()`, and make the resulting route location consistent across browsers. `router.push()` is now idempotent, meaning that calling `router.push(route.fullPath)`, `router.push({ hash: route.hash })`, `router.push({ query: route.query })`, and `router.push({ params: route.params })` will not create extra encoding.
 
 ## Breaking Changes: API Changes