コンテンツにスキップ
開発ガイドライン
Esc
↑↓移動↵開く⌘Jプレビュー
このページの内容

ライブラリの利用

外部ライブラリの選定基準、利用できるライブラリ、導入方法、更新と脆弱性の管理

ライブラリを使うと少ない工数で実装できますが、利用するライブラリが信用できるかどうかは十分に検証する必要があります。

利用できるライブラリ

次のライブラリは、検討なしで利用して構いません。 これら以外のライブラリを利用する場合は、選定基準に基づいて検討してください。

UI

  • Embla Carousel: カルーセル・スライダー。軽量で、マークアップとスタイルを自由に組める
  • Swiper: カルーセル・スライダー。ループ、ページネーション、エフェクトなどの機能が揃っている

アニメーション

  • GSAP: タイムラインやスクロール連動などの複雑なアニメーション。プラグインを含めて無料で使えるが、独自ライセンスのため条件は公式サイトで確認する

DOM 操作

  • jQuery: 既存サイトの保守に限り利用可。新規実装では標準の DOM API を使用する。既存サイトでも、既知の XSS 脆弱性がある 3.5 未満のバージョンは更新する

選定基準

次の点を確認してから導入してください。

  • 必要性: 標準の API や CSS で実装できないか。プロジェクトの規模や要件に対して機能が過剰でないか
  • ライセンス: クライアントのサイトで商用利用できるか。著作権表示などの条件は何か
  • 開発の継続性: 定期的に更新されているか。GitHub の Issue やリリースの状況はどうか
  • セキュリティ: 既知の脆弱性がないか
  • 整合性: 既存のプロジェクト構成やコーディング規約と合うか

導入方法

パッケージマネージャーで管理する(推奨)

ライブラリは pnpm でインストールし、package.json でバージョンを管理します。コードからは import して利用し、Vite などのバンドラーでビルドします。

pnpm add swiper gsap
import Swiper from "swiper";
import "swiper/css";
import { gsap } from "gsap";

バンドラーを使えない場合

CMS やその他の制約でバンドラーを使えない場合は、CDN から読み込むか、ライブラリのファイルをサイトと同じサーバーに配置して読み込みます。

CDN から読み込む場合

CDN から読み込む場合は、次の 2 点を必ず守ってください。

  • バージョンを固定する: URL に @11 や @latest ではなく、@14.2.0 のように完全なバージョンを指定する
  • SRI を付ける: integrity 属性と crossorigin="anonymous" を付け、CDN 上のファイルが改ざんされても実行されないようにする
<!-- ❌ バージョンが固定されておらず、SRI もない -->
<script defer src="https://cdn.jsdelivr.net/npm/swiper/swiper-bundle.min.js"></script>

<!-- ✅ バージョンを固定し、SRI を付けている -->
<script
  defer
  src="https://cdn.jsdelivr.net/npm/swiper@14.2.0/swiper-bundle.min.js"
  integrity="sha256-1OHYiHI8gGI+0WHyIK9HNKVzWl3TCr4LmGD6W1Pmvnc="
  crossorigin="anonymous"
></script>

サーバーに配置する場合

ライブラリのファイルをダウンロードし、サイトと同じサーバーに配置して読み込みます。ライセンスファイルも一緒に配置してください。 CDN の障害の影響を受けないため、CDN を使えない・使いたくない案件ではこの方法を使います。

/assets/vendor/
├── swiper/
│   ├── swiper-bundle.min.js
│   ├── swiper-bundle.min.css
│   └── LICENSE
└── gsap/
    ├── gsap.min.js
    └── LICENSE
<head>
  <!-- 外部ライブラリ -->
  <link rel="stylesheet" href="/assets/vendor/swiper/swiper-bundle.min.css" />
  <script defer src="/assets/vendor/swiper/swiper-bundle.min.js"></script>
  <script defer src="/assets/vendor/gsap/gsap.min.js"></script>

  <!-- 自作スクリプト -->
  <script defer src="/assets/js/common.js"></script>
</head>

更新と脆弱性の管理

pnpm でインストールした依存パッケージは、ロックファイルのコミット、pnpm audit、Dependabot による自動更新で管理します。詳細は 依存関係の脆弱性管理を参照してください。

このページは役に立ちましたか?