OutlinedCompactChip

Composable Component

A compact Outlined Wear Material Chip that offers two slots and a specific layout for an icon and label. Both the icon and label are optional however it is expected that at least one will be provided.

Android
@Composable
public fun OutlinedCompactChip(
    onClick: () -> Unit,
    modifier: Modifier = Modifier,
    label: (@Composable RowScope.() -> Unit)? = null,
    icon: (@Composable BoxScope.() -> Unit)? = null,
    colors: ChipColors = ChipDefaults.outlinedChipColors(),
    enabled: Boolean = true,
    interactionSource: MutableInteractionSource? = null,
    contentPadding: PaddingValues = ChipDefaults.CompactChipContentPadding,
    shape: Shape = MaterialTheme.shapes.large,
    border: ChipBorder = ChipDefaults.outlinedChipBorder(),
): Unit

Parameters
onClick Will be called when the user clicks the chip
modifier Modifier to be applied to the chip
label A slot for providing the chip's main label. The contents are expected to be text which is "start" aligned if there is an icon preset and "center" aligned if not.
icon A slot for providing the chip's icon. The contents are expected to be a horizontally and vertically aligned icon of size ChipDefaults.SmallIconSize when used with a label or ChipDefaults.IconSize when used as the only content in the CompactChip. In order to correctly render when the Chip is not enabled the icon must set its alpha value to LocalContentAlpha.
colors ChipColors that will be used to resolve the background and content color for this chip in different states. See ChipDefaults.outlinedChipColors. Defaults to ChipDefaults.primaryChipColors
enabled Controls the enabled state of the chip. When false, this chip will not be clickable
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.
contentPadding The spacing values to apply internally between the container and the content
shape Defines the chip's shape. It is strongly recommended to use the default as this shape is a key characteristic of the Wear Material Theme
border ChipBorder that will be used to resolve the border for this chip in different states. See ChipDefaults.outlinedChipBorder.

Code Examples

OutlinedCompactChipWithIconAndLabel

@Composable
fun OutlinedCompactChipWithIconAndLabel() {
    OutlinedCompactChip(
        onClick = { /* Do something */ },
        enabled = true,
        // CompactChip label should be no more than 1 line of text
        label = { Text("Single line label", maxLines = 1, overflow = TextOverflow.Ellipsis) },
        icon = {
            Icon(
                painter = painterResource(id = R.drawable.ic_airplanemode_active_24px),
                contentDescription = "airplane",
                modifier = Modifier.size(ChipDefaults.SmallIconSize),
            )
        },
    )
}