Chip

Base level Wear Material [Chip] that offers a single slot to take any content.

Is used as the container for more opinionated [Chip] components that take specific content such as icons and labels.

The [Chip] is Stadium shaped and has a max height designed to take no more than two lines of text of [Typography.button] style. The [Chip] can have an icon or image horizontally parallel to the two lines of text. With localisation and/or large font sizes, the [Chip] height adjusts to accommodate the contents.

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.

Installation

This component is available for Jetpack Compose (Android)

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

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 border parameter.",
    level = DeprecationLevel.HIDDEN)
fun Chip(
    onClick: () -> Unit,
    colors: ChipColors,
    modifier: Modifier = Modifier,
    enabled: Boolean = true,
    contentPadding: PaddingValues = ChipDefaults.ContentPadding,
    shape: Shape = MaterialTheme.shapes.large,
    interactionSource: MutableInteractionSource = remember { MutableInteractionSource() },
    role: Role? = Role.Button,
    content: @Composable RowScope.() -> Unit,
)

Parameters

name	description
`onClick`	Will be called when the user clicks the chip
`colors`	[ChipColors] that will be used to resolve the background and content color for this chip in different states. See [ChipDefaults.chipColors].
`modifier`	Modifier to be applied to the chip
`enabled`	Controls the enabled state of the chip. When `false`, this chip will not be clickable
`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
`interactionSource`	The [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.
`role`	The type of user interface element. Accessibility services might use this to describe the element or do customizations

@Composable
fun Chip(
    onClick: () -> Unit,
    colors: ChipColors,
    border: ChipBorder,
    modifier: Modifier = Modifier,
    enabled: Boolean = true,
    contentPadding: PaddingValues = ChipDefaults.ContentPadding,
    shape: Shape = MaterialTheme.shapes.large,
    interactionSource: MutableInteractionSource? = null,
    role: Role? = Role.Button,
    content: @Composable RowScope.() -> Unit,
)

Parameters

name	description
`onClick`	Will be called when the user clicks the chip
`colors`	[ChipColors] that will be used to resolve the background and content color for this chip in different states. See [ChipDefaults.chipColors].
`border`	[ChipBorder] that will be used to resolve the border for this chip in different states. See [ChipDefaults.chipBorder].
`modifier`	Modifier to be applied to the chip
`enabled`	Controls the enabled state of the chip. When `false`, this chip will not be clickable
`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
`interactionSource`	an 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.
`role`	The type of user interface element. Accessibility services might use this to describe the element or do customizations

@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

name	description
`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 "start" or "center" aligned if not.
`onClick`	Will be called when the user clicks the chip
`modifier`	Modifier to be applied to the chip
`secondaryLabel`	A 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.
`icon`	A 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]
`enabled`	Controls the enabled state of the chip. When `false`, this chip will not be clickable
`interactionSource`	The [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.
`contentPadding`	The 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

name	description
`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 "start" or "center" aligned if not.
`onClick`	Will be called when the user clicks the chip
`modifier`	Modifier to be applied to the chip
`secondaryLabel`	A 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.
`icon`	A 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]
`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 [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.
`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 chip border in different states. See [ChipDefaults.chipBorder].

Code Examples

ChipWithIconAndLabel

@Composable
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
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),
            )
        }
    )
}