SearchBar
A search bar represents a 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.
The SearchBar component represents a search bar in the collapsed state. It should be used in conjunction with an ExpandedFullScreenSearchBar or ExpandedDockedSearchBar to display search results when expanded.
Parameters
the state of the search bar. This state should also be passed to the inputField and the expanded search bar.
the input field of this search bar that allows entering a query, typically a SearchBarDefaults.InputField.
the Modifier to be applied to this search bar when collapsed.
the shape of this search bar when collapsed.
SearchBarColors that will be used to resolve the colors used for this search bar in different states. See SearchBarDefaults.colors.
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.
the elevation for the shadow below this search bar.
Samples
androidx.compose.material3.samples.SimpleSearchBarSampleA 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.
A search bar expands into a search "view" and can be used to display dynamic suggestions or search results.
A SearchBar tries to occupy the entirety of its allowed size in the expanded state. For full-screen behavior as specified by Material guidelines, parent layouts of the SearchBar must not pass any Constraints that limit its size, and the host activity should set WindowCompat.setDecorFitsSystemWindows(window, false).
If this expansion behavior is undesirable, for example on large tablet screens, DockedSearchBar can be used instead.
Parameters
the input field of this search bar that allows entering a query, typically a SearchBarDefaults.InputField.
whether this search bar is expanded and showing search results.
the callback to be invoked when this search bar's expanded state is changed.
the Modifier to be applied to this search bar.
the shape of this search bar when it is not expanded. When expanded, the shape will always be SearchBarDefaults.fullScreenShape.
SearchBarColors that will be used to resolve the colors used for this search bar in different states. See SearchBarDefaults.colors.
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.
the elevation for the shadow below this search bar
the window insets that this search bar will respect
the content of this search bar to display search results below the inputField.
Deprecated
Use overload which takes inputField as a parameter
Replace with
SearchBar(
inputField = {
SearchBarDefaults.InputField(
textFieldState = textFieldState,
searchBarState = searchBarState,
onSearch = onSearch,
modifier = modifier,
enabled = enabled,
readOnly = readOnly,
textStyle = textStyle,
placeholder = placeholder,
leadingIcon = leadingIcon,
trailingIcon = trailingIcon,
prefix = prefix,
suffix = suffix,
inputTransformation = inputTransformation,
outputTransformation = outputTransformation,
keyboardOptions = keyboardOptions,
lineLimits = lineLimits,
scrollState = scrollState,
shape = shape,
colors = colors,
interactionSource = interactionSource,
)
},
expanded = active,
onExpandedChange = onActiveChange,
modifier = modifier,
shape = shape,
colors = colors,
tonalElevation = tonalElevation,
shadowElevation = shadowElevation,
windowInsets = windowInsets,
content = content,
)