# capacitor-plugin-navigation-bar

**Repository Path**: 3433/capacitor-plugin-navigation-bar

## Basic Information

- **Project Name**: capacitor-plugin-navigation-bar
- **Description**: 安卓底部功能导航安卓底部功能导航
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-05-12
- **Last Updated**: 2022-12-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# capacitor-plugin-navigation-bar

navigation-bar style

## Install

```bash
npm install capacitor-plugin-navigation-bar
npx cap sync
```

## API

<docgen-index>

* [`setColor(...)`](#setcolor)
* [`setDividerColor(...)`](#setdividercolor)
* [`setOverlaysWebView(...)`](#setoverlayswebview)
* [`show()`](#show)
* [`hide()`](#hide)
* [`getStatusBarHeight()`](#getstatusbarheight)
* [`getInfo()`](#getinfo)
* [Interfaces](#interfaces)

</docgen-index>

<docgen-api>
<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->

### setColor(...)

```typescript
setColor(options: ColorOption) => Promise<void>
```

| Param         | Type                                                |
| ------------- | --------------------------------------------------- |
| **`options`** | <code><a href="#coloroption">ColorOption</a></code> |

--------------------


### setDividerColor(...)

```typescript
setDividerColor(options: ColorOption) => Promise<void>
```

| Param         | Type                                                |
| ------------- | --------------------------------------------------- |
| **`options`** | <code><a href="#coloroption">ColorOption</a></code> |

--------------------


### setOverlaysWebView(...)

```typescript
setOverlaysWebView(options: SetOverlaysWebViewOptions) => Promise<void>
```

| Param         | Type                                                                            |
| ------------- | ------------------------------------------------------------------------------- |
| **`options`** | <code><a href="#setoverlayswebviewoptions">SetOverlaysWebViewOptions</a></code> |

--------------------


### show()

```typescript
show() => Promise<void>
```

--------------------


### hide()

```typescript
hide() => Promise<void>
```

--------------------


### getStatusBarHeight()

```typescript
getStatusBarHeight() => Promise<StatusBarHeightResult>
```

**Returns:** <code>Promise&lt;<a href="#statusbarheightresult">StatusBarHeightResult</a>&gt;</code>

--------------------


### getInfo()

```typescript
getInfo() => Promise<InfoOption>
```

**Returns:** <code>Promise&lt;<a href="#infooption">InfoOption</a>&gt;</code>

--------------------


### Interfaces


#### ColorOption

| Prop        | Type                |
| ----------- | ------------------- |
| **`color`** | <code>string</code> |


#### SetOverlaysWebViewOptions

| Prop          | Type                 |
| ------------- | -------------------- |
| **`overlay`** | <code>boolean</code> |


#### StatusBarHeightResult

| Prop         | Type                |
| ------------ | ------------------- |
| **`height`** | <code>number</code> |


#### InfoOption

| Prop                | Type                 |
| ------------------- | -------------------- |
| **`visible`**       | <code>boolean</code> |
| **`divider_color`** | <code>string</code>  |
| **`color`**         | <code>string</code>  |
| **`overlays`**      | <code>boolean</code> |

</docgen-api>