@EnvironmentでViewの環境値を読み取ろう-SwiftUI

自分で用意したデータを処理する際に使用する@Stateや@ObservedObjectとは違い、タイトルの通り、@EnvironmentはViewの環境値を読み取れるProperty Wrapperです。今回はこの@Environmentの使い方と読み取ることができる値について説明していきます。

使い方

それでは使い方です。今回は端末の外観モードの設定を取得し、ダークなら文字色を白に、ライトなら文字色を黒にするような処理を書いてみます。

struct ContentView: View {
    @Environment(\.colorScheme) var colorScheme: ColorScheme
    var body: some View {
        if colorScheme == .dark {
            Text("Hello")
                .foregroundColor(.white)
        } else if colorScheme == .light {
            Text("Hello")
                .foregroundColor(.black)
        }
    }
}

非常に簡単ですね。@Environment(.colorScheme) というようにkeyPathを指定することで colorScheme （= 外観モードの設定）を取得できます。

また、例えば上のContentViewを他の画面で呼び出す際に、ContentViewだけ常にダークモードにしておきたい、というような時には

ContentView()
    .environment(\.colorScheme, .dark)

と書くことでContentViewのcolorSchemeには必ず.darkが入るようになります。

読み取ることができる値

@Environmentで取得できる値はEnvironmentValueで定義されているものになります。

詳しくはAppleの公式ドキュメントを参照してください。https://developer.apple.com/documentation/swiftui/environmentvalues