@capgo/capacitor-navigation-bar

Capacitor Navigation Bar Plugin for customizing the Android navigation bar.

Overview

@capgo/capacitor-navigation-bar styles the Android system navigation bar (color, light or dark buttons, immersive hide and show). Use it when your Capacitor shell is full screen and the default gray bar clashes with your brand.

iOS has no software navigation bar. Plugin calls reject on iOS, so guard Android-only code paths or handle the rejection.

Platform support

Platform	Support
Android	Yes, API 24+
iOS	No system navigation bar to customize

Core Capabilities

setNavigationBarColor - Set the navigation bar color and button theme.
getNavigationBarColor - Get the current navigation bar color and button theme.

Public API

Method	Description
`setNavigationBarColor`	Set the navigation bar color and button theme.
`getNavigationBarColor`	Get the current navigation bar color and button theme.
`getPluginVersion`	Get the native Capacitor plugin version.

Source Of Truth

This reference is synced from src/definitions.ts in capacitor-navigation-bar.

If you are using @capgo/capacitor-navigation-bar to plan native media and interface behavior, connect it with Using @capgo/capacitor-navigation-bar for the native capability in Using @capgo/capacitor-navigation-bar, Using @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, Using @capgo/capacitor-video-player for the native capability in Using @capgo/capacitor-video-player, and @capgo/capacitor-video-player for the implementation detail in @capgo/capacitor-video-player.