スタートガイド

インストール手順と、このプラグインの完全なMarkdownガイドを含むセットアッププロンプトをコピーします。

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-native-navigation`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/native-navigation/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

インストール

AIアシストによるセットアップでプラグインをインストールできます。以下のコマンドを使用して、お使いの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.

手動セットアップを希望する場合は、以下のコマンドを実行してプラグインをインストールし、下記のプラットフォーム別の手順に従ってください：

パッケージをインストール
ターミナル
```
npm i @capgo/capacitor-native-navigation
```
ネイティブプロジェクトを同期
ターミナル
```
npx cap sync
```

ネイティブのChromeを設定する

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

await NativeNavigation.configure({
  contentInsetMode: 'css',
  animationDuration: 360,
  colors: {
    tint: '#0f172a',
    inactiveTint: '#64748b',
  },
});

ネイティブのnavbarを表示する

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

ネイティブのtabbarを表示する

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

ネイティブのintentイベントを処理する

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

渡す segments まで setNavbar バーの下にネイティブセグメントの行をスタックするには、例えば上部にスコープスイッチャー、その下にセクションタブを配置する場合などです。行は上から下へ描画され、各行がナビゲーションバーとレポートされるインセットに44pt (iOS) または48dp (Android) を加算します。iOSでは UISegmentedControl とガラス調のピルを使用します。AndroidではMaterialのセグメントボタンとフィルターチップを使用します。

iOSと	Androidでは

const sections = {
  account: ['General', 'Notifications', 'Password', 'Two-factor'],
  organization: ['General', 'Members', 'Plans', 'Usage', 'Credits', 'Billing', 'Security', 'Webhooks'],
};
const selection = { scope: 'account', section: 'general' };

const renderNavbar = () =>
  NativeNavigation.setNavbar({
    title: 'Settings',
    segments: [
      {
        id: 'scope',
        selectedId: selection.scope,
        items: [
          { id: 'account', title: 'Account' },
          { id: 'organization', title: 'Organization' },
        ],
      },
      {
        id: 'section',
        style: 'scroll', // scrolling chips; `auto` uses `segmented` for up to 4 items
        selectedId: selection.section,
        items: sections[selection.scope].map((title) => ({ id: title.toLowerCase(), title })),
      },
    ],
  });

await NativeNavigation.addListener('navbarSegmentSelect', async ({ groupId, id }) => {
  if (groupId === 'scope') {
    selection.scope = id;
    selection.section = 'general'; // the second level depends on the first one
  } else {
    selection.section = id;
  }
  await renderNavbar();
});

await renderNavbar();

ユーザーがタップすると選択はネイティブに移動しますが、各 setNavbar 呼び出しが selectedId を再適用します。選択したIDはステートに保持し、その後の各 setNavbar 呼び出しに渡してください。選択を拒否するには、以前の selectedIdを送信してください。アイテムは次も受け付けます icon, accessibilityLabelや enabled. を渡します segments: [] 行を削除します。8.13.0 以降で利用可能です。

遷移フロー

ネイティブトランジションは、通常の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',
});

ズーム遷移

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

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

@capgo/capacitor-transitions と併用

ネイティブのnavbar、tabbar、セーフエリアのインセット、ネイティブのintentイベントには Native Navigation を使用します。また、 @capgo/capacitor-transitions ネイティブのchromeの下にあるWebViewのページスタックにはこちらを使用します。

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 通常のページ遷移はアニメーションさせ、Native Navigationのズームヘルパーは共有要素やズームが必要なルートのみに使用してください。

CSSのinset値

を使用すると、 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

アイコンディスクリプタ

ネイティブUIで描画するため、アイコンはシリアライズ可能である必要があります。クロスプラットフォーム対応のSVG、プラットフォーム固有のSVG、SF Symbols、iOSのバンドル画像、Androidのdrawableリソース、またはAndroidのバンドル画像を使用できます。

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

インラインSVGは、LucideやFeatherなどの一般的なアイコンセットで使用されている、アイコンに特化したサブセットをサポートしています： path, line, polyline, polygon, circleや rect. SVGアイコンはデフォルトでテンプレート画像として描画されるため、ネイティブのtint colorで色を変更できます。

オプションの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>

iPhone Duo (iOS 27)

iPhone Duoでは、iOSはシステムタブバーとステータスバーをしばしば 縦のサイドレールに. env(safe-area-inset-top) 〜が可能です。 0 配置する一方で、 left または right 拡大します。設定してください。 viewport-fit=cover アプリ内のどこかで CSS env でパディングする場合は、viewport meta タグに設定します。Xcode Device Hub で、折りたたみ・展開・横向き・Split View の各状態をテストしてください。

Native Navigation は実際の UINavigationBar と UITabBarを使用しているため、 システムタブバーはレールの。 曲線に沿います タブバーの形状は下部に固定され、ウィンドウが広がっても中央のアクションは円形のくぼみに収まります。

展開時の横向きレイアウト2つ。左側ではシステムタブバーがサイドレールに配置され、右側では曲線タブバーが下部に沿い、中央のアクションが円形のくぼみに収まります。

を使用すると、 contentInsetMode: 'css'、プラグイン変数で Web コンテンツにパディングします。使う場合は max() エッジごとの env フォールバック付きで、プラグイン変数が欠けてもレイアウトが正しく保たれるように 0 インセットの重複を防ぐには：

main {
  padding-top: max(var(--cap-native-navigation-top, 0px), env(safe-area-inset-top, 0px));
  padding-right: max(var(--cap-native-navigation-right, 0px), env(safe-area-inset-right, 0px));
  padding-bottom: max(var(--cap-native-navigation-bottom, 0px), env(safe-area-inset-bottom, 0px));
  padding-left: max(var(--cap-native-navigation-left, 0px), env(safe-area-inset-left, 0px));
}

を監視します： safeAreaChanged (または capNativeNavigation:safeAreaChanged で window) レール側の状態や折りたたみ状態が変化したとき。ホストされたシステムのタブバーでは、 insets.tabbarHeight 可能性があります 0 ボトムパディングの二重適用を避けるために、以下を使用してください： insets.systemTabbarHeight または --cap-native-system-tabbar-height FABのオフセットには使用します。

Capacitorに関するガイドライン（viewport-fit、System Bars、Status Bar、テストについて）： Capacitor アプリでの iPhone Duo サポート.

プラットフォーム別の注意点

iOSのレンダリング: UINavigationBar と UITabBariOS 26以降では、システムのLiquid Glassバーの挙動を使用します。
Androidでは、AppCompatツールバーとMaterialボトムナビゲーションをレンダリングします。
Webフォールバックではネイティブバーを描画しません。ブラウザ開発用に、イベントとinset変数をミラーリングします。
このプラグインは、フルスクリーンのCapacitor WebViewを1つ保持します。フレーム、バー、セーフエリアのレポート、およびトランジションシェルはネイティブ側が制御します。

Getting Startedの続きを進める

使用している場合 スタートガイド ネイティブメディアとインターフェースの挙動を計画するには、次と連携させてください @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 を使用する際のネイティブ機能については、 @capgo/capacitor-video-player @capgo/capacitor-video-player. の実装の詳細については