[iOS/SwiftUI] @Environment 알아보기 / 모달 뷰 닫기 dismiss 활용

Environment

A property wrapper that reads a value from a view’s environment.

@Environment 는 SwiftUI 뷰 내에서 앱의 전역적인 상태와 속성을 저장하고 공유하기 위해 사용하는 프로퍼티 래퍼이다.

• 해당 래퍼를 사용하면 SwiftUI 가 해당 값에 액세스하고 변경 사항을 자동으로 감지해서 뷰를 업데이트 할 수 있다.
• Environment 키를 사용자 정의해서 추가적으로 사용할 수 있다. 앱 전역에서 사용되는 데이터, 설정, 사용자 인증 정보 저장에 유용하다.

 

일반적으로 사용되는 Environment 키

https://developer.apple.com/documentation/swiftui/environmentvalues

• \.dismiss: 모달로 열려있는 뷰를 닫기 위한 값
• \.colorScheme: 라이트 또는 다크모드인지를 나타내는 값
• \.locale: 언어 및 지역 설정을 나타내는 값
• \.calendar: 달력을 나타내는 값
• \.timeZone: 시간대를 나타내는 값
• \.layoutDirection: 레이아웃 방향 (왼쪽에서 오른쪽 또는 오른쪽에서 왼쪽)을 나타내는 값.

 

dismiss 키 예제

private struct SheetContents: View {
    @Environment(\.dismiss) private var dismiss


    var body: some View {
        Button("Done") {
            dismiss()
        }
    }
}

사용자 정의 key 만드는 예제

https://developer.apple.com/documentation/swiftui/environmentkey

• EnvironmentKey 프로토콜을 채택하는 커스텀 키를 생성한다.
  • defaultValue 속성은 해당 키의 기본값
• EnvironmentValues 의 extension 으로 위에 생성한 커스텀 키에 접근할 값을 만든다.

private struct MyEnvironmentKey: EnvironmentKey {
    static let defaultValue: String = "Default value"
}

extension EnvironmentValues {
    var myCustomValue: String {
        get { self[MyEnvironmentKey.self] }
        set { self[MyEnvironmentKey.self] = newValue }
    }
}

• environment(_:_:) view modifier 를 이용해서 뷰 계층에 Environment 를 사용할 수 있도록 할 수 있다.

MyView()
    .environment(\.myCustomValue, "Another string")

• Environment 커스텀 키를 생성한 후에는 @Environment 프로퍼티 래퍼를 사용해서 접근할 수 있다.

struct ContentView: View {
    @Environment(\.myCustomKey) var customValue
    
    var body: some View {
        Text(customValue)
    }
}

 

View Modifier 를 이용해서 조금 더 간단하게 설정하는 방법

• 생성한 커스텀 키의 값을 설정하도록 하는 메소드를 만들어서

extension View {
    func myCustomValue(_ myCustomValue: String) -> some View {
        environment(\.myCustomValue, myCustomValue)
    }
}

• environment 를 사용하는 대신 조금 더 심플하게 사용할 수 있다.

MyView()
    .myCustomValue("Another string")

 

참고 문서

• https://developer.apple.com/documentation/swiftui/environment
• https://developer.apple.com/documentation/swiftui/environmentvalues/dismiss
• https://developer.apple.com/documentation/swiftui/environmentkey