← Back to Wear Material
OutlinedChip
Overview
Code Examples
Wear Material OutlinedChip 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 OutlinedChip 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 OutlinedChip 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 OutlinedChip has a transparent background, a thin border and contents which are colored with the theme primary color. Colors can be obtained and customized using ChipDefaults.outlinedChipColors().
Chips can be enabled or disabled. A disabled chip will not respond to click events.
Example of a OutlinedChip with icon and a label only with longer text:
Overloads
OutlinedChip
@Composable
public fun OutlinedChip(
label: @Composable RowScope.() -> Unit,
onClick: () -> Unit,
modifier: Modifier = Modifier,
secondaryLabel: (@Composable RowScope.() -> Unit)? = null,
icon: (@Composable BoxScope.() -> Unit)? = null,
colors: ChipColors = ChipDefaults.outlinedChipColors(),
enabled: Boolean = true,
interactionSource: MutableInteractionSource = remember { MutableInteractionSource() },
contentPadding: PaddingValues = ChipDefaults.ContentPadding,
shape: Shape = MaterialTheme.shapes.small,
border: ChipBorder = ChipDefaults.outlinedChipBorder()
)
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. |
enabled | Controls the enabled state of the chip. When false , this chip will not be clickable |
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. |
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 |