Swiper React 组件

安装

Swiper React 仅通过 NPM 作为主要 Swiper 库的一部分提供。

  npm i swiper

用法

swiper/react 导出 2 个组件：Swiper 和 SwiperSlide

// Import Swiper React components
import { Swiper, SwiperSlide } from 'swiper/react';

// Import Swiper styles
import 'swiper/css';

export default () => {
  return (
    <Swiper
      spaceBetween={50}
      slidesPerView={3}
      onSlideChange={() => console.log('slide change')}
      onSwiper={(swiper) => console.log(swiper)}
    >
      <SwiperSlide>Slide 1</SwiperSlide>
      <SwiperSlide>Slide 2</SwiperSlide>
      <SwiperSlide>Slide 3</SwiperSlide>
      <SwiperSlide>Slide 4</SwiperSlide>
      ...
    </Swiper>
  );
};

默认情况下，Swiper React 使用 Swiper 的核心版本（不带任何附加模块）。如果您想使用导航、分页和其他模块，您必须先安装它们。

以下是 swiper/modules 中附加模块的导入列表

Virtual - 虚拟幻灯片模块
Keyboard - 键盘控制模块
Mousewheel - 鼠标滚轮控制模块
Navigation - 导航模块
Pagination - 分页模块
Scrollbar - 滚动条模块
Parallax - 视差模块
FreeMode - 自由模式模块
Grid - 网格模块
Manipulation - 幻灯片操作模块（仅适用于核心版本）
Zoom - 缩放模块
Controller - 控制器模块
A11y - 无障碍模块
History - 历史导航模块
HashNavigation - 哈希导航模块
Autoplay - 自动播放模块
EffectFade - 淡入淡出效果模块
EffectCube - 立方体效果模块
EffectFlip - 翻转效果模块
EffectCoverflow - 覆盖流效果模块
EffectCards - 卡片效果模块
EffectCreative - 创意效果模块
Thumbs - 缩略图模块

// import Swiper core and required modules
import { Navigation, Pagination, Scrollbar, A11y } from 'swiper/modules';

import { Swiper, SwiperSlide } from 'swiper/react';

// Import Swiper styles
import 'swiper/css';
import 'swiper/css/navigation';
import 'swiper/css/pagination';
import 'swiper/css/scrollbar';

export default () => {
  return (
    <Swiper
      // install Swiper modules
      modules={[Navigation, Pagination, Scrollbar, A11y]}
      spaceBetween={50}
      slidesPerView={3}
      navigation
      pagination={{ clickable: true }}
      scrollbar={{ draggable: true }}
      onSwiper={(swiper) => console.log(swiper)}
      onSlideChange={() => console.log('slide change')}
    >
      <SwiperSlide>Slide 1</SwiperSlide>
      <SwiperSlide>Slide 2</SwiperSlide>
      <SwiperSlide>Slide 3</SwiperSlide>
      <SwiperSlide>Slide 4</SwiperSlide>
      ...
    </Swiper>
  );
};

请注意，如果您传递这些参数而不指定其元素（例如，没有 navigation.nextEl、pagination.el 等），Swiper React 组件将为导航、分页和滚动条创建所需的元素。

样式

Swiper 包包含不同的 CSS 样式集

swiper/css - 仅核心 Swiper 样式
swiper/css/bundle - 所有 Swiper 样式，包括所有模块样式（如导航、分页等）

模块样式（如果您已导入捆绑样式则不需要）

swiper/css/a11y - A11y 模块所需的样式
swiper/css/autoplay - 自动播放模块所需的样式
swiper/css/controller - 控制器模块所需的样式
swiper/css/effect-cards - 卡片效果模块所需的样式
swiper/css/effect-coverflow - 覆盖流效果模块所需的样式
swiper/css/effect-creative - 创意效果模块所需的样式
swiper/css/effect-cube - 立方体效果模块所需的样式
swiper/css/effect-fade - 淡入淡出效果模块所需的样式
swiper/css/effect-flip - 翻转效果模块所需的样式
swiper/css/free-mode - 自由模式模块所需的样式
swiper/css/grid - 网格模块所需的样式
swiper/css/hash-navigation - 哈希导航模块所需的样式
swiper/css/history - 历史模块所需的样式
swiper/css/keyboard - 键盘模块所需的样式
swiper/css/manipulation - 操作模块所需的样式
swiper/css/mousewheel - 鼠标滚轮模块所需的样式
swiper/css/navigation - 导航模块所需的样式
swiper/css/pagination - 分页模块所需的样式
swiper/css/parallax - 视差模块所需的样式
swiper/css/scrollbar - 滚动条模块所需的样式
swiper/css/thumbs - 缩略图模块所需的样式
swiper/css/virtual - 虚拟模块所需的样式
swiper/css/zoom - 缩放模块所需的样式

