New Compose Multiplatform components arrived on Composables UICheck it out →

Chip

Wear Material [Chip] that offers three slots and a specific layout for an icon, label and secondaryLabel. The icon and secondaryLabel are optional. The items are laid out with the icon, if provided, at the start of a row, with a column next containing the two label slots.

The [Chip] is Stadium shaped and has a max height designed to take no more than two lines of text of [Typography.button] style. If no secondary label is provided then the label can be two lines of text. The label and secondary label should be consistently aligned. With localisation and/or large font sizes, the [Chip] height adjusts to accommodate the contents.

If a icon is provided then the labels should be "start" aligned, e.g. left aligned in ltr so that the text starts next to the icon.

The [Chip] can have different styles with configurable content colors, background colors including gradients, these are provided by [ChipColors] implementations.

The recommended set of [ChipColors] styles can be obtained from [ChipDefaults], e.g. [ChipDefaults.primaryChipColors] to get a color scheme for a primary [Chip] which by default will have a solid background of [Colors.primary] and content color of [Colors.onPrimary].

Chips can be enabled or disabled. A disabled chip will not respond to click events.

Last updated:

Installation

dependencies {
   implementation("androidx.wear.compose:compose-material:1.4.0-beta03")
}

Overloads

@Composable
@Deprecated("This overload is provided for backwards compatibility with Compose for Wear OS 1.0." +
    "A newer overload is available with an additional shape parameter.",
    level = DeprecationLevel.HIDDEN
fun Chip(
    label: @Composable RowScope.() -> Unit,
    onClick: () -> Unit,
    modifier: Modifier = Modifier,
    secondaryLabel: (@Composable RowScope.() -> Unit)? = null,
    icon: (@Composable BoxScope.() -> Unit)? = null,
    colors: ChipColors = ChipDefaults.primaryChipColors(),
    enabled: Boolean = true,
    interactionSource: MutableInteractionSource = remember { MutableInteractionSource() },
    contentPadding: PaddingValues = ChipDefaults.ContentPadding,
)

Parameters

namedescription
labelA 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 "start" or "center" aligned if not.
onClickWill be called when the user clicks the chip
modifierModifier to be applied to the chip
secondaryLabelA slot for providing the chip's secondary label. The contents are expected to be text which is "start" aligned if there is an icon preset and "start" or "center" aligned if not. label and secondaryLabel contents should be consistently aligned.
iconA slot for providing the chip's icon. The contents are expected to be a horizontally and vertically aligned icon of size [ChipDefaults.IconSize] or [ChipDefaults.LargeIconSize]. 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.chipColors]. Defaults to [ChipDefaults.primaryChipColors]
enabledControls the enabled state of the chip. When false, this chip will not be clickable
interactionSourceThe [MutableInteractionSource] representing the stream of [Interaction]s for this Chip. You can create and pass in your own remembered [MutableInteractionSource] if you want to observe [Interaction]s and customize the appearance / behavior of this Chip in different [Interaction]s.
contentPaddingThe spacing values to apply internally between the container and the content
@Composable
fun Chip(
    label: @Composable RowScope.() -> Unit,
    onClick: () -> Unit,
    modifier: Modifier = Modifier,
    secondaryLabel: (@Composable RowScope.() -> Unit)? = null,
    icon: (@Composable BoxScope.() -> Unit)? = null,
    colors: ChipColors = ChipDefaults.primaryChipColors(),
    enabled: Boolean = true,
    interactionSource: MutableInteractionSource? = null,
    contentPadding: PaddingValues = ChipDefaults.ContentPadding,
    shape: Shape = MaterialTheme.shapes.large,
    border: ChipBorder = ChipDefaults.chipBorder()
)

Parameters

namedescription
labelA 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 "start" or "center" aligned if not.
onClickWill be called when the user clicks the chip
modifierModifier to be applied to the chip
secondaryLabelA slot for providing the chip's secondary label. The contents are expected to be text which is "start" aligned if there is an icon preset and "start" or "center" aligned if not. label and secondaryLabel contents should be consistently aligned.
iconA slot for providing the chip's icon. The contents are expected to be a horizontally and vertically aligned icon of size [ChipDefaults.IconSize] or [ChipDefaults.LargeIconSize]. 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.chipColors]. Defaults to [ChipDefaults.primaryChipColors]
enabledControls the enabled state of the chip. When false, this chip will not be clickable
interactionSourcean optional hoisted [MutableInteractionSource] for observing and emitting [Interaction]s 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.
contentPaddingThe spacing values to apply internally between the container and the content
shapeDefines 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 chip border in different states. See [ChipDefaults.chipBorder].

Code Examples

ChipWithIconAndLabel

@Composable
@Sampled
fun ChipWithIconAndLabel() {
    Chip(
        onClick = { /* Do something */ },
        enabled = true,
        // Primary label can have up to 3 lines of text
        label = {
            Text(
                text = "Main label can span up to 3 lines",
                maxLines = 3, overflow = TextOverflow.Ellipsis
            )
        },
        icon = {
            Icon(
                painter = painterResource(id = R.drawable.ic_airplanemode_active_24px),
                contentDescription = "airplane",
                modifier = Modifier.size(ChipDefaults.IconSize)
                    .wrapContentSize(align = Alignment.Center),
            )
        }
    )
}

ChipWithIconAndLabels

@Composable
@Sampled
fun ChipWithIconAndLabels() {
    Chip(
        onClick = { /* Do something */ },
        enabled = true,
        // Primary label has maximum 3 lines, Secondary label has maximum 2 lines.
        label = { Text(text = "Main label", maxLines = 3, overflow = TextOverflow.Ellipsis) },
        secondaryLabel = {
            Text(text = "secondary label", maxLines = 2, overflow = TextOverflow.Ellipsis)
        },
        icon = {
            Icon(
                painter = painterResource(id = R.drawable.ic_airplanemode_active_24px),
                contentDescription = "airplane",
                modifier = Modifier.size(ChipDefaults.IconSize)
                    .wrapContentSize(align = Alignment.Center),
            )
        }
    )
}