@polyfillhq/capacitor-plugin-safe-area
v0.0.7
Published
A Capacitor V3/V4 plugin to get Statusbar Height on Android and get SafeArea info on iOS. Forked to fix breaking bugs.
Downloads
5
Maintainers
Readme
capacitor-plugin-safe-area
a capacitor V3/V4 plugin to get safeArea info on Android and IOS
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()
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 |