Swiper props

Swiper React 组件接收所有 Swiper 参数作为组件 props，以及一些额外的 props

属性	类型	默认值	描述
`tag`	`字符串`	`'div'`	主 Swiper 容器 HTML 元素标签
`wrapperTag`	`字符串`	`'div'`	Swiper wrapper HTML 元素标签
`onSwiper`	`(swiper) => void`	`'div'`	接收 Swiper 实例的回调

它还支持所有 on{Eventname} 格式的 Swiper 事件。例如，slideChange 事件变为 onSlideChange prop

  <Swiper
    onSlideChange={() => {/*...*/}}
    onReachEnd={() => {/*...*/}}
    ...
  >

SwiperSlide props

属性	类型	默认值	描述
`tag`	`字符串`	`'div'`	Swiper Slide HTML 元素标签
`zoom`	`布尔值`	`false`	启用缩放模式所需的额外包装器
`virtualIndex`	`数字`		实际 swiper 幻灯片索引。虚拟幻灯片必须设置

SwiperSlide 渲染函数

SwiperSlide 组件可以接受一个渲染函数，该函数接收一个包含以下属性的对象

isActive - 当当前幻灯片处于活动状态时为 true
isPrev - 当当前幻灯片是活动幻灯片的前一个时为 true
isNext - 当当前幻灯片是活动幻灯片的下一个时为 true
isVisible - 当当前幻灯片可见时为 true（必须启用 watchSlidesProgress Swiper 参数）
isDuplicate - 当当前幻灯片是重复幻灯片时为 true（当启用 loop 模式时）例如

<Swiper>
  <SwiperSlide>
    {({ isActive }) => (
      <div>Current slide is {isActive ? 'active' : 'not active'}</div>
    )}
  </SwiperSlide>
</Swiper>

useSwiper

Swiper React 提供 useSwiper 钩子，以便在 Swiper 内部的组件中轻松获取 Swiper 实例

// some-inner-component.jsx
import { React } from 'react';
import { useSwiper } from 'swiper/react';

export default function SlideNextButton() {
  const swiper = useSwiper();

  return (
    <button onClick={() => swiper.slideNext()}>Slide to the next slide</button>
  );
}

useSwiperSlide

useSwiperSlide 是另一个用于 Swiper 幻灯片内部组件的钩子，用于获取幻灯片数据（与 SwiperSlide 渲染函数中的数据相同）

// some-inner-component.jsx
import { React } from 'react';
import { useSwiperSlide } from 'swiper/react';

export default function SlideTitle() {
  const swiperSlide = useSwiperSlide();

  return (
    <p>Current slide is {swiperSlide.isActive ? 'active' : 'not active'}</p>
  );
}

插槽

Swiper React 使用“插槽”进行内容分发。有 4 个可用插槽

container-start - 元素将添加到 swiper-container 的开头
container-end (默认) - 元素将添加到 swiper-container 的末尾
wrapper-start - 元素将添加到 swiper-wrapper 的开头
wrapper-end - 元素将添加到 swiper-wrapper 的末尾

例如

<Swiper>
  <SwiperSlide>Slide 1</SwiperSlide>
  <SwiperSlide>Slide 2</SwiperSlide>
  <span slot="container-start">Container Start</span>
  <span slot="container-end">Container End</span>
  <span slot="wrapper-start">Wrapper Start</span>
  <span slot="wrapper-end">Wrapper End</span>
</Swiper>

将渲染为

<div class="swiper">
  <span slot="container-start">Container Start</span>
  <div class="swiper-wrapper">
    <span slot="wrapper-start">Wrapper Start</span>
    <div class="swiper-slide">Slide 1</div>
    <div class="swiper-slide">Slide 2</div>
    <span slot="wrapper-end">Wrapper End</span>
  </div>
  <span slot="container-end">Container End</span>
</div>

虚拟 slide

