아이콘이나 UI 요소에 붙여 표시되는 Push badge 컴포넌트입니다.
Dot, Text, MaxCount 타입 중 하나를 선택할 수 있으며, 위치·사이즈·색상·타이포그래피를 설정할 수 있습니다.
아바타 등 겹치는 배경에서 배지를 분리하는 outlineBorder(외곽 보더)와, 부착 위치를 미세 조정하는 inset 을 지원합니다.
다이나믹 타입(시스템 폰트 확대)은 핸드오프 기준에 맞춰 fontScale [MAX_FONT_SCALE] 까지만 반영합니다.
배지 높이는 고정값이 아니라 라인 높이 + 세로 패딩 으로 결정되므로 확대 배율에 따라 함께 커집니다.
// 임의 문자열WantedPushBadge(variant = PushBadgeVariant.Text, text ="N")// 개수(99 초과 시 "99+")WantedPushBadge(variant = PushBadgeVariant.MaxCount, text ="128")// -> "99+"// 아바타 위에 외곽 보더와 함께WantedPushBadge(size = PushBadgeSize.Medium, outlineBorder =true)
Parameters
이름
타입
설명
modifier
Modifier
배지의 배치·정렬 등에 사용되는 Modifier입니다.
variant
PushBadgeVariant
표시할 배지 타입입니다. Dot, Text, MaxCount 중 선택합니다.
size
PushBadgeSize
배지의 크기입니다. XSmall, Small, Medium 중 선택합니다.
position
PushBadgePosition
배지의 위치입니다. TopEnd 등 9가지 위치를 지원합니다.
text
String
Text·MaxCount 타입일 때 표시할 문자열입니다. MaxCount 는 이 값을 숫자로 해석합니다.
maxCount
Int
MaxCount 타입의 상한값입니다. text 를 숫자로 해석한 값이 이 값을 넘으면 "maxCount+"로 표기합니다. 기본값은 99입니다.
outlineBorder
Boolean
겹치는 배경에서 배지를 분리하는 외곽 보더 표시 여부입니다. 기본값은 false입니다.
outlineBorderColor
Color
외곽 보더 색상입니다. 기본값은 backgroundNeutralPrimary입니다.
background
Color
배지의 배경 색상입니다. 기본값은 surfaceBrandPrimary입니다.
contentColor
Color
텍스트 색상입니다. 기본값은 static_white입니다.
textStyle
TextStyle?
텍스트 타이포그래피 오버라이드입니다. null이면 사이즈별 기본값을 사용합니다.
inset
DpOffset
부착 위치 미세 조정값입니다. 값이 커질수록 대상 안쪽으로 이동하며, 기본값은 (0, 0)입니다.
Advanced
PushBadgeTypes
Push badge Type 클래스입니다.
이 클래스는 Push badge의 표시 유형, 크기, 위치를 정의하는 열거형 클래스들을 포함합니다.
PushBadgeMetrics
Push badge 의 사이즈별 치수 스펙입니다. (Figma 4.0.0 핸드오프 기준)
Properties
이름
타입
설명
dotSize
Dp
Dot 타입의 점 지름입니다.
dotOutlineBorderSize
Dp
Dot 타입에 outlineBorder 적용 시 외곽 보더 지름입니다.
textPaddingVertical
Dp
Text/MaxCount 배지의 상하 여백입니다. 라인 높이와 합쳐 배지 높이를 만듭니다.
textPaddingHorizontal
Dp
Text/MaxCount 배지의 좌우 여백입니다.
textOutlineBorderGap
Dp
Text/MaxCount 배지에 outlineBorder 적용 시 배지와 외곽 보더 사이 간격입니다.
Enum
PushBadgeVariant
값
설명
Dot
작은 점 형태의 배지를 표시합니다.
Text
임의의 문자열(숫자·"N" 등)을 그대로 표시합니다.
MaxCount
개수를 표시하되 maxCount 초과 시 "maxCount+"(예: 99+)로 표기합니다.