library: Allows custom Overscroll enabled platforms

Author: YuKongA

miuix/src/androidMain/kotlin/top/yukonga/miuix/kmp/utils/Overscroll.android.kt

@@ -9,13 +9,12 @@ import androidx.compose.ui.platform.LocalDensity
 import androidx.compose.ui.platform.LocalView
 import androidx.compose.ui.unit.Dp
 import androidx.compose.ui.unit.dp
-import androidx.window.layout.WindowMetrics
 import androidx.window.layout.WindowMetricsCalculator
 
 @Composable
 actual fun getWindowSize(): WindowSize {
     val context = LocalContext.current
-    val windowMetrics: WindowMetrics = WindowMetricsCalculator.getOrCreate().computeCurrentWindowMetrics(context)
+    val windowMetrics = WindowMetricsCalculator.getOrCreate().computeCurrentWindowMetrics(context)
     val widthPx = windowMetrics.bounds.width()
     val heightPx = windowMetrics.bounds.height()
     return WindowSize(widthPx, heightPx)

miuix/src/androidMain/kotlin/top/yukonga/miuix/kmp/utils/Utils.android.kt

@@ -11,8 +11,9 @@ import androidx.compose.runtime.remember
 import androidx.compose.ui.Modifier
 import androidx.compose.ui.input.nestedscroll.nestedScroll
 import androidx.compose.ui.unit.dp
-import top.yukonga.miuix.kmp.utils.enableOverscroll
+import top.yukonga.miuix.kmp.utils.Platform
 import top.yukonga.miuix.kmp.utils.overScrollVertical
+import top.yukonga.miuix.kmp.utils.platform
 import top.yukonga.miuix.kmp.utils.rememberOverscrollFlingBehavior
 
 /**
@@ -22,7 +23,7 @@ import top.yukonga.miuix.kmp.utils.rememberOverscrollFlingBehavior
  * @param state The state of the [LazyColumn].
  * @param contentPadding The padding to apply to the content.
  * @param userScrollEnabled Whether the user can scroll the [LazyColumn].
- * @param enableOverScroll Whether to enable over-scroll.
+ * @param isEnabledOverScroll Whether the Overscroll is enabled.
  * @param topAppBarScrollBehavior The scroll behavior of the top app bar.
  * @param content The [Composable] content of the [LazyColumn].
  */
@@ -32,13 +33,13 @@ fun LazyColumn(
     state: LazyListState = rememberLazyListState(),
     contentPadding: PaddingValues = PaddingValues(0.dp),
     userScrollEnabled: Boolean = true,
-    enableOverScroll: Boolean = true,
+    isEnabledOverScroll: () -> Boolean = { platform() == Platform.Android },
     topAppBarScrollBehavior: ScrollBehavior? = null,
     content: LazyListScope.() -> Unit
 ) {
-    val firstModifier = remember(enableOverScroll, enableOverscroll()) {
-        if (enableOverScroll && enableOverscroll()) {
-            modifier.overScrollVertical(onOverscroll = { topAppBarScrollBehavior?.isPinned = it })
+    val firstModifier = remember(isEnabledOverScroll) {
+        if (isEnabledOverScroll.invoke()) {
+            modifier.overScrollVertical(onOverscroll = { topAppBarScrollBehavior?.isPinned = it }, isEnabled = isEnabledOverScroll)
         } else {
             modifier
         }
@@ -49,7 +50,7 @@ fun LazyColumn(
         } ?: firstModifier
     }
     val flingBehavior =
-        if (enableOverScroll && enableOverscroll()) {
+        if (isEnabledOverScroll.invoke()) {
             rememberOverscrollFlingBehavior { state }
         } else {
             ScrollableDefaults.flingBehavior()

miuix/src/commonMain/kotlin/top/yukonga/miuix/kmp/basic/LazyColumn.kt

@@ -84,8 +84,9 @@ fun Modifier.overScrollVertical(
     scrollEasing: ((currentOffset: Float, newOffset: Float) -> Float)? = null,
     springStiff: Float = OutBoundSpringStiff,
     springDamp: Float = OutBoundSpringDamp,
-    onOverscroll: ((Boolean) -> Unit)? = null
-): Modifier = overScrollOutOfBound(isVertical = true, nestedScrollToParent, scrollEasing, springStiff, springDamp, onOverscroll)
+    onOverscroll: ((Boolean) -> Unit)? = null,
+    isEnabled: () -> Boolean = { platform() == Platform.Android }
+): Modifier = overScrollOutOfBound(isVertical = true, nestedScrollToParent, scrollEasing, springStiff, springDamp, onOverscroll, isEnabled)
 
 /**
  * @see overScrollOutOfBound
@@ -96,22 +97,25 @@ fun Modifier.overScrollHorizontal(
     scrollEasing: ((currentOffset: Float, newOffset: Float) -> Float)? = null,
     springStiff: Float = OutBoundSpringStiff,
     springDamp: Float = OutBoundSpringDamp,
-    onOverscroll: ((Boolean) -> Unit)? = null
-): Modifier = overScrollOutOfBound(isVertical = false, nestedScrollToParent, scrollEasing, springStiff, springDamp, onOverscroll)
+    onOverscroll: ((Boolean) -> Unit)? = null,
+    isEnabled: () -> Boolean = { platform() == Platform.Android }
+): Modifier = overScrollOutOfBound(isVertical = false, nestedScrollToParent, scrollEasing, springStiff, springDamp, onOverscroll, isEnabled)
 
 /**
  * OverScroll effect for scrollable Composable.
  *
  * @Author: cormor
  * @Email: [email protected]
- * @param isVertical is vertical, or horizontal ?
- * @param nestedScrollToParent Whether to dispatch nested scroll events to parent
+ * @param isVertical is vertical, or horizontal?
+ * @param nestedScrollToParent Whether to dispatch nested scroll events to parent.
  * @param scrollEasing U can refer to [DefaultParabolaScrollEasing], The incoming values are the currently existing overscroll Offset
  * and the new offset from the gesture.
  * modify it to cooperate with [springStiff] to customize the sliding damping effect.
  * The current default easing comes from iOS, you don't need to modify it!
  * @param springStiff springStiff for overscroll effect，For better user experience, the new value is not recommended to be higher than[StiffnessMediumLow]
- * @param springDamp springDamp for overscroll effect，generally do not need to set
+ * @param springDamp springDamp for overscroll effect，generally do not need to set。
+ * @param onOverscroll Callback when the overscroll state changes, the parameter is whether the current state is Overscrolling.
+ * @param isEnabled Whether to enable Overscroll effect, default is true.
  */
 @Stable
 @Suppress("NAME_SHADOWING")
@@ -121,9 +125,10 @@ fun Modifier.overScrollOutOfBound(
     scrollEasing: ((currentOffset: Float, newOffset: Float) -> Float)?,
     springStiff: Float = OutBoundSpringStiff,
     springDamp: Float = OutBoundSpringDamp,
-    onOverscroll: ((Boolean) -> Unit)? = null
+    onOverscroll: ((Boolean) -> Unit)? = null,
+    isEnabled: () -> Boolean = { platform() == Platform.Android }
 ): Modifier = composed {
-    if (!enableOverscroll()) return@composed this
+    if (!isEnabled()) return@composed this
     val onOverscroll by rememberUpdatedState(onOverscroll)
     val nestedScrollToParent by rememberUpdatedState(nestedScrollToParent)
     val scrollEasing by rememberUpdatedState(scrollEasing ?: DefaultParabolaScrollEasing)
@@ -307,6 +312,4 @@ fun rememberOverscrollFlingBehavior(
             }
         }
     }
-}
-
-expect fun enableOverscroll(): Boolean
+}