スタートガイド

インストール

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-navigation-bar` plugin in my project.

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

bun add @capgo/capacitor-navigation-bar
bunx cap sync

インポート

import { NavigationBar } from '@capgo/capacitor-navigation-bar';

クイックスタート

ダークなヘッダーと明るいアイコンにナビゲーションバーを合わせる。

import { NavigationBar } from '@capgo/capacitor-navigation-bar';

await NavigationBar.setNavigationBarColor({
  color: '#0f172a',
  darkButtons: false,
});

例: イマーシブリーダーモード

await NavigationBar.hide();
// later, when leaving the reader
await NavigationBar.show();

例: 現在のテーマを読み取る

const { color, darkButtons } = await NavigationBar.getNavigationBarColor();

よくある落とし穴

• Android のみ: このプラグインには iOS のナビゲーションバーに相当する機能はありません。
• エッジトゥエッジステータスバーと WebView のセーフエリア CSS と組み合わせることで、バーが再表示された際にコンテンツが隠れないようにします。

API の概要

setNavigationBarColor

ナビゲーションバーの色とボタンのテーマを設定します。

import { NavigationBar, NavigationBarColor } from '@capgo/capacitor-navigation-bar';

// Set to white with dark buttons
await NavigationBar.setNavigationBarColor({
  color: NavigationBarColor.WHITE,
  darkButtons: true
});

// Set to custom color
await NavigationBar.setNavigationBarColor({
  color: '#FF5733',
  darkButtons: false
});

// Set a custom divider color on Android 9+
await NavigationBar.setNavigationBarColor({
  color: NavigationBarColor.WHITE,
  darkButtons: true,
  dividerColor: '#D9D9D9'
});

getNavigationBarColor

現在のナビゲーションバーの色とボタンのテーマを取得します。

import { NavigationBar } from '@capgo/capacitor-navigation-bar';

const { color, darkButtons } = await NavigationBar.getNavigationBarColor();
console.log('Current color:', color);
console.log('Using dark buttons:', darkButtons);

型リファレンス

NavigationBarColor

ナビゲーションバーのプリセットカラー。

export enum NavigationBarColor {
  /** White color */
  WHITE = '#FFFFFF',
  /** Black color */
  BLACK = '#000000',
  /** Transparent color */
  TRANSPARENT = 'transparent',
}

Source of Truth

このページはプラグインの src/definitions.tsから生成されています。upstream で公開 API が変更されたら、再度 sync を実行してください。

Getting Startedの続きを進める

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