Compose Multiplatform Material3/androidx.compose.material3/ExpandedDockedSearchBar

ExpandedDockedSearchBar

@Composable
fun ExpandedDockedSearchBar(state: SearchBarState, inputField: @Composable () -> Unit, modifier: Modifier = Modifier, shape: Shape = SearchBarDefaults.dockedShape, colors: SearchBarColors = SearchBarDefaults.colors(), tonalElevation: Dp = SearchBarDefaults.TonalElevation, shadowElevation: Dp = SearchBarDefaults.ShadowElevation, properties: PopupProperties = PopupProperties(focusable = true, clippingEnabled = false), content: @Composable ColumnScope.() -> Unit)

ExpandedDockedSearchBar represents a search bar that is currently expanding or in the expanded state, showing search results. This component is displayed in a popup over the collapsed search bar. It is recommended to use ExpandedDockedSearchBar on medium and large screens such as tablets, and to instead use ExpandedFullScreenSearchBar on compact screen such as phones.

Parameters

state

the state of the search bar. This state should also be passed to the inputField and the collapsed search bar.

inputField

the input field of this search bar that allows entering a query, typically a SearchBarDefaults.InputField.

modifier

the Modifier to be applied to this expanded search bar.

shape

the shape of this search bar.

colors

SearchBarColors that will be used to resolve the colors used for this search bar in different states. See SearchBarDefaults.colors.

tonalElevation

when SearchBarColors.containerColor is ColorScheme.surface, a translucent primary color overlay is applied on top of the container. A higher tonal elevation value will result in a darker color in light theme and lighter color in dark theme. See also: Surface.

shadowElevation

the elevation for the shadow below this search bar.

properties

the platform-specific properties to configure the dialog's behavior. Any properties which limit the dialog's size (e.g. DialogProperties.usePlatformDefaultWidth) are ignored.

content

the content of this search bar to display search results below the inputField.

Samples

androidx.compose.material3.samples.DockedSearchBarScaffoldSample