Skip to content

Commit e13e84c

Browse files
committed
Replace usages of 'displacement' to 'moved' in parameter names
Change-Id: I5b3da60041b046454e848d187f6dd2bfadf22b9a
1 parent 806726a commit e13e84c

File tree

9 files changed

+45
-45
lines changed

9 files changed

+45
-45
lines changed

core/designsystem/src/main/java/com/google/samples/apps/nowinandroid/core/designsystem/component/scrollbar/AppScrollbars.kt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,14 +61,14 @@ private const val SCROLLBAR_INACTIVE_TO_DORMANT_TIME_IN_MS = 2_000L
6161
* @param modifier a [Modifier] for the [Scrollbar]
6262
* @param state the driving state for the [Scrollbar]
6363
* @param orientation the orientation of the scrollbar
64-
* @param onThumbDisplaced the fast scroll implementation
64+
* @param onThumbMoved the fast scroll implementation
6565
*/
6666
@Composable
6767
fun ScrollableState.DraggableScrollbar(
6868
modifier: Modifier = Modifier,
6969
state: ScrollbarState,
7070
orientation: Orientation,
71-
onThumbDisplaced: (Float) -> Unit,
71+
onThumbMoved: (Float) -> Unit,
7272
) {
7373
val interactionSource = remember { MutableInteractionSource() }
7474
Scrollbar(
@@ -82,7 +82,7 @@ fun ScrollableState.DraggableScrollbar(
8282
orientation = orientation,
8383
)
8484
},
85-
onThumbDisplaced = onThumbDisplaced,
85+
onThumbMoved = onThumbMoved,
8686
)
8787
}
8888

