PickerState

Class

Android
public class PickerState
constructor(
    /*@IntRange(from = 1)*/
    initialNumberOfOptions: Int,
    initiallySelectedOption: Int = 0,
    public val repeatItems: Boolean = true,
) : ScrollableState

A state object that can be hoisted to observe item selection.

In most cases, this will be created via rememberPickerState.

Parameters

initialNumberOfOptionsthe number of options
initiallySelectedOptionthe option to show in the center at the start
repeatItemsif true (the default), the contents of the component will be repeated

Functions

public suspend fun scrollToOption(index: Int)

Instantly scroll to an item.

Parameters

indexThe index of the option to scroll to.
public suspend fun animateScrollToOption(index: Int)

Animate (smooth scroll) to the given item 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.

Parameters

indexThe index of the option to scroll to.

Companion Object

Properties

Android
public val Saver: Saver<PickerState, Any>

The default Saver implementation for PickerState.