跳到主要内容
版本：v7

从 IonSlides 迁移到 Swiper.js

正在寻找 IonSlides？

IonSlides 在 v6.0.0 中已被弃用，并在 v7.0.0 中移除。我们建议直接使用 Swiper.js 库。迁移过程详见下文。

如果您需要一个现代的触摸滑块组件，我们推荐使用 Swiper.js。本指南将介绍如何在您的 Ionic Framework 应用程序中为 React 设置 Swiper。它还将介绍您可能需要的、从 IonSlides 迁移到官方 Swiper React 集成的任何迁移信息。

备注

Swiper 的 React 组件计划在 Swiper 的未来版本中移除，取而代之的是 Swiper Element。但是，本指南展示了如何迁移到 React 组件，因为它在撰写本文时提供了最稳定的体验。值得注意的是，React 对 Web Components 的支持还不够强大。

在 Ionic Framework 中使用 Swiper.js 并不需要 使用 Swiper 的 React 组件。

开始入门​

首先，更新到最新版本的 Ionic：

npm install @ionic/react@latest @ionic/react-router@latest

完成后，在您的项目中安装 Swiper 依赖：

npm install swiper@latest
备注

使用 Create React App 的开发者必须使用 react-scripts v5.0.0+ 配合最新版本的 Swiper。

滑动手势样式​

接下来，我们需要导入基础的 Swiper 样式。我们还将导入 Ionic 提供的样式，这些样式允许我们使用与 IonSlides 相同的 CSS 变量来自定义 Swiper 样式。

我们建议在使用 Swiper 的组件中导入样式。这确保样式仅在需要时加载：

import React from 'react';
import { IonContent, IonPage } from '@ionic/react';
import { Swiper, SwiperSlide } from 'swiper/react';

import 'swiper/css';
import '@ionic/react/css/ionic-swiper.css';

const Home: React.FC = () => {
  return (
    ...
  );
};
export default Home;
备注

在 Ionic 中使用 Swiper.js 并不需要 导入 @ionic/react/css/ionic-swiper.css。此文件用于与 IonSlides 组件向后兼容，如果您不希望使用样式表中提供的 CSS 变量，可以安全地省略它。

更新选择器​

以前，我们可以通过 ion-slides 和 ion-slide 来应用任何自定义样式。这些样式块的内容保持不变，但我们需要更新选择器。以下是从 ion-slides 迁移到 Swiper React 时的选择器更改列表：

ion-slides 选择器Swiper 选择器
ion-slides.swiper
ion-slide.swiper-slide

预处理器（可选）​

对于使用 SCSS 或 Less 样式的开发者，Swiper 也提供了这些文件的导入。

对于 Less 样式，将 Swiper 导入路径中的 css 替换为 less：

import React from 'react';
import { IonContent, IonPage } from '@ionic/react';
import { Swiper, SwiperSlide } from 'swiper/react';

import 'swiper/less';
import '@ionic/react/css/ionic-swiper.css';

const Home: React.FC = () => {
  return (
    ...
  );
};
export default Home;

对于 SCSS 样式，将 Swiper 导入路径中的 css 替换为 scss：

import React from 'react';
import { IonContent, IonPage } from '@ionic/react';
import { Swiper, SwiperSlide } from 'swiper/react';

import 'swiper/scss';
import '@ionic/react/css/ionic-swiper.css';

const Home: React.FC = () => {
  return (
    ...
  );
};
export default Home;

使用组件​

Swiper 导出了两个组件：Swiper 和 SwiperSlide。Swiper 组件相当于 IonSlides，而 SwiperSlide 相当于 IonSlide。

这些组件从 swiper/react 导入：

import React from 'react';
import { IonContent, IonPage } from '@ionic/react';
import { Swiper, SwiperSlide } from 'swiper/react';

import 'swiper/css';
import '@ionic/react/css/ionic-swiper.css';

const Home: React.FC = () => {
  return (
    <IonPage>
      <IonContent>
        <Swiper>
          <SwiperSlide>Slide 1</SwiperSlide>
          <SwiperSlide>Slide 2</SwiperSlide>
          <SwiperSlide>Slide 3</SwiperSlide>
        </Swiper>
      </IonContent>
    </IonPage>
  );
};
export default Home;

使用模块​

默认情况下，Swiper for React 不导入任何额外的模块。要使用诸如 Navigation 或 Pagination 等模块，您需要先导入它们。

IonSlides 自动包含了 Pagination、Scrollbar、Autoplay、Keyboard 和 Zoom 模块。本指南的这部分将向您展示如何安装这些模块。

首先，我们需要从 swiper 包中导入模块及其对应的 CSS 文件：

