Compose Multiplatform Material3/androidx.compose.material3/DockedSearchBar

DockedSearchBar

@Composable

fun DockedSearchBar(inputField: @Composable () -> Unit, expanded: Boolean, onExpandedChange: (Boolean) -> Unit, modifier: Modifier = Modifier, shape: Shape = SearchBarDefaults.dockedShape, colors: SearchBarColors = SearchBarDefaults.colors(), tonalElevation: Dp = SearchBarDefaults.TonalElevation, shadowElevation: Dp = SearchBarDefaults.ShadowElevation, content: @Composable ColumnScope.() -> Unit)

Material Design search.

A search bar represents a floating search field that allows users to enter a keyword or phrase and get relevant information. It can be used as a way to navigate through an app via search queries.

An search bar expands into a search "view" and can be used to display dynamic suggestions or search results.

A DockedSearchBar displays search results in a bounded table below the input field. It is an alternative to SearchBar when expanding to full-screen size is undesirable on large screens such as tablets.

An example looks like:

Parameters

inputField

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

expanded

whether this search bar is expanded and showing search results.

onExpandedChange

the callback to be invoked when this search bar's expanded state is changed.

modifier

the Modifier to be applied to this 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 the search bar.

content

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

Samples

androidx.compose.material3.samples.DockedSearchBarSample

@Composable

fun ~~DockedSearchBar~~(query: String, onQueryChange: (String) -> Unit, onSearch: (String) -> Unit, active: Boolean, onActiveChange: (Boolean) -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, placeholder: @Composable () -> Unit? = null, leadingIcon: @Composable () -> Unit? = null, trailingIcon: @Composable () -> Unit? = null, shape: Shape = SearchBarDefaults.dockedShape, colors: SearchBarColors = SearchBarDefaults.colors(), tonalElevation: Dp = SearchBarDefaults.TonalElevation, shadowElevation: Dp = SearchBarDefaults.ShadowElevation, interactionSource: MutableInteractionSource? = null, content: @Composable ColumnScope.() -> Unit)

Deprecated

Use overload which takes inputField as a parameter

Replace with

DockedSearchBar(
    inputField = {
        SearchBarDefaults.InputField(
            query = query,
            onQueryChange = onQueryChange,
            onSearch = onSearch,
            expanded = active,
            onExpandedChange = onActiveChange,
            enabled = enabled,
            placeholder = placeholder,
            leadingIcon = leadingIcon,
            trailingIcon = trailingIcon,
            colors = colors.inputFieldColors,
            interactionSource = interactionSource,
        )
    },
    expanded = active,
    onExpandedChange = onActiveChange,
    modifier = modifier,
    shape = shape,
    colors = colors,
    tonalElevation = tonalElevation,
    shadowElevation = shadowElevation,
    content = content,
)