Created
May 17, 2023 11:19
-
-
Save nhcodes/dc68c65ee586628fda5700911e44543f to your computer and use it in GitHub Desktop.
Android NumberPicker for Jetpack Compose
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
import androidx.compose.foundation.ExperimentalFoundationApi | |
import androidx.compose.foundation.gestures.snapping.rememberSnapFlingBehavior | |
import androidx.compose.foundation.layout.Box | |
import androidx.compose.foundation.layout.fillMaxWidth | |
import androidx.compose.foundation.layout.height | |
import androidx.compose.foundation.layout.offset | |
import androidx.compose.foundation.lazy.LazyColumn | |
import androidx.compose.foundation.lazy.rememberLazyListState | |
import androidx.compose.material3.Divider | |
import androidx.compose.material3.LocalContentColor | |
import androidx.compose.material3.LocalTextStyle | |
import androidx.compose.material3.Text | |
import androidx.compose.runtime.Composable | |
import androidx.compose.runtime.LaunchedEffect | |
import androidx.compose.runtime.mutableStateOf | |
import androidx.compose.runtime.remember | |
import androidx.compose.runtime.snapshotFlow | |
import androidx.compose.ui.Alignment | |
import androidx.compose.ui.Modifier | |
import androidx.compose.ui.draw.drawWithContent | |
import androidx.compose.ui.graphics.BlendMode | |
import androidx.compose.ui.graphics.Brush | |
import androidx.compose.ui.graphics.Color | |
import androidx.compose.ui.graphics.CompositingStrategy | |
import androidx.compose.ui.graphics.graphicsLayer | |
import androidx.compose.ui.layout.onSizeChanged | |
import androidx.compose.ui.platform.LocalDensity | |
import androidx.compose.ui.text.TextStyle | |
import androidx.compose.ui.text.style.TextOverflow | |
import kotlinx.coroutines.flow.distinctUntilChanged | |
import kotlinx.coroutines.flow.map | |
@OptIn(ExperimentalFoundationApi::class) | |
@Composable | |
fun Picker( | |
items: List<String>, | |
state: PickerState = rememberPickerState(), | |
modifier: Modifier = Modifier, | |
startIndex: Int = 0, | |
visibleItemsCount: Int = 3, | |
textModifier: Modifier = Modifier, | |
textStyle: TextStyle = LocalTextStyle.current, | |
dividerColor: Color = LocalContentColor.current, | |
) { | |
val visibleItemsMiddle = visibleItemsCount / 2 | |
val listScrollCount = Integer.MAX_VALUE | |
val listScrollMiddle = listScrollCount / 2 | |
val listStartIndex = listScrollMiddle - listScrollMiddle % items.size - visibleItemsMiddle + startIndex | |
fun getItem(index: Int) = items[index % items.size] | |
val listState = rememberLazyListState(initialFirstVisibleItemIndex = listStartIndex) | |
val flingBehavior = rememberSnapFlingBehavior(lazyListState = listState) | |
val itemHeightPixels = remember { mutableStateOf(0) } | |
val itemHeightDp = pixelsToDp(itemHeightPixels.value) | |
val fadingEdgeGradient = remember { | |
Brush.verticalGradient( | |
0f to Color.Transparent, | |
0.5f to Color.Black, | |
1f to Color.Transparent | |
) | |
} | |
LaunchedEffect(listState) { | |
snapshotFlow { listState.firstVisibleItemIndex } | |
.map { index -> getItem(index + visibleItemsMiddle) } | |
.distinctUntilChanged() | |
.collect { item -> state.selectedItem = item } | |
} | |
Box(modifier = modifier) { | |
LazyColumn( | |
state = listState, | |
flingBehavior = flingBehavior, | |
horizontalAlignment = Alignment.CenterHorizontally, | |
modifier = Modifier | |
.fillMaxWidth() | |
.height(itemHeightDp * visibleItemsCount) | |
.fadingEdge(fadingEdgeGradient) | |
) { | |
items(listScrollCount) { index -> | |
Text( | |
text = getItem(index), | |
maxLines = 1, | |
overflow = TextOverflow.Ellipsis, | |
style = textStyle, | |
modifier = Modifier | |
.onSizeChanged { size -> itemHeightPixels.value = size.height } | |
.then(textModifier) | |
) | |
} | |
} | |
Divider( | |
color = dividerColor, | |
modifier = Modifier.offset(y = itemHeightDp * visibleItemsMiddle) | |
) | |
Divider( | |
color = dividerColor, | |
modifier = Modifier.offset(y = itemHeightDp * (visibleItemsMiddle + 1)) | |
) | |
} | |
} | |
private fun Modifier.fadingEdge(brush: Brush) = this | |
.graphicsLayer(compositingStrategy = CompositingStrategy.Offscreen) | |
.drawWithContent { | |
drawContent() | |
drawRect(brush = brush, blendMode = BlendMode.DstIn) | |
} | |
@Composable | |
private fun pixelsToDp(pixels: Int) = with(LocalDensity.current) { pixels.toDp() } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
import androidx.compose.foundation.layout.Arrangement | |
import androidx.compose.foundation.layout.Column | |
import androidx.compose.foundation.layout.Row | |
import androidx.compose.foundation.layout.fillMaxSize | |
import androidx.compose.foundation.layout.fillMaxWidth | |
import androidx.compose.foundation.layout.padding | |
import androidx.compose.material3.Surface | |
import androidx.compose.material3.Text | |
import androidx.compose.runtime.Composable | |
import androidx.compose.runtime.remember | |
import androidx.compose.ui.Alignment | |
import androidx.compose.ui.Modifier | |
import androidx.compose.ui.text.TextStyle | |
import androidx.compose.ui.unit.dp | |
import androidx.compose.ui.unit.sp | |
@Composable | |
fun PickerExample() { | |
Surface(modifier = Modifier.fillMaxSize()) { | |
Column( | |
horizontalAlignment = Alignment.CenterHorizontally, | |
verticalArrangement = Arrangement.Center, | |
modifier = Modifier.fillMaxSize() | |
) { | |
val values = remember { (1..99).map { it.toString() } } | |
val valuesPickerState = rememberPickerState() | |
val units = remember { listOf("seconds", "minutes", "hours") } | |
val unitsPickerState = rememberPickerState() | |
Text(text = "Example Picker", modifier = Modifier.padding(top = 16.dp)) | |
Row(modifier = Modifier.fillMaxWidth()) { | |
Picker( | |
state = valuesPickerState, | |
items = values, | |
visibleItemsCount = 3, | |
modifier = Modifier.weight(0.3f), | |
textModifier = Modifier.padding(8.dp), | |
textStyle = TextStyle(fontSize = 32.sp) | |
) | |
Picker( | |
state = unitsPickerState, | |
items = units, | |
visibleItemsCount = 3, | |
modifier = Modifier.weight(0.7f), | |
textModifier = Modifier.padding(8.dp), | |
textStyle = TextStyle(fontSize = 32.sp) | |
) | |
} | |
Text( | |
text = "Interval: ${valuesPickerState.selectedItem} ${unitsPickerState.selectedItem}", | |
modifier = Modifier.padding(vertical = 16.dp) | |
) | |
} | |
} | |
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
import androidx.compose.runtime.Composable | |
import androidx.compose.runtime.getValue | |
import androidx.compose.runtime.mutableStateOf | |
import androidx.compose.runtime.remember | |
import androidx.compose.runtime.setValue | |
@Composable | |
fun rememberPickerState() = remember { PickerState() } | |
class PickerState { | |
var selectedItem by mutableStateOf("") | |
} |
Author
nhcodes
commented
May 17, 2023
Amazing work.
Hello,
I am currently working on porting the OneUI design components to jetpack compose. I came around this widget of yours, and was wondering if you would be willing to publish these code snippets under the MIT or APACHE 2.0 license?
You can find out more about this project here
Best regards, Snow
There is a generic version here with wrapSelectorWheel and onValueChange parameters
I prefer this over ChargeMap's NumberPicker for the sole reason that drag velocity determines scrolling speed due to the use of LazyColumn. Thank you :)
@BlieffertTim This is what I did to integrate an onPositionChanged()
DisposableEffect(listState.isScrollInProgress) {
if (!listState.isScrollInProgress) {
val position = (listState.firstVisibleItemIndex + visibleItemsMiddle) % items.size
onPositionChanged(position)
}
onDispose { }
}
to return the value, you can instead return state.selectedItem
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment