メインコンテンツへスキップ

@capgo/capacitor-sheets

Capacitor WebViewsに最適化された、フレームワークに依存しないボトムシート、ドロワー、ダイアログ、オーバーレイ。

フレームワークに依存しない

標準ベースのカスタム要素を直接使用するか、React、Vue、Angular、Svelte、Solid 用のセットアップヘルパーを使用できます。

Capacitor の準備完了

Webレイヤーから、セーフエリア、キーボードの動き、ネイティブのエッジジェスチャー、WebViewのテーマカラー減光を考慮します。

あらゆるシート形状

ボトムシート、サイドドロワー、トップシート、中央ダイアログ、トースト、デタッチドシート、カード、ページ、ライトボックスを作成できます。

モダンCSS

detentsの作成には、 em, remビューポート単位、 calc()およびCSS変数を使用でき、デフォルトのサイズ設定は em に基づいています。

プラットフォームサポート備考
iOSとWebレイヤーWKWebView 内のカスタム要素
AndroidではWebレイヤーAndroid WebView 内のカスタム要素
WebはいCapacitor Web ビルドでも共通のコンポーネント

@capgo/capacitor-sheets 特定のUIフレームワークを採用せずに、高品質なモバイルオーバーレイを必要とする Capacitor アプリ向けです。カスタム要素として提供されるため、コアパッケージに React、Vue、Angular、Svelte、Solid などのランタイム依存関係はありません。

以下のような場合に最適です:

  • 1つ以上のデテント(高さ設定)を持つボトムシート
  • 左右のサイドバーおよびトップシート
  • 中央配置のダイアログ、ライトボックス、カード、トースト風オーバーレイ
  • 背後のアプリを操作できるパーシステントシート
  • 画面端から表示されるフルページオーバーレイ
  • シートの進行状況に応じたスタック、奥行き、パララックス効果
  • 進行状況や距離の値を取得できるスクロールヘルパー
  • ノッチ、ホームインジケーター、Androidの切り欠き、ソフトウェアキーボードに対応した Capacitor セーフなレイアウト
ユースケースCapgo Sheetsパターン
長いシートcap-sheet コンテンツを自然にスクロール、または cap-scroll
デテント付きシートdetents="18em 32em" と stepTo() またはステップトリガー
サイドバーcontent-placement="left" または content-placement="right"
ボトムシートデフォルト content-placement="bottom"
キーボード対応シートnative-focus-scroll-prevention およびビジュアルビューポートのオフセット制御
トーストinert-outside="false", focus-trap="false", 外側クリックによる非表示なし
デタッチドシートcap-sheet-special-wrapper カスタムマージンと角丸に対応
ボトムアップページフルハイトのボトムシートコンテンツ
トップシートcontent-placement="top"
スタッキング対応シートcap-sheet-stack depth変数付き
Depth付きSheetcap-sheet-outlet progress連動のtransform
パララックスページcap-sheet-outlet を使用して cap-scroll 進捗
ページ画面端から入るビューポート全体のコンテンツ
Lightboxcontent-placement="center" backdropとメディアコンテンツ付き
Detent付きPersistent Sheetdefault-presented, swipe-dismissal="false"や inert-outside="false"
Cardコンパクトで中央揃えのシートコンテンツ
  • <cap-sheet> 表示状態、detents、配置、ジェスチャー、アクセシビリティ、およびイベントを管理します。
  • <cap-sheet-trigger> present、dismiss、toggle、およびdetent-stepのアクションを定義します。
  • <cap-sheet-view> オーバーレイの位置を調整し、セーフエリアとキーボードのオフセットを適用します。
  • <cap-sheet-backdrop> 進捗と同期したバックドロップを描画します。
  • <cap-sheet-content> シートのサーフェスを描画します。
  • <cap-sheet-handle> ドラッグおよびキーボードによるdetentコントロールを提供します。
  • <cap-sheet-stack> スタックされたシートを制御します。
  • <cap-sheet-outlet> シートの進捗を、ページ、深度、およびパララックス効果に公開します。
  • <cap-scroll> と <cap-scroll-content> スクロールの進捗と距離のヘルパーを公開します。
  • setupSheet(element, options?) フレームワークのエフェクトやライフサイクルフックからシートを設定します。

デフォルトのシートビューポートは、 env(safe-area-inset-*) および Capacitor スタイルの --safe-area-inset-* フォールバック変数を読み取り、選択したエッジをオーバーレイ周囲のパディングとして適用します。 safe-area="auto" すべてのエッジを保護します。使用するのは safe-area="bottom left right" または safe-area="none" ユースケースで異なる挙動が必要な場合です。

キーボード処理はデフォルトで有効です。シートは次をリッスンします。 visualViewport リサイズやスクロールイベントに対応し、ビューポートにキーボードのオフセットを追加して、コントロールにフォーカスを当てます。 preventScroll これにより、入力フィールドがソフトウェアキーボードに隠れず、常に表示された状態を維持できます。

このパッケージはWebレイヤーで動作します。ネイティブのUIKitやAndroidのボトムシートをレンダリングしないため、Capacitor において重要なWebViewの制約を遵守しつつ、アプリのデザインを完全にコントロールできます。

リポジトリのREADMEには、サポートされているすべてのユースケースに対応したAnimated WebPのデモが含まれています。また、StackBlitzのPlaygroundからも例を確認できます:

長いシートDetents
@capgo/capacitor-sheets 用のAnimated Long Sheetデモ@capgo/capacitor-sheets 用のDetent付きAnimated Sheetデモ
サイドバーLightbox
@capgo/capacitor-sheets のアニメーションサイドバー・デモ@capgo/capacitor-sheets のアニメーションライトボックス・デモ

@capgo/capacitor-sheets からさらに学ぶ

「@capgo/capacitor-sheets からさらに学ぶ」セクション

使用している場合 @capgo/capacitor-sheets ネイティブプラグインの作業を計画するには、次と連携してください: Capgo プラグインディレクトリ Capgo プラグインディレクトリのプロダクトワークフローについては、 Capgo による Capacitor プラグイン Capgo による Capacitor プラグインの実装詳細については、 プラグインの追加または更新 プラグインの追加または更新に関する実装詳細については、 Ionic Enterprise プラグインの代替案 Ionic Enterprise Plugin Alternatives のプロダクトワークフロー、および Capgo Native Build Capgo Native Builds のプロダクトワークフローについては、