Remove unserializable properties in the DialogFragmentArguments class.

To configure a WebView inside a DialogFragment and make it as flexible as possible without copying and pasting every function that WebView has, this pull request makes DialogFragment rely on Configurator Fragments which implement the WebViewDownloadConfigurator and WebViewConfigurator interfaces.

I chose to use fragments to configure the inner WebView because configurator fragments will be re-instantiated after a configuration change, and Android developers are accustomed to avoiding memory leaks.

Author: mert.yuksel

libraries/dialogs/src/main/java/com/trendyol/uicomponents/dialogs/Builder.kt

@@ -31,10 +31,8 @@ open class InfoDialogBuilder internal constructor() : Builder() {
     var showContentAsHtml: Boolean = false
     var contentTextPosition: TextPosition? = null
     var webViewContent: WebViewContent? = null
-    var webViewBuilder: (WebView.() -> Unit)? = null
     var horizontalPadding: Float? = null
     var verticalPadding: Float? = null
-    var webViewDownloadListener: DownloadListener? = null
 
     internal fun buildInfoDialog(block: InfoDialogBuilder.() -> Unit): DialogFragment {
         return InfoDialogBuilder().apply(block).let {
@@ -56,12 +54,10 @@ open class InfoDialogBuilder internal constructor() : Builder() {
                     titleTextPosition = it.titleTextPosition,
                     contentTextPosition = it.contentTextPosition,
                     webViewContent = it.webViewContent,
-                    webViewBuilder = it.webViewBuilder,
                     isFullHeightWebView = it.isFullHeightWebView
                 ).toBundle()
                 this.closeButtonListener = it.closeButtonListener ?: { }
                 this.onDismissListener = it.onDialogDismissListener ?: {}
-                this.webViewDownloadListener = it.webViewDownloadListener
             }
         }
     }

libraries/dialogs/src/main/java/com/trendyol/uicomponents/dialogs/DialogFragment.kt

@@ -8,17 +8,21 @@ import android.text.method.LinkMovementMethod
 import android.text.util.Linkify
 import android.view.LayoutInflater
 import android.view.View
+import android.view.ViewConfiguration
 import android.view.ViewGroup
 import android.view.ViewOutlineProvider
 import android.webkit.DownloadListener
 import android.webkit.WebChromeClient
 import android.webkit.WebViewClient
 import androidx.core.widget.doAfterTextChanged
+import androidx.fragment.app.Fragment
 import androidx.fragment.app.FragmentManager
 import androidx.lifecycle.ViewModelProviders
 import com.google.android.material.bottomsheet.BottomSheetBehavior
 import com.trendyol.dialog.R
 import com.trendyol.dialog.databinding.FragmentDialogBinding
+import com.trendyol.uicomponents.dialogs.configurator.WebViewConfigurator
+import com.trendyol.uicomponents.dialogs.configurator.WebViewDownloadConfigurator
 import com.trendyol.uicomponents.dialogs.list.DialogListAdapter
 import com.trendyol.uicomponents.dialogs.list.DialogListViewModel
 import com.trendyol.uicomponents.dialogs.list.ItemDecorator
