as

Settings
Sign out
Notifications
Alexa
Amazon Appstore
Ring
AWS
Documentation
Support
Contact Us
My Cases
Get Started
Design and Develop
Publish
Reference
Support

expo-system-ui

The @amazon-devices/expo-system-ui library allows you to interact with system UI elements, such as the root view background color, that fall outside of the React tree.

Installation

  1. Add the JavaScript library dependency in the package.json file.

    Copied to clipboard.

     dependencies: {
         ...
         "@amazon-devices/expo-system-ui": "~2.0.0",
         "@amazon-devices/keplerscript-turbomodule-api": "~1.0.0",
     }
    
  2. Reinstall dependencies using the npm install command.

Examples

Copied to clipboard.

import React, {useState} from 'react';
import {StyleSheet, View, Button} from 'react-native';
import * as SystemUI from '@amazon-devices/expo-system-ui';
import {ColorValue} from 'react-native';

export const App = () => {
  const [backgroundColor, setBackgroundColor] = useState<ColorValue | null>(
    '#0000ff',
  );

  const changeBackgroundColor = async (color: string | null) => {
    console.log(backgroundColor);
    await SystemUI.setBackgroundColorAsync(color);
    setBackgroundColor(await SystemUI.getBackgroundColorAsync());
  };

  return (
    <View style={[styles.container, backgroundColor ? {backgroundColor} : {}]}>
      <Button
        title="Change background color"
        onPress={() =>
          changeBackgroundColor(
            backgroundColor === '#0000ff' ? '#ff0000' : '#0000ff',
          )
        }
      />
    </View>
  );
};

const styles = StyleSheet.create({
  container: {
    flex: 1,
    alignItems: 'center',
    justifyContent: 'center',
  },
});

API reference

See the documentation page for more information about this library and API reference: Official Expo documentation for expo-system-ui.

Methods

Method Description
getBackgroundColorAsync Gets the root view background color.
setBackgroundColorAsync Changes the root view background color.

Supported versions

Package Version Based On @amazon-devices/react-native-kepler version
2.0.x 2.7.0 2.0.x

For information on additional libraries, see Supported Third-Party Libraries and Services.


Last updated: Sep 30, 2025