升级到 Ionic 6
按照本指南将您的 Ionic 5 应用升级到 Ionic 6。
开始
Angular
- Ionic 6 支持 Angular 12+。通过查阅 Angular 更新指南 更新到最新版本的 Angular。
- 更新到最新版本的 Ionic 6:
npm install @ionic/angular@6
如果您使用的是 Ionic Angular Server,也请同时更新:
npm install @ionic/angular@6 @ionic/angular-server@6
- 移除所有
Config.set()的使用。改为在IonicModule.forRoot()中设置您的配置。更多示例请参阅配置文档。 - 移除之前从
@ionic/angular导出的setupConfig函数的使用。改为在IonicModule.forRoot()中设置您的配置。
React
- Ionic 6 支持 React 17+。更新到最新版本的 React:
npm install react@latest react-dom@latest
- 更新到最新版本的 Ionic 6:
npm install @ionic/react@6 @ionic/react-router@6
- 更新
package.json中scripts对象的test字段,添加transformIgnorePatterns:
"scripts": {
"test": "react-scripts test --transformIgnorePatterns 'node_modules/(?!(@ionic/react|@ionic/react-router|@ionic/core|@stencil/core|ionicons)/)'",
...
}
- 在
App组件文件中导入并调用setupIonicReact。如果您同时在使用setupConfig,请将配置传递给setupIonicReact:
之前
import { setupConfig } from '@ionic/react';
...
setupConfig({
mode: 'md'
});
之后
import { setupIonicReact } from '@ionic/react';
...
setupIonicReact({
mode: 'md'
});
即使开发者没有设置自定义配置,也必须导入并调用 setupIonicReact。
更多示例请参阅配置文档。
- 将所有从
@ionic/core导入的控制器引用更新为从@ionic/core/components导入。以下是menuController的迁移示例:
之前
import { menuController } from '@ionic/core';
之后
import { menuController } from '@ionic/core/components';
Vue
- Ionic 6 支持 Vue 3.0.6+。更新到最新版本的 Vue:
npm install vue@3 vue-router@4
- 对于使用 Vue CLI 的应用,请安装 Vue CLI 5:
npm install -g @vue/cli@next
然后,升级所有 Vue CLI 插件:
vue upgrade --next
- 更新到最新版本的 Ionic 6:
npm install @ionic/vue@6 @ionic/vue-router@6
- 在
jest.config.js或package.json的jest字段中添加以下transformIgnorePatterns:
module.exports = {
...
transformIgnorePatterns: ['/node_modules/(?!@ionic/vue|@ionic/vue-router|@ionic/core|@stencil/core|ionicons)']
}
{
...
"jest": {
"transformIgnorePatterns": ["/node_modules/(?!@ionic/vue|@ionic/vue-router|@ionic/core|@stencil/core|ionicons)"]
}
}
更多信息请参阅下面的测试部分。
-
移除之前从
@ionic/vue导出的setupConfig函数的使用。改为在安装IonicVue插件时设置您的配置。更多示例请参阅配置文档。 -
将
useIonRouter的IonRouter类型重命名为UseIonRouterResult。 -
将
useKeyboard的IonKeyboardRef类型重命名为UseKeyboardResult。 -
将覆盖层事件监听器更新为使用新格式:
之前
<ion-modal
:is-open="modalOpenRef"
@onWillPresent="onModalWillPresentHandler"
@onDidPresent="onModalDidPresentHandler"
@onWillDismiss="onModalWillDismissHandler"
@onDidDismiss="onModalDidDismissHandler"
>
...
</ion-modal>
之后
<ion-modal
:is-open="modalOpenRef"
@willPresent="onModalWillPresentHandler"
@didPresent="onModalDidPresentHandler"
@willDismiss="onModalWillDismissHandler"
@didDismiss="onModalDidDismissHandler"
>
...
</ion-modal>
这适用于 ion-action-sheet、ion-alert、ion-loading、ion-modal、ion-picker、ion-popover 和 ion-toast。
- 在使用
ion-tabs时,请在内部传入一个ion-router-outlet:
之前
<ion-tabs>
<ion-tab-bar slot="bottom"> ... </ion-tab-bar>
</ion-tabs>
<script>
import { IonTabs, IonTabBar } from '@ionic/vue';
import { defineComponent } from 'vue';
export default defineComponent({
components: { IonTabs, IonTabBar },
});
</script>
之后
<ion-tabs>
<ion-router-outlet></ion-router-outlet>
<ion-tab-bar slot="bottom"> ... </ion-tab-bar>
</ion-tabs>
<script>
import { IonTabs, IonTabBar, IonRouterOutlet } from '@ionic/vue';
import { defineComponent } from 'vue';
export default defineComponent({
components: { IonTabs, IonTabBar, IonRouterOutlet },
});
</script>
- 标签页内的额外路由应重写为同级路由而不是子路由:
之前
const routes: Array<RouteRecordRaw> = [
{
path: '/',
redirect: '/tabs/tab1'
},
{
path: '/tabs/',
component: Tabs,
children: [
{
path: '',
redirect: 'tab1'
},
{
path: 'tab1',
component: () => import('@/views/Tab1.vue'),
children: {
{
path: 'view',
component: () => import('@/views/Tab1View.vue')
}
}
},
{
path: 'tab2',
component: () => import('@/views/Tab2.vue')
},
{
path: 'tab3',
component: () => import('@/views/Tab3.vue')
}
]
}
]
之后
const routes: Array<RouteRecordRaw> = [
{
path: '/',
redirect: '/tabs/tab1',
},
{
path: '/tabs/',
component: Tabs,
children: [
{
path: '',
redirect: 'tab1',
},
{
path: 'tab1',
component: () => import('@/views/Tab1.vue'),
},
{
path: 'tab1/view',
component: () => import('@/views/Tab1View.vue'),
},
{
path: 'tab2',
component: () => import('@/views/Tab2.vue'),
},
{
path: 'tab3',
component: () => import('@/views/Tab3.vue'),
},
],
},
];
Core
- 更新到最新版本的 Ionic 6:
npm install @ionic/core@6
更新您的代码
Datetime
-
移除所有
placeholder、pickerOptions、pickerFormat、monthNames、monthShortNames、dayNames和dayShortNames属性的使用。ion-datetime现在会根据设备上设置的语言和区域自动格式化组件内显示的月份名称、日期名称和时间。更多信息请参阅 ion-datetime 本地化文档。 -
移除所有
text和placeholderCSS 阴影部分的使用。 -
移除所有
--padding-bottom、--padding-end、--padding-start、--padding-top和--placeholder-colorCSS 变量的使用。要自定义ion-datetime上的内边距,您可以使用任何paddingCSS 属性。 -
移除所有
open方法的使用。要在覆盖层中显示日期时间,请将其放置在ion-modal或ion-popover组件内部。更多信息请参阅 ion-datetime 使用示例。 -
移除所有
displayFormat或displayTimezone属性的使用。要解析ionChange事件负载中提供的 UTC 字符串,我们建议使用 date-fns。示例请参阅 ion-datetime 日期解析文档。
更多迁移示例请参阅日期时间迁移示例应用。
Icon
Ionic 6 现在搭载了 Ionicons 6。查看 Ionicons 6 重大变更指南 并做必要的更改。
Input
确保不要将 null 作为值传递给 placeholder 属性。我们建议使用 undefined 代替。
Modal
ion-modal 现在使用了 Shadow DOM。将所有针对 ion-modal 内部样式的更新改为使用 ion-modal CSS 变量 或 ion-modal CSS 阴影部分:
之前
ion-modal .modal-wrapper {
...;
}
ion-modal ion-backdrop {
...;
}
之后
ion-modal::part(content) {
...;
}
ion-modal::part(backdrop) {
...;
}
Popover
ion-popover 现在使用了 Shadow DOM。将所有针对 ion-popover 内部样式的更新改为使用 ion-popover CSS 变量 或 ion-popover CSS 阴影部分:
之前
ion-popover .popover-arrow {
...;
}
ion-popover ion-backdrop {
...;
}
ion-popover .popover-content {
...;
}
之后
ion-popover::part(arrow) {
...;
}
ion-popover::part(backdrop) {
...;
}
ion-popover::part(content) {
...;
}
Radio
移除所有 RadioChangeEventDetail 接口的使用。
Select
确保不要将 null 作为值传递给 placeholder 属性。我们建议使用 undefined 代替。
Textarea
确保不要将 null 作为值传递给 placeholder 属性。我们建议使用 undefined 代替。
浏览器支持
Ionic 支持的浏览器列表已经更改。查阅浏览器支持指南以确保您将应用部署到受支持的浏览器上。
如果您有 browserslist 或 .browserslistrc 文件,请将其更新为以下内容:
Chrome >=60
Firefox >=63
Edge >=79
Safari >=13
iOS >=13
测试
Ionic 6 现在以 ES Modules 形式发布。所有主流浏览器都支持 ES Modules,它带来了开发体验和代码维护方面的改进。使用 Jest 进行测试的开发者需要更新其 Jest 配置,因为 Jest 27 尚未完全支持 ES Modules。
此更新涉及使用 Babel 将 Ionic 的 ES Modules 编译为 Jest 可以理解的 CommonJS(CJS)格式。一旦 Jest 提供对 ES Modules 的支持,此更改将不再需要。请参阅 https://github.com/facebook/jest/issues/9430 了解 Jest 中 ES Modules 支持的更新。
如果您是从头开始创建新的 Ionic 应用,我们的 starter 应用中已经为您完成了此配置。对于现有 Ionic 应用的用户,请按照以下步骤让 Jest 与 Ionic 6 配合使用:
- 在您的 Jest 配置中添加一个包含相关 Ionic 包的
transformIgnorePatterns字段。这通常位于jest.config.js或package.json的jest字段中:
module.exports = {
...
transformIgnorePatterns: ['/node_modules/(?!@ionic/core|@stencil/core|ionicons)']
}
{
...
"jest": {
"transformIgnorePatterns": ["/node_modules/(?!@ionic/core|@stencil/core|ionicons)"]
}
}
如果您使用的是 Ionic React 或 Ionic Vue,请确保将相应的包添加到 transformIgnorePatterns 数组中。对于 Ionic React,这包括 @ionic/react 和 @ionic/react-router。对于 Ionic Vue,这包括 @ionic/vue 和 @ionic/vue-router。
对于使用 Create React App(CRA)的开发者,目前无法在 Jest 配置文件中更新 transformIgnorePatterns。这是 CRA 的限制,不是 Ionic 能够控制的。不过,我们可以将 transformIgnorePatterns 直接传递给 react-scripts test 命令:
"scripts": {
"test": "react-scripts test --transformIgnorePatterns 'node_modules/(?!(@ionic/react|@ionic/react-router|@ionic/core|@stencil/core|ionicons)/)'",
...
}
如果您仍然遇到问题,这里有一些可以尝试的方法:
-
确认
@babel/preset-env包含在您的项目级配置中,而不是文件级配置中。这通常意味着在<项目根目录>/babel.config.json中定义 Babel 配置。 -
如果您在
package.json文件中有browserslist/test字段,请确保其设置为current node。
需要升级帮助?
请务必查看 Ionic 6 重大变更指南。一些默认属性和 CSS 变量的值发生了变化,开发者需要了解这些变化。此页面仅列出了需要用户操作的重大变更。
如果您需要升级帮助,请在 Ionic 论坛 上发帖。