Expo NavigationBar

一个库，提供对 Android 上原生导航栏的各种交互的访问。

Android

Included in Expo Go

Bundled version:

~5.0.10

expo-navigation-bar 使你可以修改并观察 Android 设备上的原生导航栏。由于某些 Android 平台的限制，该 API 的部分功能与 expo-status-bar API 存在重叠。

属性以样式属性命名；可见性、位置、背景颜色、边框颜色等。

🌐 Properties are named after style properties; visibility, position, backgroundColor, borderColor, and so on.

当 Android 设备启用“手势导航”时，此软件包中的 API 不会产生任何影响。目前没有原生的 Android API 可用于检测“手势导航”是否已启用。

🌐 The APIs in this package have no impact when "Gesture Navigation" is enabled on the Android device. There is currently no native Android API to detect if "Gesture Navigation" is enabled or not.

安装

🌐 Installation

Terminal

- npx expo install expo-navigation-bar

If you are installing this in an existing React Native app, make sure to install expo in your project.

应用配置中的配置

🌐 Configuration in app config

如果你在项目中使用配置插件（连续原生生成 (CNG)），可以使用其内置的配置插件来配置 expo-navigation-bar。该插件允许你配置无法在运行时设置并且需要构建新的应用二进制文件才能生效的各种属性。如果你的应用不使用 CNG，那么你需要手动配置该库。

🌐 You can configure expo-navigation-bar using its built-in config plugin if you use config plugins in your project (Continuous Native Generation (CNG)). The plugin allows you to configure various properties that cannot be set at runtime and require building a new app binary to take effect. If your app does not use CNG, then you'll need to manually configure the library.

Example app.json with config plugin

app.json

{
  "expo": {
    "plugins": [
      [
        "expo-navigation-bar",
        {
          "backgroundColor": "#0f172a",
          "barStyle": "light",
          "borderColor": "#1f2937",
          "visibility": "visible",
          "behavior": "inset-swipe",
          "position": "relative"
        }
      ]
    ]
  }
}

Configurable properties

Name	Default	Description
`backgroundColor`	`undefined`	Sets the navigation bar background color. Accepts color string supported by React Native. For example, `"#0f172a"`.
`barStyle`	`undefined`	Controls whether Android renders light or dark navigation bar buttons. Accepts `light` and `dark` as values.
`borderColor`	`undefined`	Sets the divider color above the navigation bar.
`visibility`	`undefined`	Determines whether the navigation bar starts visible or hidden. Accepts `visible` to show the bar immediately and `hidden` to hide it until the user reveals it with a system gesture.
`behavior`	`undefined`	Controls how hidden system bars behave when revealed. Accepts `overlay-swipe`, `inset-swipe`, or `inset-touch` as values.
`position`	`undefined`	Sets whether your layout is inset for the navigation bar. Accepts `relative` to keep the navigation bar outside the content and `absolute` to draw the content edge-to-edge under the bar.
`legacyVisible`	`undefined`	Legacy equivalent of `androidNavigationBar.visible`. Accepts `leanback`, `immersive`, or `sticky-immersive` as values.

Are you using this library in an existing React Native app?

如果你没有使用连续本地生成（CNG）或者你正在手动使用一个原生 Android 项目，那么你需要将以下配置添加到你的原生项目中：

🌐 If you're not using Continuous Native Generation (CNG) or you're using a native android project manually, then you need to add the following configuration to your native project:

要将 backgroundColor 应用于导航栏，请在 android/app/src/main/res/values/colors.xml 中添加 navigationBarColor：

<resources>
  <!-- ... -->
  <color name="navigationBarColor">#0f172a</color>
</resources>

然后，将 android:navigationBarColor 应用于 android/app/src/main/res/values/styles.xml:

<style name="AppTheme" parent="Theme.AppCompat.DayNight.NoActionBar">
  <!-- ... -->
  <item name="android:navigationBarColor">@color/navigationBarColor</item>
</style>

要将 borderColor、visibility、position 和 behavior 应用于导航栏，请将 expo_navigation_bar_border_color、expo_navigation_bar_visibility、expo_navigation_bar_position 和 expo_navigation_bar_behavior 添加到 android/app/src/main/res/values/strings.xml：

