feat(ios): Add limitsNavigationsToAppBoundDomains configuration option (

#4789)
ionic-team · Jul 6, 2021 · 2b7016f · 2b7016f
1 parent 6791348
commit 2b7016f
Show file tree

Hide file tree

Showing 7 changed files with 29 additions and 0 deletions.
diff --git a/cli/src/declarations.ts b/cli/src/declarations.ts
@@ -321,6 +321,21 @@ export interface CapacitorConfig {
      * @since 3.0.0
      */
     includePlugins?: string[];
+
+    /**
+     * Sets WKWebView configuration for limitsNavigationsToAppBoundDomains.
+     *
+     * If the Info.plist file includes `WKAppBoundDomains` key, it's recommended to
+     * set this option to true, otherwise some features won't work.
+     * But as side effect, it blocks navigation outside the domains in the
+     * `WKAppBoundDomains` list.
+     * `localhost` (or the value configured as `server.hostname`) also needs to be
+     * added to the `WKAppBoundDomains` list.
+     *
+     * @since 3.1.0
+     * @default false
+     */
+    limitsNavigationsToAppBoundDomains?: boolean;
   };
 
   server?: {

diff --git a/ios/Capacitor/Capacitor/CAPBridgeViewController.swift b/ios/Capacitor/Capacitor/CAPBridgeViewController.swift
@@ -105,6 +105,9 @@ import Cordova
         webViewConfiguration.suppressesIncrementalRendering = false
         webViewConfiguration.allowsAirPlayForMediaPlayback = true
         webViewConfiguration.mediaTypesRequiringUserActionForPlayback = []
+        if #available(iOS 14.0, *) {
+            webViewConfiguration.limitsNavigationsToAppBoundDomains = instanceConfiguration.limitsNavigationsToAppBoundDomains
+        }
         if let appendUserAgent = instanceConfiguration.appendedUserAgentString {
             if let appName = webViewConfiguration.applicationNameForUserAgent {
                 webViewConfiguration.applicationNameForUserAgent = "\(appName)  \(appendUserAgent)"

diff --git a/ios/Capacitor/Capacitor/CAPInstanceConfiguration.h b/ios/Capacitor/Capacitor/CAPInstanceConfiguration.h
@@ -22,6 +22,7 @@ NS_SWIFT_NAME(InstanceConfiguration)
 @property (nonatomic, readonly) UIScrollViewContentInsetAdjustmentBehavior contentInsetAdjustmentBehavior;
 @property (nonatomic, readonly, nonnull) NSURL *appLocation;
 @property (nonatomic, readonly, nullable) NSString *appStartPath;
+@property (nonatomic, readonly) BOOL limitsNavigationsToAppBoundDomains;
 
 @property (nonatomic, readonly, nonnull) NSDictionary *legacyConfig DEPRECATED_MSG_ATTRIBUTE("Use direct properties instead");
 

diff --git a/ios/Capacitor/Capacitor/CAPInstanceConfiguration.m b/ios/Capacitor/Capacitor/CAPInstanceConfiguration.m
@@ -34,6 +34,7 @@ - (instancetype)initWithDescriptor:(CAPInstanceDescriptor *)descriptor isDebug:(
         _contentInsetAdjustmentBehavior = descriptor.contentInsetAdjustmentBehavior;
         _appLocation = descriptor.appLocation;
         _appStartPath = descriptor.appStartPath;
+        _limitsNavigationsToAppBoundDomains = descriptor.limitsNavigationsToAppBoundDomains;
         _pluginConfigurations = descriptor.pluginConfigurations;
         _legacyConfig = descriptor.legacyConfig;
         // construct the necessary URLs

diff --git a/ios/Capacitor/Capacitor/CAPInstanceDescriptor.h b/ios/Capacitor/Capacitor/CAPInstanceDescriptor.h
@@ -103,6 +103,11 @@ NS_SWIFT_NAME(InstanceDescriptor)
  @discussion Defaults to nil, in which case Capacitor will attempt to load @c index.html.
  */
 @property (nonatomic, copy, nullable) NSString *appStartPath;
+/**
+ @brief Whether or not the Capacitor WebView will limit the navigation to @c WKAppBoundDomains listed in the Info.plist.
+ @discussion Defaults to @c false. Set by @c ios.limitsNavigationsToAppBoundDomains in the configuration file.  Required to be @c true for plugins to work if the app includes @c WKAppBoundDomains in the Info.plist.
+ */
+@property (nonatomic, assign) BOOL limitsNavigationsToAppBoundDomains;
 /**
  @brief The parser used to load the cofiguration for Cordova plugins.
  */

diff --git a/ios/Capacitor/Capacitor/CAPInstanceDescriptor.m b/ios/Capacitor/Capacitor/CAPInstanceDescriptor.m
@@ -41,6 +41,7 @@ - (void)_setDefaultsWithAppLocation:(NSURL*)location {
     _handleApplicationNotifications = YES;
     _contentInsetAdjustmentBehavior = UIScrollViewContentInsetAdjustmentNever;
     _appLocation = location;
+    _limitsNavigationsToAppBoundDomains = FALSE;
     _cordovaConfiguration = [[CDVConfigParser alloc] init];
     _warnings = 0;
     if (location == nil) {

diff --git a/ios/Capacitor/Capacitor/CAPInstanceDescriptor.swift b/ios/Capacitor/Capacitor/CAPInstanceDescriptor.swift
@@ -122,6 +122,9 @@ internal extension InstanceDescriptor {
             } else if let hideLogs = (config[keyPath: "ios.hideLogs"] as? Bool) ?? (config[keyPath: "hideLogs"] as? Bool), hideLogs {
                 loggingBehavior = .none
             }
+            if let limitsNavigations = config[keyPath: "ios.limitsNavigationsToAppBoundDomains"] as? Bool {
+                limitsNavigationsToAppBoundDomains = limitsNavigations
+            }
         }
     }
     // swiftlint:enable cyclomatic_complexity