An action that dismisses a window associated to a particular scene.
Use the ``EnvironmentValues/dismissWindow`` environment value to get the
instance of this structure for a given ``Environment``. Then call the
instance to dismiss a window. You call the instance directly because it
defines a ``DismissWindowAction/callAsFunction(id:)`` method that Swift
calls when you call the instance.
For example, you can define a button that closes an auxiliary window:
@main
struct MyApp: App {
var body: some Scene {
WindowGroup {
ContentView()
}
#if os(macOS)
Window("Auxiliary", id: "auxiliary") {
AuxiliaryContentView()
}
#endif
}
}
struct DismissWindowButton: View {
@Environment(\.dismissWindow) private var dismissWindow
var body: some View {
Button("Close Auxiliary Window") {
dismissWindow(id: "auxiliary")
}
}
}
If the window was opened with ``EnvironmentValues/pushWindow``, the original
presenting will reappear when this action is performed.
@MainActor @preconcurrency func callAsFunction<D>(id: String, value: D) where D : Decodable, D : Encodable, D : Hashable
Dismisses the window defined by the window group that is presenting the
specified value type and that's associated with the specified identifier.
Don't call this method directly. SwiftUI calls it when you
call the ``EnvironmentValues/dismissWindow`` action with an identifier
and a value:
dismissWindow(id: "message", value: message.id)
For information about how Swift uses the `callAsFunction()` method to
simplify call site syntax, see
[Methods with Special Names](https://docs.swift.org/swift-book/documentation/the-swift-programming-language/declarations#Methods-with-Special-Names)
in *The Swift Programming Language*.
- Parameters:
- id: The identifier of the scene to dismiss.
- value: The value which is currently presented.
Dismisses the window that's associated with the specified identifier.
When the specified identifier represents a ``WindowGroup``, all of the
open windows in that group will be dismissed. For dismissing a single
window associated to a `WindowGroup` scene, use
``dismissWindow(value:)`` or ``dismissWindow(id:value:)``.
Don't call this method directly. SwiftUI calls it when you
call the ``EnvironmentValues/dismissWindow`` action with an identifier:
dismissWindow(id: "message")
For information about how Swift uses the `callAsFunction()` method to
simplify call site syntax, see
[Methods with Special Names](https://docs.swift.org/swift-book/documentation/the-swift-programming-language/declarations#Methods-with-Special-Names)
in *The Swift Programming Language*.
- Parameter id: The identifier of the scene to dismiss.
method · iOS 17.0+
callAsFunction
TypeScript
callAsFunctionValue(value: number): Promise<void>
Swift declaration
@MainActor @preconcurrency func callAsFunction<D>(value: D) where D : Decodable, D : Encodable, D : Hashable
Dismisses the window defined by the window group that is presenting the
specified value type.
If multiple windows match the provided value, then they all will be
dismissed. For dismissing a specific window in a specific group, use
``dismissWindow(id:value:)``.
Don't call this method directly. SwiftUI calls it when you
call the ``EnvironmentValues/dismissWindow`` action with an identifier
and a value:
dismissWindow(value: message.id)
For information about how Swift uses the `callAsFunction()` method to
simplify call site syntax, see
[Methods with Special Names](https://docs.swift.org/swift-book/documentation/the-swift-programming-language/declarations#Methods-with-Special-Names)
in *The Swift Programming Language*.
- Parameters:
- value: The value which is currently presented.
method · iOS 17.0+
callAsFunction
TypeScript
callAsFunction(): Promise<void>
Swift declaration
@MainActor @preconcurrency func callAsFunction()
Dismisses the current window.
Don't call this method directly. SwiftUI calls it when you
call the ``EnvironmentValues/dismissWindow`` action:
dismissWindow()
For information about how Swift uses the `callAsFunction()` method to
simplify call site syntax, see
[Methods with Special Names](https://docs.swift.org/swift-book/documentation/the-swift-programming-language/declarations#Methods-with-Special-Names)
in *The Swift Programming Language*.
