PickerState

val Saver: Saver<PickerState, Any>

The default Saver implementation for PickerState.

PickerState(
    initialNumberOfOptions: @IntRange(from = 1) Int,
    initiallySelectedIndex: @IntRange(from = 0) Int = 0,
    shouldRepeatOptions: Boolean = true
)

suspend fun animateScrollToOption(index: Int): Unit

Animate (smooth scroll) to the given option at index.

A smooth scroll always happens to the closest item if PickerState has repeatItems=true. For example, picker values are : 0 1 2 3 0 1 2 3 0 1 2 3 Target value is 0. 0 1 2 3 >0< 1 2 3>0< 1 2 3 Picker can be scrolled forwards or backwards. To get to the target 0 it requires 1 step to scroll forwards and 3 steps to scroll backwards. Picker will be scrolled forwards as this is the closest destination.

If the distance between possible targets is the same, picker will be scrolled backwards.

import androidx.compose.foundation.layout.Box
import androidx.compose.foundation.layout.fillMaxSize
import androidx.compose.runtime.derivedStateOf
import androidx.compose.runtime.remember
import androidx.compose.runtime.rememberCoroutineScope
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.unit.dp
import androidx.wear.compose.material3.Button
import androidx.wear.compose.material3.Picker
import androidx.wear.compose.material3.Text
import androidx.wear.compose.material3.rememberPickerState

val coroutineScope = rememberCoroutineScope()
val state = rememberPickerState(initialNumberOfOptions = 10)
val contentDescription by remember { derivedStateOf { "${state.selectedOptionIndex + 1}" } }

Box(modifier = Modifier.fillMaxSize(), contentAlignment = Alignment.Center) {
    Picker(
        state = state,
        spacing = 4.dp,
        contentDescription = contentDescription,
    ) {
        Button(
            onClick = { coroutineScope.launch { state.animateScrollToOption(it) } },
            label = { Text("$it") }
        )
    }
}

open fun dispatchRawDelta(delta: Float): Float

open suspend fun scroll(scrollPriority: MutatePriority, block: suspend ScrollScope.() -> Unit): Unit

suspend fun scrollToOption(index: Int): Unit

Instantly scroll to an option.

import androidx.compose.runtime.derivedStateOf
import androidx.compose.runtime.remember
import androidx.compose.runtime.rememberCoroutineScope
import androidx.compose.ui.unit.dp
import androidx.wear.compose.material3.Button
import androidx.wear.compose.material3.Picker
import androidx.wear.compose.material3.Text
import androidx.wear.compose.material3.rememberPickerState

val coroutineScope = rememberCoroutineScope()
val state = rememberPickerState(initialNumberOfOptions = 10)
val contentDescription by remember { derivedStateOf { "${state.selectedOptionIndex + 1}" } }
Picker(
    state = state,
    spacing = 4.dp,
    contentDescription = contentDescription,
) {
    Button(
        onClick = { coroutineScope.launch { state.scrollToOption(it) } },
        label = { Text("$it") }
    )
}

open val canScrollBackward: Boolean

open val canScrollForward: Boolean

open val isScrollInProgress: Boolean

var numberOfOptions: Int

Represents how many different choices are presented by this Picker

val selectedOptionIndex: Int

Index of the selected option (i.e. at the center).

val shouldRepeatOptions: Boolean

if true (the default), the options will be repeated.