V1.0.0 升级指南

[danranVm]

• [x] I have searched the issues of this repository and believe that this is not a duplicate.

欢迎来到 @idux 的第一个正式版本，之前版本的用户请参考下列注意事项进行升级。

如果在升级过程中遇到问题，欢迎提出。 如果发现本指南存在遗漏/错误，请指出! 或者你遇到了新的问题并解决了，欢迎补充!

开始之前

1. 首先确保你 Node.js >= 16.10.0
2. 创建新的分支，或者使用其他方式备份当前项目

升级步骤

• 将 @idux/cdk, @idux/components 和 @idux/pro 全部升级到 v1.0.0-rc.9 版本
• 参考下面列出的 breaking changes， 按照提示修改代码
• 运行项目，确保控制台没有 @idux 的警告日志
• 将 @idux/cdk, @idux/components 和 @idux/pro 全部升级到 v1.0.0 正式版本

注意事项

• Select, RadioGroup 和 CheckboxGroup 的 dataSource 默认使用 key 作为选项的值，不再兼容 value, 必须指定 getKey="value"

  <script lang="ts">
    const dataSource = [{ label: 'Tom', value: 'tom'}, { label: 'Jerry', value: 'jerry' }]
  </script>
  <template>
    <IxSelect :dataSource="dataSource" getKey="value" />
  </template>
  

V1.0.0 breaking changes

下面列举出了从 alpha.0 - rc.9 版本间所有的破坏性变更。

CDK

• click-outside
  • the clickOutside was deprecated, please use vClickOutside instead'
• forms
  • the trim of ValidatorOptions was deprecated.
  • the setValidator was deprecated, please use setValidators instead.
  • the setAsyncValidator was deprecated, please use setAsyncValidators instead.
  • the useValueControl was deprecated, please use useControl or useAccessorAndControl instead.
  • the useValueAccessor was deprecated, please use useAccessor or useAccessorAndControl instead.
• popper
  • the modifiers was deprecated, please use middlewares instead.
  • the forceUpdate was deprecated.
  • the onFirstUpdate was deprecated.
• resize
  • the const { stop } = useResizeObserver() was deprecated, please use const stop = useResizeObserver() instead.
• scroll
  • the itemKey of VirtualScrollProps was deprecated, please use getKey instead.

Components

• cascader
  • the additional of CascaderData was deprecated, please use customAdditional instead.
• checkbox
  • the options was deprecated, please use dataSource instead.
• config
  • the target of DrawerConfig was deprecated, please use container instead.
  • the target of DropdownConfig was deprecated, please use overlayContainer instead.
  • the target of ImageViewerConfig was deprecated, please use container instead.
  • the target of MenuConfig was deprecated, please use overlayContainer instead.
  • the target of MessageConfig was deprecated, please use container instead.
  • the target of ModalConfig was deprecated, please use container instead.
  • the target of NotificationConfig was deprecated, please use container instead.
  • the target of PopconfirmConfig was deprecated, please use overlayContainer instead.
  • the target of PopoverConfig was deprecated, please use overlayContainer instead.
  • the target of SelectConfig was deprecated, please use overlayContainer instead.
  • the valueKey of SelectConfig was deprecated, please use getKey instead.
  • the rowKey of TableConfig was deprecated, please use getKey instead.
  • the target of TooltipConfig was deprecated, please use overlayContainer instead.
  • the nodeKey of TreeConfig was deprecated, please use getKey instead.
  • the nodeKey of TreeSelectConfig was deprecated, please use getKey instead.
  • the target of TreeSelectConfig was deprecated, please use overlayContainer instead.
• divider
  • the position was deprecated, please use labelPlacement instead.
  • the type was deprecated, please use vertical instead.
• drawer
  • the target was deprecated, please use container instead.
  • the wrapperClassName was deprecated.
• dropdown
  • the target was deprecated, please use overlayContainer instead.
• form
  • the hasFeedback was deprecated.
  • the statusIcon was deprecated.
  • the extra was deprecated, please use description instead.
  • the extraMessage was deprecated, please use description instead.
  • the useFormAccessor was deprecated, please use useAccessorAndControl + useFormItemRegister instead.
• image
  • the target was deprecated, please use container instead.
• menu
  • the target was deprecated, please use overlayContainer instead.
  • the additional of MenuIData was deprecated, please use customAdditional instead'.
  • the slots of MenuData was deprecated, please use customIcon and customLabel instead'.
• message
  • the target was deprecated, please use container instead.
• modal
  • the target was deprecated, please use container instead.
  • the wrapperClassName was deprecated.
• notification
  • the target was deprecated, please use container instead.
• radio
  • the options was deprecated, please use dataSource instead.
• select
  • the maxLabelCount was deprecated, please use maxLabel instead.
  • the options was deprecated, please use dataSource instead.
  • the searchFilter was deprecated, please use searchFn instead'.
  • the target was deprecated, please use overlayContainer instead.
  • the valueKey was deprecated, please use getKey instead.
  • the additional of SelectData was deprecated, please use customAdditional instead.
• space
  • the direction was deprecated, please use vertical instead.
  • the split was deprecated, please use separator instead.
• table
  • the rowClassName was deprecated, please use customAdditional instead.
  • the rowKey was deprecated, please use getKey instead.
  • the scrll.x was deprecated, please use scrll.width instead.
  • the scrll.y was deprecated, please use scrll.height instead.
  • the additional of TableColumn was deprecated, please use customAdditional instead'.
  • the customRender of TableColumn was deprecated, please use customCell of TableColumn instead'.
  • the responsive of TableColumn was deprecated.
• tooltip, popover, popconfirm
  • the target was deprecated, please use overlayContainer instead.
• tree
  • the cascade and checkStrategy are deprecated, please use cascaderStrategy instead.
  • the nodeKey are deprecated, please use getKey instead.
  • the additional of TreeNode was deprecated, please use customAdditional instead'.
• tree-select
  • the cascade and checkStrategy are deprecated, please use cascaderStrategy instead.
  • the maxLabelCount are deprecated, please use maxLabel instead.
  • the nodeKey are deprecated, please use getKey instead.
  • the target are deprecated, please use overlayContainer instead.
  • the additional of TreeNode was deprecated, please use customAdditional instead.
• typography
  • the directive was deprecated.