feat(ios): allow changing or removing input accessory view (#1544)

* feat(ios): allow changing or removing input accessory view

see https://developer.apple.com/documentation/uikit/uiresponder/inputaccessoryview?language=objc for more information

* lint

Co-authored-by: jyc5120 <jason@livingskytech.com>

---------

Co-authored-by: jyc5120 <jason@livingskytech.com>

Author: lucasfernog

.changes/input-view-accessory-builder.md

@@ -0,0 +1,5 @@
+---
+"wry": patch
+---
+
+Allow modifying or removing the input accessory view on iOS via `WebViewBuilderExtIos::with_input_accessory_view_builder`.

src/lib.rs

@@ -407,6 +407,10 @@ pub use http;
 pub use proxy::{ProxyConfig, ProxyEndpoint};
 pub use web_context::WebContext;
 
+#[cfg(target_os = "ios")]
+pub type InputAccessoryViewBuilder =
+  dyn Fn(&objc2_ui_kit::UIView) -> Option<Retained<objc2_ui_kit::UIView>>;
+
 /// A rectangular region.
 #[derive(Clone, Copy, Debug)]
 pub struct Rect {
@@ -1410,11 +1414,12 @@ impl<'a> WebViewBuilder<'a> {
 }
 
 #[cfg(any(target_os = "macos", target_os = "ios"))]
-#[derive(Clone)]
 pub(crate) struct PlatformSpecificWebViewAttributes {
   data_store_identifier: Option<[u8; 16]>,
   traffic_light_inset: Option<dpi::Position>,
   allow_link_preview: bool,
+  #[cfg(target_os = "ios")]
+  input_accessory_view_builder: Option<Box<InputAccessoryViewBuilder>>,
 }
 
 #[cfg(any(target_os = "macos", target_os = "ios"))]
@@ -1425,6 +1430,8 @@ impl Default for PlatformSpecificWebViewAttributes {
       traffic_light_inset: None,
       // platform default for this is true
       allow_link_preview: true,
+      #[cfg(target_os = "ios")]
+      input_accessory_view_builder: None,
     }
   }
 }
@@ -1476,6 +1483,40 @@ impl WebViewBuilderExtDarwin for WebViewBuilder<'_> {
   }
 }
 
+#[cfg(target_os = "ios")]
+pub trait WebViewBuilderExtIos {
+  /// Allows overriding the the keyboard accessory view on iOS.
+  /// Returning `None` effectively removes the view.
+  ///
+  /// The closure parameter is the webview instance.
+  ///
+  /// The accessory view is the view that appears above the keyboard when a text input element is focused.
+  /// It usually displays a view with "Done", "Next" buttons.
+  fn with_input_accessory_view_builder<
+    F: Fn(&objc2_ui_kit::UIView) -> Option<Retained<objc2_ui_kit::UIView>> + 'static,
+  >(
+    self,
+    builder: F,
+  ) -> Self;
+}
+
+#[cfg(target_os = "ios")]
+impl WebViewBuilderExtIos for WebViewBuilder<'_> {
+  fn with_input_accessory_view_builder<
+    F: Fn(&objc2_ui_kit::UIView) -> Option<Retained<objc2_ui_kit::UIView>> + 'static,
+  >(
+    self,
+    builder: F,
+  ) -> Self {
+    self.and_then(|mut b| {
+      b.platform_specific
+        .input_accessory_view_builder
+        .replace(Box::new(builder));
+      Ok(b)
+    })
+  }
+}
+
 #[cfg(windows)]
 #[derive(Clone)]
 pub(crate) struct PlatformSpecificWebViewAttributes {

src/wkwebview/class/wry_web_view.rs

@@ -29,6 +29,8 @@ pub struct WryWebViewIvars {
   pub(crate) drag_drop_handler: Box<dyn Fn(DragDropEvent) -> bool>,
   #[cfg(target_os = "macos")]
   pub(crate) accept_first_mouse: objc2::runtime::Bool,
+  #[cfg(target_os = "ios")]
+  pub(crate) input_accessory_view_builder: Option<Box<crate::InputAccessoryViewBuilder>>,
   pub(crate) custom_protocol_task_ids: Mutex<HashMap<usize, Retained<NSUUID>>>,
 }
 
@@ -59,6 +61,16 @@ define_class!(
     fn accept_first_mouse(&self, _event: &NSEvent) -> Bool {
       self.ivars().accept_first_mouse
     }
+
+    #[cfg(target_os = "ios")]
+    #[unsafe(method_id(inputAccessoryView))]
+    fn input_accessory_view(&self) -> Option<Retained<objc2_ui_kit::UIView>> {
+      if let Some(builder) = &self.ivars().input_accessory_view_builder {
+        builder(self)
+      } else {
+        unsafe { objc2::msg_send![super(self), inputAccessoryView] }
+      }
+    }
   }
   unsafe impl NSObjectProtocol for WryWebView {}
 

src/wkwebview/class/wry_web_view_parent.rs

@@ -2,9 +2,9 @@
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-License-Identifier: MIT
 
-use std::cell::Cell;
-
-use objc2::{define_class, msg_send, rc::Retained, DefinedClass, MainThreadOnly};
+#[cfg(target_os = "macos")]
+use objc2::DefinedClass;
+use objc2::{define_class, msg_send, rc::Retained, MainThreadOnly};
 #[cfg(target_os = "macos")]
 use objc2_app_kit::{NSApplication, NSEvent, NSView, NSWindow, NSWindowButton};
 use objc2_foundation::MainThreadMarker;
@@ -15,7 +15,7 @@ use objc2_ui_kit::UIView as NSView;
 
 pub struct WryWebViewParentIvars {
   #[cfg(target_os = "macos")]
-  traffic_light_inset: Cell<Option<(f64, f64)>>,
+  traffic_light_inset: std::cell::Cell<Option<(f64, f64)>>,
 }
 
 define_class!(

src/wkwebview/mod.rs

@@ -77,7 +77,7 @@ use std::{
   net::Ipv4Addr,
   os::raw::c_char,
   panic::AssertUnwindSafe,
-  ptr::{null_mut, NonNull},
+  ptr::NonNull,
   rc::Rc,
   str::{self, FromStr},
   sync::{Arc, Mutex, RwLock},
@@ -272,6 +272,8 @@ impl InnerWebView {
         },
         #[cfg(target_os = "macos")]
         accept_first_mouse: Bool::new(attributes.accept_first_mouse),
+        #[cfg(target_os = "ios")]
+        input_accessory_view_builder: pl_attrs.input_accessory_view_builder,
         custom_protocol_task_ids: Default::default(),
       });
 
@@ -284,7 +286,7 @@ impl InnerWebView {
         let proxy_config = match proxy_config {
           ProxyConfig::Http(endpoint) => {
             let nw_endpoint = nw_endpoint_t::try_from(endpoint).unwrap();
-            nw_proxy_config_create_http_connect(nw_endpoint, null_mut())
+            nw_proxy_config_create_http_connect(nw_endpoint, std::ptr::null_mut())
           }
           ProxyConfig::Socks5(endpoint) => {
             let nw_endpoint = nw_endpoint_t::try_from(endpoint).unwrap();
@@ -508,6 +510,7 @@ impl InnerWebView {
         }
       }
 
+      #[cfg_attr(target_os = "ios", allow(unused_mut))]
       let mut w = Self {
         id: webview_id,
         mtm,
@@ -778,7 +781,7 @@ r#"Object.defineProperty(window, 'ipc', {
           &window,
           None,
           None,
-          null_mut(),
+          std::ptr::null_mut(),
         )
       }
     }