首页指南参考教程
This is documentation for the next SDK version. For up-to-date documentation, see the latest version (SDK 51).

Expo SystemUI

A library that allows interacting with system UI elements.

Android
iOS
Web

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.

Installation

Terminal
npx expo install expo-system-ui

If 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.

API

import * as SystemUI from 'expo-system-ui';

Methods

Android
iOS
Web

SystemUI.getBackgroundColorAsync()

Gets the root view background color.

Returns:

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();
Android
iOS
Web

SystemUI.setBackgroundColorAsync(color)

NameTypeDescription
colornull | ColorValue

Any valid CSS 3 (SVG) color.


Changes the root view background color. Call this function in the root file outside of you component.

Returns:

Promise<void>

Example

SystemUI.setBackgroundColorAsync("black");
Expo 中文网 - 粤ICP备13048890号