Swiper を使い始める

インストール

Swiper をプロジェクトに含める/インポートする方法はいくつかあります。

NPM からインストールする

Swiper は NPM からインストールできます。

$ npm install swiper

// import Swiper JS
import Swiper from 'swiper';
// import Swiper styles
import 'swiper/css';

const swiper = new Swiper(...);

デフォルトでは、Swiper は追加モジュール (ナビゲーション、ページネーションなど) を含まないコアバージョンのみをエクスポートします。そのため、それらもインポートして設定する必要があります。

// core version + navigation, pagination modules:
import Swiper from 'swiper';
import { Navigation, Pagination } from 'swiper/modules';
// import Swiper and modules styles
import 'swiper/css';
import 'swiper/css/navigation';
import 'swiper/css/pagination';

// init Swiper:
const swiper = new Swiper('.swiper', {
  // configure Swiper to use modules
  modules: [Navigation, Pagination],
  ...
});

すべてのモジュール (バンドル) を含む Swiper をインポートする場合は、`swiper/bundle` からインポートする必要があります。

// import Swiper bundle with all modules installed
import Swiper from 'swiper/bundle';

// import styles bundle
import 'swiper/css/bundle';

// init Swiper:
const swiper = new Swiper(...);

CDN から Swiper を使用する

プロジェクトに Swiper ファイルを含めたくない場合は、CDN から使用できます。以下のファイルが利用可能です。

<link
  rel="stylesheet"
  href="https://cdn.jsdelivr.net/npm/swiper@11/swiper-bundle.min.css"
/>

<script src="https://cdn.jsdelivr.net/npm/swiper@11/swiper-bundle.min.js"></script>

ブラウザで ES モジュールを使用する場合、そのための CDN バージョンもあります。

<script type="module">
  import Swiper from 'https://cdn.jsdelivr.net/npm/swiper@11/swiper-bundle.min.mjs'

  const swiper = new Swiper(...)
</script>

アセットをダウンロードする

Swiper アセットをローカルで使用したい場合は、https://www.jsdelivr.com/package/npm/swiper から直接ダウンロードできます。

Swiper HTML レイアウトを追加する

次に、基本的な Swiper レイアウトをアプリに追加する必要があります。

<!-- Slider main container -->
<div class="swiper">
  <!-- Additional required wrapper -->
  <div class="swiper-wrapper">
    <!-- Slides -->
    <div class="swiper-slide">Slide 1</div>
    <div class="swiper-slide">Slide 2</div>
    <div class="swiper-slide">Slide 3</div>
    ...
  </div>
  <!-- If we need pagination -->
  <div class="swiper-pagination"></div>

  <!-- If we need navigation buttons -->
  <div class="swiper-button-prev"></div>
  <div class="swiper-button-next"></div>

  <!-- If we need scrollbar -->
  <div class="swiper-scrollbar"></div>
</div>

Swiper CSS スタイル/サイズ

Swiper の CSS スタイルに加えて、Swiper のサイズを設定するためにカスタムスタイルを追加する必要がある場合があります。

.swiper {
  width: 600px;
  height: 300px;
}

Swiper を初期化する

最後に、JS で Swiper を初期化する必要があります。

const swiper = new Swiper('.swiper', {
  // Optional parameters
  direction: 'vertical',
  loop: true,

  // If we need pagination
  pagination: {
    el: '.swiper-pagination',
  },

  // Navigation arrows
  navigation: {
    nextEl: '.swiper-button-next',
    prevEl: '.swiper-button-prev',
  },

  // And if we need scrollbar
  scrollbar: {
    el: '.swiper-scrollbar',
  },
});

次のステップ

ご覧のとおり、Swiper を Web サイトやアプリに統合するのは非常に簡単です。次のステップをご紹介します。

• API ドキュメントを参照して、すべての Swiper API とその制御方法について詳しく学んでください。
• 利用可能なデモをご覧ください。
• Swiper について質問がある場合は、Stack Overflow または Swiper ディスカッション で質問してください。
• バグを見つけた場合は、GitHub で issue を作成してください。
• サポートが必要な場合は、Swiper パトロン向けのプライベート Discord サポートチャットルームがあります。