跳到主要内容
版本：v4

@capacitor/status-bar

StatusBar API 提供配置状态栏样式以及显示/隐藏状态栏的方法。

安装​

npm install @capacitor/status-bar
npx cap sync

iOS 注意事项​

此插件需要在 Info.plist 中将 "View controller-based status bar appearance" (UIViewControllerBasedStatusBarAppearance) 设置为 YES。如需帮助请阅读 iOS 配置指南。

状态栏默认可见，样式默认为 Style.Default。您可以通过在 Info.plist 中添加 UIStatusBarHidden 和/或 UIStatusBarStyle 来修改这些默认值。

setBackgroundColor 和 setOverlaysWebView 方法目前在 iOS 设备上不受支持。

示例​

import { StatusBar, Style } from '@capacitor/status-bar';

// 仅限 iOS
window.addEventListener('statusTap', function () {
  console.log('状态栏被点击');
});

// 在透明状态栏下显示内容（仅限 Android）
StatusBar.setOverlaysWebView({ overlay: true });

const setStatusBarStyleDark = async () => {
  await StatusBar.setStyle({ style: Style.Dark });
};

const setStatusBarStyleLight = async () => {
  await StatusBar.setStyle({ style: Style.Light });
};

const hideStatusBar = async () => {
  await StatusBar.hide();
};

const showStatusBar = async () => {
  await StatusBar.show();
};

API​

setStyle(...)​

setStyle(options: StyleOptions) => Promise<void>

设置状态栏当前样式。

参数类型
options
StyleOptions

自版本： 1.0.0

setBackgroundColor(...)​

setBackgroundColor(options: BackgroundColorOptions) => Promise<void>

设置状态栏背景颜色。

此方法仅支持 Android。

参数类型
options
BackgroundColorOptions

自版本： 1.0.0

show(...)​

show(options?: AnimationOptions | undefined) => Promise<void>

显示状态栏。 在 iOS 上，如果状态栏初始为隐藏且初始样式设置为 UIStatusBarStyleLightContent，首次调用 show 方法时可能会出现动画异常，显示文本先为深色再过渡为浅色。建议在首次调用时使用 Animation.None 作为动画选项。

参数类型
options
AnimationOptions

自版本： 1.0.0

hide(...)​

hide(options?: AnimationOptions | undefined) => Promise<void>

隐藏状态栏。

参数类型
options
AnimationOptions

自版本： 1.0.0

getInfo()​

getInfo() => Promise<StatusBarInfo>

获取状态栏当前状态信息。

返回值： 

Promise<StatusBarInfo>

自版本： 1.0.0

setOverlaysWebView(...)​

setOverlaysWebView(options: SetOverlaysWebViewOptions) => Promise<void>

设置状态栏是否覆盖 WebView，以便使用其下方的空间。

此方法仅支持 Android。

参数类型
options
SetOverlaysWebViewOptions

自版本： 1.0.0

Interfaces​

StyleOptions​

属性类型描述自版本
style
Style
状态栏文本的样式。1.0.0

BackgroundColorOptions​

属性类型描述自版本
colorstring设置状态栏颜色的十六进制值。此选项仅支持 Android。1.0.0

AnimationOptions​

属性类型描述自版本
animation
Animation
显示或隐藏时使用的状态栏动画类型。此选项仅支持 iOS。1.0.0

StatusBarInfo​

属性类型描述自版本
visibleboolean状态栏是否可见。1.0.0
style
Style
当前状态栏样式。1.0.0
colorstring当前状态栏颜色。此选项仅支持 Android。1.0.0
overlaysboolean状态栏是否处于覆盖模式。此选项仅支持 Android。1.0.0

SetOverlaysWebViewOptions​

属性类型描述自版本
overlayboolean是否覆盖状态栏。1.0.0

Enums​

Style​

成员值描述自版本
Dark'DARK'深色背景下的浅色文本。1.0.0
Light'LIGHT'浅色背景下的深色文本。1.0.0
Default'DEFAULT'样式基于设备外观。如果设备使用深色模式，状态栏文本将显示为浅色；如果设备使用浅色模式，状态栏文本将显示为深色。在 Android 上，默认样式为应用启动时的样式。1.0.0

Animation​

成员值描述自版本
None'NONE'显示/隐藏时不使用动画。1.0.0
Slide'SLIDE'显示/隐藏时使用滑动动画。在 iOS 15+ 上无效。1.0.0
Fade'FADE'显示/隐藏时使用淡入淡出动画。1.0.0

Contents

编辑此页