跳到主要内容
版本:v8

从 Ionic 5 升级到 6

备注

本指南假定您已将应用更新到 Ionic 5 的最新版本。在开始本指南之前,请确保您已遵循更新到 Ionic 5 指南

破坏性变更

有关从 Ionic 5 到 Ionic 6 的完整破坏性变更列表,请参阅 Ionic Framework 仓库中的破坏性变更文档

开始之前

Angular

  1. Ionic 6 支持 Angular 12+。请按照 Angular 更新指南 更新到最新版本的 Angular。
  2. 更新到最新版本的 Ionic 6:
npm install @ionic/angular@6

如果您正在使用 Ionic Angular Server,请确保也更新它:

npm install @ionic/angular@6 @ionic/angular-server@6
  1. 移除所有 Config.set() 的使用。请改为在 IonicModule.forRoot() 中设置您的配置。更多示例请参阅 Angular 配置文档
  2. 移除所有之前从 @ionic/angular 导出的 setupConfig 函数的使用。请改为在 IonicModule.forRoot() 中设置您的配置。

React

  1. Ionic 6 支持 React 17+。更新到最新版本的 React:
npm install react@latest react-dom@latest
  1. 更新到最新版本的 Ionic 6:
npm install @ionic/react@6 @ionic/react-router@6
  1. 更新 package.jsonscripts 对象的 test 字段,添加 transformIgnorePatterns
"scripts": {
"test": "react-scripts test --transformIgnorePatterns 'node_modules/(?!(@ionic/react|@ionic/react-router|@ionic/core|@stencil/core|ionicons)/)'",
...
}
  1. 在您的 App 组件文件中导入并调用 setupIonicReact。如果您也在使用 setupConfig,请将配置传递给 setupIonicReact 而不是 setupConfig

之前

App.tsx
import { setupConfig } from '@ionic/react';

...

setupConfig({
mode: 'md'
});

之后

App.tsx
import { setupIonicReact } from '@ionic/react';

...

setupIonicReact({
mode: 'md'
});
备注

即使开发者不设置自定义配置,也必须导入并调用 setupIonicReact

更多示例请参阅 React 配置文档

  1. 将所有控制器导入从 @ionic/core 更新为 @ionic/core/components。以下是 menuController 的迁移示例:

之前

import { menuController } from '@ionic/core';

之后

import { menuController } from '@ionic/core/components';

Vue

  1. Ionic 6 支持 Vue 3.0.6+。更新到最新版本的 Vue:
npm install vue@3 vue-router@4
  1. 对于使用 Vue CLI 的应用,请安装 Vue CLI 5:
npm install -g @vue/cli@next

然后,升级所有 Vue CLI 插件:

vue upgrade --next
  1. 更新到最新版本的 Ionic 6:
npm install @ionic/vue@6 @ionic/vue-router@6
  1. 将以下 transformIgnorePatterns 添加到 jest.config.jspackage.jsonjest 字段中:
jest.config.js
module.exports = {
...
transformIgnorePatterns: ['/node_modules/(?!@ionic/vue|@ionic/vue-router|@ionic/core|@stencil/core|ionicons)']
}
package.json
  {
...
"jest": {
"transformIgnorePatterns": ["/node_modules/(?!@ionic/vue|@ionic/vue-router|@ionic/core|@stencil/core|ionicons)"]
}
}

更多信息请参阅下面的测试部分

  1. 移除所有之前从 @ionic/vue 导出的 setupConfig 函数的使用。请改为在安装 IonicVue 插件时设置您的配置。更多示例请参阅 Vue 配置文档

  2. useIonRouterIonRouter 类型重命名为 UseIonRouterResult

  3. useKeyboardIonKeyboardRef 类型重命名为 UseKeyboardResult

  4. 将所有覆盖层事件监听器重命名为使用新格式:

之前

<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-sheetion-alertion-loadingion-modalion-pickerion-popoverion-toast

  1. 在任何使用的 ion-tabs 中传入 ion-router-outlet

之前

<ion-tabs>
<ion-tab-bar slot="bottom"> ... </ion-tab-bar>
</ion-tabs>

<script setup lang="ts">
import { IonTabs, IonTabBar } from '@ionic/vue';
</script>

之后

<ion-tabs>
<ion-router-outlet></ion-router-outlet>
<ion-tab-bar slot="bottom"> ... </ion-tab-bar>
</ion-tabs>

<script setup lang="ts">
import { IonTabs, IonTabBar, IonRouterOutlet } from '@ionic/vue';
</script>
  1. 选项卡内的附加路由应重写为同级路由而非子路由:

之前

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

  1. 更新到最新版本的 Ionic 6:
npm install @ionic/core@6

更新您的代码

Datetime

  1. 移除所有 placeholderpickerOptionspickerFormatmonthNamesmonthShortNamesdayNamesdayShortNames 属性的使用。ion-datetime 现在会根据设备的语言和区域设置自动格式化组件内显示的月份名称、日期名称和时间。更多信息请参阅 ion-datetime 本地化文档

  2. 移除所有 textplaceholder CSS 阴影部分 的使用。

  3. 移除所有 --padding-bottom--padding-end--padding-start--padding-top--placeholder-color CSS 变量的使用。要自定义 ion-datetime 上的内边距,您可以使用任何 padding CSS 属性。

  4. 移除所有 open 方法的使用。要在一个覆盖层中显示 datetime,请将其放置在 ion-modalion-popover 组件中。更多信息请参阅 ion-datetime 使用示例

  5. 移除所有 displayFormatdisplayTimezone 属性的使用。要解析 ionChange 事件载荷中提供的 UTC 字符串,我们建议使用 date-fns。示例请参阅 ion-datetime 日期解析文档

备注

更多迁移示例请参阅 Datetime 迁移示例应用

Icon

Ionic 6 现在附带 Ionicons 6。请查看 Ionicons 6 破坏性变更指南并进行必要的更改。

Input

确保 null 不会作为值传递给 placeholder 属性。我们建议改用 undefined

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 编译为 CommonJS (CJS) 格式,这是 Jest 能够理解的格式。一旦 Jest 支持 ES Modules,此更改将不再需要。有关 Jest 中 ES Modules 支持的更新,请参阅 https://github.com/facebook/jest/issues/9430。

如果您是从一个新的 Ionic 应用开始,我们的 starter 应用中已经为您完成了此配置。对于已有 Ionic 应用的用户,请按照以下步骤让 Jest 与 Ionic 6 配合使用:

  1. 在您的 Jest 配置中添加一个 transformIgnorePatterns 字段,包含相关的 Ionic 包。这通常在 jest.config.jspackage.jsonjest 字段中找到:
jest.config.js
module.exports = {
...
transformIgnorePatterns: ['/node_modules/(?!@ionic/core|@stencil/core|ionicons)']
}
package.json
  {
...
"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 命令:

package.json
"scripts": {
"test": "react-scripts test --transformIgnorePatterns 'node_modules/(?!(@ionic/react|@ionic/react-router|@ionic/core|@stencil/core|ionicons)/)'",
...
}

如果您仍然遇到问题,可以尝试以下几点:

  1. 确认 @babel/preset-env 包含在您的项目级配置中,而不是文件相对配置中。这通常意味着在 <project-root>/babel.config.json 中定义 Babel 配置。

  2. 如果您在 package.json 中有 browserslist/test 字段,请确保将其设置为 current node

需要升级帮助?

请务必查看 Ionic 6 破坏性变更指南。默认属性和 CSS 变量值有一些更改,开发者可能需要了解。此页面仅列出需要用户操作的破坏性变更。

如果您需要升级帮助,请在 Ionic 论坛上发帖。