core/designsystem/src/main/java/com/google/samples/apps/nowinandroid/core/designsystem/component/scrollbar/LazyScrollbarUtilities.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ internal inline fun <LazyState : ScrollableState, LazyStateItem> LazyState.scrol
7878
)
7979
ScrollbarState(
8080
thumbSizePercent = thumbSizePercent,
81-
thumbDisplacementPercent = when {
81+
thumbMovedPercent = when {
8282
reverseLayout() -> 1f - thumbTravelPercent
8383
else -> thumbTravelPercent
8484
},

core/designsystem/src/main/java/com/google/samples/apps/nowinandroid/core/designsystem/component/scrollbar/Scrollbar.kt

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ value class ScrollbarState internal constructor(
8080
companion object {
8181
val FULL = ScrollbarState(
8282
thumbSizePercent = 1f,
83-
thumbDisplacementPercent = 0f,
83+
thumbMovedPercent = 0f,
8484
)
8585
}
8686
}
@@ -104,16 +104,16 @@ private value class ScrollbarTrack(
104104
* @param thumbSizePercent the thumb size of the scrollbar as a percentage of the total track size.
105105
* Refers to either the thumb width (for horizontal scrollbars)
106106
* or height (for vertical scrollbars).
107-
* @param thumbDisplacementPercent the distance the thumb has traveled as a percentage of total
107+
* @param thumbMovedPercent the distance the thumb has traveled as a percentage of total
108108
* track size.
109109
*/
110110
fun ScrollbarState(
111111
thumbSizePercent: Float,
112-
thumbDisplacementPercent: Float,
112+
thumbMovedPercent: Float,
113113
) = ScrollbarState(
114114
packFloats(
115115
val1 = thumbSizePercent,
116-
val2 = thumbDisplacementPercent,
116+
val2 = thumbMovedPercent,
117117
),
118118
)
119119

@@ -126,7 +126,7 @@ val ScrollbarState.thumbSizePercent
126126
/**
127127
* Returns the distance the thumb has traveled as a percentage of total track size
128128
*/
129-
val ScrollbarState.thumbDisplacementPercent
129+
val ScrollbarState.thumbMovedPercent
130130
get() = unpackFloat2(packedValue)
131131

132132
/**
@@ -179,7 +179,7 @@ internal fun Orientation.valueOf(intOffset: IntOffset) = when (this) {
179179
* @param minThumbSize the minimum size of the scrollbar thumb
180180
* @param interactionSource allows for observing the state of the scroll bar
181181
* @param thumb a composable for drawing the scrollbar thumb
182-
* @param onThumbDisplaced an function for reacting to scroll bar displacements caused by direct
182+
* @param onThumbMoved an function for reacting to scroll bar displacements caused by direct
183183
* interactions on the scrollbar thumb by the user, for example implementing a fast scroll
184184
*/
185185
@Composable
@@ -190,7 +190,7 @@ fun Scrollbar(
190190
minThumbSize: Dp = 40.dp,
191191
interactionSource: MutableInteractionSource? = null,
192192
thumb: @Composable () -> Unit,
193-
onThumbDisplaced: ((Float) -> Unit)? = null,
193+
onThumbMoved: ((Float) -> Unit)? = null,
194194
) {
195195
val localDensity = LocalDensity.current
196196

@@ -206,7 +206,7 @@ fun Scrollbar(
206206
var track by remember { mutableStateOf(ScrollbarTrack(packedValue = 0)) }
207207

208208
val thumbTravelPercent = when {
209-
interactionThumbTravelPercent.isNaN() -> state.thumbDisplacementPercent
209+
interactionThumbTravelPercent.isNaN() -> state.thumbMovedPercent
210210
else -> interactionThumbTravelPercent
211211
}
212212
val thumbSizePx = max(
@@ -217,7 +217,7 @@ fun Scrollbar(
217217
targetValue = with(localDensity) { thumbSizePx.toDp() },
218218
label = "scrollbar thumb size",
219219
)
220-
val thumbDisplacementPx = min(
220+
val thumbMovedPx = min(
221221
a = track.size * thumbTravelPercent,
222222
b = track.size - thumbSizePx,
223223
)
@@ -282,8 +282,8 @@ fun Scrollbar(
282282
},
283283
),
284284
) {
285-
val scrollbarThumbDisplacement = max(
286-
a = with(localDensity) { thumbDisplacementPx.toDp() },
285+
val scrollbarThumbMovedDp = max(
286+
a = with(localDensity) { thumbMovedPx.toDp() },
287287
b = 0.dp,
288288
)
289289
// scrollbar thumb container
@@ -299,10 +299,10 @@ fun Scrollbar(
299299
.offset(
300300
y = when (orientation) {
301301
Orientation.Horizontal -> 0.dp
302-
Orientation.Vertical -> scrollbarThumbDisplacement
302+
Orientation.Vertical -> scrollbarThumbMovedDp
303303
},
304304
x = when (orientation) {
305-
Orientation.Horizontal -> scrollbarThumbDisplacement
305+
Orientation.Horizontal -> scrollbarThumbMovedDp
306306
Orientation.Vertical -> 0.dp
307307
},
308308
),
@@ -311,7 +311,7 @@ fun Scrollbar(
311311
}
312312
}
313313

314-
if (onThumbDisplaced == null) return
314+
if (onThumbMoved == null) return
315315

316316
// State that will be read inside the effects that follow
317317
// but will not cause re-triggering of them
@@ -325,26 +325,26 @@ fun Scrollbar(
325325
return@LaunchedEffect
326326
}
327327

328-
var currentThumbDisplacement = updatedState.thumbDisplacementPercent
329-
val destinationThumbDisplacement = track.thumbPosition(
328+
var currentThumbMovedPercent = updatedState.thumbMovedPercent
329+
val destinationThumbMovedPercent = track.thumbPosition(
330330
dimension = orientation.valueOf(pressedOffset),
331331
)
332-
val isPositive = currentThumbDisplacement < destinationThumbDisplacement
332+
val isPositive = currentThumbMovedPercent < destinationThumbMovedPercent
333333
val delta = SCROLLBAR_PRESS_DELTA_PCT * if (isPositive) 1f else -1f
334334

335-
while (currentThumbDisplacement != destinationThumbDisplacement) {
336-
currentThumbDisplacement = when {
335+
while (currentThumbMovedPercent != destinationThumbMovedPercent) {
336+
currentThumbMovedPercent = when {
337337
isPositive -> min(
338-
a = currentThumbDisplacement + delta,
339-
b = destinationThumbDisplacement,
338+
a = currentThumbMovedPercent + delta,
339+
b = destinationThumbMovedPercent,
340340
)
341341
else -> max(
342-
a = currentThumbDisplacement + delta,
343-
b = destinationThumbDisplacement,
342+
a = currentThumbMovedPercent + delta,
343+
b = destinationThumbMovedPercent,
344344
)
345345
}
346-
onThumbDisplaced(currentThumbDisplacement)
347-
interactionThumbTravelPercent = currentThumbDisplacement
346+
onThumbMoved(currentThumbMovedPercent)
347+
interactionThumbTravelPercent = currentThumbMovedPercent
348348
delay(SCROLLBAR_PRESS_DELAY_MS)
349349
}
350350
}
@@ -358,7 +358,7 @@ fun Scrollbar(
358358
val currentTravel = track.thumbPosition(
359359
dimension = orientation.valueOf(draggedOffset),
360360
)
361-
onThumbDisplaced(currentTravel)
361+
onThumbMoved(currentTravel)
362362
interactionThumbTravelPercent = currentTravel
363363
}
364364
}

core/designsystem/src/main/java/com/google/samples/apps/nowinandroid/core/designsystem/component/scrollbar/ThumbExt.kt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,9 @@ import androidx.compose.runtime.setValue
3131
* @param itemsAvailable the amount of items in the list.
3232
*/
3333
@Composable
34-
fun LazyListState.rememberFastScroller(
34+
fun LazyListState.rememberDraggableScroller(
3535
itemsAvailable: Int,
36-
): (Float) -> Unit = rememberFastScroller(
36+
): (Float) -> Unit = rememberDraggableScroller(
3737
itemsAvailable = itemsAvailable,
3838
scroll = ::scrollToItem,
3939
)
@@ -43,9 +43,9 @@ fun LazyListState.rememberFastScroller(
4343
* @param itemsAvailable the amount of items in the grid.
4444
*/
4545
@Composable
46-
fun LazyGridState.rememberFastScroller(
46+
fun LazyGridState.rememberDraggableScroller(
4747
itemsAvailable: Int,
48-
): (Float) -> Unit = rememberFastScroller(
48+
): (Float) -> Unit = rememberDraggableScroller(
4949
itemsAvailable = itemsAvailable,
5050
scroll = ::scrollToItem,
5151
)
@@ -56,7 +56,7 @@ fun LazyGridState.rememberFastScroller(
5656
* @param scroll a function to be invoked when an index has been identified to scroll to.
5757
*/
5858
@Composable
59-
private inline fun rememberFastScroller(
59+
private inline fun rememberDraggableScroller(
6060
itemsAvailable: Int,
6161
crossinline scroll: suspend (index: Int) -> Unit,
6262
): (Float) -> Unit {

feature/bookmarks/src/main/java/com/google/samples/apps/nowinandroid/feature/bookmarks/BookmarksScreen.kt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ import androidx.lifecycle.LifecycleEventObserver
6363
import androidx.lifecycle.compose.collectAsStateWithLifecycle
6464
import com.google.samples.apps.nowinandroid.core.designsystem.component.NiaLoadingWheel
6565
import com.google.samples.apps.nowinandroid.core.designsystem.component.scrollbar.DraggableScrollbar
66-
import com.google.samples.apps.nowinandroid.core.designsystem.component.scrollbar.rememberFastScroller
66+
import com.google.samples.apps.nowinandroid.core.designsystem.component.scrollbar.rememberDraggableScroller
6767
import com.google.samples.apps.nowinandroid.core.designsystem.component.scrollbar.scrollbarState
6868
import com.google.samples.apps.nowinandroid.core.designsystem.theme.LocalTintTheme
6969
import com.google.samples.apps.nowinandroid.core.designsystem.theme.NiaTheme
@@ -216,7 +216,7 @@ private fun BookmarksGrid(
216216
.align(Alignment.CenterEnd),
217217
state = scrollbarState,
218218
orientation = Orientation.Vertical,
219-
onThumbDisplaced = scrollableState.rememberFastScroller(
219+
onThumbMoved = scrollableState.rememberDraggableScroller(
220220
itemsAvailable = itemsAvailable,
221221
),
222222
)

feature/foryou/src/main/java/com/google/samples/apps/nowinandroid/feature/foryou/ForYouScreen.kt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ import com.google.samples.apps.nowinandroid.core.designsystem.component.NiaIconT
9393
import com.google.samples.apps.nowinandroid.core.designsystem.component.NiaOverlayLoadingWheel
9494
import com.google.samples.apps.nowinandroid.core.designsystem.component.scrollbar.DecorativeScrollbar
9595
import com.google.samples.apps.nowinandroid.core.designsystem.component.scrollbar.DraggableScrollbar
96-
import com.google.samples.apps.nowinandroid.core.designsystem.component.scrollbar.rememberFastScroller
96+
import com.google.samples.apps.nowinandroid.core.designsystem.component.scrollbar.rememberDraggableScroller
9797
import com.google.samples.apps.nowinandroid.core.designsystem.component.scrollbar.scrollbarState
9898
import com.google.samples.apps.nowinandroid.core.designsystem.icon.NiaIcons
9999
import com.google.samples.apps.nowinandroid.core.designsystem.theme.NiaTheme
@@ -238,7 +238,7 @@ internal fun ForYouScreen(
238238
.align(Alignment.CenterEnd),
239239
state = scrollbarState,
240240
orientation = Orientation.Vertical,
241-
onThumbDisplaced = state.rememberFastScroller(
241+
onThumbMoved = state.rememberDraggableScroller(
242242
itemsAvailable = itemsAvailable,
243243
),
244244
)

feature/interests/src/main/java/com/google/samples/apps/nowinandroid/feature/interests/TabContent.kt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ import androidx.compose.ui.Modifier
3636
import androidx.compose.ui.platform.testTag
3737
import androidx.compose.ui.unit.dp
3838
import com.google.samples.apps.nowinandroid.core.designsystem.component.scrollbar.DraggableScrollbar
39-
import com.google.samples.apps.nowinandroid.core.designsystem.component.scrollbar.rememberFastScroller
39+
import com.google.samples.apps.nowinandroid.core.designsystem.component.scrollbar.rememberDraggableScroller
4040
import com.google.samples.apps.nowinandroid.core.designsystem.component.scrollbar.scrollbarState
4141
import com.google.samples.apps.nowinandroid.core.model.data.FollowableTopic
4242

@@ -91,7 +91,7 @@ fun TopicsTabContent(
9191
.align(Alignment.CenterEnd),
9292
state = scrollbarState,
9393
orientation = Orientation.Vertical,
94-
onThumbDisplaced = scrollableState.rememberFastScroller(
94+
onThumbMoved = scrollableState.rememberDraggableScroller(
9595
itemsAvailable = topics.size,
9696
),
9797
)

feature/search/src/main/java/com/google/samples/apps/nowinandroid/feature/search/SearchScreen.kt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ import androidx.compose.ui.unit.dp
8181
import androidx.hilt.navigation.compose.hiltViewModel
8282
import androidx.lifecycle.compose.collectAsStateWithLifecycle
8383
import com.google.samples.apps.nowinandroid.core.designsystem.component.scrollbar.DraggableScrollbar
84-
import com.google.samples.apps.nowinandroid.core.designsystem.component.scrollbar.rememberFastScroller
84+
import com.google.samples.apps.nowinandroid.core.designsystem.component.scrollbar.rememberDraggableScroller
8585
import com.google.samples.apps.nowinandroid.core.designsystem.component.scrollbar.scrollbarState
8686
import com.google.samples.apps.nowinandroid.core.designsystem.icon.NiaIcons
8787
import com.google.samples.apps.nowinandroid.core.designsystem.theme.NiaTheme
@@ -389,7 +389,7 @@ private fun SearchResultBody(
389389
.align(Alignment.CenterEnd),
390390
state = scrollbarState,
391391
orientation = Orientation.Vertical,
392-
onThumbDisplaced = state.rememberFastScroller(
392+
onThumbMoved = state.rememberDraggableScroller(
393393
itemsAvailable = itemsAvailable,
394394
),
395395
)

feature/topic/src/main/java/com/google/samples/apps/nowinandroid/feature/topic/TopicScreen.kt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ import com.google.samples.apps.nowinandroid.core.designsystem.component.NiaBackg
5555
import com.google.samples.apps.nowinandroid.core.designsystem.component.NiaFilterChip
5656
import com.google.samples.apps.nowinandroid.core.designsystem.component.NiaLoadingWheel
5757
import com.google.samples.apps.nowinandroid.core.designsystem.component.scrollbar.DraggableScrollbar
58-
import com.google.samples.apps.nowinandroid.core.designsystem.component.scrollbar.rememberFastScroller
58+
import com.google.samples.apps.nowinandroid.core.designsystem.component.scrollbar.rememberDraggableScroller
5959
import com.google.samples.apps.nowinandroid.core.designsystem.component.scrollbar.scrollbarState
6060
import com.google.samples.apps.nowinandroid.core.designsystem.icon.NiaIcons
6161
import com.google.samples.apps.nowinandroid.core.designsystem.theme.NiaTheme
@@ -159,7 +159,7 @@ internal fun TopicScreen(
159159
.align(Alignment.CenterEnd),
160160
state = scrollbarState,
161161
orientation = Orientation.Vertical,
162-
onThumbDisplaced = state.rememberFastScroller(
162+
onThumbMoved = state.rememberDraggableScroller(
163163
itemsAvailable = itemsAvailable,
164164
),
165165
)

0 commit comments

Comments
 (0)