トランジション

Using @capgo/capacitor-transitions

@capgo/capacitor-transitions adds Ionic-style route transitions to Capacitor apps without adopting Ionic UI. It runs in the web layer, keeps your existing router, and can auto-enable an iOS edge swipe-back gesture only inside native Capacitor iOS.

__CAPGO_KEEP_0__

npm install @capgo/capacitor-transitions

code

要素を登録する

import '@capgo/capacitor-transitions';

ページを Wrap する

<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" to enable the gesture only when Capacitor reports a native iOS runtime:

<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 ネイティブレイヤーがナビゲーションバーまたはタブバーを所有する場合に使用

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 アニメーションページボディとネイティブナビゲーション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の@capgo/capacitor-transitionsを使用し続ける

Capacitorを使用している場合 @capgo/capacitor-transitionsを使用して Capacitorの@__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-transitionsと接続します。 Capacitorの@capgo/capacitor-transitionsの実装詳細を参照してください for the implementation detail in @capgo/capacitor-transitions, @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-transitionsを使用 Capacitorの実装詳細については、Getting Startedを参照してください。 capgo/capacitor-live-activitiesを使用します。 Capacitorのネイティブ機能については、capgo/capacitor-live-activitiesを使用します。 capgo/capacitor-live-activities Capacitorの実装詳細については、capgo/capacitor-live-activitiesを参照してください。また、 capgo/capacitor-video-playerを使用します。 Capacitorのネイティブ機能については、capgo/capacitor-video-playerを使用します。