Convert OverzoomEffect to a class to prevent custom implementations

saket · Jan 11, 2025 · 22fd7f7 · 22fd7f7
1 parent a11265e
commit 22fd7f7
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 7 deletions.
diff --git a/zoomable/api/api.txt b/zoomable/api/api.txt
@@ -85,7 +85,7 @@ package me.saket.telephoto.zoomable {
     property public final me.saket.telephoto.zoomable.HardwareShortcutsSpec Disabled;
   }
 
-  @androidx.compose.runtime.Immutable public interface OverzoomEffect {
+  @androidx.compose.runtime.Immutable public final class OverzoomEffect {
     field public static final me.saket.telephoto.zoomable.OverzoomEffect.Companion Companion;
   }
 

diff --git a/zoomable/src/commonMain/kotlin/me/saket/telephoto/zoomable/ZoomSpec.kt b/zoomable/src/commonMain/kotlin/me/saket/telephoto/zoomable/ZoomSpec.kt
@@ -80,22 +80,27 @@ class ZoomLimit(
   val overzoomEffect: OverzoomEffect = OverzoomEffect.RubberBanding,
 )
 
+/**
+ * Represents a visual effect that displays when the zoom limits of a zoomable container
+ * have been reached.
+ *
+ * TODO: Make OverzoomEffect extensible by consumers when ready.
+ */
 @Immutable
-interface OverzoomEffect {
+class OverzoomEffect internal constructor(
+  @Suppress("unused") private val value: Int
+) {
   companion object {
     /**
      * Applies a rubber banding effect to zoom gestures when content is zoomed beyond
      * its limit as a form of visual feedback that the content can't be zoomed any further.
      */
-    val RubberBanding: OverzoomEffect = RubberBandingOverzoomEffect
+    val RubberBanding: OverzoomEffect = OverzoomEffect(1)
 
     /**
      * Does not limit over/under zooms in any manner. Content will zoom in a free-form
      * manner even when it goes beyond its limit (until the gesture is released).
      */
-    val NoLimits: OverzoomEffect = NoLimitsOverzoomEffect
+    val NoLimits: OverzoomEffect = OverzoomEffect(2)
   }
 }
-
-internal data object RubberBandingOverzoomEffect : OverzoomEffect
-internal data object NoLimitsOverzoomEffect : OverzoomEffect