@notiz/capacitor-plugin-android-safe-area
v0.1.0
Published
Safe area for Android
Downloads
5
Readme
@notiz/capacitor-plugin-android-safe-area
Safe area
Install
npm install @notiz/capacitor-plugin-android-safe-area
npx cap sync
API
refresh()
refresh() => Promise<void>
getSafeAreaInsets()
getSafeAreaInsets() => Promise<SafeAreaInsetsResult>
Returns: Promise<SafeAreaInsetsResult>
addListener('safeAreaPluginsInsetChange', ...)
addListener(eventName: 'safeAreaPluginsInsetChange', listener: SafeAreaInsetsChangedCallback) => PluginListenerHandle
| Param | Type |
| --------------- | --------------------------------------------------------------------------------------- |
| eventName
| 'safeAreaPluginsInsetChange' |
| listener
| SafeAreaInsetsChangedCallback |
Returns: PluginListenerHandle
Interfaces
SafeAreaInsetsResult
| Prop | Type |
| ------------ | --------------------------------------------------------- |
| insets
| SafeAreaInsets |
SafeAreaInsets
| Prop | Type |
| ------------ | ------------------- |
| top
| number |
| bottom
| number |
| right
| number |
| left
| number |
PluginListenerHandle
| Prop | Type |
| ------------ | ----------------------------------------- |
| remove
| () => Promise<void> |
Type Aliases
SafeAreaInsetsChangedCallback
(insets: SafeAreaInsets): void