<resources>
  <!-- ... -->
  <!-- For `expo_navigation_bar_border_color`, convert the color string to a 32-bit integer. -->
  <string name="expo_navigation_bar_border_color"
  translatable="false">-14735049</string>
  <string name="expo_navigation_bar_visibility" translatable="false">visible</string>
  <string name="expo_navigation_bar_position" translatable="false">relative</string>
  <string name="expo_navigation_bar_behavior" translatable="false">inset-swipe</string>
</resources>

要将 legacyVisible 应用于导航栏，请在 android/app/src/main/res/values/strings.xml 中添加 expo_navigation_bar_legacy_visible：

<resources>
  <!-- ... -->
  <string name="expo_navigation_bar_legacy_visible" translatable="false">immersive</string>
</resources>

应用接口

🌐 API

import * as NavigationBar from 'expo-navigation-bar';

Hooks

`useVisibility()`

Android

React hook that statefully updates with the visibility of the system navigation bar.

Returns:

NavigationBarVisibility | null

Visibility of the navigation bar, null during async initialization.

Example

function App() {
  const visibility = NavigationBar.useVisibility()
  // React Component...
}

Methods

`NavigationBar.getBackgroundColorAsync()`

Android

Gets the navigation bar's background color.

Returns:

Promise<string>

Current navigation bar color in hex format. Returns #00000000 (transparent) on unsupported platforms (iOS, web).

Example

const color = await NavigationBar.getBackgroundColorAsync();

`NavigationBar.getBehaviorAsync()`

Android

Gets the behavior of the status and navigation bars when the user swipes or touches the screen.

Returns:

Promise<NavigationBarBehavior>

Navigation bar interaction behavior. Returns inset-touch on unsupported platforms (iOS, web).

Example

await NavigationBar.getBehaviorAsync()

`NavigationBar.getBorderColorAsync()`

Android

Gets the navigation bar's top border color, also known as the "divider color".

Returns:

Promise<string>

Navigation bar top border color in hex format. Returns #00000000 (transparent) on unsupported platforms (iOS, web).

Example

const color = await NavigationBar.getBorderColorAsync();

`NavigationBar.getButtonStyleAsync()`

Android

Gets the navigation bar's button color styles.

Returns:

Promise<NavigationBarButtonStyle>

Navigation bar foreground element color settings. Returns light on unsupported platforms (iOS, web).

Example

const style = await NavigationBar.getButtonStyleAsync();

`NavigationBar.getVisibilityAsync()`

Android

Get the navigation bar's visibility.

Returns:

Promise<NavigationBarVisibility>

Navigation bar's current visibility status. Returns hidden on unsupported platforms (iOS, web).

Example

const visibility = await NavigationBar.getVisibilityAsync("hidden");

`NavigationBar.setBackgroundColorAsync(color)`

Android

Parameter	Type	Description
color	`string`	Any valid CSS 3 (SVG) color.

Changes the navigation bar's background color.

Returns:

Promise<void>

Example

NavigationBar.setBackgroundColorAsync("white");

`NavigationBar.setBehaviorAsync(behavior)`

Android

Parameter	Type	Description
behavior	`NavigationBarBehavior`	Dictates the interaction behavior of the navigation bar.

Sets the behavior of the status bar and navigation bar when they are hidden and the user wants to reveal them.

For example, if the navigation bar is hidden (setVisibilityAsync(false)) and the behavior is 'overlay-swipe', the user can swipe from the bottom of the screen to temporarily reveal the navigation bar.

'overlay-swipe': Temporarily reveals the System UI after a swipe gesture (bottom or top) without insetting your App's content.
'inset-swipe': Reveals the System UI after a swipe gesture (bottom or top) and insets your App's content (Safe Area). The System UI is visible until you explicitly hide it again.
'inset-touch': Reveals the System UI after a touch anywhere on the screen and insets your App's content (Safe Area). The System UI is visible until you explicitly hide it again.

Returns:

Promise<void>

Example

await NavigationBar.setBehaviorAsync('overlay-swipe')

`NavigationBar.setBorderColorAsync(color)`

Android

