Prise en main

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 une installation manuelle, installez le plugin en exécutant les commandes suivantes et 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

Assortissez 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 lecteur immersif

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 la barre de navigation iOS dans ce plugin.
• Edge to edge: combinez avec votre barre d'état 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

Définir la couleur de la barre de navigation et le thème des boutons.

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 prédéfinies de la barre de navigation.

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 de src/definitions.ts. Relancez la synchronisation lorsque l’API public change en amont.

Continuer depuis Getting Started

Si vous utilisez Prise en main pour planifier le comportement des médias et de l'interface natifs, connectez-l’à Utiliser @capgo/capacitor-navigation-bar pour la fonctionnalité native dans l'utilisation de @capgo/capacitor-navigation-bar, Utiliser @capgo/capacitor-live-activities pour la capacité native dans 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.