Skip to content

Commit 1d33c51

Browse files
authored
docs: fix typos and uniform punctuation in migration v3 (#5098)
1 parent f6725f8 commit 1d33c51

File tree

4 files changed

+93
-101
lines changed

4 files changed

+93
-101
lines changed

CHANGELOG.en-US.md

+23-25
Original file line numberDiff line numberDiff line change
@@ -240,51 +240,49 @@ Github:[https://github.com/surely-vue/table]
240240

241241
🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥
242242

243-
- Open source documentation
243+
- Open source documentation.
244244
- Removed the `lazy` attribute of Transfer, it does not have a real optimization effect.
245245
- Removed the `combobox` mode of Select, please use `AutoComplete` instead.
246246
- Deprecated Button.Group, please use `Space` instead.
247-
- `Timeline.Item` new label
248-
- `Steps` added `responsive`, `percent`
249-
- `Collapse` added `ghost`, `collapsible`
250-
- `Popconfirm` added `cancelButton`, `okButton`, and `esc` button hiding
251-
- `ConfigProvider` added ConfigProvider.config to define the configuration of `Modal.xxx` `message` `notification`
252-
- `Tree` `TreeSelect`
247+
- `Timeline.Item` new label.
248+
- `Steps` added `responsive`, `percent`.
249+
- `Collapse` added `ghost`, `collapsible`.
250+
- `Popconfirm` added `cancelButton`, `okButton`, and `esc` button hiding.
251+
- `ConfigProvider` added ConfigProvider.config to define the configuration of `Modal.xxx` `message` `notification`.
252+
- `Tree` `TreeSelect`.
253253

254-
- Added virtual scrolling, discarded using `a-tree-node` `a-tree-select-node` to build nodes, using `treeData` property instead to improve component performance
255-
- Deprecated `scopedSlots` `slots` custom rendering node, and replace it with `v-slot:title` to improve ease of use, avoid slot configuration expansion, and also avoid slot conflicts
254+
- Added virtual scrolling, discarded using `a-tree-node` `a-tree-select-node` to build nodes, using `treeData` property instead to improve component performance.
255+
- Deprecated `scopedSlots` `slots` custom rendering node, and replace it with `v-slot:title` to improve ease of use, avoid slot configuration expansion, and also avoid slot conflicts.
256256

257257
- `Table`
258258

259259
- Removed the `rowSelection.hideDefaultSelections` property of Table, please use `SELECTION_ALL` and `SELECTION_INVERT` in `rowSelection.selections` instead, [custom options](/components/table/#components-table-demo- row-selection-custom).
260-
- Removed Column slots and replaced them with `v-slot:headerCell` `v-slot:headerCell` `v-slot:bodyCell` `v-slot:customFilterDropdown` `v-slot:customFilterIcon` to improve ease of use , To avoid slot configuration expansion, but also to avoid the problem of slot conflicts
261-
- Added expandFixed to control whether the expanded icon is fixed
260+
- Removed Column slots and replaced them with `v-slot:headerCell` `v-slot:headerCell` `v-slot:bodyCell` `v-slot:customFilterDropdown` `v-slot:customFilterIcon` to improve ease of use , To avoid slot configuration expansion, but also to avoid the problem of slot conflicts.
261+
- Added expandFixed to control whether the expanded icon is fixed.
262262
- Added the showSorterTooltip header whether to display the tooltip for the next sort.
263-
- Added sticky for setting sticky head and scroll bar
264-
- Added rowExpandable to set whether to allow row expansion
265-
- New slot headerCell is used to personalize the header cell
266-
- Added slot bodyCell for personalized cell
267-
- New slot customFilterDropdown is used to customize the filter menu, which needs to be used with `column.customFilterDropdown`
268-
- Added slot customFilterIcon for custom filter icons
269-
- New slot emptyText is used to customize the display content of empty data
270-
- Added slot summary for the summary column
263+
- Added sticky for setting sticky head and scroll bar.
264+
- Added rowExpandable to set whether to allow row expansion.
265+
- New slot headerCell is used to personalize the header cell.
266+
- Added slot bodyCell for personalized cell.
267+
- New slot customFilterDropdown is used to customize the filter menu, which needs to be used with `column.customFilterDropdown`.
268+
- Added slot customFilterIcon for custom filter icons.
269+
- New slot emptyText is used to customize the display content of empty data.
270+
- Added slot summary for the summary column.
271271

272272
- `DatePicker` `TimePicker` `Calendar`
273273

274274
- By default, a more lightweight dayjs is used to replace momentjs. If your project is too large and uses a lot of momentjs methods, you can refer to the document [Custom Time Library](/docs/vue/replace-date-cn), Replace with momentjs.
275-
- UI interaction adjustment, align with antd 4.x interaction specifications
275+
- UI interaction adjustment, align with antd 4.x interaction specifications.
276276

277277
- `Form` The main goal of this update is to improve performance. If you don't have custom form controls, you can almost ignore this part
278278

279279
- Since version 3.0, Form.Item no longer hijacks child elements, but automatically checks through provider/inject dependency injection. This method can improve component performance, and there is no limit to the number of child elements. The same is true for child elements. It can be a high-level component that is further encapsulated.
280280

281-
You can reference [Customized Form Controls](#components-form-demo-customized-form-controls)
282-
283-
But it also has some disadvantages:
281+
You can reference [Customized Form Controls](#components-form-demo-customized-form-controls), but it also has some disadvantages:
284282

285283
1. If the custom component wants Form.Item to be verified and displayed, you need to inject `const {id, onFieldChange, onFieldBlur} = useFormItemContext()` and call the corresponding method.
286284

287-
2. A Form.Item can only collect the data of one form item. If there are multiple form items, it will cause collection confusion, for example,
285+
2. A Form.Item can only collect the data of one form item. If there are multiple form items, it will cause collection confusion. For example,
288286

289287
```html
290288
<a-form-item>
@@ -293,7 +291,7 @@ Github:[https://github.com/surely-vue/table]
293291
</a-form-item>
294292
```
295293

296-
As above Form.Item does not know whether to collect `name="a"` or `name=`b``, you can solve this kind of problem in the following two ways:
294+
As above Form.Item does not know whether to collect `name="a"` or `name="b"`, you can solve this kind of problem in the following two ways:
297295

298296
The first is to use multiple `a-form-item`:
299297

CHANGELOG.zh-CN.md

+23-25
Original file line numberDiff line numberDiff line change
@@ -239,49 +239,47 @@ Github:[https://github.com/surely-vue/table]
239239

240240
🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥
241241

242-
- 文档开源,如果您的公司不能外网访问,可以私有化部署,但不可以传播,不可以商业化
242+
- 文档开源,如果您的公司不能外网访问,可以私有化部署,但不可以传播,不可以商业化
243243
- 移除了 Transfer 的 `lazy` 属性,它并没有起到真正的优化效果。
244244
- 移除了 Select 的 `combobox` 模式,请使用 `AutoComplete` 替代。
245245
- 废弃 Button.Group,请使用 `Space` 代替。
246-
- `Timeline.Item` 新增 label
247-
- `Steps` 新增 `responsive``percent`
248-
- `Collapse` 新增 `ghost``collapsible`
249-
- `Popconfirm` 新增 `cancelButton``okButton`, 以及 `esc` 按键隐藏
250-
- `ConfigProvider` 新增 ConfigProvider.config,定义 `Modal.xxx` `message` `notification` 的配置
246+
- `Timeline.Item` 新增 label
247+
- `Steps` 新增 `responsive``percent`
248+
- `Collapse` 新增 `ghost``collapsible`
249+
- `Popconfirm` 新增 `cancelButton``okButton`, 以及 `esc` 按键隐藏
250+
- `ConfigProvider` 新增 ConfigProvider.config,定义 `Modal.xxx` `message` `notification` 的配置
251251
- `Tree` `TreeSelect`
252252

253-
- 新增了虚拟滚动,废弃使用 `a-tree-node` `a-tree-select-node` 构建节点,使用 `treeData` 属性替代,提升组件性能
254-
- 废弃 `scopedSlots` `slots` 自定义渲染节点,使用 `v-slot:title` 替换,提升易用性,避免插槽配置膨胀,同时也避免了插槽冲突问题
253+
- 新增了虚拟滚动,废弃使用 `a-tree-node` `a-tree-select-node` 构建节点,使用 `treeData` 属性替代,提升组件性能
254+
- 废弃 `scopedSlots` `slots` 自定义渲染节点,使用 `v-slot:title` 替换,提升易用性,避免插槽配置膨胀,同时也避免了插槽冲突问题
255255

256256
- `Table`
257257

258258
- 移除了 Table 的 `rowSelection.hideDefaultSelections` 属性,请在 `rowSelection.selections` 中使用 `SELECTION_ALL``SELECTION_INVERT` 替代,[自定义选择项](/components/table/#components-table-demo-row-selection-custom)
259-
- 移除了 Column slots,分别使用 `v-slot:headerCell` `v-slot:headerCell` `v-slot:bodyCell` `v-slot:customFilterDropdown` `v-slot:customFilterIcon` 替换,提升易用性,避免插槽配置膨胀,同时也避免了插槽冲突问题
260-
- 新增 expandFixed 控制展开图标是否固定
259+
- 移除了 Column slots,分别使用 `v-slot:headerCell` `v-slot:headerCell` `v-slot:bodyCell` `v-slot:customFilterDropdown` `v-slot:customFilterIcon` 替换,提升易用性,避免插槽配置膨胀,同时也避免了插槽冲突问题
260+
- 新增 expandFixed 控制展开图标是否固定
261261
- 新增 showSorterTooltip 表头是否显示下一次排序的 tooltip 提示。
262-
- 新增 sticky 用于设置粘性头部和滚动条
263-
- 新增 rowExpandable 用于设置是否允许行展开
264-
- 新增插槽 headerCell 用于个性化头部单元格
265-
- 新增插槽 bodyCell 用于个性化单元格
266-
- 新增插槽 customFilterDropdown 用于自定义筛选菜单,需要配合 `column.customFilterDropdown` 使用
267-
- 新增插槽 customFilterIcon 用于自定义筛选图标
268-
- 新增插槽 emptyText 用于自定义空数据时的显示内容
269-
- 新增插槽 summary 用于总结栏
262+
- 新增 sticky 用于设置粘性头部和滚动条
263+
- 新增 rowExpandable 用于设置是否允许行展开
264+
- 新增插槽 headerCell 用于个性化头部单元格
265+
- 新增插槽 bodyCell 用于个性化单元格
266+
- 新增插槽 customFilterDropdown 用于自定义筛选菜单,需要配合 `column.customFilterDropdown` 使用
267+
- 新增插槽 customFilterIcon 用于自定义筛选图标
268+
- 新增插槽 emptyText 用于自定义空数据时的显示内容
269+
- 新增插槽 summary 用于总结栏
270270

271271
- `DatePicker` `TimePicker` `Calendar`
272272

273273
- 默认使用更加轻量级的 dayjs 替换 momentjs,如果你的项目过大,使用了大量的 momentjs 的方法,你可以参考文档[自定义时间库](/docs/vue/replace-date-cn),替换成 momentjs。
274-
- UI 交互调整,对齐 antd 4.x 交互规范
274+
- UI 交互调整,对齐 antd 4.x 交互规范
275275

276276
- `Form` 这次更新主要目标是提升性能,如果你没有自定义表单控件,几乎可以忽略该部分
277277

278-
- 自 3.0 版本以后,Form.Item 不再劫持子元素,而是通过 provider / inject 依赖注入的方式进行自动校验,这种方式可以提高组件性能,子元素也不会限制个数,同样子元素也可以是进一步封装的高级组件。你可以参考[自定义表单控件示例](#components-form-demo-customized-form-controls)
279-
280-
但它同样会有一些缺点:
278+
- 自 3.0 版本以后,Form.Item 不再劫持子元素,而是通过 provider / inject 依赖注入的方式进行自动校验,这种方式可以提高组件性能,子元素也不会限制个数,同样子元素也可以是进一步封装的高级组件。你可以参考[自定义表单控件示例](#components-form-demo-customized-form-controls),但它同样会有一些缺点:
281279

282280
1、自定义组件如果希望 Form.Item 进行校验展示,你需要 `const {id, onFieldChange, onFieldBlur} = useFormItemContext()` 注入,并调用相应的方法。
283281

284-
2、一个 Form.Item 只能收集一个表单项的数据,如果有多个表单项,会导致收集错乱,例如,
282+
2、一个 Form.Item 只能收集一个表单项的数据,如果有多个表单项,会导致收集错乱。例如:
285283

286284
```html
287285
<a-form-item>
@@ -290,7 +288,7 @@ Github:[https://github.com/surely-vue/table]
290288
</a-form-item>
291289
```
292290

293-
如上 Form.Item 并不知道需要收集 `name="a"` 还是 `name=`b``,你可以通过如下三种方式去解决此类问题:
291+
如上 Form.Item 并不知道需要收集 `name="a"` 还是 `name="b"`,你可以通过如下三种方式去解决此类问题:
294292

295293
第一种,使用多个 `a-form-item`:
296294

@@ -301,7 +299,7 @@ Github:[https://github.com/surely-vue/table]
301299
</a-form-item>
302300
```
303301

304-
第二种,使用自定义组件包裹,并在自定义组件中调用 `useFormItemContext`,相当于把多个表单项合并成了一个
302+
第二种,使用自定义组件包裹,并在自定义组件中调用 `useFormItemContext`,相当于把多个表单项合并成了一个
305303

306304
```html
307305
<script>

0 commit comments

Comments
 (0)