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 has a max height designed to take no more than two lines of text If no secondary label is provided then the label can be two lines of text. The label and secondary label should be consistently aligned.

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 and painted background including gradients.

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

For more information, see the Chips(https://developer.android.com/training/wearables/components/chips) guide.

@param 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. @param onClick Will be called when the user clicks the chip @param background Resolves the background for this chip in different states. @param modifier Modifier to be applied to the chip @param 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. @param icon A slot for providing the chip's icon. The contents are expected to be a horizontally and vertically aligned icon. @param enabled Controls the enabled state of the chip. When false, this chip will not be clickable @param interactionSource The MutableInteractionSource representing the stream of Interactions for this Chip. You can create and pass in your own remembered MutableInteractionSource if you want to observe Interactions and customize the appearance / behavior of this Chip in different Interactions. @param contentPadding The spacing values to apply internally between the container and the content. @param 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. @param border Resolves the chip border in different states. @param defaultIconSpacing Spacing between icon and label, if both are provided. @param role Role semantics that accessibility services can use to provide more context to users.

Overloads

Chip

@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
@Composable
fun Chip(
    label: @Composable RowScope.() -> Unit,
    onClick: () -> Unit,
    background: @Composable (enabled: Boolean) -> State<Painter>,
    modifier: Modifier,
    secondaryLabel: (@Composable RowScope.() -> Unit)?,
    icon: (@Composable BoxScope.() -> Unit)?,
    enabled: Boolean,
    interactionSource: MutableInteractionSource,
    contentPadding: PaddingValues,
    shape: Shape,
    border: @Composable (enabled: Boolean) -> State<BorderStroke?>?,
    defaultIconSpacing: Dp,
    role: Role?,
)

Parameters