import React from 'react';
import { IonContent, IonPage } from '@ionic/react';
import { Swiper, SwiperSlide } from 'swiper/react';
import { Autoplay, Keyboard, Pagination, Scrollbar, Zoom } from 'swiper/modules';

import 'swiper/css';
import 'swiper/css/autoplay';
import 'swiper/css/keyboard';
import 'swiper/css/pagination';
import 'swiper/css/scrollbar';
import 'swiper/css/zoom';
import '@ionic/react/css/ionic-swiper.css';

const Home: React.FC = () => {
  return (
    <IonPage>
      <IonContent>
        <Swiper>
          <SwiperSlide>Slide 1</SwiperSlide>
          <SwiperSlide>Slide 2</SwiperSlide>
          <SwiperSlide>Slide 3</SwiperSlide>
        </Swiper>
      </IonContent>
    </IonPage>
  );
};
export default Home;

接下来，我们需要通过 Swiper 组件的 modules 属性将这些模块提供给 Swiper：

import React from 'react';
import { IonContent, IonPage } from '@ionic/react';
import { Swiper, SwiperSlide } from 'swiper/react';
import { Autoplay, Keyboard, Pagination, Scrollbar, Zoom } from 'swiper/modules';

import 'swiper/css';
import 'swiper/css/autoplay';
import 'swiper/css/keyboard';
import 'swiper/css/pagination';
import 'swiper/css/scrollbar';
import 'swiper/css/zoom';
import '@ionic/react/css/ionic-swiper.css';

const Home: React.FC = () => {
  return (
    <IonPage>
      <IonContent>
        <Swiper modules={[Autoplay, Keyboard, Pagination, Scrollbar, Zoom]}>
          <SwiperSlide>Slide 1</SwiperSlide>
          <SwiperSlide>Slide 2</SwiperSlide>
          <SwiperSlide>Slide 3</SwiperSlide>
        </Swiper>
      </IonContent>
    </IonPage>
  );
};
export default Home;

最后，我们可以通过使用相应的属性来开启这些功能：

import React from 'react';
import { IonContent, IonPage } from '@ionic/react';
import { Swiper, SwiperSlide } from 'swiper/react';
import { Autoplay, Keyboard, Pagination, Scrollbar, Zoom } from 'swiper/modules';

import 'swiper/css';
import 'swiper/css/autoplay';
import 'swiper/css/keyboard';
import 'swiper/css/pagination';
import 'swiper/css/scrollbar';
import 'swiper/css/zoom';
import '@ionic/react/css/ionic-swiper.css';

const Home: React.FC = () => {
  return (
    <IonPage>
      <IonContent>
        <Swiper
          modules={[Autoplay, Keyboard, Pagination, Scrollbar, Zoom]}
          autoplay={true}
          keyboard={true}
          pagination={true}
          scrollbar={true}
          zoom={true}
        >
          <SwiperSlide>Slide 1</SwiperSlide>
          <SwiperSlide>Slide 2</SwiperSlide>
          <SwiperSlide>Slide 3</SwiperSlide>
        </Swiper>
      </IonContent>
    </IonPage>
  );
};
export default Home;
备注

查看 https://swiperjs.com/react#usage 获取完整的模块列表。

IonicSlides 模块​

使用 IonSlides 时，Ionic 会自动定制数十个 Swiper 属性。这带来了在移动设备上滑动时感觉流畅的体验。我们建议使用 IonicSlides 模块，以确保在直接使用 Swiper 时也设置了这些属性。但是，在 Ionic 中使用 Swiper.js 并不需要 使用此模块。

建议查看 IonicSlides 设置的 属性，并确定您希望自定义哪些属性。

我们可以通过从 @ionic/react 导入 IonicSlides 模块，并将其作为最后一项传入 modules 数组来安装它：

import React from 'react';
import { IonContent, IonPage, IonicSlides } from '@ionic/react';
import { Swiper, SwiperSlide } from 'swiper/react';
import { Autoplay, Keyboard, Pagination, Scrollbar, Zoom } from 'swiper/modules';

import 'swiper/css';
import 'swiper/css/autoplay';
import 'swiper/css/keyboard';
import 'swiper/css/pagination';
import 'swiper/css/scrollbar';
import 'swiper/css/zoom';
import '@ionic/react/css/ionic-swiper.css';

const Home: React.FC = () => {
  return (
    <IonPage>
      <IonContent>
        <Swiper
          modules={[Autoplay, Keyboard, Pagination, Scrollbar, Zoom, IonicSlides]}
          autoplay={true}
          keyboard={true}
          pagination={true}
          scrollbar={true}
          zoom={true}
        >
          <SwiperSlide>Slide 1</SwiperSlide>
          <SwiperSlide>Slide 2</SwiperSlide>
          <SwiperSlide>Slide 3</SwiperSlide>
        </Swiper>
      </IonContent>
    </IonPage>
  );
};
export default Home;
备注

