トランジション Capacitor プラグイン

@capgo/capacitor-transitions の活用

@capgo/capacitor-transitions Ionic UI を採用せずに、Capacitor アプリへ Ionic スタイルのルート遷移を追加します。Web レイヤーで動作し、既存のルーターを維持したまま、ネイティブの Capacitor iOS 内でのみ iOS のエッジスワイプバックジェスチャーを自動有効化できます。

インストール

npm install @capgo/capacitor-transitions

このパッケージはネイティブプラグイン code を追加しないため、ネイティブ同期ステップはありません。

要素を登録する

import '@capgo/capacitor-transitions';

ページをラップする

<cap-router-outlet platform="auto" swipe-gesture="auto">
  <cap-page>
    <cap-header slot="header">
      <h1>Inbox</h1>
    </cap-header>

    <cap-content slot="content">
      <button>Open message</button>
    </cap-content>

    <cap-footer slot="footer">
      <nav>Tabs</nav>
    </cap-footer>
  </cap-page>
</cap-router-outlet>

ルーターに接続する

通常のルート更新の前に、遷移方向を設定します：

import { setDirection } from '@capgo/capacitor-transitions/react';

setDirection('forward');
router.push('/message/42');

setDirection('back');
router.back();

React の例

import { useEffect, useRef } from 'react';
import { useNavigate } from 'react-router-dom';
import { initTransitions, setDirection, setupPage, setupRouterOutlet } from '@capgo/capacitor-transitions/react';
import '@capgo/capacitor-transitions';

initTransitions({ platform: 'auto' });

export function AppShell() {
  const outletRef = useRef<HTMLElement>(null);

  useEffect(() => {
    if (!outletRef.current) return;
    setupRouterOutlet(outletRef.current, { platform: 'auto', swipeGesture: 'auto' });
  }, []);

  return <cap-router-outlet ref={outletRef}>{/* routes */}</cap-router-outlet>;
}

export function InboxPage() {
  const navigate = useNavigate();
  const pageRef = useRef<HTMLElement>(null);

  useEffect(() => {
    if (!pageRef.current) return;
    return setupPage(pageRef.current);
  }, []);

  return (
    <cap-page ref={pageRef}>
      <cap-header slot="header">
        <h1>Inbox</h1>
      </cap-header>
      <cap-content slot="content">
        <button
          onClick={() => {
            setDirection('forward');
            navigate('/message/42');
          }}
        >
          Open message
        </button>
      </cap-content>
    </cap-page>
  );
}

React 用のサブパスには、カスタム要素の JSX 型定義が含まれています。TypeScript で依然として cap-router-outlet が JSX.IntrinsicElementsに存在しないと表示される場合は、以下のファイルを追加してください：

// src/capgo-transitions.d.ts
import '@capgo/capacitor-transitions/react';

Vite、Create React App、およびほとんどの webpack React アプリでは、そのファイルを次のディレクトリ配下に置く場合： src/ で十分です。Next.js やカスタム TypeScript 構成では、以下に含まれていることを確認してください： tsconfig.json:

{
  "include": ["src", "src/capgo-transitions.d.ts"]
}

スワイプバックを有効にする

使用する swipe-gesture="auto" Capacitor がネイティブの iOS ランタイムを報告した場合のみジェスチャーを有効にします：

<cap-router-outlet swipe-gesture="auto"></cap-router-outlet>

JavaScript から強制することも可能です：

const outlet = document.querySelector('cap-router-outlet');

outlet?.setSwipeGesture(true);
outlet?.setSwipeGesture(false);
outlet?.setSwipeGesture('auto');

ジェスチャーは遷移中に指に追従し、ユーザーが指を離すと完了またはキャンセルされます。次を追加してください： data-swipe-gesture-ignore エッジジェスチャーを開始させたくないボタン、スライダー、ドロワーに指定します。

ネイティブナビゲーションと併用する

インストール @capgo/native-navigation ネイティブレイヤーが navbar や tabbar を制御する場合：

npm install @capgo/native-navigation
npx cap sync

ネイティブの chrome を設定し、遷移は WebView ページに限定します：

import { NativeNavigation } from '@capgo/native-navigation';
import { setDirection } from '@capgo/capacitor-transitions/react';
import { router } from './router';

await NativeNavigation.configure({
  contentInsetMode: 'css',
});

await NativeNavigation.setNavbar({
  title: 'Inbox',
  backButton: { visible: false },
});

await NativeNavigation.addListener('navbarBack', () => {
  setDirection('back');
  router.back();
});

async function openMessage(id: string) {
  setDirection('forward');
  router.push(`/message/${id}`);

  await NativeNavigation.setNavbar({
    title: 'Message',
    backButton: { visible: true, title: 'Inbox' },
  });
}

使用する cap-content アニメーション付きのページボディと、インセット用の native-navigation CSS 変数について：

<cap-router-outlet platform="auto" swipe-gesture="auto">
  <cap-page>
    <cap-content slot="content" fullscreen>
      <main class="native-page">Inbox content</main>
    </cap-content>
  </cap-page>
</cap-router-outlet>

.native-page {
  padding-top: var(--cap-native-navigation-top);
  padding-bottom: var(--cap-native-navigation-bottom);
}

ネイティブのナビゲーションバーを、動く Web ヘッダーとして複製しないでください。 @capgo/native-navigation バーをネイティブのままにし、 @capgo/capacitor-transitions その下のページコンテンツをアニメーションさせます。

リファレンス全文

• GitHub: https://github.com/Cap-go/capacitor-transitions/
• ドキュメント: /docs/plugins/transitions/

「@capgo/capacitor-transitions の使用」から続ける

使用している場合 @capgo/capacitor-transitions の活用 ネイティブメディアとインターフェースの挙動を計画するには、次と連携させてください @capgo/capacitor-transitions @capgo/capacitor-transitions の実装詳細については、 スタートガイド スタートガイドの実装詳細については、 @capgo/capacitor-live-activities の使用 @capgo/capacitor-live-activities の使用におけるネイティブ機能については、 @capgo/capacitor-live-activities @capgo/capacitor-live-activities の実装の詳細については、 @capgo/capacitor-video-playerの使用方法 「@capgo/capacitor-video-player. の使い方」のネイティブ機能については