Instance Method インスタンスメソッド

environment(_:_:)

Sets the environment value of the specified key path to the given value. 指定されたキーパスの環境値をこの与えられた値へと設定します。

Declaration 宣言

func environment<V>(_ keyPath: WritableKeyPath<EnvironmentValues, V>, _ value: V) -> some View

Return Value 戻り値

A view that has the given value set in its environment. あるビュー、それはこの与えられた値をそれの環境において設定したものです。

Parameters パラメータ

keyPath

A key path that indicates the property of the EnvironmentValues structure to update. あるキーパス、それは更新することになるEnvironmentValues構造体のプロパティを指し示します。

value

The new value to set for the item specified by keyPath. keyPathによって指定された項目に対して設定することになる新しい値。

Discussion 議論

Use this modifier to set one of the writable properties of the EnvironmentValues structure, including custom values that you create. For example, you can set the value associated with the truncationMode key: この修飾子を使ってEnvironmentValues構造体の書き込み可能プロパティそれら、あなたが作成するあつらえの値それらを含む、の1つを設定してください。例えば、あなたはtruncationModeキーと結び付けられた値を設定できます:


MyView()
    .environment(\.truncationMode, .head)

You then read the value inside MyView or one of its descendants using the Environment property wrapper: あなたはそれからその値をMyViewまたはそれの子孫の1つの内部でEnvironmentプロパティラッパーを使って読み出します:


struct MyView: View {
    @Environment(\.truncationMode) var truncationMode: Text.TruncationMode


    var body: some View { ... }
}

SwiftUI provides dedicated view modifiers for setting most environment values, like the truncationMode(_:) modifier which sets the truncationMode value: SwiftUIは、ほとんどの環境値を設定することに対して専用のビュー修飾子を提供します、たとえばtruncationMode(_:)修飾子、それはtruncationMode値を設定します:


MyView()
    .truncationMode(.head)

Prefer the dedicated modifier when available, and offer your own when defining custom environment values, as described in EnvironmentKey. 利用可能な時は専用修飾子を選んでください、そしてあつらえの環境値を定義している時はあなた自身で提供してください、EnvironmentKeyにおいて記述されるように。

The environment(_:_:) modifier affects the given view, as well as that view’s descendant views. It has no effect outside the view hierarchy on which you call it. environment(_:_:)修飾子は、その与えられたビューに影響を及ぼします、同様にそのビューの持つ子孫ビューも。それは、あなたがそれを呼び出したところのビュー階層の外側に影響を及ぼしません。

See Also 参照

Environment Values 環境値