@@ -193,8 +197,8 @@ class DialogFragment internal constructor() : BaseBottomSheetDialog() {
                 if (visibility == View.VISIBLE) {
                     webChromeClient = WebChromeClient()
                     webViewClient = WebViewClient()
-                    dialogArguments.webViewBuilder?.invoke(webViewContent)
-
+                    findWebViewConfigurator(requireFragmentManager())
+                        ?.configureWebView(webViewContent)
                     loadWebViewContent(viewState.webViewContent)
                     if (dialogArguments.isFullHeightWebView) {
                         binding.webViewContent.layoutParams.height =
@@ -219,8 +223,31 @@ class DialogFragment internal constructor() : BaseBottomSheetDialog() {
         }
     }
 
-    fun showDialog(fragmentManager: FragmentManager) {
-        show(fragmentManager, TAG)
+    fun showDialog(
+        fragmentManager: FragmentManager,
+    ) {
+        showDialog(fragmentManager, null, null)
+    }
+
+    fun <ViewConfigurator, DownloadConfigurator> showDialog(
+        fragmentManager: FragmentManager,
+        webViewConfigurator: ViewConfigurator?,
+        downloadConfigurator: DownloadConfigurator?,
+    ) where DownloadConfigurator : Fragment,
+            DownloadConfigurator : WebViewDownloadConfigurator,
+            ViewConfigurator : Fragment,
+            ViewConfigurator : WebViewConfigurator {
+
+        val transaction = fragmentManager.beginTransaction()
+        with(transaction) {
+            if (webViewConfigurator != null) {
+                transaction.add(webViewConfigurator, WebViewConfigurator.TAG)
+            }
+            if (downloadConfigurator != null) {
+                add(downloadConfigurator, WebViewDownloadConfigurator.TAG)
+            }
+        }
+        show(transaction, TAG)
     }
 
     private fun setUpViewModel(items: List<Pair<Boolean, CharSequence>>) {
@@ -252,14 +279,29 @@ class DialogFragment internal constructor() : BaseBottomSheetDialog() {
 
     override fun onResume() {
         super.onResume()
-        binding.webViewContent.setDownloadListener(webViewDownloadListener)
+        findWebViewDownloadConfigurator(requireFragmentManager())
+            ?.configureDownloadListener(binding.webViewContent)
     }
 
     override fun onPause() {
         super.onPause()
         binding.webViewContent.setDownloadListener(null)
     }
 
+    private fun findWebViewDownloadConfigurator(
+        fragmentManager: FragmentManager
+    ): WebViewDownloadConfigurator? {
+        val fragment = fragmentManager.findFragmentByTag(WebViewDownloadConfigurator.TAG)
+        return fragment as? WebViewDownloadConfigurator
+    }
+
+    private fun findWebViewConfigurator(
+        fragmentManager: FragmentManager
+    ): WebViewConfigurator? {
+        val fragment = fragmentManager.findFragmentByTag(WebViewConfigurator.TAG)
+        return fragment as? WebViewConfigurator
+    }
+
     companion object {
 
         const val TAG: String = "TRENDYOL_BOTTOM_SHEET_DIALOG"

libraries/dialogs/src/main/java/com/trendyol/uicomponents/dialogs/DialogFragmentArguments.kt

@@ -37,7 +37,6 @@ class DialogFragmentArguments(
     val titleTextPosition: TextPosition? = null,
     val contentTextPosition: TextPosition? = null,
     val webViewContent: WebViewContent? = null,
-    val webViewBuilder: (WebView.() -> Unit)? = null,
     val infoListItems: List<Pair<CharSequence, CharSequence>>? = null,
     val itemDividers: List<ItemDivider> = emptyList(),
     val isFullHeightWebView : Boolean = false

libraries/dialogs/src/main/java/com/trendyol/uicomponents/dialogs/configurator/WebViewConfigurator.kt

@@ -0,0 +1,12 @@
+package com.trendyol.uicomponents.dialogs.configurator
+
+import android.webkit.WebView
+
+interface WebViewConfigurator {
+
+    fun configureWebView(webView: WebView)
+
+    companion object {
+        const val TAG: String = "WebViewConfigurator"
+    }
+}

libraries/dialogs/src/main/java/com/trendyol/uicomponents/dialogs/configurator/WebViewDownloadConfigurator.kt

@@ -0,0 +1,12 @@
+package com.trendyol.uicomponents.dialogs.configurator
+
+import android.webkit.WebView
+
+interface WebViewDownloadConfigurator {
+
+    fun configureDownloadListener(webView: WebView)
+
+    companion object {
+        const val TAG: String = "WebViewDownloadConfigurator"
+    }
+}

sample/src/main/java/com/trendyol/uicomponents/DialogsActivity.kt

@@ -1,14 +1,9 @@
 package com.trendyol.uicomponents
 
-import android.app.DownloadManager
 import android.graphics.Color
-import android.net.Uri
 import android.os.Bundle
-import android.os.Environment
 import android.text.SpannableString
 import android.text.SpannableStringBuilder
-import android.webkit.DownloadListener
-import android.webkit.URLUtil
 import android.webkit.WebViewClient
 import android.widget.Toast
 import androidx.appcompat.app.AppCompatActivity
@@ -30,9 +25,6 @@ class DialogsActivity : AppCompatActivity() {
 
     private lateinit var binding: ActivityDialogsBinding
 
-    private val downloadManager: DownloadManager? by lazy(LazyThreadSafetyMode.NONE) {
-        getSystemService(DOWNLOAD_SERVICE) as? DownloadManager
-    }
 
     override fun onCreate(savedInstanceState: Bundle?) {
         super.onCreate(savedInstanceState)
@@ -152,12 +144,11 @@ class DialogsActivity : AppCompatActivity() {
             closeButtonListener = infoDialogClosed
             webViewContent =
                 WebViewContent.UrlContent("https://github.com/Trendyol/android-ui-components")
-            webViewBuilder = {
-                settings.javaScriptEnabled = true
-                settings.domStorageEnabled = true
-                webViewClient = WebViewClient()
-            }
-        }.showDialog(supportFragmentManager)
+        }.showDialog(
+            fragmentManager = supportFragmentManager,
+            webViewConfigurator = WebViewDomAndJSEnabler(),
+            downloadConfigurator = null,
+        )
     }
 
     private fun showInfoListDialog() {
@@ -189,21 +180,13 @@ class DialogsActivity : AppCompatActivity() {
             showContentAsHtml = true
             titleTextColor = CardInputViewR.color.civ_error_stroke
             showCloseButton = true
-            webViewBuilder = {
-                settings.javaScriptEnabled = true
-            }
-            webViewDownloadListener = DownloadListener { url, _, contentDisposition, mimetype, _ ->
-                val downloadRequest = DownloadManager.Request(Uri.parse(url))
-                    .setTitle(title)
-                    .setMimeType(mimetype)
-                    .setDestinationInExternalPublicDir(
-                        Environment.DIRECTORY_DOWNLOADS,
-                        URLUtil.guessFileName(url, contentDisposition, mimetype)
-                    )
-                    .setNotificationVisibility(DownloadManager.Request.VISIBILITY_VISIBLE_NOTIFY_COMPLETED)
-                downloadManager?.enqueue(downloadRequest)
-            }
-        }.showDialog(supportFragmentManager)
+        }.showDialog(
+            fragmentManager = supportFragmentManager,
+            webViewConfigurator = WebViewJavascriptEnabler(),
+            downloadConfigurator = WebViewDownloadListenerConfigurator.newInstance(
+                "Info Dialog with WebView Download Listener"
+            )
+        )
     }
 
     override fun onRestoreInstanceState(savedInstanceState: Bundle) {
@@ -272,4 +255,4 @@ class DialogsActivity : AppCompatActivity() {
     private fun showToast(message: String) {
         Toast.makeText(this, message, Toast.LENGTH_SHORT).show()
     }
-}
+}

sample/src/main/java/com/trendyol/uicomponents/WebViewDomAndJSEnabler.kt

@@ -0,0 +1,13 @@
+package com.trendyol.uicomponents
+
+import android.webkit.WebViewClient
+import androidx.fragment.app.Fragment
+import com.trendyol.uicomponents.dialogs.configurator.WebViewConfigurator
+
+class WebViewDomAndJSEnabler : WebViewConfigurator, Fragment() {
+    override fun configureWebView(webView: android.webkit.WebView) {
+        webView.settings.javaScriptEnabled = true
+        webView.settings.domStorageEnabled = true
+        webView.webViewClient = WebViewClient()
+    }
+}

sample/src/main/java/com/trendyol/uicomponents/WebViewDownloadListenerConfigurator.kt

@@ -0,0 +1,40 @@
+package com.trendyol.uicomponents
+
+import android.app.DownloadManager
+import android.net.Uri
+import android.os.Environment
+import android.webkit.DownloadListener
+import android.webkit.URLUtil
+import android.webkit.WebView
+import androidx.core.content.ContextCompat
+import androidx.core.os.bundleOf
+import androidx.fragment.app.Fragment
+import com.trendyol.uicomponents.dialogs.configurator.WebViewDownloadConfigurator
+
+class WebViewDownloadListenerConfigurator : WebViewDownloadConfigurator, Fragment() {
+    private val downloadManager: DownloadManager? by lazy(LazyThreadSafetyMode.NONE) {
+        ContextCompat.getSystemService(requireContext(), DownloadManager::class.java)
+    }
+
+    override fun configureDownloadListener(webView: WebView) {
+        webView.setDownloadListener(DownloadListener { url, _, contentDisposition, mimetype, _ ->
+            val downloadRequest = DownloadManager.Request(Uri.parse(url))
+                .setTitle(requireArguments().getString("title"))
+                .setMimeType(mimetype)
+                .setDestinationInExternalPublicDir(
+                    Environment.DIRECTORY_DOWNLOADS,
+                    URLUtil.guessFileName(url, contentDisposition, mimetype)
+                )
+                .setNotificationVisibility(DownloadManager.Request.VISIBILITY_VISIBLE_NOTIFY_COMPLETED)
+            downloadManager?.enqueue(downloadRequest)
+        })
+    }
+
+    companion object {
+        fun newInstance(title: String): WebViewDownloadListenerConfigurator =
+            WebViewDownloadListenerConfigurator().apply {
+                this.arguments = bundleOf("title" to title)
+            }
+    }
+
+}

sample/src/main/java/com/trendyol/uicomponents/WebViewJavascriptEnabler.kt

@@ -0,0 +1,12 @@
+package com.trendyol.uicomponents
+
+import android.webkit.WebView
+import androidx.fragment.app.Fragment
+import com.trendyol.uicomponents.dialogs.configurator.WebViewConfigurator
+
+class WebViewJavascriptEnabler : WebViewConfigurator, Fragment() {
+
+    override fun configureWebView(webView: WebView) {
+        webView.settings.javaScriptEnabled = true
+    }
+}