reelkitReelKit

インストール

reelkit のパッケージをインストールして、プロジェクトを設定します。

パッケージの選び方

使うものだけをインストールしてください：

パッケージ説明用途
@reelkit/coreフレームワークに依存しないコア独自の組み込み
@reelkit/reactReact コンポーネントReact 18 以降のアプリケーション
@reelkit/react-reel-playerフルスクリーンの縦型動画プレイヤーInstagram／TikTok 風のプレイヤー
@reelkit/react-lightbox画像ギャラリーのオーバーレイフルスクリーンでの画像プレビュー
@reelkit/react-stories-playerInstagram 風のストーリープレイヤー自動送りとジェスチャーのあるストーリー
@reelkit/angularAngular のスタンドアロンコンポーネントAngular 17 以降のアプリケーション
@reelkit/angular-reel-playerフルスクリーンの縦型動画プレイヤーInstagram／TikTok 風のプレイヤー
@reelkit/angular-lightbox画像ギャラリーのオーバーレイフルスクリーンでの画像プレビュー
@reelkit/vueVue 3 のコンポーネントとコンポーザブルVue 3 のアプリケーション
@reelkit/vue-reel-playerフルスクリーンの縦型動画プレイヤーInstagram／TikTok 風のプレイヤー
@reelkit/vue-lightbox画像ギャラリーのオーバーレイフルスクリーンでの画像プレビュー

バンドルサイズ

どのパッケージもバンドルへの影響が最小になるよう最適化されています：

パッケージJSJS (gzip)CSSCSS (gzip)
@reelkit/core26.7 kB10.1 kB--
@reelkit/react13.4 kB4.8 kB--
@reelkit/react-reel-player17.0 kB5.4 kB9.7 kB2.1 kB
@reelkit/react-lightbox10.0 kB3.4 kB7.7 kB1.6 kB
@reelkit/react-stories-player19.1 kB5.8 kB7.5 kB1.7 kB
@reelkit/angular66.7 kB15.1 kB--
@reelkit/angular-reel-player149.0 kB24.4 kB--
@reelkit/angular-lightbox93.5 kB15.4 kB--
@reelkit/vue14.4 kB5.0 kB--
@reelkit/vue-reel-player21.1 kB6.2 kB9.7 kB2.1 kB
@reelkit/vue-lightbox14.4 kB4.1 kB6.8 kB1.4 kB

ほかのライブラリとの比較

ReelKit は常に DOM に 3 枚のスライド しか描画せず、10,000 件を超えるアイテムも扱えます。ほかのカルーセルライブラリはすべてのスライドを描画するため、大きなリストでは動作が止まってしまいます。

ライブラリJS (gzip)仮想化備考
ReelKit (core + react)14.9 kB依存関係なし
ReelKit (core + angular)25.2 kB依存関係なし
ReelKit (core + vue)15.0 kB依存関係なし
Swiper~25 kBプラグインフルバンドル。ツリーシェイキング可能
Embla Carousel~7 kB✗軽量、プラグイン方式
keen-slider~6 kB✗依存関係なし

npm

bash

yarn

bash

pnpm

bash

npm

bash

yarn

bash

pnpm

bash

npm

bash

yarn

bash

pnpm

bash

Peer dependencies

フレームワーク向けのパッケージには、すでにプロジェクトに入っているはずの peer dependencies があります：

@reelkit/react

  • react >= 18.0.0
  • react-dom >= 18.0.0

@reelkit/react-reel-player

  • @reelkit/react
  • react >= 18.0.0
  • react-dom >= 18.0.0
  • lucide-react >= 0.400.0

@reelkit/react-lightbox

  • @reelkit/react
  • react >= 18.0.0
  • react-dom >= 18.0.0
  • lucide-react >= 0.400.0

@reelkit/react-stories-player

  • @reelkit/react
  • react >= 18.0.0
  • react-dom >= 18.0.0
  • lucide-react >= 0.400.0

@reelkit/angular

  • @angular/core >= 17.0.0
  • @angular/common >= 17.0.0

@reelkit/angular-reel-player

  • @reelkit/angular
  • @angular/core >= 19.0.0
  • lucide-angular >= 0.460.0

@reelkit/angular-lightbox

  • @reelkit/angular
  • @angular/core >= 17.0.0
  • lucide-angular >= 0.400.0

@reelkit/vue

  • vue >= 3.0.0

lucide-react はデフォルトのコントロールのアイコンにだけ使います。renderControls で独自のコントロールを渡す場合は、インストールを省けます。

lucide-angular はデフォルトのコントロールのアイコンにだけ使います。rkPlayerControls で独自のコントロールを渡す場合は、インストールを省けます。

TypeScript

すべてのパッケージに TypeScript の型定義が同梱されています。追加の @types パッケージは必要ありません。

ブラウザー対応

reelkit はすべてのモダンブラウザーで動作します：

  • Chrome/Edge 88+
  • Firefox 78+
  • Safari 14+
  • iOS Safari 14+
  • Android Chrome 88+

次のステップ