A library that allows interacting with system UI elements.
expo-system-ui
enables you to interact with UI elements that fall outside of the React tree. Specifically the root view background color, and locking the user interface style globally on Android.
-
npx expo install expo-system-ui
If you're installing this in a bare React Native app, you should also follow these additional installation instructions.
import * as SystemUI from 'expo-system-ui';
SystemUI.getBackgroundColorAsync()
Gets the root view background color.
Example
const color = await SystemUI.getBackgroundColorAsync();
Returns
Promise<ColorValue | null>
Current root view background color in hex format. Returns null
if the background color is not set.
SystemUI.setBackgroundColorAsync(color)
Name | Type | Description |
---|---|---|
color | null | ColorValue | Any valid CSS 3 (SVG) color. |
Changes the root view background color. Call this function in the root file outside of you component.
Example
SystemUI.setBackgroundColorAsync("black");
Returns
Promise<void>