Skip to main content
Component to control the app status bar. It is possible to have multiple StatusBar components mounted at the same time. The props will be merged in the order the StatusBar components were mounted.

Example

Props

'default' | 'light-content' | 'dark-content'
Sets the color of the status bar text.
  • 'default' - Default status bar style (dark for iOS, light for Android)
  • 'light-content' - Dark background, white texts and icons
  • 'dark-content' - Light background, dark texts and icons
boolean
If the transition between status bar property changes should be animated. Supported for backgroundColor, barStyle and hidden.
boolean
If the status bar is hidden.

Android-Specific Props

ColorValue
The background color of the status bar.Note: This prop has no effect on Android 15+Platform: Android
boolean
If the status bar is translucent. When translucent is set to true, the app will draw under the status bar. This is useful when using a semi-transparent status bar color.Note: This prop has no effect on Android 15+Platform: Android

iOS-Specific Props

boolean
If the network activity indicator should be visible.Platform: iOSDeprecated: Not supported in iOS 13+
'fade' | 'slide' | 'none'
default:"'fade'"
The transition effect when showing and hiding the status bar using the hidden prop.Platform: iOS

Static Properties

currentHeight

The current height of the status bar on the device. Platform: Android

Static Methods

pushStackEntry()

Push a StatusBar entry onto the stack. The return value should be passed to popStackEntry when complete.

popStackEntry()

Pop a StatusBar entry from the stack.

replaceStackEntry()

Replace an existing StatusBar stack entry with new props.

setHidden()

Show or hide the status bar. Note: Use pushStackEntry instead for better control.

setBarStyle()

Set the status bar style. Note: Use pushStackEntry instead for better control.

setBackgroundColor()

Set the background color for the status bar. Platform: Android Note: Use pushStackEntry instead for better control.

setTranslucent()

Control the translucency of the status bar. Platform: Android Note: Use pushStackEntry instead for better control.

setNetworkActivityIndicatorVisible()

Show or hide the network activity indicator. Platform: iOS Deprecated: Not supported in iOS 13+

Imperative API

For cases where using a component is not ideal, there are static methods to manipulate the StatusBar display stack.

Multiple StatusBar Components

You can have multiple StatusBar components mounted simultaneously. The props will be merged in the order they were mounted, with the most recently mounted component taking precedence:
When the modal is visible, the status bar will use light-content. When it’s dismissed, it will revert to dark-content.

Best Practices

  • Use the declarative component API when possible
  • Use pushStackEntry and popStackEntry for temporary status bar changes
  • Avoid using the legacy set* methods as they don’t update the internal stack
  • Remember that Android 15+ has restrictions on status bar customization