iOSでステータスバーの背景色を変える拡張関数(Swift)

はじめに

iOSでは、ステータスバーの背景色を単体でかんたんに変えることができません。
UIViewController#view.backgroundColor を指定するとステータスバーの背景色が変わりますが、同時にビュー全体の背景色も変わってしまいます。

いくつか方法はあるのですが、今回は「上左右をSuperviewに合わせ、下をSafe Areaの上に付けたビュー」を追加することで実現します。
Storyboardを作成するたびに手動でビューを追加するのは手間なので、呼び出すだけでステータスバーの背景色を変えられる拡張関数を実装しました。

環境

• OS：macOS Mojave 10.14.6
• Xcode：11.3.1 (11C504)
• Swift：5.1.3
• iOS：13.3

実装

UIViewController に拡張関数を追加します。

UIViewController+StatusBar.swift

import UIKit

extension UIViewController {
    private final class StatusBarView: UIView { }
    
    func setStatusBarBackgroundColor(_ color: UIColor?) {
        for subView in self.view.subviews where subView is StatusBarView {
            subView.removeFromSuperview()
        }
        guard let color = color else {
            return
        }
        let statusBarView = StatusBarView()
        statusBarView.backgroundColor = color
        self.view.addSubview(statusBarView)
        statusBarView.translatesAutoresizingMaskIntoConstraints = false
        statusBarView.topAnchor.constraint(equalTo: self.view.topAnchor).isActive = true
        statusBarView.leadingAnchor.constraint(equalTo: self.view.leadingAnchor).isActive = true
        statusBarView.trailingAnchor.constraint(equalTo: self.view.trailingAnchor).isActive = true
        statusBarView.bottomAnchor.constraint(equalTo: self.view.safeAreaLayoutGuide.topAnchor).isActive = true
    }
}

複数回呼ばれてもビューが重ならないよう、処理の最初で StatusBarView があったら剥がすようにしています。

使い方

UIViewController の viewDidLoad() で色を指定して呼び出すのみです。

FooViewController.swift

final class FooViewController: UIViewController {
    override func viewDidLoad() {
        super.viewDidLoad()

        configureView()
    }

    private func configureView() {
        setStatusBarBackgroundColor(.blue)
    }
}

ノッチの有無にかかわらず、ステータスバーの背景色が変わります。

iPhone 8	iPhone 11 Pro Max

参考リンク

• https://twitter.com/hatakenokakashi/status/1271001822447063040?s=20