This is documentation for the next SDK version. For up-to-date documentation, see the latest version (SDK 51).
A library that allows interacting with system UI elements.
GitHub
npm
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-uiIf you are installing this in an existing React Native app (bare workflow), start by installing expo in your project. Then, follow the additional instructions as mentioned by library's README under "Installation in bare React Native projects" section.
import * as SystemUI from 'expo-system-ui';
SystemUI.getBackgroundColorAsync()Gets the root view background color.
Promise<ColorValue | null>
Current root view background color in hex format. Returns null if the background color is not set.
Example
const color = await SystemUI.getBackgroundColorAsync();
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.
Promise<void>
Example
SystemUI.setBackgroundColorAsync("black");