Compose Multiplatform Material3/androidx.compose.material3/SuggestionChip

SuggestionChip

@Composable
fun SuggestionChip(onClick: () -> Unit, label: @Composable () -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, icon: @Composable () -> Unit? = null, shape: Shape = SuggestionChipDefaults.shape, colors: ChipColors = SuggestionChipDefaults.suggestionChipColors(), elevation: ChipElevation? = SuggestionChipDefaults.suggestionChipElevation(), border: BorderStroke? = SuggestionChipDefaults.suggestionChipBorder(enabled), interactionSource: MutableInteractionSource? = null)

Material Design suggestion chip.

Chips help people enter information, make selections, filter content, or trigger actions. Chips can show multiple interactive elements together in the same area, such as a list of selectable movie times, or a series of email contacts.

Suggestion chips help narrow a user's intent by presenting dynamically generated suggestions, such as possible responses or search filters.

Suggestion chip image

This suggestion chip is applied with a flat style. If you want an elevated style, use the ElevatedSuggestionChip.

Example of a flat SuggestionChip with a trailing icon:

Parameters

onClick

called when this chip is clicked

label

text label for this chip

modifier

the Modifier to be applied to this chip

enabled

controls the enabled state of this chip. When false, this component will not respond to user input, and it will appear visually disabled and disabled to accessibility services.

icon

optional icon at the start of the chip, preceding the label text

shape

defines the shape of this chip's container, border (when border is not null), and shadow (when using elevation)

colors

ChipColors that will be used to resolve the colors used for this chip in different states. See SuggestionChipDefaults.suggestionChipColors.

elevation

ChipElevation used to resolve the elevation for this chip in different states. This controls the size of the shadow below the chip. Additionally, when the container color is ColorScheme.surface, this controls the amount of primary color applied as an overlay. See SuggestionChipDefaults.suggestionChipElevation.

border

the border to draw around the container of this chip. Pass null for no border. See SuggestionChipDefaults.suggestionChipBorder.

interactionSource

an optional hoisted MutableInteractionSource for observing and emitting Interactions for this chip. You can use this to change the chip's appearance or preview the chip in different states. Note that if null is provided, interactions will still happen internally.

Samples

androidx.compose.material3.samples.SuggestionChipSample