ガイド
ネイティブナビゲーションのチュートリアル
使用する@capgo/capacitor-native-navigation
@capgo/capacitor-native-navigation ネイティブトップナビゲーション、ボトムタブクローム、ルートトランジションシェルを単一のフルスクリーンCapacitor WebView 上にレンダリングします。ウェブフレームワークはルートとコンテンツを所有し、ネイティブはアプリフレームを所有します。
インストールと同期
npm install @capgo/capacitor-native-navigation
npx cap sync
ネイティブフレームを設定する
import { NativeNavigation } from '@capgo/capacitor-native-navigation';
await NativeNavigation.configure({
contentInsetMode: 'css',
animationDuration: 360,
colors: {
tint: '#0f172a',
inactiveTint: '#64748b',
},
});
ネイティブナビゲーションバーをレンダリングする
await NativeNavigation.setNavbar({
title: 'Inbox',
subtitle: 'Native chrome',
transparent: true,
backButton: { visible: false },
rightItems: [
{
id: 'compose',
title: 'Compose',
icon: {
svg: '<svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2"><path d="M12 20h9"/><path d="M16.5 3.5a2.12 2.12 0 0 1 3 3L7 19l-4 1 1-4Z"/></svg>',
},
},
],
});
ネイティブタブバーをレンダリングする
await NativeNavigation.setTabbar({
selectedId: 'inbox',
labelVisibilityMode: 'selected',
icons: true,
colors: {
dynamic: true,
tint: '#0f172a',
inactiveTint: '#64748b',
},
tabs: [
{
id: 'inbox',
title: 'Inbox',
icon: {
svg: '<svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2"><path d="M4 4h16v16H4z"/><path d="m4 13 4 4h8l4-4"/></svg>',
},
},
{
id: 'search',
title: 'Search',
icon: {
svg: '<svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2"><circle cx="11" cy="11" r="7"/><path d="m20 20-3-3"/></svg>',
},
},
],
});
ネイティブイベントをルーターに接続する
ネイティブバーは意図を発信します。ルーターはまだルート変更を実行します:
await NativeNavigation.addListener('navbarBack', () => {
router.back();
});
await NativeNavigation.addListener('navbarItemTap', ({ id }) => {
if (id === 'compose') router.push('/compose');
});
await NativeNavigation.addListener('tabSelect', ({ id }) => {
router.push(`/${id}`);
});
ルート変更をアニメーションする
通常のWebルート更新の周りにトランジショントランザクションを使用する:
const transition = await NativeNavigation.beginTransition({
direction: 'forward',
});
router.push('/message/42');
await router.ready?.();
await NativeNavigation.setNavbar({
title: 'Message',
backButton: { visible: true, title: 'Inbox' },
});
await NativeNavigation.finishTransition({
id: transition.id,
direction: 'forward',
});
ズームトランジションを追加する
カード、グリッドアイテム、またはメディアプレビューから開くルートの場合、ルートのズームヘルパーを使用する
import { beginZoomTransition, finishZoomTransition } from '@capgo/capacitor-native-navigation';
const card = document.querySelector('[data-message-card]');
if (card) {
const transition = await beginZoomTransition(card, { cornerRadius: 18 });
router.push('/message/42');
await router.ready?.();
await NativeNavigation.setNavbar({
title: 'Message',
backButton: { visible: true, title: 'Inbox' },
});
await finishZoomTransition(undefined, {
id: transition.id,
cornerRadius: 18,
});
}
ネイティブインセットでコンテンツをパディングする
「 contentInsetMode 」は css, native バーのCSS 変数を書き出します:
.page {
padding-top: var(--cap-native-navigation-top);
padding-bottom: var(--cap-native-navigation-bottom);
}
アイコンの選択肢
アイコンは、React または Vue ノードではありません。native アセットをバンドルしない場合に使用するSVG を使用してください:
const icon = {
svg: '<svg viewBox="0 0 24 24"><path d="M3 10.5 12 3l9 7.5"/></svg>',
template: true,
ios: { sfSymbol: 'house.fill' },
android: { resource: 'ic_menu_view' },
};
インライン SVG は path, line, polyline, polygon, circle, rect,
Combine with @capgo/capacitor-transitions
@__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-transitions を組み合わせてください。 @capgo/capacitor-transitions native navbar、tabbar、safe-area insets、native インテント イベントを使用するNative Navigation を使用します。
npm install @capgo/capacitor-native-navigation @capgo/capacitor-transitions
npx cap sync
native chrome の下の WebView ページ スタックを使用する場合、
import { NativeNavigation } from '@capgo/capacitor-native-navigation';
import '@capgo/capacitor-transitions';
import { initTransitions, setupRouterOutlet, setDirection } from '@capgo/capacitor-transitions/react';
initTransitions({ platform: 'auto' });
const outlet = document.querySelector('cap-router-outlet');
if (outlet) {
setupRouterOutlet(outlet, { platform: 'auto', swipeGesture: 'auto' });
}
await NativeNavigation.configure({
contentInsetMode: 'css',
});
両方のパッケージを一度に初期化します。
<cap-router-outlet platform="auto" swipe-gesture="auto">
<cap-page>
<cap-content slot="content" fullscreen>
<main class="page">Inbox content</main>
</cap-content>
</cap-page>
</cap-router-outlet>
ページに、web バーを複製しないtransition 出力の焦点を維持します。
async function openMessage(id: string) {
setDirection('forward');
await router.push(`/messages/${id}`);
await NativeNavigation.setNavbar({
title: 'Message',
backButton: { visible: true, title: 'Inbox' },
});
}
await NativeNavigation.addListener('navbarBack', () => {
setDirection('back');
router.back();
});
await NativeNavigation.addListener('tabSelect', ({ id }) => {
setDirection('root');
router.push(`/${id}`);
});
Pick one animation layer per route change. Let @capgo/capacitor-transitions animate normal page pushes, and use Native Navigation's zoom helpers only for shared-element or zoom routes.
Full Reference
- GitHub https://github.com/Cap-go/capacitor-native-navigation/
- ドキュメント: /docs/plugins/native-navigation/
Keep going from Using @capgo/capacitor-native-navigation
Capgoを使用している場合 Using @capgo/capacitor-native-navigation nativeメディアとインターフェイスの動作を計画する場合、@__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-native-navigation @capgo/capacitor-native-navigation @capgo/capacitor-native-navigationの実装詳細は@capgo/capacitor-native-navigation スタート スタートの実装詳細について @capgo/capacitor-live-activitiesを使用する @capgo/capacitor-live-activitiesのネイティブ機能について @capgo/capacitor-live-activities @capgo/capacitor-live-activitiesの実装詳細について @capgo/capacitor-video-playerを使用する @capgo/capacitor-video-playerのネイティブ機能について