Add max thumb length. This allows to also set a static thumb length b…

…y setting the min and max thumb length the same value.
nanihadesuka · Jun 30, 2024 · 994a35e · 994a35e
1 parent 5406b96
commit 994a35e
Show file tree

Hide file tree

Showing 21 changed files with 165 additions and 10 deletions.
diff --git a/app/build.gradle.kts b/app/build.gradle.kts
@@ -11,8 +11,8 @@ android {
         applicationId = "my.nanihadesuka.lazycolumnscrollbar"
         minSdk = 21
         targetSdk = 34
-        versionCode = 8
-        versionName = "2.0.0"
+        versionCode = 9
+        versionName = "2.1.0"
 
         testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
         vectorDrawables {

diff --git a/app/src/main/java/my/nanihadesuka/lazycolumnscrollbar/MainActivity.kt b/app/src/main/java/my/nanihadesuka/lazycolumnscrollbar/MainActivity.kt
@@ -314,7 +314,7 @@ fun LazyHorizontalGridView() {
 
 @Composable
 fun ColumnView() {
-    val listData = (0..100).toList()
+    val listData = (0..18).toList()
     val listState = rememberScrollState()
     val indicatorContent = @Composable { normalizedOffset: Float, isThumbSelected: Boolean ->
         Indicator(

diff --git a/lib/build.gradle.kts b/lib/build.gradle.kts
@@ -5,7 +5,7 @@ plugins {
 }
 
 object MySettings {
-    val versionName: String = "2.0.7"
+    val versionName: String = "2.1.0"
     val namespace = "my.nanihadesuka.lazycolumnscrollbar"
 }
 

diff --git a/lib/src/main/java/my/nanihadesuka/compose/ColumnScrollbar.kt b/lib/src/main/java/my/nanihadesuka/compose/ColumnScrollbar.kt
@@ -47,6 +47,7 @@ fun InternalColumnScrollbar(
         state = state,
         visibleLengthDp = visibleLengthDp,
         thumbMinLength = settings.thumbMinLength,
+        thumbMaxLength = settings.thumbMaxLength,
         alwaysShowScrollBar = settings.alwaysShowScrollbar,
         selectionMode = settings.selectionMode
     )

diff --git a/lib/src/main/java/my/nanihadesuka/compose/LazyColumnScrollbar.kt b/lib/src/main/java/my/nanihadesuka/compose/LazyColumnScrollbar.kt
@@ -40,8 +40,9 @@ fun InternalLazyColumnScrollbar(
     val controller = rememberLazyListStateController(
         state = state,
         thumbMinLength = settings.thumbMinLength,
+        thumbMaxLength = settings.thumbMaxLength,
         alwaysShowScrollBar = settings.alwaysShowScrollbar,
-        selectionMode = settings.selectionMode
+        selectionMode = settings.selectionMode,
     )
 
     ElementScrollbar(

diff --git a/lib/src/main/java/my/nanihadesuka/compose/LazyHorizontalGridScrollbar.kt b/lib/src/main/java/my/nanihadesuka/compose/LazyHorizontalGridScrollbar.kt
@@ -40,6 +40,7 @@ fun InternalLazyHorizontalGridScrollbar(
     val controller = rememberLazyGridStateController(
         state = state,
         thumbMinLength = settings.thumbMinLength,
+        thumbMaxLength = settings.thumbMaxLength,
         alwaysShowScrollBar = settings.alwaysShowScrollbar,
         selectionMode = settings.selectionMode,
         orientation = Orientation.Horizontal

diff --git a/lib/src/main/java/my/nanihadesuka/compose/LazyRowScrollbar.kt b/lib/src/main/java/my/nanihadesuka/compose/LazyRowScrollbar.kt
@@ -40,6 +40,7 @@ fun InternalLazyRowScrollbar(
     val controller = rememberLazyListStateController(
         state = state,
         thumbMinLength = settings.thumbMinLength,
+        thumbMaxLength = settings.thumbMaxLength,
         alwaysShowScrollBar = settings.alwaysShowScrollbar,
         selectionMode = settings.selectionMode,
     )

diff --git a/lib/src/main/java/my/nanihadesuka/compose/LazyVerticalGridScrollbar.kt b/lib/src/main/java/my/nanihadesuka/compose/LazyVerticalGridScrollbar.kt
@@ -40,6 +40,7 @@ fun InternalLazyVerticalGridScrollbar(
     val controller = rememberLazyGridStateController(
         state = state,
         thumbMinLength = settings.thumbMinLength,
+        thumbMaxLength = settings.thumbMaxLength,
         alwaysShowScrollBar = settings.alwaysShowScrollbar,
         selectionMode = settings.selectionMode,
         orientation = Orientation.Vertical

diff --git a/lib/src/main/java/my/nanihadesuka/compose/RowScrollbar.kt b/lib/src/main/java/my/nanihadesuka/compose/RowScrollbar.kt
@@ -46,6 +46,7 @@ fun InternalRowScrollbar(
         state = state,
         visibleLengthDp = visibleLengthDp,
         thumbMinLength = settings.thumbMinLength,
+        thumbMaxLength = settings.thumbMaxLength,
         alwaysShowScrollBar = settings.alwaysShowScrollbar,
         selectionMode = settings.selectionMode,
     )

diff --git a/lib/src/main/java/my/nanihadesuka/compose/ScrollbarSettings.kt b/lib/src/main/java/my/nanihadesuka/compose/ScrollbarSettings.kt
@@ -21,6 +21,7 @@ data class ScrollbarSettings(
     val thumbThickness: Dp = Default.thumbThickness,
     val thumbShape: Shape = Default.thumbShape,
     val thumbMinLength: Float = Default.thumbMinLength,
+    val thumbMaxLength: Float = Default.thumbMaxLength,
     val thumbUnselectedColor: Color = Default.thumbUnselectedColor,
     val thumbSelectedColor: Color = Default.thumbSelectedColor,
     val selectionMode: ScrollbarSelectionMode = Default.selectionMode,
@@ -30,6 +31,12 @@ data class ScrollbarSettings(
     val hideEasingAnimation: Easing = Default.hideEasingAnimation,
     val durationAnimationMillis: Int = Default.durationAnimationMillis,
 ) {
+    init {
+        require(thumbMinLength <= thumbMaxLength) {
+            "thumbMinLength ($thumbMinLength) must be less or equal to thumbMaxLength ($thumbMaxLength)"
+        }
+    }
+
     companion object {
         val Default = ScrollbarSettings(
             enabled = true,
@@ -38,6 +45,7 @@ data class ScrollbarSettings(
             thumbThickness = 6.dp,
             scrollbarPadding = 8.dp,
             thumbMinLength = 0.1f,
+            thumbMaxLength = 1.0f,
             thumbUnselectedColor = Color(0xFF2A59B6),
             thumbSelectedColor = Color(0xFF5281CA),
             thumbShape = CircleShape,

diff --git a/lib/src/main/java/my/nanihadesuka/compose/controller/LazyGridStateController.kt b/lib/src/main/java/my/nanihadesuka/compose/controller/LazyGridStateController.kt
@@ -23,13 +23,15 @@ import kotlin.math.floor
 internal fun rememberLazyGridStateController(
     state: LazyGridState,
     thumbMinLength: Float,
+    thumbMaxLength: Float,
     alwaysShowScrollBar: Boolean,
     selectionMode: ScrollbarSelectionMode,
     orientation: Orientation
 ): LazyGridStateController {
     val coroutineScope = rememberCoroutineScope()
 
     val thumbMinLengthUpdated = rememberUpdatedState(thumbMinLength)
+    val thumbMaxLengthUpdated = rememberUpdatedState(thumbMaxLength)
     val alwaysShowScrollBarUpdated = rememberUpdatedState(alwaysShowScrollBar)
     val selectionModeUpdated = rememberUpdatedState(selectionMode)
     val orientationUpdated = rememberUpdatedState(orientation)
@@ -114,7 +116,10 @@ internal fun rememberLazyGridStateController(
 
     val thumbSizeNormalized = remember {
         derivedStateOf {
-            thumbSizeNormalizedReal.value.coerceAtLeast(thumbMinLengthUpdated.value)
+            thumbSizeNormalizedReal.value.coerceIn(
+                thumbMinLengthUpdated.value,
+                thumbMaxLengthUpdated.value,
+            )
         }
     }
 
@@ -142,7 +147,9 @@ internal fun rememberLazyGridStateController(
 
                 val firstItem = realFirstVisibleItem.value ?: return@let 0f
                 val top = firstItem.run {
-                    ceil(index.toFloat() / nElementsMainAxis.value.toFloat()) + fractionHiddenTop(state.firstVisibleItemScrollOffset)
+                    ceil(index.toFloat() / nElementsMainAxis.value.toFloat()) + fractionHiddenTop(
+                        state.firstVisibleItemScrollOffset
+                    )
                 } / ceil(it.totalItemsCount.toFloat() / nElementsMainAxis.value.toFloat())
                 offsetCorrection(top)
             }

diff --git a/lib/src/main/java/my/nanihadesuka/compose/controller/LazyListStateController.kt b/lib/src/main/java/my/nanihadesuka/compose/controller/LazyListStateController.kt
@@ -22,12 +22,14 @@ import kotlin.math.floor
 internal fun rememberLazyListStateController(
     state: LazyListState,
     thumbMinLength: Float,
+    thumbMaxLength: Float,
     alwaysShowScrollBar: Boolean,
     selectionMode: ScrollbarSelectionMode
 ): LazyListStateController {
     val coroutineScope = rememberCoroutineScope()
 
     val thumbMinLengthUpdated = rememberUpdatedState(thumbMinLength)
+    val thumbMaxLengthUpdated = rememberUpdatedState(thumbMaxLength)
     val alwaysShowScrollBarUpdated = rememberUpdatedState(alwaysShowScrollBar)
     val selectionModeUpdated = rememberUpdatedState(selectionMode)
     val reverseLayout = remember { derivedStateOf { state.layoutInfo.reverseLayout } }
@@ -80,7 +82,10 @@ internal fun rememberLazyListStateController(
 
     val thumbSizeNormalized = remember {
         derivedStateOf {
-            thumbSizeNormalizedReal.value.coerceAtLeast(thumbMinLengthUpdated.value)
+            thumbSizeNormalizedReal.value.coerceIn(
+                thumbMinLengthUpdated.value,
+                thumbMaxLengthUpdated.value,
+            )
         }
     }
 

diff --git a/lib/src/main/java/my/nanihadesuka/compose/controller/ScrollStateController.kt b/lib/src/main/java/my/nanihadesuka/compose/controller/ScrollStateController.kt
@@ -22,13 +22,15 @@ internal fun rememberScrollStateController(
     state: ScrollState,
     visibleLengthDp: Dp,
     thumbMinLength: Float,
+    thumbMaxLength: Float,
     alwaysShowScrollBar: Boolean,
     selectionMode: ScrollbarSelectionMode
 ): ScrollStateController {
     val coroutineScope = rememberCoroutineScope()
 
     val visibleLengthDpUpdated = rememberUpdatedState(visibleLengthDp)
     val thumbMinLengthUpdated = rememberUpdatedState(thumbMinLength)
+    val thumbMaxLengthUpdated = rememberUpdatedState(thumbMaxLength)
     val alwaysShowScrollBarUpdated = rememberUpdatedState(alwaysShowScrollBar)
     val selectionModeUpdated = rememberUpdatedState(selectionMode)
 
@@ -54,7 +56,10 @@ internal fun rememberScrollStateController(
 
     val thumbSizeNormalized = remember {
         derivedStateOf {
-            thumbSizeNormalizedReal.value.coerceAtLeast(thumbMinLengthUpdated.value)
+            thumbSizeNormalizedReal.value.coerceIn(
+                thumbMinLengthUpdated.value,
+                thumbMaxLengthUpdated.value,
+            )
         }
     }
 

diff --git a/lib/src/test/java/my/nanihadesuka/compose/ColumnScrollbarTest.kt b/lib/src/test/java/my/nanihadesuka/compose/ColumnScrollbarTest.kt
@@ -225,6 +225,16 @@ class ColumnScrollbarTest(private val itemCount: Int) {
         }
     }
 
+    @Test
+    fun `scrollbar thumb exact height`() {
+        setContent(thumbMinLength = 0.4f, thumbMaxLength = 0.4f)
+        scrollbarScreen(composeRule) {
+            assert {
+                hasThumbHeight(value = 0.4f)
+            }
+        }
+    }
+
     @Test
     fun `scrollbar thumb min height`() {
         setContent(thumbMinLength = 0.2f)
@@ -367,6 +377,7 @@ class ColumnScrollbarTest(private val itemCount: Int) {
         thickness: Dp = 6.dp,
         padding: Dp = 8.dp,
         thumbMinLength: Float = 0.1f,
+        thumbMaxLength: Float = 1f,
         thumbUnselectedColor: Color = Color(0xFF2A59B6),
         thumbSelectedColor: Color = Color(0xFF5281CA),
         thumbShape: Shape = CircleShape,
@@ -386,6 +397,7 @@ class ColumnScrollbarTest(private val itemCount: Int) {
                     scrollbarPadding = padding,
                     thumbThickness = thickness,
                     thumbMinLength = thumbMinLength,
+                    thumbMaxLength = thumbMaxLength,
                     thumbUnselectedColor = thumbUnselectedColor,
                     thumbSelectedColor = thumbSelectedColor,
                     thumbShape = thumbShape,

diff --git a/lib/src/test/java/my/nanihadesuka/compose/LazyColumnScrollbarTest.kt b/lib/src/test/java/my/nanihadesuka/compose/LazyColumnScrollbarTest.kt
@@ -287,6 +287,16 @@ class LazyColumnScrollbarTest(private val itemCount: Int) {
         }
     }
 
+    @Test
+    fun `scrollbar thumb exact height`() {
+        setContent(thumbMinLength = 0.4f, thumbMaxLength = 0.4f)
+        scrollbarScreen(composeRule) {
+            assert {
+                hasThumbHeight(value = 0.4f)
+            }
+        }
+    }
+
     @Test
     fun `scrollbar thumb min height`() {
         setContent(thumbMinLength = 0.2f)
@@ -429,6 +439,7 @@ class LazyColumnScrollbarTest(private val itemCount: Int) {
         thickness: Dp = 6.dp,
         padding: Dp = 8.dp,
         thumbMinLength: Float = 0.1f,
+        thumbMaxLength: Float = 1f,
         thumbColor: Color = Color(0xFF2A59B6),
         thumbSelectedColor: Color = Color(0xFF5281CA),
         thumbShape: Shape = CircleShape,
@@ -449,6 +460,7 @@ class LazyColumnScrollbarTest(private val itemCount: Int) {
                     scrollbarPadding = padding,
                     thumbThickness = thickness,
                     thumbMinLength = thumbMinLength,
+                    thumbMaxLength = thumbMaxLength,
                     thumbUnselectedColor = thumbColor,
                     thumbSelectedColor = thumbSelectedColor,
                     thumbShape = thumbShape,

diff --git a/lib/src/test/java/my/nanihadesuka/compose/LazyHorizontalGridScrollbarTest.kt b/lib/src/test/java/my/nanihadesuka/compose/LazyHorizontalGridScrollbarTest.kt
@@ -288,6 +288,16 @@ class LazyHorizontalGridScrollbarTest(private val itemCount: Int) {
         }
     }
 
+    @Test
+    fun `scrollbar thumb exact width`() {
+        setContent(thumbMinLength = 0.4f, thumbMaxLength = 0.4f)
+        scrollbarScreen(composeRule) {
+            assert {
+                hasThumbWidth(value = 0.4f)
+            }
+        }
+    }
+
     @Test
     fun `scrollbar thumb min width`() {
         setContent(thumbMinLength = 0.2f)
@@ -430,6 +440,7 @@ class LazyHorizontalGridScrollbarTest(private val itemCount: Int) {
         thickness: Dp = 6.dp,
         padding: Dp = 8.dp,
         thumbMinLength: Float = 0.1f,
+        thumbMaxLength: Float = 1f,
         thumbColor: Color = Color(0xFF2A59B6),
         thumbSelectedColor: Color = Color(0xFF5281CA),
         thumbShape: Shape = CircleShape,
@@ -450,6 +461,7 @@ class LazyHorizontalGridScrollbarTest(private val itemCount: Int) {
                     scrollbarPadding = padding,
                     thumbThickness = thickness,
                     thumbMinLength = thumbMinLength,
+                    thumbMaxLength = thumbMaxLength,
                     thumbUnselectedColor = thumbColor,
                     thumbSelectedColor = thumbSelectedColor,
                     thumbShape = thumbShape,

diff --git a/lib/src/test/java/my/nanihadesuka/compose/LazyRowScrollbarTest.kt b/lib/src/test/java/my/nanihadesuka/compose/LazyRowScrollbarTest.kt
@@ -285,6 +285,16 @@ class LazyRowScrollbarTest(private val itemCount: Int) {
         }
     }
 
+    @Test
+    fun `scrollbar thumb exact width`() {
+        setContent(thumbMinLength = 0.4f, thumbMaxLength = 0.4f)
+        scrollbarScreen(composeRule) {
+            assert {
+                hasThumbWidth(value = 0.4f)
+            }
+        }
+    }
+
     @Test
     fun `scrollbar thumb min width`() {
         setContent(thumbMinLength = 0.2f)
@@ -427,6 +437,7 @@ class LazyRowScrollbarTest(private val itemCount: Int) {
         thickness: Dp = 6.dp,
         padding: Dp = 8.dp,
         thumbMinLength: Float = 0.1f,
+        thumbMaxLength: Float = 1f,
         thumbColor: Color = Color(0xFF2A59B6),
         thumbSelectedColor: Color = Color(0xFF5281CA),
         thumbShape: Shape = CircleShape,
@@ -447,6 +458,7 @@ class LazyRowScrollbarTest(private val itemCount: Int) {
                     scrollbarPadding = padding,
                     thumbThickness = thickness,
                     thumbMinLength = thumbMinLength,
+                    thumbMaxLength = thumbMaxLength,
                     thumbUnselectedColor = thumbColor,
                     thumbSelectedColor = thumbSelectedColor,
                     thumbShape = thumbShape,

diff --git a/lib/src/test/java/my/nanihadesuka/compose/LazyVerticalGridScrollbarTest.kt b/lib/src/test/java/my/nanihadesuka/compose/LazyVerticalGridScrollbarTest.kt
@@ -288,6 +288,16 @@ class LazyVerticalGridScrollbarTest(private val itemCount: Int) {
         }
     }
 
+    @Test
+    fun `scrollbar thumb exact height`() {
+        setContent(thumbMinLength = 0.4f, thumbMaxLength = 0.4f)
+        scrollbarScreen(composeRule) {
+            assert {
+                hasThumbHeight(value = 0.4f)
+            }
+        }
+    }
+
     @Test
     fun `scrollbar thumb min height`() {
         setContent(thumbMinLength = 0.2f)
@@ -430,6 +440,7 @@ class LazyVerticalGridScrollbarTest(private val itemCount: Int) {
         thickness: Dp = 6.dp,
         padding: Dp = 8.dp,
         thumbMinLength: Float = 0.1f,
+        thumbMaxLength: Float = 1f,
         thumbColor: Color = Color(0xFF2A59B6),
         thumbSelectedColor: Color = Color(0xFF5281CA),
         thumbShape: Shape = CircleShape,
@@ -450,6 +461,7 @@ class LazyVerticalGridScrollbarTest(private val itemCount: Int) {
                     scrollbarPadding = padding,
                     thumbThickness = thickness,
                     thumbMinLength = thumbMinLength,
+                    thumbMaxLength = thumbMaxLength,
                     thumbUnselectedColor = thumbColor,
                     thumbSelectedColor = thumbSelectedColor,
                     thumbShape = thumbShape,