2.0.0 • Published 1 year ago

@emmaus/capacitor-plugin-android-insets v2.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

@emmaus/capacitor-plugin-android-insets

Capacitor plugin for retrieving proper top offset of Android status bar.

This repo is published version with changed name of https://github.com/jorisbertomeu/capacitor-insets-v2, which was based on archived https://github.com/igorcd/capacitor-insets-plugin/. It should work perfectly fine in Capacitor@4.

Install

# with npm
npm install --save @emmaus/capacitor-plugin-android-insets
# with yarn
yarn add @emmaus/capacitor-plugin-android-insets
# after any install
npx cap sync

Why?

This plugin is required only on Android when using StatusBar.setOverlaysWebView({ overlay: true }). There is a problem with top offset counting, when status bar is transparent. Related issue: https://github.com/ionic-team/capacitor/issues/2840.

Usage

import { AndroidInsets } from '@emmaus/capacitor-plugin-android-insets';

const { value } = await AndroidInsets.top();

API

getDisplayInfo()

getDisplayInfo() => Promise<GetDisplayInfoReturn>

Returns: Promise<GetDisplayInfoReturn>


setNavbarBackgroundColor(...)

setNavbarBackgroundColor(options: { r: number; g: number; b: number; a: number; }) => Promise<void>
ParamType
options{ r: number; g: number; b: number; a: number; }

Interfaces

GetDisplayInfoReturn

PropType
isGestureModeboolean
rotation'portrait' | 'landscape-left' | 'landscape-right' | 'unknown'
statusbarHeightnumber
navbarPosition'BOTTOM' | 'RIGHT' | 'LEFT' | 'UNKNOWN'
navbarSizenumber
insetTopnumber
insetRightnumber
insetBottomnumber
insetLeftnumber
2.0.0

1 year ago

1.1.1

1 year ago

1.1.0

1 year ago

1.0.3

2 years ago

1.0.2

2 years ago

1.0.1

2 years ago

1.0.0

2 years ago