Skip to content
Cordova NavigationBar Plugin
Java JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src
www
.gitignore
LICENSE
README.md
package.json
plugin.xml

README.md

cordova-plugin-navigationbar-color

The NavigationBar object provides some functions to control the Android device navigation bar.

Installation

cordova plugin add cordova-plugin-navigationbar-color

Preferences

config.xml

  • NavigationBarBackgroundColor (color hex string, default value #000000). Color of navigation bar.
<preference name="NavigationBarBackgroundColor" value="#000000" />
  • NavigationBarLigth (boolean, defaults to false). Change the color of the buttons in the navigation bar to black, use in light colors of the navigation bar (Android 8.0 or higher).
<preference name="NavigationBarLigth" value="true" />

Methods

This plugin defines global NavigationBar object.

Although in the global scope, it is not available until after the deviceready event.

document.addEventListener("deviceready", onDeviceReady, false);

function onDeviceReady()
{
    console.log(NavigationBar);
}

NavigationBar.backgroundColorByHexString

Set color of navigation bar by hex string.

NavigationBar.backgroundColorByHexString(String colorHex, Boolean ligthNavigationBar = false);
  • colorHex Color hex string. Set the color of navigation bar.

  • ligthNavigationBar Change the color of the buttons in the navigation bar to black, use in light colors of the navigation bar (Android 8.0 or higher).

NavigationBar.backgroundColorByName

Set color of navigation bar by color name.

NavigationBar.backgroundColorByName(String colorName, Boolean ligthNavigationBar = false);
  • colorName Color name. Set the color of navigation bar.

    • Possible values
    • black: Equals #000000
    • darkGray: Equals #A9A9A9
    • lightGray: Equals #D3D3D3
    • white: Equals #FFFFFF
    • gray: Equals #808080
    • red: Equals #FF0000
    • green: Equals #00FF00
    • blue: Equals #0000FF
    • cyan: Equals #00FFFF
    • yellow: Equals #FFFF00
    • magenta: Equals #FF00FF
    • orange: Equals #FFA500
    • purple: Equals #800080
    • brown: Equals #A52A2A
  • ligthNavigationBar Change the color of the buttons in the navigation bar to black, use in light colors of the navigation bar (Android 8.0 or higher).

NavigationBar.hide

Hide the navigation bar.

NavigationBar.hide();

NavigationBar.show

Shows the navigation bar.

NavigationBar.show();
You can’t perform that action at this time.