这里的虚拟幻灯片渲染完全由 React 处理，除了设置 virtual:true 属性和在幻灯片上设置 virtualIndex 之外，不需要任何其他操作。

import { Virtual } from 'swiper/modules';
import { Swiper, SwiperSlide } from 'swiper/react';

// Import Swiper styles
import 'swiper/css';
import 'swiper/css/virtual';

export default () => {
  // Create array with 1000 slides
  const slides = Array.from({ length: 1000 }).map(
    (el, index) => `Slide ${index + 1}`
  );

  return (
    <Swiper modules={[Virtual]} spaceBetween={50} slidesPerView={3} virtual>
      {slides.map((slideContent, index) => (
        <SwiperSlide key={slideContent} virtualIndex={index}>
          {slideContent}
        </SwiperSlide>
      ))}
    </Swiper>
  );
};

控制器

控制器需要将一个 Swiper 实例传递给另一个

  import React, { useState } from 'react';
  import { Controller } from 'swiper/modules';
  import { Swiper, SwiperSlide } from 'swiper/react';

  const App = () => {
    // store controlled swiper instance
    const [controlledSwiper, setControlledSwiper] = useState(null);

    return (
      <main>
        {/* Main Swiper -> pass controlled swiper instance */}
        <Swiper modules={[Controller]} controller={{ control: controlledSwiper }} ...>
          {/* ... */}
        </Swiper>

        {/* Controlled Swiper -> store swiper instance */}
        <Swiper modules={[Controller]} onSwiper={setControlledSwiper} ...>
          {/* ... */}
        </Swiper>
      </main>
    )
  }

对于双向控制（当两个 Swiper 相互控制时），它应该是这样的

import React, { useState } from 'react';
import { Controller } from 'swiper/modules';
import { Swiper, SwiperSlide } from 'swiper/react';

const App = () => {
  // store swiper instances
  const [firstSwiper, setFirstSwiper] = useState(null);
  const [secondSwiper, setSecondSwiper] = useState(null);

  return (
    <main>
      <Swiper
        modules={[Controller]}
        onSwiper={setFirstSwiper}
        controller={{ control: secondSwiper }}
      >
        {/* ... */}
      </Swiper>

      <Swiper
        modules={[Controller]}
        onSwiper={setSecondSwiper}
        controller={{ control: firstSwiper }}
      >
        {/* ... */}
      </Swiper>
    </main>
  );
};

缩略图

与控制器一样，我们需要存储缩略图实例并将其传递给主画廊

  import React, { useState } from 'react';
  import { Swiper, SwiperSlide } from 'swiper/react';
  import { Thumbs } from 'swiper/modules';

  const App = () => {
    // store thumbs swiper instance
    const [thumbsSwiper, setThumbsSwiper] = useState(null);

    return (
      <main>
        {/* Main Swiper -> pass thumbs swiper instance */}
        <Swiper modules={[Thumbs]} thumbs={{ swiper: thumbsSwiper }} ...>
          {/* ... */}
        </Swiper>

        {/* Thumbs Swiper -> store swiper instance */}
        {/* It is also required to set watchSlidesProgress prop */ }
        <Swiper
          modules={[Thumbs]}
          watchSlidesProgress
          onSwiper={setThumbsSwiper}
          ...
        >
          {/* ... */}
        </Swiper>
      </main>
    )
  }

效果

以下效果可用

淡入淡出
立方体
Coverflow
翻转
卡片
创意

要使用效果，您必须先导入并安装它们（与其他所有模块一样）。

您可以在此处找到运行中的效果演示。

完整的淡入淡出效果示例

import React from 'react';
import { Swiper, SwiperSlide } from 'swiper/react';
import { EffectFade } from 'swiper/modules';

import 'swiper/css';
import 'swiper/css/effect-fade';

export default () => {
  return (
    <Swiper modules={[EffectFade]} effect="fade">
      {[1, 2, 3].map((i, el) => {
        return <SwiperSlide>Slide {el}</SwiperSlide>;
      })}
    </Swiper>
  );
};

接下来做什么？

如您所见，将 Swiper 集成到您的网站或应用中非常容易。以下是您接下来的步骤

前往API 文档以了解有关所有 Swiper API 以及如何控制它的更多信息。
查看可用的演示。
如果您对 Swiper 有疑问，请在 StackOverflow 或 Swiper 讨论区提问。
如果您发现错误，请在 GitHub 上创建问题。

在 GitHub 上编辑此页面