@falconeta/capacitor-android-full-view

Capacitor plugin for retrieving proper top offset, bottom offset and set full screen ONLY for android


Keywords
capacitor, plugin, native
License
MIT
Install
npm install @falconeta/capacitor-android-full-view@5.0.0

Documentation

capacitor-android-full-view

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

Install

# with npm
npm install --save @falconeta/capacitor-android-full-view
# with yarn
yarn add @falconeta/capacitor-android-full-view
# 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: ionic-team/capacitor#2840.

Usage

import { AndroidFullView } from 'capacitor-android-full-view'

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

API

top()

top() => Promise<TopBottomReturn>

Returns top offset of the status bar

Returns: Promise<TopBottomReturn>


bottom()

bottom() => Promise<TopBottomReturn>

Returns bottom offset of the status bar

Returns: Promise<TopBottomReturn>


Interfaces

TopBottomReturn

Prop Type
value number