使用标记显示一个小视觉元素,以在另一个可组合项上表示状态或数值。以下是您可能使用徽章的一些常见场景:
- 通知:在应用图标或通知铃铛上显示未读通知的数量。
- 消息:指示聊天应用中有新消息或未读消息。
- 状态更新:显示任务的状态,例如“已完成”“进行中”或“失败”。
- 购物车数量:显示用户购物车中商品的数量。
- 新内容:突出显示可供用户使用的新内容或功能。
API Surface
使用 BadgedBox
可组合项在应用中实现徽章。它最终是容器。您可以通过以下两个主要参数控制其外观:
content
:BadgedBox
包含的可组合内容。通常为Icon
。badge
:显示在内容上方作为标记的可组合项。通常是专用的Badge
可组合项。
基本示例
以下代码段展示了 BadgedBox
的基本实现:
@Composable fun BadgeExample() { BadgedBox( badge = { Badge() } ) { Icon( imageVector = Icons.Filled.Mail, contentDescription = "Email" ) } }
此示例显示了一个与所提供的 Icon
可组合项重叠的徽章。请注意代码中的以下事项:
BadgedBox
充当总容器。BadgedBox
的badge
参数的参数为Badge
。由于Badge
没有自己的参数,因此应用会显示默认徽章,即一个小红圈。Icon
可用作BadgedBox
的content
参数的参数。徽章显示在该图标上方。在本例中,该图标为邮件图标。
如下所示:
详细示例
以下代码段演示了如何在徽章中显示值,以响应用户操作。
@Composable fun BadgeInteractiveExample() { var itemCount by remember { mutableStateOf(0) } Column( verticalArrangement = Arrangement.spacedBy(16.dp) ) { BadgedBox( badge = { if (itemCount > 0) { Badge( containerColor = Color.Red, contentColor = Color.White ) { Text("$itemCount") } } } ) { Icon( imageVector = Icons.Filled.ShoppingCart, contentDescription = "Shopping cart", ) } Button(onClick = { itemCount++ }) { Text("Add item") } } }
此示例实现了一个购物车图标,其中包含一个显示用户购物车中商品数量的标记。
- 只有当项数超过 0 时,系统才会显示
BadgedBox
。 containerColor
和contentColor
的参数用于控制徽章的外观。Badge
内容槽的Text
可组合项会显示在徽章中。在本例中,它会显示购物车中的商品数量。
此实现如下所示: