Premiers pas

Copiez un prompt de configuration avec les étapes d'installation et le guide markdown complet pour ce plugin.

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-navigation-bar`
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/navigation-bar/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.

Installer

Vous pouvez utiliser notre configuration assistée par IA pour installer le plugin. Ajoutez les skills Capgo à votre outil d'IA avec la commande suivante :

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

Utilisez ensuite le prompt suivant :

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

Si vous préférez la configuration manuelle, installez le plugin avec les commandes suivantes, puis suivez les instructions spécifiques à chaque plateforme ci-dessous :

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

Importer

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

Démarrage rapide

Adaptez la barre de navigation à un header sombre et des icônes claires.

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

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

Exemple : mode lecture immersive

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

Exemple : lire le thème actuel

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

Erreurs courantes

Android uniquement : il n'existe pas d'équivalent de barre de navigation iOS dans ce plugin.
Edge to edge: combinez-l’avec votre barre de statut et le CSS de la safe area de la WebView pour que le contenu ne soit pas masqué lorsque la barre réapparaît.

Aperçu de API

`setNavigationBarColor`

Set the navigation bar color and button theme.

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`

Récupérez la couleur actuelle de la barre de navigation et le thème des boutons.

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

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

Référence de type

`NavigationBarColor`

Couleurs de barre de navigation prédéfinies.

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

Source de vérité

Cette page est générée à partir du src/definitions.ts. Relancez la synchronisation lorsque l’API public change en amont.

Continuer depuis Getting Started

Si vous utilisez Premiers pas pour planifier le comportement des médias et de l'interface natifs, connectez-l’à Utiliser @capgo/capacitor-navigation-bar pour la capacité native dans Utiliser @capgo/capacitor-navigation-bar, Utiliser @capgo/capacitor-live-activities pour la fonctionnalité native de la page Utiliser @capgo/capacitor-live-activities, @capgo/capacitor-live-activities pour le détail d'implémentation dans @capgo/capacitor-live-activities , Utiliser @capgo/capacitor-video-player pour la capacité native dans Utiliser @capgo/capacitor-video-player , et @capgo/capacitor-video-player pour le détail d'implémentation dans @capgo/capacitor-video-player.