{"id":13801344,"url":"https://github.com/hugotomazi/navigation-bar","last_synced_at":"2026-01-12T05:50:22.025Z","repository":{"id":45923730,"uuid":"398834444","full_name":"hugotomazi/navigation-bar","owner":"hugotomazi","description":"Navigation Bar plugin for Capacitor","archived":false,"fork":false,"pushed_at":"2024-06-23T12:59:01.000Z","size":1335,"stargazers_count":72,"open_issues_count":7,"forks_count":25,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-13T18:18:09.326Z","etag":null,"topics":["android","capacitor-community","capacitor-plugin","ionic-framework","ionic5","ios","navigation-bar","web"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hugotomazi.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-08-22T15:32:45.000Z","updated_at":"2025-03-30T10:31:45.000Z","dependencies_parsed_at":"2024-01-02T23:09:45.051Z","dependency_job_id":"a6f0b9a2-656d-46a9-9a0b-33effc1e3af1","html_url":"https://github.com/hugotomazi/navigation-bar","commit_stats":{"total_commits":40,"total_committers":7,"mean_commits":5.714285714285714,"dds":"0.19999999999999996","last_synced_commit":"635535cc58526dae556b6e4e2ec508573c190a2f"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hugotomazi%2Fnavigation-bar","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hugotomazi%2Fnavigation-bar/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hugotomazi%2Fnavigation-bar/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hugotomazi%2Fnavigation-bar/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hugotomazi","download_url":"https://codeload.github.com/hugotomazi/navigation-bar/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253932806,"owners_count":21986449,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["android","capacitor-community","capacitor-plugin","ionic-framework","ionic5","ios","navigation-bar","web"],"created_at":"2024-08-04T00:01:21.807Z","updated_at":"2026-01-12T05:50:22.019Z","avatar_url":"https://github.com/hugotomazi.png","language":"TypeScript","funding_links":["https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick\u0026hosted_button_id=F9VPVZKHK4SZW"],"categories":["Other plugins"],"sub_categories":["Specialized Hardware"],"readme":"\u003cp align=\"center\"\u003e\u003cbr\u003e\u003cimg src=\"https://user-images.githubusercontent.com/236501/85893648-1c92e880-b7a8-11ea-926d-95355b8175c7.png\" width=\"128\" height=\"128\" /\u003e\u003c/p\u003e\n\u003ch3 align=\"center\"\u003eNavigation Bar\u003c/h3\u003e\n\u003cp align=\"center\"\u003e\u003cstrong\u003e\u003ccode\u003e@hugotomazi/capacitor-navigation-bar\u003c/code\u003e\u003c/strong\u003e\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n  Capacitor plugin for Navigation Bar manipulation.\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://img.shields.io/maintenance/yes/2024?style=flat-square\" /\u003e\n  \u003ca href=\"https://github.com/hugotomazi/navigation-bar/actions?query=workflow%3A%22CI%22\"\u003e\u003cimg src=\"https://img.shields.io/github/workflow/status/hugotomazi/navigation-bar/CI/master?style=flat-square\" /\u003e\u003c/a\u003e\n  \u003ca href=\"https://www.npmjs.com/package/@hugotomazi/capacitor-navigation-bar\"\u003e\u003cimg src=\"https://img.shields.io/npm/l/@hugotomazi/capacitor-navigation-bar?style=flat-square\" /\u003e\u003c/a\u003e\n\u003cbr\u003e\n  \u003ca href=\"https://www.npmjs.com/package/@hugotomazi/capacitor-navigation-bar\"\u003e\u003cimg src=\"https://img.shields.io/npm/dw/@hugotomazi/capacitor-navigation-bar?style=flat-square\" /\u003e\u003c/a\u003e\n  \u003ca href=\"https://www.npmjs.com/package/@hugotomazi/capacitor-navigation-bar\"\u003e\u003cimg src=\"https://img.shields.io/npm/v/@hugotomazi/capacitor-navigation-bar?style=flat-square\" /\u003e\u003c/a\u003e\n\u003c!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --\u003e\n\u003ca href=\"#contributors-\"\u003e\u003cimg src=\"https://img.shields.io/badge/all%20contributors-5-orange?style=flat-square\" /\u003e\u003c/a\u003e\n\u003c!-- ALL-CONTRIBUTORS-BADGE:END --\u003e\n\u003cbr/\u003e\n\u003ca href=\"https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick\u0026hosted_button_id=F9VPVZKHK4SZW\"\u003e\n  \u003cimg src=\"https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif\" alt=\"Donate with PayPal button\"\u003e\n\u003c/a\u003e\n\u003c/p\u003e\n\u003cbr/\u003e\n\u003cp align=\"center\"\u003e\n  \u003cimg height=\"450\" src=\"https://github.com/hugotomazi/navigation-bar/blob/master/demoProject/src/assets/example.gif?raw=true\"\u003e\n\u003c/p\u003e\n\n## Maintainers\n\n| Maintainer  | GitHub                                      | Social                                                          |\n| ----------- | ------------------------------------------- | --------------------------------------------------------------- |\n| Hugo Tomazi | [hugotomazi](https://github.com/hugotomazi) | [@hugotomazi](https://br.linkedin.com/in/hugo-tomazi-299034101) |\n\n\n## Install\n\n```bash\nnpm install @hugotomazi/capacitor-navigation-bar\nnpx cap sync\n```\n\n## Configuration\n\nNo configuration required for this plugin.\n\n## API\n\n\u003cdocgen-index\u003e\n\n* [`show()`](#show)\n* [`hide()`](#hide)\n* [`setColor(...)`](#setcolor)\n* [`setTransparency(...)`](#settransparency)\n* [`getColor()`](#getcolor)\n* [`addListener(...)`](#addlistener)\n* [`addListener(...)`](#addlistener)\n* [`addListener(...)`](#addlistener)\n* [Interfaces](#interfaces)\n* [Enums](#enums)\n\n\u003c/docgen-index\u003e\n\n\u003cdocgen-api\u003e\n\u003c!--Update the source file JSDoc comments and rerun docgen to update the docs below--\u003e\n\n### show()\n\n```typescript\nshow() =\u003e Promise\u003cvoid\u003e\n```\n\nDisplay the navigation bar.\n\n--------------------\n\n\n### hide()\n\n```typescript\nhide() =\u003e Promise\u003cvoid\u003e\n```\n\nHide the navigation bar.\n\n--------------------\n\n\n### setColor(...)\n\n```typescript\nsetColor(options: ColorParameters) =\u003e Promise\u003cvoid\u003e\n```\n\nChange the color of the navigation bar.\n*Support alpha hexadecimal numbers.\n\n| Param         | Type                                                        |\n| ------------- | ----------------------------------------------------------- |\n| **`options`** | \u003ccode\u003e\u003ca href=\"#colorparameters\"\u003eColorParameters\u003c/a\u003e\u003c/code\u003e |\n\n--------------------\n\n\n### setTransparency(...)\n\n```typescript\nsetTransparency(options: { isTransparent: boolean; }) =\u003e Promise\u003cvoid\u003e\n```\n\nSet the Transparency\n\n| Param         | Type                                     |\n| ------------- | ---------------------------------------- |\n| **`options`** | \u003ccode\u003e{ isTransparent: boolean; }\u003c/code\u003e |\n\n--------------------\n\n\n### getColor()\n\n```typescript\ngetColor() =\u003e Promise\u003c{ color: string; }\u003e\n```\n\nGets the current color of the navigation bar in Hexadecimal.\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;{ color: string; }\u0026gt;\u003c/code\u003e\n\n--------------------\n\n\n### addListener(...)\n\n```typescript\naddListener(event: NavigationBarPluginEvents.SHOW, listenerFunc: () =\u003e void) =\u003e Promise\u003cPluginListenerHandle\u003e\n```\n\nEvent fired after navigation bar is displayed\n\n| Param              | Type                                                                                 | Description |\n| ------------------ | ------------------------------------------------------------------------------------ | ----------- |\n| **`event`**        | \u003ccode\u003e\u003ca href=\"#navigationbarpluginevents\"\u003eNavigationBarPluginEvents.SHOW\u003c/a\u003e\u003c/code\u003e | The event   |\n| **`listenerFunc`** | \u003ccode\u003e() =\u0026gt; void\u003c/code\u003e                                                           | Callback    |\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;\u003ca href=\"#pluginlistenerhandle\"\u003ePluginListenerHandle\u003c/a\u003e\u0026gt;\u003c/code\u003e\n\n--------------------\n\n\n### addListener(...)\n\n```typescript\naddListener(event: NavigationBarPluginEvents.HIDE, listenerFunc: () =\u003e void) =\u003e Promise\u003cPluginListenerHandle\u003e\n```\n\nEvent fired after navigation bar is hidden\n\n| Param              | Type                                                                                 | Description |\n| ------------------ | ------------------------------------------------------------------------------------ | ----------- |\n| **`event`**        | \u003ccode\u003e\u003ca href=\"#navigationbarpluginevents\"\u003eNavigationBarPluginEvents.HIDE\u003c/a\u003e\u003c/code\u003e | The event   |\n| **`listenerFunc`** | \u003ccode\u003e() =\u0026gt; void\u003c/code\u003e                                                           | Callback    |\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;\u003ca href=\"#pluginlistenerhandle\"\u003ePluginListenerHandle\u003c/a\u003e\u0026gt;\u003c/code\u003e\n\n--------------------\n\n\n### addListener(...)\n\n```typescript\naddListener(event: NavigationBarPluginEvents.COLOR_CHANGE, listenerFunc: (returnObject: { color: string; }) =\u003e void) =\u003e Promise\u003cPluginListenerHandle\u003e\n```\n\nEvent fired after navigation bar color is changed\n\n| Param              | Type                                                                                         | Description |\n| ------------------ | -------------------------------------------------------------------------------------------- | ----------- |\n| **`event`**        | \u003ccode\u003e\u003ca href=\"#navigationbarpluginevents\"\u003eNavigationBarPluginEvents.COLOR_CHANGE\u003c/a\u003e\u003c/code\u003e | The event   |\n| **`listenerFunc`** | \u003ccode\u003e(returnObject: { color: string; }) =\u0026gt; void\u003c/code\u003e                                   | Callback    |\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;\u003ca href=\"#pluginlistenerhandle\"\u003ePluginListenerHandle\u003c/a\u003e\u0026gt;\u003c/code\u003e\n\n--------------------\n\n\n### Interfaces\n\n\n#### ColorParameters\n\n| Prop              | Type                 | Description                                                               |\n| ----------------- | -------------------- | ------------------------------------------------------------------------- |\n| **`color`**       | \u003ccode\u003estring\u003c/code\u003e  | Sets the new color of the navigation bar.                                 |\n| **`darkButtons`** | \u003ccode\u003eboolean\u003c/code\u003e | Sets whether the default navigation bar buttons should be black or white. |\n\n\n#### PluginListenerHandle\n\n| Prop         | Type                                      |\n| ------------ | ----------------------------------------- |\n| **`remove`** | \u003ccode\u003e() =\u0026gt; Promise\u0026lt;void\u0026gt;\u003c/code\u003e |\n\n\n### Enums\n\n\n#### NavigationBarPluginEvents\n\n| Members            | Value                        | Description                                  |\n| ------------------ | ---------------------------- | -------------------------------------------- |\n| **`SHOW`**         | \u003ccode\u003e'onShow'\u003c/code\u003e        | Called after the navigation bar is displayed |\n| **`HIDE`**         | \u003ccode\u003e'onHide'\u003c/code\u003e        | Called after navigation bar is hidden        |\n| **`COLOR_CHANGE`** | \u003ccode\u003e'onColorChange'\u003c/code\u003e | Called after navigation bar color is changed |\n\n\u003c/docgen-api\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhugotomazi%2Fnavigation-bar","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhugotomazi%2Fnavigation-bar","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhugotomazi%2Fnavigation-bar/lists"}