spark/com.adevinta.spark.components.textfields/MultiChoiceComboBox

MultiChoiceComboBox

@Composable
fun MultiChoiceComboBox(state: TextFieldState, expanded: Boolean, onExpandedChange: (Boolean) -> Unit, onDismissRequest: () -> Unit, selectedChoices: ImmutableList<SelectedChoice>, onSelectedClick: (String) -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, required: Boolean = false, label: String? = null, placeholder: String? = null, helper: String? = null, leadingContent: @Composable AddonScope.() -> Unit? = null, trailingContent: @Composable AddonScope.() -> Unit? = null, status: FormFieldStatus? = null, statusMessage: String? = null, inputTransformation: InputTransformation? = null, keyboardOptions: KeyboardOptions = KeyboardOptions.Default, onKeyboardAction: KeyboardActionHandler? = null, lineLimits: TextFieldLineLimits = TextFieldLineLimits.Default, onTextLayout: Density.(getResult: () -> TextLayoutResult?) -> Unit? = null, interactionSource: MutableInteractionSource? = null, outputTransformation: OutputTransformation? = null, scrollState: ScrollState = rememberScrollState(), dropdownContent: @Composable MultiChoiceDropdownItemColumnScope.() -> Unit)

A ComboBox component that allows users to select multiple options from a dropdown list. It combines a text field with a dropdown menu, providing a searchable interface for selecting options. The selected choices are displayed as chips below the text field.

Parameters

state

The state of the text field that controls the input value

expanded

Whether the dropdown menu is currently expanded

onExpandedChange

Callback invoked when the expanded state changes

onDismissRequest

Callback invoked when the dropdown menu should be dismissed

selectedChoices

The list of currently selected choices

onSelectedClick

Callback invoked when a selected choice chip is clicked, typically to remove it

modifier

Modifier to be applied to the ComboBox

enabled

Whether the ComboBox is enabled

required

Whether the field is required

label

Optional label text displayed above the ComboBox

placeholder

Optional placeholder text shown when the field is empty

helper

Optional helper text displayed below the ComboBox

leadingContent

Optional composable content displayed at the start of the ComboBox

trailingContent

Optional composable content displayed at the end of the ComboBox, if not provided, a default trailing icon will be used.

status

Optional status of the form field (e.g., error, success)

statusMessage

Optional message associated with the status

inputTransformation

Optional transformation applied to input text

keyboardOptions

Options for the keyboard

onKeyboardAction

Optional handler for keyboard actions

lineLimits

Limits for the number of lines in the text field

onTextLayout

Optional callback for text layout changes

interactionSource

Optional interaction source for the ComboBox

outputTransformation

Optional transformation applied to output text

scrollState

Scroll state for the text field

dropdownContent

Content of the dropdown menu, using MultiChoiceDropdownItemColumnScope

See also

for a version that supports single selection

@Composable
fun MultiChoiceComboBox(state: TextFieldState, expanded: Boolean, onExpandedChange: (Boolean) -> Unit, onDismissRequest: () -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, required: Boolean = false, label: String? = null, placeholder: String? = null, helper: String? = null, leadingContent: @Composable AddonScope.() -> Unit? = null, trailingContent: @Composable AddonScope.() -> Unit? = null, status: FormFieldStatus? = null, statusMessage: String? = null, inputTransformation: InputTransformation? = null, keyboardOptions: KeyboardOptions = KeyboardOptions.Default, onKeyboardAction: KeyboardActionHandler? = null, lineLimits: TextFieldLineLimits = TextFieldLineLimits.Default, onTextLayout: Density.(getResult: () -> TextLayoutResult?) -> Unit? = null, interactionSource: MutableInteractionSource? = null, outputTransformation: OutputTransformation? = null, scrollState: ScrollState = rememberScrollState(), dropdownContent: @Composable MultiChoiceDropdownItemColumnScope.() -> Unit)

A ComboBox component that allows users to select multiple options from a dropdown list. It combines a text field with a dropdown menu, providing a searchable interface for selecting options. This overload does not manage selected choices directly, and is intended for use cases where selection state is handled externally or not needed.

Parameters

state

The state of the text field that controls the input value

expanded

Whether the dropdown menu is currently expanded

onExpandedChange

Callback invoked when the expanded state changes

onDismissRequest

Callback invoked when the dropdown menu should be dismissed

modifier

Modifier to be applied to the ComboBox

enabled

Whether the ComboBox is enabled

required

Whether the field is required

label

Optional label text displayed above the ComboBox

placeholder

Optional placeholder text shown when the field is empty

helper

Optional helper text displayed below the ComboBox

leadingContent

Optional composable content displayed at the start of the ComboBox

trailingContent

Optional composable content displayed at the end of the ComboBox, if not provided, a default trailing icon will be used.

status

Optional status of the form field (e.g., error, success)

statusMessage

Optional message associated with the status

inputTransformation

Optional transformation applied to input text

keyboardOptions

Options for the keyboard

onKeyboardAction

Optional handler for keyboard actions

lineLimits

Limits for the number of lines in the text field

onTextLayout

Optional callback for text layout changes

interactionSource

Optional interaction source for the ComboBox

outputTransformation

Optional transformation applied to output text

scrollState

Scroll state for the text field

dropdownContent

Content of the dropdown menu, using MultiChoiceDropdownItemColumnScope

See also

for a version that supports single selection

for the version that manages selected choices