From c7d324cb7fa2d37503228684cba90aa62d64fa44 Mon Sep 17 00:00:00 2001 From: chenjiahan Date: Sat, 22 Aug 2020 14:26:29 +0800 Subject: [PATCH] docs: update migrate guide --- docs/markdown/migrate-from-v2.zh-CN.md | 65 +++++++++++++++++++++----- vant.config.js | 2 +- 2 files changed, 54 insertions(+), 13 deletions(-) diff --git a/docs/markdown/migrate-from-v2.zh-CN.md b/docs/markdown/migrate-from-v2.zh-CN.md index 4c2b1fa21..0194738a6 100644 --- a/docs/markdown/migrate-from-v2.zh-CN.md +++ b/docs/markdown/migrate-from-v2.zh-CN.md @@ -1,4 +1,18 @@ -# 从 2.x 版本迁移 +# 从 v2 升级 + +### 介绍 + +本文档提供了从 Vant 2 到 Vant 3 的升级指南。 + +### 升级步骤 + +#### 1. 升级 Vue 3 + +Vant 3 是基于 Vue 3 开发的,在使用 Vant 3 前,请将项目中的 Vue 升级到 3.0 以上版本。 + +#### 2. 处理不兼容更新 + +Vant 2 到 Vant 3 存在一些不兼容更新,请仔细阅读下方的不兼容更新内容,并依次处理。 ## 不兼容更新 @@ -51,6 +65,7 @@ GoodsAction 商品导航组件重命名为 **ActionBar 行动栏**。 ```html + ``` @@ -75,6 +90,7 @@ GoodsAction 商品导航组件重命名为 **ActionBar 行动栏**。 ```html + ``` @@ -102,6 +118,14 @@ GoodsAction 商品导航组件重命名为 **ActionBar 行动栏**。 同时内部使用的 Info 组件也会重命名为 Badge。 +```html + + + + + +``` + ### 重命名 get-container 属性 Vue 3.0 中增加了 `Teleport` 组件,提供将组件渲染到任意 DOM 位置的能力,Vant 2.x 也通过 `get-container` 属性提供了类似的能力。为了与官方的 API 保持一致,Vant 中的 `get-container` 属性将重命名为 `teleport`。 @@ -138,17 +162,34 @@ Vue 3.0 中增加了 `Teleport` 组件,提供将组件渲染到任意 DOM 位 ### API 调整 -- Area: 移除 change 事件的第一个参数(picker 实例) -- Button: 蓝色按钮对应的类型由 `info` 调整为 `primary` -- Button: 绿色按钮对应的类型由 `primary` 调整为 `success` -- Picker: 移除 change 事件的第一个参数(picker 实例) -- Picker: 默认开启 show-toolbar 属性 -- Picker: 级联选择下,confirm/change 事件返回的回调参数将包含为完整的选项对象。 -- SwipeCell: `open` 事件的 `detail` 参数重命名为 `name` -- SwipeCell: `on-close` 属性重命名为 `before-close`,并调整参数结构 -- Toast: `mask` 属性重命名为 `overlay` -- TreeSelect: `navclick` 事件重命名为 `click-nav` -- TreeSelect: `itemclick` 事件重命名为 `click-item` +#### Area + +- 移除 change 事件的第一个参数(picker 实例) + +#### Button + +- 蓝色按钮对应的类型由 `info` 调整为 `primary` +- 绿色按钮对应的类型由 `primary` 调整为 `success` + +#### Picker + +- 移除 change 事件的第一个参数(picker 实例) +- 默认开启 show-toolbar 属性 +- 级联选择下,confirm/change 事件返回的回调参数将包含为完整的选项对象。 + +#### SwipeCell + +- `open` 事件的 `detail` 参数重命名为 `name` +- `on-close` 属性重命名为 `before-close`,并调整参数结构 + +#### Toast + +- `mask` 属性重命名为 `overlay` + +#### TreeSelect + +- `navclick` 事件重命名为 `click-nav` +- `itemclick` 事件重命名为 `click-item` ### 注册全局方法 diff --git a/vant.config.js b/vant.config.js index 9710bdba0..ab4cdd03e 100644 --- a/vant.config.js +++ b/vant.config.js @@ -55,7 +55,7 @@ module.exports = { }, { path: 'migrate-from-v2', - title: '从 2.x 版本迁移', + title: '从 v2 升级', }, { path: 'theme',