From a8fe4fcecf59b3a25d7dd8796643870f85069e2f Mon Sep 17 00:00:00 2001 From: Cr <631807682@qq.com> Date: Thu, 22 Aug 2019 18:00:54 +0800 Subject: [PATCH] docs(zh): add promise based push/replace (#2898) * docs(zh): add promise based push/replace * docs(zh): clarifying omit the 2nd and 3rd parameter behaviour * Update docs/zh/guide/essentials/navigation.md Co-Authored-By: GU Yiling --- docs/zh/api/README.md | 2 ++ docs/zh/guide/essentials/navigation.md | 2 +- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/zh/api/README.md b/docs/zh/api/README.md index 484d13c0a..c099be171 100644 --- a/docs/zh/api/README.md +++ b/docs/zh/api/README.md @@ -316,7 +316,9 @@ router.afterEach((to, from) => {}) ``` js router.push(location, onComplete?, onAbort?) +router.push(location).then(onComplete).catch(onAbort) router.replace(location, onComplete?, onAbort?) +router.replace(location).then(onComplete).catch(onAbort) router.go(n) router.back() router.forward() diff --git a/docs/zh/guide/essentials/navigation.md b/docs/zh/guide/essentials/navigation.md index 24fdf463a..488e919f5 100644 --- a/docs/zh/guide/essentials/navigation.md +++ b/docs/zh/guide/essentials/navigation.md @@ -46,7 +46,7 @@ router.push({ path: '/user', params: { userId }}) // -> /user 同样的规则也适用于 `router-link` 组件的 `to` 属性。 -在 2.2.0+，可选的在 `router.push` 或 `router.replace` 中提供 `onComplete` 和 `onAbort` 回调作为第二个和第三个参数。这些回调将会在导航成功完成 (在所有的异步钩子被解析之后) 或终止 (导航到相同的路由、或在当前导航完成之前导航到另一个不同的路由) 的时候进行相应的调用。 +在 2.2.0+，可选的在 `router.push` 或 `router.replace` 中提供 `onComplete` 和 `onAbort` 回调作为第二个和第三个参数。这些回调将会在导航成功完成 (在所有的异步钩子被解析之后) 或终止 (导航到相同的路由、或在当前导航完成之前导航到另一个不同的路由) 的时候进行相应的调用。在 3.1.0+，可以省略第二个和第三个参数，此时如果支持 Promise，`router.push` 或 `router.replace` 将返回一个 Promise。 **注意**： 如果目的地和当前路由相同，只有参数发生了改变 (比如从一个用户资料到另一个 `/users/1` -> `/users/2`)，你需要使用 [`beforeRouteUpdate`](./dynamic-matching.md#响应路由参数的变化) 来响应这个变化 (比如抓取用户信息)。