Version: Next
StatusBar
用于控制应用状态栏的组件。状态栏是屏幕顶部的区域,通常显示当前时间、Wi-Fi 和蜂窝网络信息、电池电量和/或其他状态图标。
和导航器一起使用
可以同时挂载多个 StatusBar 组件。属性将按照 StatusBar 组件的挂载顺序进行合并。
- TypeScript
- JavaScript
命令式 API
对于不适合使用组件的场景,StatusBar 也提供了以组件静态方法形式暴露的命令式 API。不过不推荐同时使用静态 API 和组件来设置同一个属性,因为静态 API 设置的值会在下一次渲染时被组件设置的值覆盖。
参考
常量
currentHeight Android
状态栏的高度,包括刘海高度(如果有的话)。
Props
animated
状态栏属性变化时是否使用动画过渡。支持 barStyle 和 hidden 属性。
| 类型 | 必需 | 默认值 |
|---|---|---|
| boolean | 否 | false |
barStyle
设置状态栏文本的颜色。
在 Android 上,此属性仅对 API 23 及以上版本生效。
| 类型 | 必需 | 默认值 |
|---|---|---|
| StatusBarStyle | 否 | 'default' |
hidden
是否隐藏状态栏。
| 类型 | 必需 | 默认值 |
|---|---|---|
| boolean | 否 | false |
showHideTransition iOS
使用 hidden 属性显示和隐藏状态栏时的过渡效果。
| 类型 | 默认值 |
|---|---|
| StatusBarAnimation | 'fade' |
方法
popStackEntry()
React TSX
static popStackEntry(entry: StatusBarProps);
获取并移除栈中最后一个 StatusBar 条目。
参数:
| 名称 | 类型 | 描述 |
|---|---|---|
| entry 必需 | any | pushStackEntry 返回的条目。 |
pushStackEntry()
React TSX
static pushStackEntry(props: StatusBarProps): StatusBarProps;
将一个 StatusBar 条目压入栈中。返回值应在完成后传递给 popStackEntry。
参数:
| 名称 | 类型 | 描述 |
|---|---|---|
| props 必需 | any | 包含要在栈条目中使用的 StatusBar 属性的对象。 |
replaceStackEntry()
React TSX
static replaceStackEntry(
entry: StatusBarProps,
props: StatusBarProps
): StatusBarProps;
用新的属性替换栈中已有的 StatusBar 条目。
参数:
| 名称 | 类型 | 描述 |
|---|---|---|
| entry 必需 | any | 要替换的 pushStackEntry 返回的条目。 |
| props 必需 | any | 包含要在替换栈条目中使用的 StatusBar 属性的对象。 |
setBarStyle()
React TSX
static setBarStyle(style: StatusBarStyle, animated?: boolean);
设置状态栏的样式。
参数:
| 名称 | 类型 | 描述 |
|---|---|---|
| style 必需 | StatusBarStyle | 要设置的状态栏样式。 |
| animated | boolean | 是否使用动画过渡。 |
setHidden()
React TSX
static setHidden(hidden: boolean, animation?: StatusBarAnimation);
显示或隐藏状态栏。
参数:
| 名称 | 类型 | 描述 |
|---|---|---|
| hidden 必需 | boolean | 是否隐藏状态栏。 |
| animation iOS | StatusBarAnimation | 改变状态栏隐藏属性时的动画效果。 |
类型定义
StatusBarAnimation
iOS 上状态栏的过渡动画类型。
| 类型 |
|---|
| enum |
常量:
| 值 | 类型 | 描述 |
|---|---|---|
'fade' | string | 渐变动画 |
'slide' | string | 滑动动画 |
'none' | string | 无动画 |
StatusBarStyle
状态栏样式类型。
| 类型 |
|---|
| enum |
常量:
| 值 | 类型 | 描述 |
|---|---|---|
'default' | string | 默认状态栏样式(iOS 为深色,Android 为浅色) |
'light-content' | string | 白色文字和图标 |
'dark-content' | string | 深色文字和图标(Android 上需要 API>=23) |