Backport dynamic layout for search widget

Author: Isira-Seneviratne

app/build.gradle

@@ -185,6 +185,7 @@ dependencies {
     implementation libs.material
     implementation libs.appcompat
     implementation libs.core.ktx
+    implementation libs.androidx.core.remoteviews
     implementation libs.browser
     implementation libs.constraintlayout
     implementation libs.fragment.ktx

app/src/main/java/org/wikipedia/widgets/WidgetProviderSearch.kt

@@ -7,44 +7,52 @@ import android.content.ComponentName
 import android.content.Context
 import android.content.Intent
 import android.os.Build
-import android.util.SizeF
+import android.os.Bundle
 import android.widget.RemoteViews
 import androidx.core.app.PendingIntentCompat
+import androidx.core.util.SizeFCompat
+import androidx.core.widget.updateAppWidget
 import org.wikipedia.Constants.InvokeSource
 import org.wikipedia.R
 import org.wikipedia.search.SearchActivity
 
 class WidgetProviderSearch : AppWidgetProvider() {
     override fun onUpdate(context: Context, appWidgetManager: AppWidgetManager, appWidgetIds: IntArray) {
         val thisWidget = ComponentName(context, WidgetProviderSearch::class.java)
-        val allWidgetIds = appWidgetManager.getAppWidgetIds(thisWidget)
-        for (widgetId in allWidgetIds) {
-
-            val pendingIntent = PendingIntentCompat.getActivity(context, 0,
-                SearchActivity.newIntent(context, InvokeSource.WIDGET, null)
-                    .setFlags(Intent.FLAG_ACTIVITY_NEW_TASK),
-                PendingIntent.FLAG_UPDATE_CURRENT, false)
+        for (widgetId in appWidgetManager.getAppWidgetIds(thisWidget)) {
+            updateWidget(context, appWidgetManager, widgetId)
+        }
+    }
 
-            val largeView = RemoteViews(context.packageName, R.layout.widget_search_large)
-            largeView.setOnClickPendingIntent(R.id.widget_container, pendingIntent)
+    override fun onAppWidgetOptionsChanged(
+        context: Context,
+        appWidgetManager: AppWidgetManager,
+        appWidgetId: Int,
+        newOptions: Bundle,
+    ) {
+        // appWidgetManager.updateAppWidget must be called here on API levels < 31
+        if (Build.VERSION.SDK_INT < Build.VERSION_CODES.S) {
+            updateWidget(context, appWidgetManager, appWidgetId)
+        }
+    }
 
-            val remoteViews = if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.S) {
-                val smallView = RemoteViews(context.packageName, R.layout.widget_search_small)
-                val mediumView = RemoteViews(context.packageName, R.layout.widget_search_medium)
-                smallView.setOnClickPendingIntent(R.id.widget_container, pendingIntent)
-                mediumView.setOnClickPendingIntent(R.id.widget_container, pendingIntent)
+    private fun updateWidget(context: Context, appWidgetManager: AppWidgetManager, appWidgetId: Int) {
+        val small = SizeFCompat(32f, 32f)
+        val medium = SizeFCompat(64f, 32f)
+        val large = SizeFCompat(160f, 32f)
+        val pendingIntent = PendingIntentCompat.getActivity(context, 0,
+            SearchActivity.newIntent(context, InvokeSource.WIDGET, null)
+                .setFlags(Intent.FLAG_ACTIVITY_NEW_TASK),
+            PendingIntent.FLAG_UPDATE_CURRENT, false)
 
-                val viewMapping: Map<SizeF, RemoteViews> = mapOf(
-                    SizeF(32f, 32f) to smallView,
-                    SizeF(64f, 32f) to mediumView,
-                    SizeF(160f, 32f) to largeView
-                )
-                RemoteViews(viewMapping)
-            } else {
-                largeView
+        appWidgetManager.updateAppWidget(appWidgetId, listOf(small, medium, large)) {
+            val remoteViewId = when (it) {
+                small -> R.layout.widget_search_small
+                medium -> R.layout.widget_search_medium
+                else -> R.layout.widget_search_large
             }
-
-            appWidgetManager.updateAppWidget(widgetId, remoteViews)
+            RemoteViews(context.packageName, remoteViewId)
+                .apply { setOnClickPendingIntent(R.id.widget_container, pendingIntent) }
         }
     }
 }

gradle/libs.versions.toml

@@ -8,6 +8,7 @@ coilCompose = "3.3.0"
 commonsLang3 = "3.18.0"
 constraintlayout = "2.2.1"
 coreKtx = "1.17.0"
+coreRemoteviews = "1.1.0"
 desugar_jdk_libs = "2.1.5"
 drawerlayout = "1.2.0"
 espressoVersion = "3.7.0"
@@ -55,6 +56,7 @@ composeViewModel = "2.9.3"
 [libraries]
 android-sdk = { module = "org.maplibre.gl:android-sdk", version.ref = "androidSdk" }
 android-plugin-annotation-v9 = { module = "org.maplibre.gl:android-plugin-annotation-v9", version.ref = "androidPluginAnnotationV9" }
+androidx-core-remoteviews = { module = "androidx.core:core-remoteviews", version.ref = "coreRemoteviews" }
 androidx-espresso-intents = { module = "androidx.test.espresso:espresso-intents", version.ref = "espressoVersion" }
 androidx-junit = { module = "androidx.test.ext:junit", version.ref = "junitVersion" }
 androidx-navigation-compose = { module = "androidx.navigation:navigation-compose", version.ref = "navigationCompose" }