An action that opens a URL.
Read the ``EnvironmentValues/openURL`` environment value to get an
instance of this structure for a given ``Environment``. Call the
instance to open a URL. You call the instance directly because it
defines a ``OpenURLAction/callAsFunction(_:)`` method that Swift
calls when you call the instance.
For example, you can open a web site when the user taps a button:
struct OpenURLExample: View {
@Environment(\.openURL) private var openURL
var body: some View {
Button {
if let url = URL(string: "https://www.example.com") {
openURL(url)
}
} label: {
Label("Get Help", systemImage: "person.fill.questionmark")
}
}
}
If you want to know whether the action succeeds, add a completion
handler that takes a Boolean value. In this case, Swift implicitly
calls the ``OpenURLAction/callAsFunction(_:completion:)`` method
instead. That method calls your completion handler after it determines
whether it can open the URL, but possibly before it finishes opening
the URL. You can add a handler to the example above so that
it prints the outcome to the console:
openURL(url) { accepted in
print(accepted ? "Success" : "Failure")
}
The system provides a default open URL action with behavior
that depends on the contents of the URL. For example, the default
action opens a Universal Link in the associated app if possible,
or in the user’s default web browser if not.
You can also set a custom action using the ``View/environment(_:_:)``
view modifier. Any views that read the action from the environment,
including the built-in ``Link`` view and ``Text`` views with markdown
links, or links in attributed strings, use your action. Initialize an
action by calling the ``OpenURLAction/init(handler:)`` initializer with
a handler that takes a URL and returns an ``OpenURLAction/Result``:
Text("Visit [Example Company](https://www.example.com) for details.")
.environment(\.openURL, OpenURLAction { url in
handleURL(url) // Define this method to take appropriate action.
return .handled
})
SwiftUI translates the value that your custom action's handler
returns into an appropriate Boolean result for the action call.
For example, a view that uses the action declared above
receives `true` when calling the action, because the
handler always returns ``OpenURLAction/Result/handled``.
Asynchronously opens a URL, following system conventions.
Don't call this method directly. SwiftUI calls it when you
call the ``OpenURLAction`` structure that you get from the
``Environment``, using a URL and a completion handler as arguments:
struct OpenURLExample: View {
@Environment(\.openURL) private var openURL
var body: some View {
Button {
if let url = URL(string: "https://www.example.com") {
// Implicitly calls openURL.callAsFunction(url) { ... }
openURL(url) { accepted in
print(accepted ? "Success" : "Failure")
}
}
} label: {
Label("Get Help", systemImage: "person.fill.questionmark")
}
}
}
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/ReferenceManual/Declarations.html#ID622)
in *The Swift Programming Language*.
- Parameters:
- url: The URL to open.
- completion: A closure the method calls after determining if
it can open the URL, but possibly before fully opening the URL.
The closure takes a Boolean value that indicates whether the
method can open the URL.
Opens a URL, following system conventions.
Don't call this method directly. SwiftUI calls it when you
call the ``OpenURLAction`` structure that you get from the
``Environment``, using a URL as an argument:
struct OpenURLExample: View {
@Environment(\.openURL) private var openURL
var body: some View {
Button {
if let url = URL(string: "https://www.example.com") {
openURL(url) // Implicitly calls openURL.callAsFunction(url)
}
} label: {
Label("Get Help", systemImage: "person.fill.questionmark")
}
}
}
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/ReferenceManual/Declarations.html#ID622)
in *The Swift Programming Language*.
- Parameter url: The URL to open.
Skipped declarations
1 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.
