digaus / community-capacitor-fullscreen

Plugin to enable and handle Android fullscreen

@capacitor-community/fullscreen

Enables immersive fullscreen mode for android devices

Install

npm install @capacitor-community/fullscreen
npx cap sync

API

• setNavigationBarContrastColor(...)
• setStatusBarContrastColor(...)
• getSafeAreaInsets()
• getSafeAreaInsets()
• addListener('insetsChanged', ...)
• Interfaces

setNavigationBarContrastColor(...)

setNavigationBarContrastColor(value: { contrast: 'light' | 'dark'; }) => Promise<void>

Param	Type
value	{ contrast: 'light' | 'dark'; }

---

setStatusBarContrastColor(...)

setStatusBarContrastColor(value: { contrast: 'light' | 'dark'; }) => Promise<void>

Param	Type
value	{ contrast: 'light' | 'dark'; }

---

getSafeAreaInsets()

getSafeAreaInsets() => Promise<SafeAreaInsets>

Returns: Promise<SafeAreaInsets>

---

getSafeAreaInsets()

getSafeAreaInsets() => Promise<SafeAreaInsets>

Returns: Promise<SafeAreaInsets>

---

addListener('insetsChanged', ...)

addListener(eventName: 'insetsChanged', listenerFunc: (insets: SafeAreaInsets) => void) => Promise<PluginListenerHandle> & PluginListenerHandle

Param	Type
eventName	'insetsChanged'
listenerFunc	(insets: SafeAreaInsets) => void

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

---

Interfaces

SafeAreaInsets

Prop	Type
top	number
right	number
bottom	number
left	number

PluginListenerHandle

Prop	Type
remove	() => Promise<void>