跳到主要内容
版本：v6

从 IonSlides 迁移到 Swiper.js

如果您需要一个现代的触摸滑块组件，我们推荐使用 Swiper.js。它为我们的 IonSlides 组件提供支持，但现在我们建议开发者直接使用 Swiper for React。

本指南将介绍如何在 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>幻灯片 1</SwiperSlide>
          <SwiperSlide>幻灯片 2</SwiperSlide>
          <SwiperSlide>幻灯片 3</SwiperSlide>
        </Swiper>
      </IonContent>
    </IonPage>
  );
};
export default Home;

使用模块​

默认情况下，Swiper for React 不导入任何额外的模块。要使用导航或分页等模块，需要先导入它们。

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';

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>幻灯片 1</SwiperSlide>
          <SwiperSlide>幻灯片 2</SwiperSlide>
          <SwiperSlide>幻灯片 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';

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>幻灯片 1</SwiperSlide>
          <SwiperSlide>幻灯片 2</SwiperSlide>
          <SwiperSlide>幻灯片 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';

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>幻灯片 1</SwiperSlide>
          <SwiperSlide>幻灯片 2</SwiperSlide>
          <SwiperSlide>幻灯片 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';

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>幻灯片 1</SwiperSlide>
          <SwiperSlide>幻灯片 2</SwiperSlide>
          <SwiperSlide>幻灯片 3</SwiperSlide>
        </Swiper>
      </IonContent>
    </IonPage>
  );
};
export default Home;
备注

IonicSlides 模块必须是数组中的最后一个模块。这将使其能够自动自定义分页、滚动条、缩放等模块的设置。

属性​

Swiper 选项直接作为 props 提供给 <Swiper> 组件，而不是通过 IonSlides 中的 options 对象。

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

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

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

const MyComponent: React.FC = () => {
  return (
    <Swiper slidesPerView={3} loop={true}>
      <SwiperSlide>幻灯片 1</SwiperSlide>
      <SwiperSlide>幻灯片 2</SwiperSlide>
      <SwiperSlide>幻灯片 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>幻灯片 1</IonSlide>
      <IonSlide>幻灯片 2</IonSlide>
      <IonSlide>幻灯片 3</IonSlide>
    </IonSlides>
  );
};

迁移时，我们将事件名称改为 onSlideChange：

const MyComponent: React.FC = () => {
  return (
    <Swiper onSlideChange={() => onSlideChange()}>
      <SwiperSlide>幻灯片 1</SwiperSlide>
      <SwiperSlide>幻灯片 2</SwiperSlide>
      <SwiperSlide>幻灯片 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';
...
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 属性（例如 swiperRef.slides.length）。
lockSwipeToNext()改用 allowSlidesNext 属性。
lockSwipeToPrev()改用 allowSlidePrev 属性。
lockSwipes()改用 allowSlideNext、allowSlidePrev 和 allowTouchMove 属性。
startAutoplay()改用 autoplay 属性。
stopAutoplay()改用 autoplay 属性。

效果​

如果您使用的是 Cube 或 Fade 等效果，可以像安装其他模块一样安装它们。在本示例中，我们将使用淡入淡出效果。首先，我们从 swiper 导入 EffectFade 并将其提供给 modules 数组：

import React from 'react';
import { IonContent, IonPage, IonicSlides } from '@ionic/react';
import { EffectFade } from 'swiper';
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>幻灯片 1</SwiperSlide>
          <SwiperSlide>幻灯片 2</SwiperSlide>
          <SwiperSlide>幻灯片 3</SwiperSlide>
        </Swiper>
      </IonContent>
    </IonPage>
  );
};
export default Home;

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

import React from 'react';
import { IonContent, IonPage, IonicSlides } from '@ionic/react';
import { EffectFade } from 'swiper';
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>幻灯片 1</SwiperSlide>
          <SwiperSlide>幻灯片 2</SwiperSlide>
          <SwiperSlide>幻灯片 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';
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>幻灯片 1</SwiperSlide>
          <SwiperSlide>幻灯片 2</SwiperSlide>
          <SwiperSlide>幻灯片 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 Forum 上创建帖子。

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

在提交 issue 之前，请考虑在 Swiper 讨论板或 Ionic Forum 上创建帖子，看看您的问题是否可以通过社区解决。

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

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

目录

编辑此页