Code Monkey home page Code Monkey logo

capacitor-plugin-android-insets's Introduction

@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: ionic-team/capacitor#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>
Param Type
options { r: number; g: number; b: number; a: number; }

Interfaces

GetDisplayInfoReturn

Prop Type
isGestureMode boolean
rotation 'portrait' | 'landscape-left' | 'landscape-right' | 'unknown'
statusbarHeight number
navbarPosition 'BOTTOM' | 'RIGHT' | 'LEFT' | 'UNKNOWN'
navbarSize number
insetTop number
insetRight number
insetBottom number
insetLeft number

capacitor-plugin-android-insets's People

Contributors

chriswep avatar f0rsaken avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.