Getting Started

インストール

CapgoのAI-Assisted Setupを使用してプラグインをインストールできます。AIツールにCapgoスキルを追加するには、以下のコマンドを実行してください。

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

次に、以下のプロンプトを使用してください。

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-native-navigation` plugin in my project.

Manual Setupを使用する場合は、以下のコマンドを実行してプラグインをインストールし、以下のプラットフォーム固有の指示に従ってください。

1. パッケージをインストール

   npm i @capgo/capacitor-native-navigation

2. ネイティブプロジェクトを同期

   npx cap sync

3. ネイティブChromeを設定

   import { NativeNavigation } from '@capgo/capacitor-native-navigation';
   
   await NativeNavigation.configure({
     contentInsetMode: 'css',
     animationDuration: 360,
     colors: {
       tint: '#0f172a',
       inactiveTint: '#64748b',
     },
   });

4. ネイティブナビゲーションバーをレンダリング

   await NativeNavigation.setNavbar({
     title: 'Home',
     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>',
         },
       },
     ],
   });

5. ネイティブタブバーをレンダリング

   await NativeNavigation.setTabbar({
     selectedId: 'home',
     labelVisibilityMode: 'selected',
     icons: true,
     colors: {
       dynamic: true,
       tint: '#0f172a',
       inactiveTint: '#64748b',
     },
     tabs: [
       {
         id: 'home',
         title: 'Home',
         icon: {
           svg: '<svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2"><path d="M3 10.5 12 3l9 7.5"/><path d="M5 10v10h14V10"/></svg>',
         },
       },
       {
         id: 'settings',
         title: 'Settings',
         badge: '2',
         icon: {
           svg: '<svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2"><circle cx="12" cy="12" r="3"/><path d="M12 2v3M12 19v3M2 12h3M19 12h3"/></svg>',
         },
       },
     ],
   });

6. ネイティブイベントを処理

   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}`);
   });

Transition flow

通常のJavaScriptルート変更のトランザクションとして、ネイティブのトランジションが実行されます。

const transition = await NativeNavigation.beginTransition({
  direction: 'forward',
});

router.push('/detail');
await router.ready?.();

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

await NativeNavigation.finishTransition({
  id: transition.id,
  direction: 'forward',
});

Zoom transition

カードから詳細へのフロー、またはメディアのプレビューのフローでカードを詳細に切り替える際に、ズームのヘルパーを使用します。ルーターのコンテンツが変更される前にタップされた要素を渡し、詳細ページが準備されたら終了します。

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,
  });
}

Native Navigationと@capgo/capacitor-transitionsを使用する

ネイティブのナビゲーションバー、タブバー、セーフエリアのインセット、ネイティブのイベントを使用するNative Navigation。ウェブビューのページスタックはネイティブのchromeの下にあります。 @capgo/capacitor-transitions Native Navigationと@__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-transitionsを使用する

npm install @capgo/capacitor-native-navigation @capgo/capacitor-transitions
npx cap sync

両パッケージを一度に初期化する:

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 ページに焦点を当て、重複したWebバーを無視する:

<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>

両パッケージを同じルーター アクションからドライブする:

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}`);
});

ルート変更ごとに1つのアニメーションレイヤーを選択する。通常のページのプッシュをアニメーション化し、共有要素またはズーム ルートの場合のみ、ネイティブ ナビゲーションのズーム ヘルパーを使用する。 @capgo/capacitor-transitions CSS インセット

__CAPGO_KEEP_0__

そして contentInsetMode: 'css'プラグインは、 document.documentElement.

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

利用可能な変数:

• --cap-native-navigation-top
• --cap-native-navigation-right
• --cap-native-navigation-bottom
• --cap-native-navigation-left
• --cap-native-navbar-height
• --cap-native-tabbar-height

アイコンの説明

コピーする

const icon = {
  svg: '<svg viewBox="0 0 24 24"><path d="M3 10.5 12 3l9 7.5"/></svg>',
  width: 24,
  height: 24,
  template: true,
  src: 'fallback_asset_name',
  ios: {
    svg: '<svg viewBox="0 0 24 24"><path d="M3 10.5 12 3l9 7.5"/></svg>',
    sfSymbol: 'house.fill',
    image: 'BundledAssetName',
  },
  android: {
    svg: '<svg viewBox="0 0 24 24"><path d="M3 10.5 12 3l9 7.5"/></svg>',
    resource: 'ic_menu_view',
    image: 'bundled_drawable_name',
  },
};

、 path, line, polyline, polygon, circleSVG アイコンは、デフォルトではテンプレート画像としてレンダリングされるため、ネイティブのタント カラーでそれらを再色化できます。 rectコピーする

オプションのWebコンポーネント

フレームワーク非依存の宣言的設定用に、パッケージはカスタム要素を登録できます:

import { defineNativeNavigationElements } from '@capgo/capacitor-native-navigation';

defineNativeNavigationElements();

<cap-native-navigation-provider enabled="true" content-inset-mode="css"></cap-native-navigation-provider>

<cap-native-navbar
  title="Home"
  transparent
  right-items='[{"id":"compose","title":"Compose","icon":{"svg":"<svg viewBox=\"0 0 24 24\"><path d=\"M12 20h9\"/></svg>"}}]'
></cap-native-navbar>

<cap-native-tabbar
  selected-id="home"
  tabs='[{"id":"home","title":"Home","icon":{"ios":{"sfSymbol":"house.fill"}}}]'
></cap-native-tabbar>

注意

Webコンポーネントはオプションです。React、Vue、Angular、Svelte、Solid、vanillaアプリはすべて、直接 API を使用できます。

プラットフォームに関する注意

• iOSはレンダリングします UINavigationBar と UITabBar; iOS 26+ はシステムの Liquid Glass バー動作を使用します。
• Android は AppCompat ツールバーと Material の下部ナビゲーションをレンダリングします。
• Web の fallback はネイティブバーを描画しません。イベントとブラウザ開発用のインセット変数をミラーリングします。
• プラグインは 1 つのフルスクリーンの Capacitor WebView を保持します。ネイティブはフレーム、バー、安全エリアの報告、トランジションシェルを所有します。

Getting Started から続けてください

Capgo を使用している場合 Capgo を使用している場合、 Capgo を使用している場合、 Capgo を使用している場合、Capacitor の @capgo/capacitor-native-navigation を使用してネイティブ機能を接続します。 Capacitor の @capgo/capacitor-native-navigation を使用してネイティブ機能を接続する場合、Capacitor の @capgo/capacitor-native-navigation を使用してネイティブ機能を接続します。 Capacitor の @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, @capgo/capacitor-live-activities for the native capability in Using @capgo/capacitor-video-player, and @capgo/capacitor-video-player for the implementation detail in @capgo/capacitor-video-player.