← Back to Tv Material
InputChip
Overview
Examples
Community Notes
Video
Chips help people enter information, make selections, filter content, or trigger actions. Chips can show multiple interactive elements together in the same area, such as a list of selectable movie times, or a series of email contacts
Input chips represent discrete pieces of information entered by a user
An Input Chip can have a leading icon or an avatar at its start. In case both are provided, the avatar will take precedence and will be displayed
@param selected whether this chip is selected or not @param onClick called when this chip is clicked @param modifier the Modifier to be applied to this chip @param enabled controls the enabled state of this chip. When false
, this component will not respond to user input, and it will appear visually disabled and disabled to accessibility services @param onLongClick callback to be called when the surface is long clicked (long-pressed) @param leadingIcon optional icon at the start of the chip, preceding the content text @param avatar optional avatar at the start of the chip, preceding the content text @param trailingIcon optional icon at the end of the chip @param shape Defines the Chip's shape @param colors Color to be used on background and content of the chip @param scale Defines size of the chip relative to its original size @param border Defines a border around the chip @param glow Shadow to be shown behind the chip @param interactionSource the MutableInteractionSource representing the stream of Interactions for this chip. You can create and pass in your own remember
ed instance to observe Interactions and customize the appearance / behavior of this chip in different states @param content for this chip, ideally a Text composable
Overloads
InputChip
@ExperimentalTvMaterial3Api
@NonRestartableComposable
@Composable
fun InputChip(
selected: Boolean,
onClick: () -> Unit,
modifier: Modifier = Modifier,
enabled: Boolean = true,
onLongClick: (() -> Unit)? = null,
leadingIcon: @Composable (() -> Unit)? = null,
avatar: @Composable (() -> Unit)? = null,
trailingIcon: @Composable (() -> Unit)? = null,
shape: SelectableChipShape = InputChipDefaults.shape(hasAvatar = avatar != null),
colors: SelectableChipColors = InputChipDefaults.colors(),
scale: SelectableChipScale = InputChipDefaults.scale(),
border: SelectableChipBorder = InputChipDefaults.border(hasAvatar = avatar != null),
glow: SelectableChipGlow = InputChipDefaults.glow(),
interactionSource: MutableInteractionSource = remember { MutableInteractionSource() },
content: @Composable () -> Unit
)
Parameters
Name | Description |
---|---|
selected | whether this chip is selected or not |
onClick | called when this chip is clicked |
modifier | the Modifier to be applied to this chip |
enabled | controls the enabled state of this chip. When false , this component will not respond to user input, and it will appear visually disabled and disabled to accessibility services |
onLongClick | callback to be called when the surface is long clicked (long-pressed) |
leadingIcon | optional icon at the start of the chip, preceding the content text |
avatar | optional avatar at the start of the chip, preceding the content text |
trailingIcon | optional icon at the end of the chip |
shape | Defines the Chip's shape |
colors | Color to be used on background and content of the chip |
scale | Defines size of the chip relative to its original size |
border | Defines a border around the chip |
glow | Shadow to be shown behind the chip |
interactionSource | the MutableInteractionSource representing the stream of Interactions for this chip. You can create and pass in your own remember ed instance to observe Interactions and customize the appearance / behavior of this chip in different states |
content | for this chip, ideally a Text composabl |