Parameter	Type	Description
color	`string`	Any valid CSS 3 (SVG) color.

Changes the navigation bar's border color.

Returns:

Promise<void>

Example

NavigationBar.setBorderColorAsync("red");

`NavigationBar.setButtonStyleAsync(style)`

Android

Parameter	Type	Description
style	`NavigationBarButtonStyle`	Dictates the color of the foreground element color.

Changes the navigation bar's button colors between white (light) and a dark gray color (dark).

Returns:

Promise<void>

Example

NavigationBar.setButtonStyleAsync("light");

`NavigationBar.setPositionAsync(position)`

Android

Parameter	Type	Description
position	`NavigationBarPosition`	Based on CSS position property.

Sets positioning method used for the navigation bar (and status bar). Setting position absolute will float the navigation bar above the content, whereas position relative will shrink the screen to inline the navigation bar.

When drawing behind the status and navigation bars, ensure the safe area insets are adjusted accordingly.

Returns:

Promise<void>

Example

// enables edge-to-edge mode
await NavigationBar.setPositionAsync('absolute')
// transparent backgrounds to see through
await NavigationBar.setBackgroundColorAsync('#ffffff00')

`NavigationBar.setStyle(style)`

Android

Parameter	Type
style	`NavigationBarStyle`

Sets the style of the navigation bar.

Returns:

void

`NavigationBar.setVisibilityAsync(visibility)`

Android

Parameter	Type	Description
visibility	`NavigationBarVisibility`	Based on CSS visibility property.

Set the navigation bar's visibility.

Returns:

Promise<void>

Example

NavigationBar.setVisibilityAsync("hidden");

`NavigationBar.unstable_getPositionAsync()`

Android

Whether the navigation and status bars float above the app (absolute) or sit inline with it (relative). This value can be incorrect if androidNavigationBar.visible is used instead of the config plugin position property.

This method is unstable because the position can be set via another native module and get out of sync. Alternatively, you can get the position by measuring the insets returned by react-native-safe-area-context.

Returns:

Promise<NavigationBarPosition>

Navigation bar positional rendering mode. Returns relative on unsupported platforms (iOS, web).

Example

await NavigationBar.unstable_getPositionAsync()

Event Subscriptions

`NavigationBar.addVisibilityListener(listener)`

Android

Parameter	Type
listener	`(event: NavigationBarVisibilityEvent) => void`

Observe changes to the system navigation bar. Due to platform constraints, this callback will also be triggered when the status bar visibility changes.

Returns:

EventSubscription

Example

NavigationBar.addVisibilityListener(({ visibility }) => {
  // ...
});

Types

`NavigationBarBehavior`

Android

Literal Type: string

Interaction behavior for the system navigation bar.

Acceptable values are: 'overlay-swipe' | 'inset-swipe' | 'inset-touch'

`NavigationBarButtonStyle`

Android

Literal Type: string

Appearance of the foreground elements in the navigation bar, i.e. the color of the menu, back, home button icons.

dark makes buttons darker to adjust for a mostly light nav bar.
light makes buttons lighter to adjust for a mostly dark nav bar.

Acceptable values are: 'light' | 'dark'

`NavigationBarPosition`

Android

Literal Type: string

Navigation bar positional mode.

Acceptable values are: 'relative' | 'absolute'

`NavigationBarStyle`

Android

Literal Type: string

Navigation bar style.

auto will automatically adjust based on the current theme.
light a light navigation bar with dark content.
dark a dark navigation bar with light content.
inverted the bar colors are inverted in relation to the current theme.

Acceptable values are: 'auto' | 'inverted' | 'light' | 'dark'

`NavigationBarVisibility`

Android

Literal Type: string

Visibility of the navigation bar.

Acceptable values are: 'visible' | 'hidden'

`NavigationBarVisibilityEvent`

Android

Current system UI visibility state. Due to platform constraints, this will return when the status bar visibility changes as well as the navigation bar.

Property	Type	Description
rawVisibility	`number`	Native Android system UI visibility state, returned from the native Android `setOnSystemUiVisibilityChangeListener` API.
visibility	`NavigationBarVisibility`	Current navigation bar visibility.