digaus / capacitor-plugin-safe-area

capacitor plugin to get safeArea info on Android and IOS, support Capacitor3/Capacitor4

capacitor-plugin-safe-area

a capacitor V3/V4 plugin to get SafeArea info on Android and IOS

if you are use Capacitor 3.x , please install version 0.0.x , and version 1.x.x for Capacitor 4.x

Install

npm install capacitor-plugin-safe-area
npx cap sync

Useage

import { SafeArea } from 'capacitor-plugin-safe-area';

SafeArea.getSafeAreaInsets().then(({ insets }) => {
  console.log(insets);
});

SafeArea.getStatusBarHeight().then(({statusBarHeight}) => {
  console.log(statusBarHeight, 'statusbarHeight');
})

API

• getSafeAreaInsets()
• getStatusBarHeight()
• Interfaces

getSafeAreaInsets()

getSafeAreaInsets() => Promise<SafeAreaInsets>

Returns: Promise<SafeAreaInsets>

---

getStatusBarHeight()

getStatusBarHeight() => Promise<StatusBarInfo>

Returns: Promise<StatusBarInfo>

---

Interfaces

SafeAreaInsets

Prop	Type
insets	SafeArea

SafeArea

Prop	Type
top	number
right	number
bottom	number
left	number

StatusBarInfo

Prop	Type
statusBarHeight	number