トランジション

@capgo/capacitor-transitions

@capgo/capacitor-transitions Capacitorアプリにイオニックスタイルのルート トランジションを追加します。イオニックUIを採用することなく、Capacitorアプリにイオニックスタイルのルート トランジションを追加します。ウェブ層で実行し、既存のルーターを維持し、iOSエッジスワイプバックジェスチャーを自動で有効にすることができます。ただし、iOSエッジスワイプバックジェスチャーは、Capacitor iOSのみで有効になります。

インストール

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.IntrinsicElementsVite、Create React App、およびほとんどのwebpack Reactアプリでは、そのファイルを

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

の下に保管するだけで十分です。Next.jsまたはカスタムのTypeScript設定の場合、含まれていることを確認してください。 src/ スワイプバックを有効にする tsconfig.json:

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

使用する

Use 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

ネイティブのクロームを設定し、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);
}

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

フルリファレンス

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

Keep going from Using @capgo/capacitor-transitions

Capacitor-Transitionsを使用している場合 Using @capgo/capacitor-transitions Capacitor-Transitionsを使用している場合 @capgo/capacitor-transitions for the implementation detail in @capgo/capacitor-transitions, Capacitor-Transitionsを使用している場合 Capacitorトランジションの使用方法については、Getting Startedを参照してください。 Using @capgo/capacitor-live-activities for the native capability in Using @capgo/capacitor-live-activities, @capgo/capacitor-live-activities for the implementation detail in @capgo/capacitor-live-activities, and Using @capgo/capacitor-video-player for the native capability in Using @capgo/capacitor-video-player.