FormsAndroid

Multi select

Select multiple searchable options with controlled values and result states.

Public APILumenMultiSelectAndroid / Compose

Native example

Use Multi select

Selection applies immediately. The host owns search, asynchronous results, cancellation, and persistence. Missing selected options retain their raw value as a chip label. Localize every string and count/removal formatter.

Multi select rendered in the Android phone emulator Lumen playground — Captured exampleAndroid phone emulator

LumenMultiSelect(
    label = "Teams", options = matchingTeams, values = selectedTeams,
    onValuesChange = { selectedTeams = it }, query = query, onQueryChange = { query = it },
    loading = searching, resultsErrorMessage = searchError, onRetry = ::retrySearch
)

Reference

Public API

The primary shared and platform-specific options exposed by LumenMultiSelect.

API	Values or type	Default	Description
label / options	String / List<LumenSelectionOption>	Required	Names the field and supplies uniquely identified, readable results.
values / onValuesChange	Set<String> / (Set<String>) -> Unit	Required	Controls selection independently from visible results.
query / onQueryChange	String / (String) -> Unit	Required	Controls caller-owned search.
loading / resultsErrorMessage / onRetry	Boolean / String? / (() -> Unit)?	false / null / null	Provides loading, safe error, and recovery states.
description / errorMessage	String?	None	Provides help and separate form validation.
enabled / readOnly	Boolean	true / false	Blocks editing and dismisses selection.
chooseLabel / searchLabel / clearSearchLabel / doneLabel	String	English defaults	Localizes selection and dialog actions.
emptyLabel / loadingLabel / retryLabel	String	English defaults	Localizes result states.
selectionLabel / removeLabel	(Int) -> String / (String) -> String	English formatters	Localizes counts and chip removal.
—	—	None	Passes the application safe-area provider insets into the native sheet.
modifier	Modifier	Modifier	Applies field layout.

Native behavior

Design and accessibility

When to use it

Accessibility

Uses a native dialog with named checkbox options, removal actions, validation, and read-only or disabled behavior.

Shared component

Available on other platforms

React Native Apple / SwiftUI