class PickerGroupScope

Summary

Public constructors

Public functions
Boolean
pickerGroupItem(
    pickerState: PickerState,
    modifier: Modifier,
    contentDescription: String?,
    focusRequester: FocusRequester?,
    onSelected: () -> Unit,
    readOnlyLabel: (@Composable BoxScope.() -> Unit)?,
    spacing: Dp,
    option: @Composable PickerScope.(optionIndex: Int, pickerSelected: Boolean) -> Unit
)

Adds a Picker item to the PickerGroup

Public constructors

PickerGroupScope

Added in 1.0.0-alpha26
PickerGroupScope()

Public functions

pickerGroupItem

fun pickerGroupItem(
    pickerState: PickerState,
    modifier: Modifier = Modifier,
    contentDescription: String? = null,
    focusRequester: FocusRequester? = null,
    onSelected: () -> Unit = {},
    readOnlyLabel: (@Composable BoxScope.() -> Unit)? = null,
    spacing: Dp = 0.dp,
    option: @Composable PickerScope.(optionIndex: Int, pickerSelected: Boolean) -> Unit
): Boolean

Adds a Picker item to the PickerGroup

Parameters
pickerState: PickerState

The state of the picker.
modifier: Modifier = Modifier

Modifier to be applied to the Picker.
contentDescription: String? = null

Text used by accessibility services to describe what the selected option represents. This text should be localized, such as by using androidx.compose.ui.res.stringResource or similar. Typically, the content description is inferred via derivedStateOf to avoid unnecessary recompositions, like this: val description by remember { derivedStateOf { /* expression using state.selectedOption */ } }.
focusRequester: FocusRequester? = null

Optional FocusRequester for the Picker. If not provided, a local instance of FocusRequester will be created to handle the focus between different pickers.
onSelected: () -> Unit = {}

Action triggered when the Picker is selected by clicking.
readOnlyLabel: (@Composable BoxScope.() -> Unit)? = null

A slot for providing a label, displayed above the selected option when the Picker is read-only. The label is overlaid with the currently selected option within a Box, so it is recommended that the label is given Alignment.TopCenter.
spacing: Dp = 0.dp

The amount of spacing in Dp between items. Can be negative, which can be useful for Text if it has plenty of whitespace.
option: @Composable PickerScope.(optionIndex: Int, pickerSelected: Boolean) -> Unit

A block which describes the content. The integer parameter to the composable denotes the index of the option and boolean denotes whether the picker is selected or not.