ガイド
トランジションのチュートリアル
@capgo/capacitor-transitions を使用する
@capgo/capacitor-transitions Ionicスタイルのルートトランジションを追加します。CapacitorアプリにIonic UIを採用することなく実行します。Web層で実行し、既存のルーターを維持し、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 Vite、Create React App、およびほとんどのwebpack Reactアプリの場合、そのファイルを保持することをお勧めします。 JSX.IntrinsicElementsファイルを追加する:
// src/capgo-transitions.d.ts
import '@capgo/capacitor-transitions/react';
For Vite, Create React App, and most webpack React apps, keeping that file under 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 ネイティブ層がナビゲーションバーまたはタブバーを所有する場合に使用してください。
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);
}
ネイティブナビゲーションバーを移動するウェブヘッダーとして複製しないでください。 @capgo/native-navigation バーはネイティブに保持します。 @capgo/capacitor-transitions それに下のページコンテンツをアニメーションします。
フルリファレンス
- GitHub https://github.com/Cap-go/capacitor-transitions/
- /docs/plugins/transitions/ドキュメント
capgo/capacitor-transitionsを使用している場合
__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-transitionsを使用 Using @capgo/capacitor-transitions https://__CAPGO_KEEP_0__.com/Cap-go/__CAPGO_KEEP_1__-transitions/ @capgo/capacitor-transitions @capgo/capacitor-transitionsの実装詳細 Getting Started Getting Startedの実装詳細 Using @capgo/capacitor-live-activities Using @capgo/capacitor-live-activitiesのネイティブ機能 @capgo/capacitor-live-activities @capgo/capacitor-live-activitiesの実装詳細 Using @capgo/capacitor-video-player Using @capgo/capacitor-video-playerのネイティブ機能