1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200
|
// Copyright (C) 2025 Apple Inc. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
// THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
// BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
// THE POSSIBILITY OF SUCH DAMAGE.
internal import SwiftUI
@_spi(Private) @_spi(CrossImportOverlay) import WebKit
internal import WebKit_Internal
@MainActor
struct WebViewRepresentable {
let owner: WebView
func makePlatformView(context: Context) -> CocoaWebViewAdapter {
// FIXME: Make this more robust by figuring out what happens when a WebPage moves between representables.
// We can't have multiple owners regardless, but we'll want to decide if it's an error, if we can handle it gracefully, and how deterministic it might even be.
// Perhaps we should keep an ownership assertion which we can tear down in something like dismantleUIView().
precondition(!owner.page.isBoundToWebView, "This web page is already bound to another web view.")
let parent = CocoaWebViewAdapter()
parent.webView = owner.page.backingWebView
owner.page.isBoundToWebView = true
return parent
}
func updatePlatformView(_ platformView: CocoaWebViewAdapter, context: Context) {
let webView = owner.page.backingWebView
let environment = context.environment
platformView.webView = webView
webView.allowsBackForwardNavigationGestures = environment.webViewAllowsBackForwardNavigationGestures.value != .disabled
webView.allowsLinkPreview = environment.webViewAllowsLinkPreview.value != .disabled
let isOpaque = environment.webViewContentBackground != .hidden
#if os(macOS)
if webView._drawsBackground != isOpaque {
webView._drawsBackground = isOpaque
}
#else
if webView.isOpaque != isOpaque {
webView.isOpaque = isOpaque
}
#endif
if EquatableScrollBounceBehavior(environment.verticalScrollBounceBehavior) == .always || EquatableScrollBounceBehavior(environment.verticalScrollBounceBehavior) == .automatic {
webView.alwaysBounceVertical = true
webView.bouncesVertically = true
} else if EquatableScrollBounceBehavior(environment.verticalScrollBounceBehavior) == .basedOnSize {
webView.alwaysBounceVertical = false
webView.bouncesVertically = true
}
if EquatableScrollBounceBehavior(environment.horizontalScrollBounceBehavior) == .always || EquatableScrollBounceBehavior(environment.horizontalScrollBounceBehavior) == .automatic {
webView.alwaysBounceHorizontal = true
webView.bouncesHorizontally = true
} else if EquatableScrollBounceBehavior(environment.horizontalScrollBounceBehavior) == .basedOnSize {
webView.alwaysBounceHorizontal = false
webView.bouncesHorizontally = true
}
webView.configuration.preferences.isTextInteractionEnabled = environment.webViewTextSelection
webView.configuration.preferences.isElementFullscreenEnabled = environment.webViewAllowsElementFullscreen
context.coordinator.update(platformView, configuration: self, environment: environment)
#if os(macOS) && !targetEnvironment(macCatalyst)
owner.page.setMenuBuilder(environment.webViewContextMenuContext?.menu)
#endif
}
func makeCoordinator() -> WebViewCoordinator {
WebViewCoordinator(configuration: self)
}
func sizeThatFits(_ proposal: ProposedViewSize, platformView: CocoaWebViewAdapter, context: Context) -> CGSize? {
guard let width = proposal.width, let height = proposal.height else {
return nil
}
// By default, SwiftUI allows representable views to have fractional sizes, however WebKit does not support this
// (it may result in incorrect behavior such as the size of the content view and scroll view being slightly mismatched).
return CGSize(width: width.rounded(), height: height.rounded());
}
}
@MainActor
final class WebViewCoordinator {
init(configuration: WebViewRepresentable) {
self.configuration = configuration
}
var configuration: WebViewRepresentable
func update(_ view: CocoaWebViewAdapter, configuration: WebViewRepresentable, environment: EnvironmentValues) {
self.configuration = configuration
self.updateFindInteraction(view, environment: environment)
}
private func updateFindInteraction(_ view: CocoaWebViewAdapter, environment: EnvironmentValues) {
guard let webView = view.webView else {
return
}
let findContext = environment.webViewFindContext
view.findContext = findContext
#if os(iOS)
webView.isFindInteractionEnabled = findContext.canFind
#endif
guard let findInteraction = view.findInteraction else {
return
}
let isFindNavigatorVisible = view.isFindNavigatorVisible
// Showing or hiding the find navigator can change the first responder, which triggers a graph cycle if done synchronously.
if findContext.canFind && findContext.isPresented?.wrappedValue == true && !isFindNavigatorVisible {
onNextMainRunLoop {
findInteraction.presentFindNavigator(showingReplace: false)
}
} else if findContext.isPresented?.wrappedValue == false && isFindNavigatorVisible {
onNextMainRunLoop {
findInteraction.dismissFindNavigator()
}
}
}
}
#if canImport(UIKit)
extension WebViewRepresentable: UIViewRepresentable {
func makeUIView(context: Context) -> CocoaWebViewAdapter {
makePlatformView(context: context)
}
func updateUIView(_ uiView: CocoaWebViewAdapter, context: Context) {
updatePlatformView(uiView, context: context)
}
func sizeThatFits(_ proposal: ProposedViewSize, uiView: CocoaWebViewAdapter, context: Context) -> CGSize? {
sizeThatFits(proposal, platformView: uiView, context: context)
}
}
#else
extension WebViewRepresentable: NSViewRepresentable {
func makeNSView(context: Context) -> CocoaWebViewAdapter {
makePlatformView(context: context)
}
func updateNSView(_ nsView: CocoaWebViewAdapter, context: Context) {
updatePlatformView(nsView, context: context)
}
func sizeThatFits(_ proposal: ProposedViewSize, nsView: CocoaWebViewAdapter, context: Context) -> CGSize? {
sizeThatFits(proposal, platformView: nsView, context: context)
}
}
#endif
// FIXME: (rdar://145030632) Remove this workaround when possible.
struct EquatableScrollBounceBehavior: Equatable {
static let automatic = Self(.automatic)
static let always = Self(.always)
static let basedOnSize = Self(.basedOnSize)
init(_ behavior: ScrollBounceBehavior) {
self.behavior = behavior
}
let behavior: ScrollBounceBehavior
static func == (lhs: EquatableScrollBounceBehavior, rhs: EquatableScrollBounceBehavior) -> Bool {
unsafeBitCast(lhs.behavior, to: Int8.self) == unsafeBitCast(rhs.behavior, to: Int8.self)
}
}
|