IonicSlides 模块必须是数组中的最后一个模块。这将让它自动定制诸如 Pagination、Scrollbar、Zoom 等模块的设置。

属性​

Swiper 选项是直接作为属性提供给 <Swiper> 组件的，而不是像 IonSlides 那样通过 options 对象传递。

假设在一个使用 IonSlides 的应用中，我们设置了 slidesPerView 和 loop 选项：

const MyComponent: React.FC = () => {
  return (
    <IonSlides
      options={{
        slidesPerView: 3,
        loop: true,
      }}
    >
      <IonSlide>Slide 1</IonSlide>
      <IonSlide>Slide 2</IonSlide>
      <IonSlide>Slide 3</IonSlide>
    </IonSlides>
  );
};

要迁移，我们需要将这些选项从 options 对象中移出，直接作为属性放到 <Swiper> 组件上：

const MyComponent: React.FC = () => {
  return (
    <Swiper slidesPerView={3} loop={true}>
      <SwiperSlide>Slide 1</SwiperSlide>
      <SwiperSlide>Slide 2</SwiperSlide>
      <SwiperSlide>Slide 3</SwiperSlide>
    </Swiper>
  );
};

以下是从 IonSlides 迁移到 Swiper React 时的完整属性更改列表：

名称备注
options将每个选项直接作为属性设置在 <Swiper> 组件上。
mode要基于模式应用不同样式，您可以在 CSS 中针对 .ios .swiper 或 .md .swiper 设置样式。
pager改用 pagination 属性。需要安装 Pagination 模块。
scrollbar您可以继续使用 scrollbar 属性，但请确保先安装 Scrollbar 模块。
备注

Swiper React 中所有可用的属性可以在 https://swiperjs.com/react#swiper-props 找到。

事件​

由于 Swiper 组件不是由 Ionic Framework 提供的，事件名称不会有 onIonSlide 前缀。

假设在一个使用 IonSlides 的应用中，我们使用了 onIonSlideDidChange 事件：

const MyComponent: React.FC = () => {
  return (
    <IonSlides onIonSlideDidChange={() => onSlideChange()}>
      <IonSlide>Slide 1</IonSlide>
      <IonSlide>Slide 2</IonSlide>
      <IonSlide>Slide 3</IonSlide>
    </IonSlides>
  );
};

要迁移，我们需要将事件名称更改为 onSlideChange：

const MyComponent: React.FC = () => {
  return (
    <Swiper onSlideChange={() => onSlideChange()}>
      <SwiperSlide>Slide 1</SwiperSlide>
      <SwiperSlide>Slide 2</SwiperSlide>
      <SwiperSlide>Slide 3</SwiperSlide>
    </Swiper>
  );
};

以下是从 IonSlides 迁移到 Swiper React 时的完整事件名称更改列表：

IonSlides 事件Swiper 事件
onIonSlideWillChangeonSlideChangeTransitionStart
onIonSlideDidChangeonSlideChangeTransitionEnd
onIonSlideDoubleTaponDoubleTap
onIonSlideDragonSliderMove
onIonSlideNextStartonSlideNextTransitionStart
onIonSlideNextEndonSlideNextTransitionEnd
onIonSlidePrevStartonSlidePrevTransitionStart
onIonSlidePrevEndonSlidePrevTransitionEnd
onIonSlideReachStartonReachBeginning
onIonSlideReachEndonReachEnd
onIonSlideTaponTap
onIonSlideTouchStartonTouchStart
onIonSlideTouchEndonTouchEnd
onIonSlideTransitionStartonTransitionStart
onIonSlideTransitionEndonTransitionEnd
onIonSlidesDidLoadonInit
备注

Swiper 中所有可用的事件可以在 https://swiperjs.com/swiper-api#events 找到。

方法​

大多数方法已被移除，取而代之的是直接访问 Swiper 的属性。

访问这些属性可能有点棘手，因为您想要访问的是 Swiper 实例本身的属性，而不是您的 React 组件。为此，我们建议通过 onSwiper 获取对 Swiper 实例的引用：

import React, { useState } from 'react';
import { Swiper, SwiperSlide } from 'swiper/react';
import { Swiper as SwiperInterface } from 'swiper/modules';
...
const Home: React.FC = () => {
  const [swiperInstance, setSwiperInstance] = useState<SwiperInterface>();
  return (
    ...
    <Swiper
      onSwiper={(swiper) => setSwiperInstance(swiper)}
    >
      ...
    </Swiper>
  )
};
export default Home;

