Use WebKitWebViewUIImplementation and UIImplementation
Learn how to switch between ASWebAuthenticationSession/Custom Tabs to WebKitWebView using Authgear Mobile SDKs.
Last updated
Was this helpful?
Learn how to switch between ASWebAuthenticationSession/Custom Tabs to WebKitWebView using Authgear Mobile SDKs.
Last updated
Was this helpful?
The default behavior of the Authgear Mobile SDKs is to launch AuthUI in in iOS and in Android. The latest versions of the mobile SDKs include WebKitWebViewUIImplementation
a UIImplementation
which makes it possible to customize the above behavior. For example, setting the uiImplementation
attribute in the configure()
method of the Authgear Capacitor SDK to WebKitWebViewUIImplementation()
will open AuthUI using on iOS and on Android.
Omitting the uiImplementation
attribute in the configure()
method will fall back to the default behavior (launching AuthUI in ASWebAuthenticationSession/Custom Tabs). You can also explicitly choose the default behavior by setting uiImplementation
to DeviceBrowserUIImplementation()
.
The following examples show how to set the uiImplementation
attribute.
Setting uiImplementation
to WebKitWebViewUIImplementation
in the above example will change the behavior of your application from the default to using WKWebView
on iOS and android.webkit.WebView
on Android.
WebKitWebViewUIImplementation
allows you to customize some parts of the UI. You can do this by passing your customization options as parameters in WebKitWebViewUIImplementation(). You can customize the following parts of the UI:
Android
actionBarBackgroundColor
: Use this option to customize the color of the action bar on the WebView Activity screen. The value should be of type integer according to this encoding:
actionBarButtonTintColor
: This option can be used to set the color of the icons and texts on the action bar. The value should also be of type integer and use the encoding here: .
iOS
navigationBarButtonTintColor
: This option sets the color of icons and texts on the navigation bar. The value should also be UIColor or an integer (React Native or Ionic SDKs) using the same encoding as navigationBarBackgroundColor
.
modalPresentationStyle
: Sets the type of modal to be shown. The value can be any of the following: "automatic", "fullScreen", "pageSheet".
The following examples show how to set custom background color, tint color, and modal presentation style.
You can implement your own custom UIImplementation
when the WebKitWebViewUIImplementation
does not meet the requirements of your use case.
The WebKitWebViewUIImplementation class itself is basically a class that implements UIImplementation
and overrides the openAuthorizationURL()
method. Hence your custom implementation may look like this:
Then, you can use your custom implementation like this:
When you drop the default DeviceBrowserUIImplementation to use your own custom UI implementation that uses WebView, it is important to note that you'll be losing the following features and services:
Passkey: Passkey is not supported in WebKitWebView.
navigationBarBackgroundColor
: This option can be used to customize the color of the navigation bar on iOS. The value should be of type or an integer (React Native or Ionic SDKs) using the following encoding: .
To get a deeper understanding of how to implement your UIImplementation, see the code for the implementation.
Login with Google: Google prohibits the use of WebKitWebView
with the Google SSO. Learn more here: . As a result WebKitWebViewUIImplementation
and Google SSO cannot be used together.