メインコンテンツへスキップ

StatusBar

アプリのステータスバーを制御するコンポーネントです。ステータスバーとは、通常画面上部にあり、現在の時刻、Wi-Fiや携帯ネットワークの情報、バッテリー残量、その他のステータスアイコンを表示する領域です。

ナビゲーターでの使用​

複数のStatusBarコンポーネントを同時にマウントすることが可能です。プロパティは、StatusBarコンポーネントがマウントされた順にマージされます。

命令型API​

コンポーネントの使用が理想的でない場合のために、コンポーネントの静的関数として公開される命令型APIもあります。ただし、静的APIとコンポーネントを同じプロパティに使用することは推奨されません。静的APIで設定された値は、次のレンダリングでコンポーネントによって設定された値で上書きされるためです。

リファレンス

定数​

currentHeight
Android
​

ステータスバーの高さで、ノッチの高さも含まれます（存在する場合）。

プロパティ​

animated​

ステータスバーのプロパティの変更間の遷移をアニメーション化するかどうか。backgroundColor、barStyle、hiddenプロパティでサポートされています。

型必須デフォルト
booleanいいえfalse

backgroundColor
Android
​

ステータスバーの背景色。

警告

Android 15で導入されたエッジツーエッジの強制により、APIレベル35ではステータスバーの背景色の設定が非推奨になりました。

型必須デフォルト
colorいいえデフォルトのシステムStatusBarの背景色、または定義されていない場合は'black'

barStyle​

ステータスバーのテキストの色を設定します。

Androidでは、APIバージョン23以上でのみ影響があります。

型必須デフォルト
StatusBarStyleいいえ'default'

hidden​

ステータスバーを非表示にするかどうか。

型必須デフォルト
booleanいいえfalse

networkActivityIndicatorVisible
iOS
​

ネットワークアクティビティインジケーターを表示するかどうか。

型デフォルト
booleanfalse

showHideTransition
iOS
​

hiddenプロパティを使用してステータスバーを表示および非表示にするときのトランジション効果。

型デフォルト
StatusBarAnimation'fade'

translucent
Android
​

ステータスバーを半透明にするかどうか。translucentをtrueに設定すると、アプリはステータスバーの下に描画されます。これは、半透明のステータスバーの色を使用する場合に便利です。

型デフォルト
booleanfalse

メソッド​

popStackEntry()​

static popStackEntry(entry: StatusBarProps);

スタックから最後のStatusBarエントリを取得して削除します。

パラメータ

名前型説明
entry
必須
任意pushStackEntryから返されたエントリ。

pushStackEntry()​

static pushStackEntry(props: StatusBarProps): StatusBarProps;

StatusBarエントリをスタックにプッシュします。完了したら、戻り値をpopStackEntryに渡す必要があります。

パラメータ

名前型説明
props
必須
任意スタックエントリで使用するStatusBarプロパティを含むオブジェクト。

replaceStackEntry()​

static replaceStackEntry(
  entry: StatusBarProps,
  props: StatusBarProps
): StatusBarProps;

既存のStatusBarスタックエントリを新しいプロパティに置き換えます。

パラメータ

名前型説明
entry
必須
任意置き換えるためのpushStackEntryから返されたエントリ。
props
必須
任意置き換えスタックエントリで使用するStatusBarプロパティを含むオブジェクト。

setBackgroundColor()
Android
​

static setBackgroundColor(color: ColorValue, animated?: boolean);

ステータスバーの背景色を設定します。

警告

Android 15で導入されたエッジツーエッジの強制により、APIレベル35ではステータスバーの背景色の設定が非推奨になりました。

パラメータ

名前型説明
color
必須
string背景色。
animatedbooleanスタイルの変更をアニメーション化します。

setBarStyle()​

static setBarStyle(style: StatusBarStyle, animated?: boolean);

ステータスバーのスタイルを設定します。

パラメータ

名前型説明
style
必須
StatusBarStyle設定するステータスバースタイル。
animatedbooleanスタイルの変更をアニメーション化します。

setHidden()​

static setHidden(hidden: boolean, animation?: StatusBarAnimation);

ステータスバーを表示または非表示にします。

パラメータ

名前型説明
hidden
必須
booleanステータスバーを非表示にします。
animation
iOS
StatusBarAnimationステータスバーのhiddenプロパティを変更するときのトランジション。

setNetworkActivityIndicatorVisible()
iOS
​

static setNetworkActivityIndicatorVisible(visible: boolean);

ネットワークアクティビティインジケーターの可視性を制御します。

パラメータ

名前型説明
visible
必須
booleanインジケーターを表示します。

setTranslucent()
Android
​

static setTranslucent(translucent: boolean);

ステータスバーの半透明度を制御します。

パラメータ

名前型説明
translucent
必須
boolean半透明として設定します。

型定義​

StatusBarAnimation​

iOSでのトランジションのステータスバーアニメーションタイプ。

型
enum

定数

値型説明
'fade'stringフェードアニメーション
'slide'stringスライドアニメーション
'none'stringアニメーションなし

StatusBarStyle​

ステータスバースタイルタイプ。

型
enum

定数

値型説明
'default'stringデフォルトのステータスバースタイル（iOSの場合はダーク、Androidの場合はライト）
'light-content'string白いテキストとアイコン
'dark-content'string暗いテキストとアイコン（AndroidではAPI>=23が必要）