Add Browser.open entersReaderIfAvailable option

ionic-team · Oct 31, 2023 · e08e9d6 · e08e9d6
1 parent 27e7825
commit e08e9d6
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 11 deletions.
diff --git a/browser/README.md b/browser/README.md
@@ -140,14 +140,15 @@ Remove all native listeners for this plugin.
 
 Represents the options passed to `open`.
 
-| Prop                    | Type                                   | Description                                                                                                                                | Since |
-| ----------------------- | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | ----- |
-| **`url`**               | <code>string</code>                    | The URL to which the browser is opened.                                                                                                    | 1.0.0 |
-| **`windowName`**        | <code>string</code>                    | Web only: Optional target for browser open. Follows the `target` property for window.open. Defaults to _blank. Ignored on other platforms. | 1.0.0 |
-| **`toolbarColor`**      | <code>string</code>                    | A hex color to which the toolbar color is set.                                                                                             | 1.0.0 |
-| **`presentationStyle`** | <code>'fullscreen' \| 'popover'</code> | iOS only: The presentation style of the browser. Defaults to fullscreen. Ignored on other platforms.                                       | 1.0.0 |
-| **`width`**             | <code>number</code>                    | iOS only: The width the browser when using presentationStyle 'popover' on iPads. Ignored on other platforms.                               | 4.0.0 |
-| **`height`**            | <code>number</code>                    | iOS only: The height the browser when using presentationStyle 'popover' on iPads. Ignored on other platforms.                              | 4.0.0 |
+| Prop                          | Type                                   | Description                                                                                                                                | Since |
+| ----------------------------- | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | ----- |
+| **`url`**                     | <code>string</code>                    | The URL to which the browser is opened.                                                                                                    | 1.0.0 |
+| **`windowName`**              | <code>string</code>                    | Web only: Optional target for browser open. Follows the `target` property for window.open. Defaults to _blank. Ignored on other platforms. | 1.0.0 |
+| **`toolbarColor`**            | <code>string</code>                    | A hex color to which the toolbar color is set.                                                                                             | 1.0.0 |
+| **`presentationStyle`**       | <code>'fullscreen' \| 'popover'</code> | iOS only: The presentation style of the browser. Defaults to fullscreen. Ignored on other platforms.                                       | 1.0.0 |
+| **`width`**                   | <code>number</code>                    | iOS only: The width the browser when using presentationStyle 'popover' on iPads. Ignored on other platforms.                               | 4.0.0 |
+| **`height`**                  | <code>number</code>                    | iOS only: The height the browser when using presentationStyle 'popover' on iPads. Ignored on other platforms.                              | 4.0.0 |
+| **`entersReaderIfAvailable`** | <code>boolean</code>                   | iOS only: Whether to automatically enter Reader mode if available for the url Ignored on other platforms.                                  | 4.0.0 |
 
 
 #### PluginListenerHandle

diff --git a/browser/ios/Plugin/Browser.swift b/browser/ios/Plugin/Browser.swift
@@ -15,9 +15,12 @@ import SafariServices
         return safariViewController
     }
 
-    @objc public func prepare(for url: URL, withTint tint: UIColor? = nil, modalPresentation style: UIModalPresentationStyle = .fullScreen) -> Bool {
+    @objc public func prepare(for url: URL, withTint tint: UIColor? = nil, modalPresentation style: UIModalPresentationStyle = .fullScreen, entersReaderIfAvailable: Bool = false) -> Bool {
         if safariViewController == nil, let scheme = url.scheme?.lowercased(), ["http", "https"].contains(scheme) {
-            let safariVC = SFSafariViewController(url: url)
+            let config = SFSafariViewController.Configuration()
+            config.entersReaderIfAvailable = entersReaderIfAvailable
+
+            let safariVC = SFSafariViewController(url: url, configuration: config)
             safariVC.delegate = self
             if let color = tint {
                 safariVC.preferredBarTintColor = color

diff --git a/browser/ios/Plugin/BrowserPlugin.swift b/browser/ios/Plugin/BrowserPlugin.swift
@@ -17,8 +17,9 @@ public class CAPBrowserPlugin: CAPPlugin {
             color = UIColor.capacitor.color(fromHex: toolbarColor)
         }
         let style = self.presentationStyle(for: call.getString("presentationStyle"))
+        let entersReaderIfAvailable = call.getBool("entersReaderIfAvailable") ?? false
         // prepare for display
-        guard implementation.prepare(for: url, withTint: color, modalPresentation: style), let viewController = implementation.viewController else {
+        guard implementation.prepare(for: url, withTint: color, modalPresentation: style, entersReaderIfAvailable: entersReaderIfAvailable), let viewController = implementation.viewController else {
             call.reject("Unable to display URL")
             return
         }

diff --git a/browser/src/definitions.ts b/browser/src/definitions.ts
@@ -105,6 +105,15 @@ export interface OpenOptions {
    * @since 4.0.0
    */
   height?: number;
+
+  /**
+   * iOS only: Whether to automatically enter Reader mode if available for the url
+   *
+   * Ignored on other platforms.
+   *
+   * @since 5.0.0
+   */
+  entersReaderIfAvailable?: boolean;
 }
 
 /**