https://github.com/Cap-go/capacitor-navigation-bar
Set navigation bar color for android lolipop and higher
https://github.com/Cap-go/capacitor-navigation-bar
Last synced: 20 days ago
JSON representation
Set navigation bar color for android lolipop and higher
- Host: GitHub
- URL: https://github.com/Cap-go/capacitor-navigation-bar
- Owner: Cap-go
- License: mit
- Created: 2023-03-10T01:27:17.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-12T21:15:45.000Z (about 1 year ago)
- Last Synced: 2024-04-13T21:54:56.888Z (about 1 year ago)
- Language: JavaScript
- Size: 329 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS.txt
Awesome Lists containing this project
- awesome-capacitor - Navigation bar - Set navigation bar color for android lolipop and higher. ([Capgo plugins](https://capgo.app/))
README
# capacitor-navigation-bar
Set navigation bar color for android lolipop and higher
## Install
```bash
npm install @capgo/capacitor-navigation-bar
npx cap sync
```
## API
* [`setNavigationBarColor(...)`](#setnavigationbarcolor)
* [`getNavigationBarColor()`](#getnavigationbarcolor)
* [Enums](#enums)
### setNavigationBarColor(...)
```typescript
setNavigationBarColor(options: { color: NavigationBarColor | string; buttonStyle?: NavigationBarButtonStyle; }) => Promise
```
| Param | Type |
| ------------- | --------------------------------------------------------------------------------------------------------------- |
| **`options`** | { color: string; buttonStyle?: NavigationBarButtonStyle; } |
--------------------
### getNavigationBarColor()
```typescript
getNavigationBarColor() => Promise<{ color: string; buttonStyle: NavigationBarButtonStyle; }>
```
**Returns:** Promise<{ color: string; buttonStyle: NavigationBarButtonStyle; }>
--------------------
### Enums
#### NavigationBarColor
| Members | Value |
| ----------------- | -------------------------- |
| **`WHITE`** | "#FFFFFF" |
| **`BLACK`** | "#000000" |
| **`TRANSPARENT`** | "transparent" |
#### NavigationBarButtonStyle
| Members | Value |
| ----------- | ---------------------- |
| **`LIGHT`** | "#FFFFFF" |
| **`DARK`** | "#000000" |