从这里开始，如果您想访问 Swiper 实例上的某个属性，可以使用 swiperInstance。例如，如果您想检查 isBeginning 属性，可以这样做：swiperInstance.isBeginning。不过请确保 swiperInstance 已定义！

以下是从 IonSlides 迁移到 Swiper React 时的完整方法更改列表：

IonSlides 方法备注
getActiveIndex()改用 activeIndex 属性。
getPreviousIndex()改用 previousIndex 属性。
getSwiper()使用 onSwiper 获取 Swiper 实例的引用。参见上面的示例。
isBeginning()改用 isBeginning 属性。
isEnd()改用 isEnd 属性。
length()改用 slides 属性。（例如 swiperInstance.slides.length）
lockSwipeToNext()改用 allowSlidesNext 属性。
lockSwipeToPrev()改用 allowSlidePrev 属性。
lockSwipes()改用 allowSlideNext、allowSlidePrev 和 allowTouchMove 属性。
startAutoplay()改用 autoplay 属性。
stopAutoplay()改用 autoplay 属性。

特效​

如果您正在使用诸如 Cube 或 Fade 等特效，您可以像安装其他模块一样安装它们。在这个例子中，我们将使用 fade 特效。首先，我们从 swiper 导入 EffectFade 并将其提供给 modules 数组：

import React from 'react';
import { IonContent, IonPage, IonicSlides } from '@ionic/react';
import { EffectFade } from 'swiper/modules';
import { Swiper, SwiperSlide } from 'swiper/react';

import 'swiper/css';
import '@ionic/react/css/ionic-swiper.css';

const Home: React.FC = () => {
  return (
    <IonPage>
      <IonContent>
        <Swiper modules={[EffectFade, IonicSlides]}>
          <SwiperSlide>Slide 1</SwiperSlide>
          <SwiperSlide>Slide 2</SwiperSlide>
          <SwiperSlide>Slide 3</SwiperSlide>
        </Swiper>
      </IonContent>
    </IonPage>
  );
};
export default Home;

接下来，我们需要导入与该特效相关的样式表：

import React from 'react';
import { IonContent, IonPage, IonicSlides } from '@ionic/react';
import { EffectFade } from 'swiper/modules';
import { Swiper, SwiperSlide } from 'swiper/react';

import 'swiper/css';
import 'swiper/css/effect-fade';
import '@ionic/react/css/ionic-swiper.css';

const Home: React.FC = () => {
  return (
    <IonPage>
      <IonContent>
        <Swiper modules={[EffectFade, IonicSlides]}>
          <SwiperSlide>Slide 1</SwiperSlide>
          <SwiperSlide>Slide 2</SwiperSlide>
          <SwiperSlide>Slide 3</SwiperSlide>
        </Swiper>
      </IonContent>
    </IonPage>
  );
};
export default Home;

之后，我们可以通过在 swiper 上设置 effect 属性为 "fade" 来激活它：

import React from 'react';
import { IonContent, IonPage, IonicSlides } from '@ionic/react';
import { EffectFade } from 'swiper/modules';
import { Swiper, SwiperSlide } from 'swiper/react';

import 'swiper/css';
import 'swiper/css/effect-fade';
import '@ionic/react/css/ionic-swiper.css';

const Home: React.FC = () => {
  return (
    <IonPage>
      <IonContent>
        <Swiper modules={[EffectFade, IonicSlides]} effect="fade">
          <SwiperSlide>Slide 1</SwiperSlide>
          <SwiperSlide>Slide 2</SwiperSlide>
          <SwiperSlide>Slide 3</SwiperSlide>
        </Swiper>
      </IonContent>
    </IonPage>
  );
};
export default Home;
备注

有关 Swiper 特效的更多信息，请参阅 https://swiperjs.com/react#effects。

总结​

现在您已经安装了 Swiper，可以使用一整套新的 Swiper 功能。我们建议从 Swiper React 介绍 开始，然后参考 Swiper API 文档。

常见问题解答​

我在哪里可以找到此迁移的示例？​

您可以在 https://github.com/ionic-team/slides-migration-samples 找到一个包含 ion-slides 和等效 Swiper 用法的示例应用。

我在哪里可以获得有关此迁移的帮助？​

如果您在迁移过程中遇到问题，请在 Ionic 论坛 上发帖。

我在哪里提交错误报告？​

在提交 issue 之前，请考虑先在 Swiper 讨论板 或 Ionic 论坛 上发帖，看看您的问题是否能由社区解决。

如果您遇到 Swiper 库的问题，新的错误应提交到 Swiper 仓库：https://github.com/nolimits4web/swiper/issues

如果您遇到 IonicSlides 模块的问题，新的错误应提交到 Ionic Framework 仓库：https://github.com/ionic-team/ionic-framework/issues

Contents

编辑此页