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 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282
|
// 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(CrossImportOverlay) import WebKit
#if !USE_APPLE_INTERNAL_SDK
// Stubs for behavior not implemented in open source.
extension WebPageWebView {
public func configureScrollInputBehavior(_ behavior: Any, for input: Any) { }
}
#endif
@MainActor
struct WebViewRepresentable {
let page: WebPage
let safeAreaInsets: EdgeInsets
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 owning pages 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(!page.isBoundToWebView, "This web page is already bound to another web view.")
let parent = CocoaWebViewAdapter()
parent.webView = page.backingWebView
#if os(iOS)
parent.extrinsicSafeAreaInsets = safeAreaInsets
#endif
page.isBoundToWebView = true
return parent
}
func updatePlatformView(_ platformView: CocoaWebViewAdapter, context: Context) {
let webView = page.backingWebView
let environment = context.environment
#if os(iOS)
platformView.extrinsicSafeAreaInsets = safeAreaInsets
#endif
platformView.webView = webView
webView.allowsBackForwardNavigationGestures = environment.webViewAllowsBackForwardNavigationGestures.value != .disabled
webView.allowsLinkPreview = environment.webViewAllowsLinkPreview.value != .disabled
webView.allowsMagnification = environment.webViewMagnificationGestures.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 let scrollInputBehavior = environment.webViewScrollInputBehaviorContext {
webView.configureScrollInputBehavior(scrollInputBehavior.behavior, for: scrollInputBehavior.input)
}
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.webViewElementFullscreenBehavior.value == .enabled
platformView.onScrollGeometryChange = environment.webViewOnScrollGeometryChange
context.coordinator.update(platformView, configuration: self, context: context)
#if os(macOS) && !targetEnvironment(macCatalyst)
if let menu = environment.webViewContextMenuContext?.menu {
page.setMenuBuilder {
menu(.init(linkURL: $0.linkURL))
}
} else {
page.setMenuBuilder(nil)
}
#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).
//
// Rounding down is needed to ensure that the view is never bigger than the requested size, otherwise miscellaneous UI
// issues manifest.
return CGSize(width: width.rounded(.down), height: height.rounded(.down))
}
static func dismantlePlatformView(_ platformView: CocoaWebViewAdapter, coordinator: WebViewCoordinator) {
coordinator.configuration.page.isBoundToWebView = false
}
}
@MainActor
final class WebViewCoordinator {
init(configuration: WebViewRepresentable) {
self.configuration = configuration
}
var configuration: WebViewRepresentable
func update(_ view: CocoaWebViewAdapter, configuration: WebViewRepresentable, context: WebViewRepresentable.Context) {
self.configuration = configuration
#if canImport(SwiftUI, _version: "7.0.57")
updateFindInteraction(view, context: context)
#endif
updateScrollPosition(view, context: context)
}
private func updateScrollPosition(_ view: CocoaWebViewAdapter, context: WebViewRepresentable.Context) {
guard let webView = view.webView else {
return
}
let environment = context.environment
// FIXME: Use the binding to update the `isPositionedByUser` property when applicable.
let scrollPosition = environment.webViewScrollPositionContext
let scrollPositionDidNotChange = view.scrollPosition?.position?.wrappedValue == scrollPosition.position?.wrappedValue
guard !scrollPositionDidNotChange else {
return
}
view.scrollPosition = scrollPosition
let scrollPositionValue = scrollPosition.position?.wrappedValue
if let point = scrollPositionValue?.point {
webView.setContentOffset(x: point.x, y: point.y, animated: context.transaction.isAnimated)
} else if let edge = scrollPositionValue?.edge {
webView.scrollTo(edge: NSDirectionalRectEdge(edge), animated: context.transaction.isAnimated)
} else if let x = scrollPositionValue?.x {
webView.setContentOffset(x: x, y: nil, animated: context.transaction.isAnimated)
} else if let y = scrollPositionValue?.y {
webView.setContentOffset(x: nil, y: y, animated: context.transaction.isAnimated)
}
}
#if canImport(SwiftUI, _version: "7.0.57")
private func updateFindInteraction(_ view: CocoaWebViewAdapter, context: WebViewRepresentable.Context) {
guard let webView = view.webView else {
return
}
let environment = context.environment
let findContext = environment.findContext
view.findContext = findContext
#if os(iOS)
webView.isFindInteractionEnabled = findContext != nil
#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 let findContext, findContext.isPresented?.wrappedValue == true && !isFindNavigatorVisible {
onNextMainRunLoop {
findInteraction.presentFindNavigator(showingReplace: false)
}
} else if findContext?.isPresented?.wrappedValue == false && isFindNavigatorVisible {
onNextMainRunLoop {
findInteraction.dismissFindNavigator()
}
}
}
#endif // canImport(SwiftUI, _version: "7.0.57")
}
#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)
}
static func dismantleUIView(_ uiView: CocoaWebViewAdapter, coordinator: WebViewCoordinator) {
dismantlePlatformView(uiView, coordinator: coordinator)
}
}
#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)
}
static func dismantleNSView(_ nsView: CocoaWebViewAdapter, coordinator: WebViewCoordinator) {
dismantlePlatformView(nsView, coordinator: coordinator)
}
}
#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)
}
}
|