class PickerGroupScope

Summary

Public constructors

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

A Picker in a PickerGroup

Public constructors

PickerGroupScope

Added in 1.0.0-alpha37
PickerGroupScope()

Public functions

PickerGroupItem

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

A Picker in a PickerGroup

Parameters
pickerState: PickerState

The state of the picker.
selected: Boolean

If the Picker is selected.
onSelected: () -> Unit

Action triggered when the Picker is selected by clicking.
modifier: Modifier = Modifier

Modifier to be applied to the Picker.
contentDescription: (() -> String)? = null

A block which computes 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.
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. If it is provided, the caller is responsible for handling the focus.
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.
verticalSpacing: Dp = 0.dp

The amount of vertical 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.