Expo

Get Started
API Reference

StatusBar

expo-status-bar gives you a component and imperative interface to control the app status bar to change its text color, background color, hide it, make it translucent or opaque, and apply animations to any of these changes. Exactly what you are able to do with the StatusBar component depends on the platform you're using.

Platform Compatibility

Android DeviceAndroid EmulatoriOS DeviceiOS SimulatorWeb
Web support
There is no API available on the web for controlling the operating system status bar, so expo-status-bar will noop, so it will do nothing, it will also not error.

Installation

Terminal
→ expo install expo-status-bar

If you're installing this in a bare React Native app, you should also follow these additional installation instructions.

Usage

import React from 'react';
import { Text, View } from 'react-native';
import { StatusBar } from 'expo-status-bar';

const App = () => (
  <View
    style={{
      flex: 1,
      backgroundColor: '#000',
      alignItems: 'center',
      justifyContent: 'center',
    }}>
    <Text style={{ color: '#fff' }}>
      Notice that the status bar has light text!
    </Text>
    <StatusBar style="light" />
  </View>
);

export default App;

API

import { StatusBar } from 'expo-status-bar';

Components

StatusBar

A component that allows you to configure your status bar without directly calling imperative methods like setBarStyle.

You will likely have multiple StatusBar components mounted in the same app at the same time. For example, if you have multiple screens in your app, you may end up using one per screen. The props of each StatusBar component will be merged in the order that they were mounted. This component is built on top of the StatusBar component exported from React Native, and it provides defaults that work better for Expo users.

StatusBarProps


  • animated

    Optional • Type: boolean

    If the transition between status bar property changes should be animated. Supported for backgroundColor, barStyle and hidden.

  • backgroundColor

    Optional • Type: string

    Android Only

    The background color of the status bar.

  • hidden

    Optional • Type: boolean

    If the status bar is hidden.

  • hideTransitionAnimation

    Optional • Type: StatusBarAnimation • Default: 'fade'

    iOS Only

    The transition effect when showing and hiding the status bar using the hidden prop.

  • networkActivityIndicatorVisible

    Optional • Type: boolean

    iOS Only

    If the network activity indicator should be visible.

  • style

    Optional • Type: StatusBarStyle • Default: 'auto'

    Sets the color of the status bar text. Default value is "auto" which picks the appropriate value according to the active color scheme, eg: if your app is dark mode, the style will be "light".

  • translucent

    Optional • Type: boolean

    Android Only

    If the status bar is translucent. When translucent is set to true, the app will draw under the status bar. This is the default behaviour in projects created with Expo tools because it is consistent with iOS.

Methods

StatusBar.setStatusBarBackgroundColor(backgroundColor, animated)

Android Only

Arguments

  • backgroundColor (string) - The background color of the status bar.
  • animated (boolean) - true to animate the background color change, false to change immediately.

Set the background color of the status bar.

Returns

  • void

StatusBar.setStatusBarHidden(hidden, animation)

Arguments

  • hidden (boolean) - If the status bar should be hidden.
  • animation (StatusBarAnimation) - Animation to use when toggling hidden, defaults to 'none'.

Toggle visibility of the status bar.

StatusBar.setStatusBarNetworkActivityIndicatorVisible(visible)

iOS Only

Arguments

  • visible (boolean) - If the network activity indicator should be visible.

Toggle visibility of the network activity indicator.

StatusBar.setStatusBarStyle(style)

Arguments

Set the bar style of the status bar.

StatusBar.setStatusBarTranslucent(translucent)

Android Only

Arguments

  • translucent (boolean) - Whether the app can draw under the status bar. When true, content will be rendered under the status bar. This is always true on iOS and cannot be changed.

Set the translucency of the status bar.

Types

StatusBarAnimation

string - Acceptable values are: 'none', 'fade', 'slide'.

StatusBarStyle

string - Acceptable values are: 'auto', 'inverted', 'light', 'dark'.