{"_id":"@donald_sh/capacitor-navigation-bar","name":"@donald_sh/capacitor-navigation-bar","dist-tags":{"latest":"4.0.2"},"versions":{"4.0.2":{"name":"@donald_sh/capacitor-navigation-bar","version":"4.0.2","description":"Capacitor Plugin for Navigation Bar","main":"dist/plugin.cjs.js","module":"dist/esm/index.js","types":"dist/esm/index.d.ts","unpkg":"dist/plugin.js","private":false,"author":{"name":"hugotomazi"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/hugotomazi/navigation-bar.git"},"bugs":{"url":"https://github.com/hugotomazi/navigation-bar/issues"},"keywords":["capacitor","plugin","native","navigation","bar"],"scripts":{"verify":"npm run verify:ios && npm run verify:android && npm run verify:web","verify:ios":"cd ios && pod install && xcodebuild -workspace Plugin.xcworkspace -scheme Plugin && cd ..","verify:android":"cd android && ./gradlew clean build test && cd ..","verify:web":"npm run build","lint":"npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint","fmt":"npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- autocorrect --format","eslint":"eslint . --ext ts","prettier":"prettier \"**/*.{css,html,ts,js,java}\"","swiftlint":"node-swiftlint","docgen":"docgen --api NavigationBarPlugin --output-readme README.md --output-json dist/docs.json","build":"npm run clean && npm run docgen && tsc && rollup -c rollup.config.js","clean":"rimraf ./dist","watch":"tsc --watch","prepublishOnly":"npm run build"},"devDependencies":{"@capacitor/android":"^6.1.0","@capacitor/core":"^6.1.0","@capacitor/docgen":"^0.2.0","@capacitor/ios":"^6.1.0","@ionic/eslint-config":"^0.3.0","@ionic/prettier-config":"^2.0.0","@ionic/swiftlint-config":"^1.1.2","eslint":"^7.32.0","prettier":"~2.7.1","prettier-plugin-java":"~1.6.2","rimraf":"^3.0.2","rollup":"^2.77.2","swiftlint":"^1.0.1","typescript":"~4.7.4"},"peerDependencies":{"@capacitor/core":"^4.0.1 || ^5.0.0 || ^6.0.0"},"prettier":"@ionic/prettier-config","swiftlint":"@ionic/swiftlint-config","eslintConfig":{"extends":"@ionic/eslint-config/recommended"},"capacitor":{"ios":{"src":"ios"},"android":{"src":"android"}},"_id":"@donald_sh/capacitor-navigation-bar@4.0.2","gitHead":"6bfcc3f0d208705be9507dd0f394a0e505053f63","homepage":"https://github.com/hugotomazi/navigation-bar#readme","_nodeVersion":"20.15.1","_npmVersion":"10.7.0","dist":{"integrity":"sha512-jyLukRr8p7DA0tGiTfPPcErzHWaqgI0yl4YmoNeMpoWv2S3MIyBTSvXI3o/CW48L/5MqtC2W/8ovvkPiIyq4Zg==","shasum":"3b0a67342b24df75ca9f1bb642e9c54ce43fe1ee","tarball":"https://registry.npmjs.org/@donald_sh/capacitor-navigation-bar/-/capacitor-navigation-bar-4.0.2.tgz","fileCount":31,"unpackedSize":47613,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEYCIQCmr+QksDgJASNuTybitMo+17v5JvznrQFaLaJdFNF85wIhAJkrNdV2CLNtBJZwJsVcjs35p6nfCSDL1BgFrLIhZbAN"}]},"_npmUser":{"name":"donald_sh","email":"dnld.sht@gmail.com"},"directories":{},"maintainers":[{"name":"donald_sh","email":"dnld.sht@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/capacitor-navigation-bar_4.0.2_1749031412416_0.1435215103184222"},"_hasShrinkwrap":false}},"time":{"created":"2025-06-04T10:03:32.313Z","4.0.2":"2025-06-04T10:03:32.606Z","modified":"2025-06-04T10:03:32.874Z"},"maintainers":[{"name":"donald_sh","email":"dnld.sht@gmail.com"}],"description":"Capacitor Plugin for Navigation Bar","homepage":"https://github.com/hugotomazi/navigation-bar#readme","keywords":["capacitor","plugin","native","navigation","bar"],"repository":{"type":"git","url":"git+https://github.com/hugotomazi/navigation-bar.git"},"author":{"name":"hugotomazi"},"bugs":{"url":"https://github.com/hugotomazi/navigation-bar/issues"},"license":"MIT","readme":"<p align=\"center\"><br><img src=\"https://user-images.githubusercontent.com/236501/85893648-1c92e880-b7a8-11ea-926d-95355b8175c7.png\" width=\"128\" height=\"128\" /></p>\n<h3 align=\"center\">Navigation Bar</h3>\n<p align=\"center\"><strong><code>@donald_sh/capacitor-navigation-bar</code></strong></p>\n<p align=\"center\">\n  Capacitor plugin for Navigation Bar manipulation.\n</p>\n\n<p align=\"center\">\n  <img src=\"https://img.shields.io/maintenance/yes/2024?style=flat-square\" />\n  <a href=\"https://github.com/hugotomazi/navigation-bar/actions?query=workflow%3A%22CI%22\"><img src=\"https://img.shields.io/github/workflow/status/hugotomazi/navigation-bar/CI/master?style=flat-square\" /></a>\n  <a href=\"https://www.npmjs.com/package/@donald_sh/capacitor-navigation-bar\"><img src=\"https://img.shields.io/npm/l/@donald_sh/capacitor-navigation-bar?style=flat-square\" /></a>\n<br>\n  <a href=\"https://www.npmjs.com/package/@donald_sh/capacitor-navigation-bar\"><img src=\"https://img.shields.io/npm/dw/@donald_sh/capacitor-navigation-bar?style=flat-square\" /></a>\n  <a href=\"https://www.npmjs.com/package/@donald_sh/capacitor-navigation-bar\"><img src=\"https://img.shields.io/npm/v/@donald_sh/capacitor-navigation-bar?style=flat-square\" /></a>\n<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->\n<a href=\"#contributors-\"><img src=\"https://img.shields.io/badge/all%20contributors-5-orange?style=flat-square\" /></a>\n<!-- ALL-CONTRIBUTORS-BADGE:END -->\n<br/>\n<a href=\"https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=F9VPVZKHK4SZW\">\n  <img src=\"https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif\" alt=\"Donate with PayPal button\">\n</a>\n</p>\n<br/>\n<p align=\"center\">\n  <img height=\"450\" src=\"https://github.com/hugotomazi/navigation-bar/blob/master/demoProject/src/assets/example.gif?raw=true\">\n</p>\n\n## Maintainers\n\n| Maintainer  | GitHub                                      | Social                                                          |\n| ----------- | ------------------------------------------- | --------------------------------------------------------------- |\n| Hugo Tomazi | [hugotomazi](https://github.com/hugotomazi) | [@donald_sh](https://br.linkedin.com/in/hugo-tomazi-299034101) |\n\n\n## Install\n\n```bash\nnpm install git+https://github.com/donald_sh/navigation-bar.git\nnpx cap sync\n```\n\n## Configuration\n\nNo configuration required for this plugin.\n\n## API\n\n<docgen-index>\n\n* [`show()`](#show)\n* [`hide()`](#hide)\n* [`setColor(...)`](#setcolor)\n* [`setTransparency(...)`](#settransparency)\n* [`getColor()`](#getcolor)\n* [`addListener(NavigationBarPluginEvents.SHOW, ...)`](#addlistenernavigationbarplugineventsshow)\n* [`addListener(NavigationBarPluginEvents.HIDE, ...)`](#addlistenernavigationbarplugineventshide)\n* [`addListener(NavigationBarPluginEvents.COLOR_CHANGE, ...)`](#addlistenernavigationbarplugineventscolor_change)\n* [Interfaces](#interfaces)\n* [Enums](#enums)\n\n</docgen-index>\n\n<docgen-api>\n<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->\n\n### show()\n\n```typescript\nshow() => Promise<void>\n```\n\nDisplay the navigation bar.\n\n--------------------\n\n\n### hide()\n\n```typescript\nhide() => Promise<void>\n```\n\nHide the navigation bar.\n\n--------------------\n\n\n### setColor(...)\n\n```typescript\nsetColor(options: ColorParameters) => Promise<void>\n```\n\nChange the color of the navigation bar.\n*Support alpha hexadecimal numbers.\n\n| Param         | Type                                                        |\n| ------------- | ----------------------------------------------------------- |\n| **`options`** | <code><a href=\"#colorparameters\">ColorParameters</a></code> |\n\n--------------------\n\n\n### setTransparency(...)\n\n```typescript\nsetTransparency(options: { isTransparent: boolean; }) => Promise<void>\n```\n\nSet the Transparency\n\n| Param         | Type                                     |\n| ------------- | ---------------------------------------- |\n| **`options`** | <code>{ isTransparent: boolean; }</code> |\n\n--------------------\n\n\n### getColor()\n\n```typescript\ngetColor() => Promise<{ color: string; }>\n```\n\nGets the current color of the navigation bar in Hexadecimal.\n\n**Returns:** <code>Promise&lt;{ color: string; }&gt;</code>\n\n--------------------\n\n\n### addListener(NavigationBarPluginEvents.SHOW, ...)\n\n```typescript\naddListener(event: NavigationBarPluginEvents.SHOW, listenerFunc: () => void) => Promise<PluginListenerHandle>\n```\n\nEvent fired after navigation bar is displayed\n\n| Param              | Type                                                                                 | Description |\n| ------------------ | ------------------------------------------------------------------------------------ | ----------- |\n| **`event`**        | <code><a href=\"#navigationbarpluginevents\">NavigationBarPluginEvents.SHOW</a></code> | The event   |\n| **`listenerFunc`** | <code>() =&gt; void</code>                                                           | Callback    |\n\n**Returns:** <code>Promise&lt;<a href=\"#pluginlistenerhandle\">PluginListenerHandle</a>&gt;</code>\n\n--------------------\n\n\n### addListener(NavigationBarPluginEvents.HIDE, ...)\n\n```typescript\naddListener(event: NavigationBarPluginEvents.HIDE, listenerFunc: () => void) => Promise<PluginListenerHandle>\n```\n\nEvent fired after navigation bar is hidden\n\n| Param              | Type                                                                                 | Description |\n| ------------------ | ------------------------------------------------------------------------------------ | ----------- |\n| **`event`**        | <code><a href=\"#navigationbarpluginevents\">NavigationBarPluginEvents.HIDE</a></code> | The event   |\n| **`listenerFunc`** | <code>() =&gt; void</code>                                                           | Callback    |\n\n**Returns:** <code>Promise&lt;<a href=\"#pluginlistenerhandle\">PluginListenerHandle</a>&gt;</code>\n\n--------------------\n\n\n### addListener(NavigationBarPluginEvents.COLOR_CHANGE, ...)\n\n```typescript\naddListener(event: NavigationBarPluginEvents.COLOR_CHANGE, listenerFunc: (returnObject: { color: string; }) => void) => Promise<PluginListenerHandle>\n```\n\nEvent fired after navigation bar color is changed\n\n| Param              | Type                                                                                         | Description |\n| ------------------ | -------------------------------------------------------------------------------------------- | ----------- |\n| **`event`**        | <code><a href=\"#navigationbarpluginevents\">NavigationBarPluginEvents.COLOR_CHANGE</a></code> | The event   |\n| **`listenerFunc`** | <code>(returnObject: { color: string; }) =&gt; void</code>                                   | Callback    |\n\n**Returns:** <code>Promise&lt;<a href=\"#pluginlistenerhandle\">PluginListenerHandle</a>&gt;</code>\n\n--------------------\n\n\n### Interfaces\n\n\n#### ColorParameters\n\n| Prop              | Type                 | Description                                                               |\n| ----------------- | -------------------- | ------------------------------------------------------------------------- |\n| **`color`**       | <code>string</code>  | Sets the new color of the navigation bar.                                 |\n| **`darkButtons`** | <code>boolean</code> | Sets whether the default navigation bar buttons should be black or white. |\n\n\n#### PluginListenerHandle\n\n| Prop         | Type                                      |\n| ------------ | ----------------------------------------- |\n| **`remove`** | <code>() =&gt; Promise&lt;void&gt;</code> |\n\n\n### Enums\n\n\n#### NavigationBarPluginEvents\n\n| Members            | Value                        | Description                                  |\n| ------------------ | ---------------------------- | -------------------------------------------- |\n| **`SHOW`**         | <code>'onShow'</code>        | Called after the navigation bar is displayed |\n| **`HIDE`**         | <code>'onHide'</code>        | Called after navigation bar is hidden        |\n| **`COLOR_CHANGE`** | <code>'onColorChange'</code> | Called after navigation bar color is changed |\n\n</docgen-api>\n","readmeFilename":"README.md","_rev":"1-ff8a9bcfdc3b284a4e8464a19c012ab8"}