capacitor-navigation-bar

Set navigation bar color for android lollipop and higher

Documentation

The most complete doc is available here: https://capgo.app/docs/plugins/navigation-bar/

Compatibility

| Plugin version | Capacitor compatibility | Maintained | | -------------- | ----------------------- | ---------- | | v8.*.* | v8.*.* | ✅ | | v7.*.* | v7.*.* | On demand | | v6.*.* | v6.*.* | ❌ | | v5.*.* | v5.*.* | ❌ |

Note: The major version of this plugin follows the major version of Capacitor. Use the version that matches your Capacitor installation (e.g., plugin v8 for Capacitor 8). Only the latest major version is actively maintained.

Install

You can use our AI-Assisted Setup to install the plugin. Add the Capgo skills to your AI tool using the following command:

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

Then use the following prompt:

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

If you prefer Manual Setup, install the plugin by running the following commands and follow the platform-specific instructions below:

npm install @capgo/capacitor-navigation-bar
npx cap sync

Example Apps

• example-app: Interactive showcase that exercises all plugin options (color presets, custom hex, dark buttons, state reading).

Configuration

You can apply navigation bar defaults when the native plugin loads:

import type { CapacitorConfig } from '@capacitor/cli';

const config: CapacitorConfig = {
  plugins: {
    NavigationBar: {
      color: '#ffffff',
      dividerColor: '#d9d9d9',
      style: 'LIGHT',
    },
  },
};

export default config;

style accepts LIGHT, DARK, or DEFAULT. Use LIGHT for dark buttons, DARK for light buttons, and DEFAULT to follow the current device appearance.

API

• hide()
• show()
• setNavigationBarColor(...)
• getNavigationBarColor()
• getPluginVersion()
• Enums

Capacitor Navigation Bar Plugin for customizing the Android navigation bar.

hide()

hide() => Promise<void>

Hide the navigation bar.

Only available on Android.

Since: 8.2.0

show()

show() => Promise<void>

Show the navigation bar.

Only available on Android.

Since: 8.2.0

setNavigationBarColor(...)

setNavigationBarColor(options: { color: NavigationBarColor | string; darkButtons?: boolean; dividerColor?: NavigationBarColor | string; }) => Promise<void>

Set the navigation bar color and button theme.

| Param | Type | Description | | ------------- | ----------------------------------------------------------------------------- | --------------------------------------------- | | options | { color: string; darkButtons?: boolean; dividerColor?: string; } | - Configuration for navigation bar appearance |

Since: 1.0.0

getNavigationBarColor()

getNavigationBarColor() => Promise<{ color: string; darkButtons: boolean; }>

Get the current navigation bar color and button theme.

Returns: Promise<{ color: string; darkButtons: boolean; }>

Since: 1.0.0

getPluginVersion()

getPluginVersion() => Promise<{ version: string; }>

Get the native Capacitor plugin version.

Returns: Promise<{ version: string; }>

Since: 1.0.0

Enums

NavigationBarColor

| Members | Value | Description | | ----------------- | -------------------------- | ----------------- | | WHITE | '#FFFFFF' | White color | | BLACK | '#000000' | Black color | | TRANSPARENT | 'transparent' | Transparent color |