Structure

Environment

A property wrapper that reads a value from a view’s environment. あるプロパティラッパー、それはある値をあるビューのもつ環境から読み出します。

Declaration 宣言

@frozen @propertyWrapper struct Environment<Value>

Overview 概要

Use the Environment property wrapper to read a value stored in a view’s environment. Indicate the value to read using an EnvironmentValues key path in the property declaration. For example, you can create a property that reads the color scheme of the current view using the key path of the colorScheme property: Environmentプロパティラッパーを使って、あるビューのもつ環境の中に格納されるある値を読み出してください。値をあるEnvironmentValuesキーパスを使って読み出すことになるのをプロパティ宣言において示してください。例えば、あなたは現在のビューのカラースキームをcolorSchemeプロパティのキーパスを使って読み出すプロパティを作成できます:


@Environment(\.colorScheme) var colorScheme: ColorScheme

You can condition a view’s content on the associated value, which you read from the declared property’s wrappedValue. As with any property wrapper, you access the wrapped value by directly referring to the property: あなたは、あるビューのもつ内容をこの関連値で整えられます、それはあなたがこの宣言されたプロパティのもつwrappedValueから読み出すものです。あらゆるプロパティラッパーと同様に、あなたはプロパティを直接に参照することによってラップされた値にアクセスします:


if colorScheme == .dark { // Checks the wrapped value.
    DarkContent()
} else {
    LightContent()
}

If the value changes, SwiftUI updates any parts of your view that depend on the value. For example, that might happen in the above example if the user changes the Appearance settings. 値が変化するならば、SwiftUIはそのビューに依存するあなたのビューのあらゆる部分を更新します。例えば、それは上の例においてユーザがAppearance設定を変更するならば起こるかもしれません。

You can use this property wrapper to read — but not set — an environment value. SwiftUI updates some environment values automatically based on system settings and provides reasonable defaults for others. You can override some of these, as well as set custom environment values that you define, using the environment(_:_:) view modifier. あなたは、このプロパティラッパーを使って、ある環境値を読み出せます — しかし設定はできません。SwiftUIは、いくつかの環境値を自動的にシステム設定に基づいて更新します、そして理にかなった初期状態をその他に対して提供します。あなたは、それらのいくつかをオーバーライドすることが、あなたが定義するあつらえの環境値を設定するのと同様に、environment(_:_:)ビュー修飾子を使って可能です。

For the complete list of environment values provided by SwiftUI, see the properties of the EnvironmentValues structure. For information about creating custom environment values, see the EnvironmentKey protocol. SwiftUIによって提供される環境値の完全な一覧として、EnvironmentValues構造体のプロパティを見てください。あつらえの環境値を作成することについての情報として、EnvironmentKeyプロトコルを見てください。

Topics 話題

Creating an Environment Instance 環境インスタンスを作成する

Getting the Value 値を取得する

Default Implementations 省略時実装

Relationships 関係

Conforms To 次に準拠

See Also 参照

Environment Data 環境データ