Reference version

This documentation is available as Markdown for AI agents and LLMs. See the full Markdown index or append .md to any documentation URL.

徽章

一个用于显示状态指示器和计数的 Jetpack Compose 徽章组件。

Android
Included in Expo Go
Recommended version:
~57.0.0

Expo UI Badge 与官方 Jetpack Compose Badge API 保持一致。它会渲染为一个小的彩色指示点,或者显示诸如数量数字之类的内容。

显示图标上数量和圆点指示器的 Material 3 徽标

安装

Terminal
npx expo install @expo/ui

If you are installing this in an existing React Native app, make sure to install expo in your project.

用法

指示点

没有子元素的徽标会渲染为一个小圆点指示器。

BadgeDot.tsx
import { Host, Badge } from '@expo/ui/jetpack-compose'; export default function BadgeDot() { return ( <Host matchContents> <Badge /> </Host> ); }

带计数的徽标

传入一个 Text 子元素以显示数字或标签。

BadgeCount.tsx
import { Host, Badge, Text } from '@expo/ui/jetpack-compose'; export default function BadgeCount() { return ( <Host matchContents> <Badge containerColor="#EF5350" contentColor="#FFFFFF"> <Text>3</Text> </Badge> </Host> ); }

API

import { Badge } from '@expo/ui/jetpack-compose';

Component

Badge

Type: React.Element<BadgeProps>

A badge component matching Compose's Badge. Renders as a small colored indicator dot, or with content (for example, a count).

BadgeProps

children

Optional • Type: ReactNode

Optional content inside the badge (for example, a Text with a count). When omitted, renders as a small indicator dot.

containerColor

Optional • Type: ColorValue • Default: BadgeDefaults.containerColor

Background color of the badge.

contentColor

Optional • Type: ColorValue • Default: BadgeDefaults.contentColor

Content color inside the badge (text/icon tint).

modifiers

Optional • Type: ModifierConfig[]

Modifiers for the component.