docs: improve migration guide (#11196)

This commit is contained in:
neverland 2022-10-30 20:40:10 +08:00 committed by GitHub
parent 3faf04c02e
commit 45f7adc701
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -41,13 +41,14 @@ import { showToast, showDialog } from 'vant';
而 CSS 代码的引入方式可以从以下两种方式中进行选择: 而 CSS 代码的引入方式可以从以下两种方式中进行选择:
- 通过 [unplugin-vue-components](https://github.com/antfu/unplugin-vue-components) 插件实现按需引入样式,详细用法参见 [快速上手](#/zh-CN/quickstart)。
- 在项目中全量引入 Vant 的样式文件: - 在项目中全量引入 Vant 的样式文件:
```js ```js
import 'vant/lib/index.css'; import 'vant/lib/index.css';
``` ```
- 通过 [unplugin-vue-components](https://github.com/antfu/unplugin-vue-components) 插件实现按需引入样式,详细用法参见 [快速上手](#/zh-CN/quickstart)。
## 组件重构 ## 组件重构
### 介绍 ### 介绍
@ -58,12 +59,13 @@ import 'vant/lib/index.css';
- `Picker` - `Picker`
- `DatetimePicker` - `DatetimePicker`
之所以重构这三个组件,是因为在之前的版本中,`Picker` 组件的 API 设计存在一些不合理的设计,导致大家在使用时经常遇到问题,比如: 这三个组件之所以重构,是因为在之前的版本中,`Picker` 组件的 API 设计存在一些不合理的设计,导致大家在使用时经常遇到问题,比如:
- columns 数据格式定义不合理,容易产生误解 - Picker columns 数据格式定义不合理,容易产生误解
- 数据流不清晰,暴露了过多的实例方法来对数据进行操作 - Picker 数据流不清晰,暴露了过多的实例方法来对数据进行操作
- DatetimePicker 逻辑过于复杂,经常在边界场景下出现 bug
为了解决上述问题,我们在 v4 版本中对 `Picker` 组件进行了重构,同时也重构了基于 `Picker` 派生出的 `Area``DatetimePicker` 组件。 为了解决上述问题,我们在 v4 版本中对 `Picker` 组件进行了重构,同时也重构了基于 `Picker` 派生出的 `Area``DatetimePicker` 组件。如果你的项目中使用了这三个组件,请仔细阅读文档并进行升级。
### Picker 组件重构 ### Picker 组件重构
@ -81,11 +83,11 @@ import 'vant/lib/index.css';
### DatetimePicker 组件重构 ### DatetimePicker 组件重构
DatetimePicker 组件被拆分为: DatetimePicker 组件被拆分为三个子组件
- [TimePicker](#/zh-CN/time-picker): 用于时间选择。 - [TimePicker](#/zh-CN/time-picker): 用于时间选择,包括时、分、秒
- [DatePicker](#/zh-CN/date-picker): 用于日期选择。 - [DatePicker](#/zh-CN/date-picker): 用于日期选择,包括年、月、日
- [PickerGroup](#/zh-CN/picker-group): 用于用于结合多个 Picker 选择器组件。 - [PickerGroup](#/zh-CN/picker-group): 用于结合多个 Picker 选择器组件,在一次交互中完成多个值的选择
同时TimePicker 和 DatePicker 组件也基于新版 Picker 组件进行重构,并优化了部分 API 设计。 同时TimePicker 和 DatePicker 组件也基于新版 Picker 组件进行重构,并优化了部分 API 设计。
@ -103,7 +105,7 @@ DatetimePicker 组件被拆分为:
### Area 组件重构 ### Area 组件重构
Area 组件是基于 Picker 组件进行封装的,因此本次升级也对 Area 组件进行了内部逻辑的重构,并优化了部分 API 设计 Area 组件是基于 Picker 组件进行封装的,因此本次升级也对 Area 组件进行了内部逻辑的重构,并优化了部分 API。
#### 主要变更 #### 主要变更
@ -123,7 +125,7 @@ Area 组件是基于 Picker 组件进行封装的,因此本次升级也对 Are
在 Vant 3 中,`Dialog` 是一个函数,调用函数可以快速唤起全局的弹窗组件,而 `Dialog.Component` 才是 `Dialog` 组件对象,这与大部分组件的用法存在差异,容易导致使用错误。 在 Vant 3 中,`Dialog` 是一个函数,调用函数可以快速唤起全局的弹窗组件,而 `Dialog.Component` 才是 `Dialog` 组件对象,这与大部分组件的用法存在差异,容易导致使用错误。
为了更符合直觉,我们在 Vant 4 中调整了 `Dialog` 的调用方式,将 `Dialog()` 函数重命名为 `showDialog()` 为了更符合直觉,我们在 Vant 4 中调整了 `Dialog` 的调用方式,将 `Dialog()` 函数重命名为 `showDialog()`,并让 `Dialog` 直接指向组件对象
```js ```js
// Vant 3 // Vant 3
@ -135,7 +137,7 @@ showDialog(); // 函数调用
Dialog; // 组件对象 Dialog; // 组件对象
``` ```
`Dialog` 上挂载的其他方法也进行了重命名,新旧 API 的映射关系如下: 由于 `Dialog` 变为了组件对象,`Dialog` 上挂载的其他方法也进行了重命名,新旧 API 的映射关系如下:
```js ```js
Dialog(); // -> showDialog() Dialog(); // -> showDialog()
@ -148,7 +150,22 @@ Dialog.resetDefaultOptions(); // -> resetDialogDefaultOptions()
#### 兼容方案 #### 兼容方案
为了便于代码迁移,我们提供了兼容方案,你可以使用 `@vant/compat` 中导出的 `Dialog` 对象来兼容原有代码。 为了便于旧版本代码迁移至 v4我们提供了兼容方案你可以使用 `@vant/compat` 中导出的 `Dialog` 对象来兼容原有代码。
第一步,安装 `@vant/compat` 包:
```bash
# 通过 npm 安装
npm add @vant/compat
# 通过 yarn 安装
yarn add @vant/compat
# 通过 pnpm 安装
pnpm add @vant/compat
```
第二步,从 `@vant/compat` 中引用 `Dialog` 方法:
```js ```js
import { Dialog } from '@vant/compat'; import { Dialog } from '@vant/compat';
@ -159,6 +176,8 @@ Dialog.close();
`@vant/compat` 中导出的 `Dialog` 与 Vant 3 中的 `Dialog` 拥有完全一致的 API 和行为,因此你只需要修改 `Dialog` 的引用路径,其他代码可以保持不变。 `@vant/compat` 中导出的 `Dialog` 与 Vant 3 中的 `Dialog` 拥有完全一致的 API 和行为,因此你只需要修改 `Dialog` 的引用路径,其他代码可以保持不变。
在项目完成升级到 Vant v4 后,建议在迭代中逐步替换为新的 `showDialog` 等方法,并移除 `@vant/compat` 包。
### Toast 调用方式调整 ### Toast 调用方式调整
Vant 4 中,`Toast` 组件的调用方式也进行了调整,与 `Dialog` 组件的改动一致: Vant 4 中,`Toast` 组件的调用方式也进行了调整,与 `Dialog` 组件的改动一致:
@ -275,14 +294,14 @@ emit('click-input');
emit('clickInput'); emit('clickInput');
``` ```
这项改动**不影响原有的模板代码**Vue 会自动在模板中对事件名进行格式转换 这项改动**不影响原有的模板代码**Vue 会自动在模板中对事件名进行格式转换,因此你无须做任何更改。
```html ```html
<!-- 以下代码可以照常运行,无须做任何更改 --> <!-- 以下代码可以照常运行,无须做任何更改 -->
<van-field @click-input="onClick" /> <van-field @click-input="onClick" />
``` ```
如果你在 JSX 中使用 Vant 组件,需要将监听的事件名调整为驼峰格式,新的监听方式更加符合 JSX 本身的规范: 如果你在 JSX 中使用 Vant 组件,需要将监听的事件名调整为驼峰格式,原有的中划线格式将不再生效,新的监听方式更加符合 JSX 本身的规范:
```jsx ```jsx
// Vant 3 // Vant 3
@ -305,7 +324,7 @@ emit('clickInput');
#### Popup #### Popup
Popup 的 CSS 样式进行了一定调整,请确认是否对项目中的 UI 产生影响。 Popup 的 CSS 样式进行了一定调整,如果你在 Popup 组件上添加了一些自定义的 CSS 样式,请确认本次升级是否对项目中的 UI 产生影响。
- 默认添加了 `box-sizing: border-box` 样式 - 默认添加了 `box-sizing: border-box` 样式
- 调整了 `position="center"` 时的水平居中方式,以解决弹窗宽度无法正确自适应的问题: - 调整了 `position="center"` 时的水平居中方式,以解决弹窗宽度无法正确自适应的问题:
@ -336,7 +355,7 @@ Popup 的 CSS 样式进行了一定调整,请确认是否对项目中的 UI
### 移除 Less 变量 ### 移除 Less 变量
目前 Vant 已经支持了基于 CSS 变量的主题定制能力,因此后续将不再提供基于 Less 的主题定制方式。 目前 Vant 已经支持了基于 CSS 变量的主题定制能力,相较于 Less 定制更加灵活。因此Vant 4 将不再提供基于 Less 的主题定制方式。
这意味着 Vant 的 npm 包中将不再会包含 `.less` 样式源文件,只会提供编译后的 `.css` 样式文件。 这意味着 Vant 的 npm 包中将不再会包含 `.less` 样式源文件,只会提供编译后的 `.css` 样式文件。
@ -344,7 +363,9 @@ Popup 的 CSS 样式进行了一定调整,请确认是否对项目中的 UI
### 简化 CSS 变量名 ### 简化 CSS 变量名
考虑到 **代码体积****使用便捷性**,我们对部分 CSS 变量的名称进行了简化,在变量名中使用更简短的单词,涉及以下变更: 考虑到 **代码体积****使用便捷性**,我们对部分 CSS 变量的名称进行了简化,在变量名中使用了更简短的单词,以减小代码体积。
本次升级涉及以下变量名变更:
```less ```less
animation-duration -> duration animation-duration -> duration
@ -363,3 +384,13 @@ transition-duration -> duration
``` ```
由于涉及的 CSS 变量较多,建议在代码仓库中进行全局匹配和替换。 由于涉及的 CSS 变量较多,建议在代码仓库中进行全局匹配和替换。
对于 `ConfigProvider` 组件,我们新增了 `ConfigProviderThemeVars` 类型定义,提供完整的类型提示。在 TypeScript 代码中,你可以通过类型提示来确保主题变量被正确替换。
```ts
import type { ConfigProviderThemeVars } from 'vant';
const themeVars: ConfigProviderThemeVars = {
sliderBarHeight: '4px',
};
```