| Item |
Rule |
| Location |
1 feature โ feature/<x>/impl/.../component/<screen>/, internal. 2+ features โ core/designsystem/.../component/, Routee prefix (modularization) |
| Name |
Figma name in PascalCase. Add the shape when it helps (Card, Chip, Bar). Use the Android term when Figma differs (modal โ Dialog), Figma name in the // comment |
| Fixed content |
Take values, not a slot, when Figma never changes the items |
| List parameter |
List. ImmutableList only for lists in UiState (ui-state) |
| Screen |
Route, Screen, events (screen) |
// feature_card_android โ Figma ์ด๋ฆ. designsystem์ ์ฃผ์, feature๋ KDoc ๊ดํธ
private val ItemSpacing = 4.dp // ํ ํฐ์ ์๋ ๊ฐ๋ง private ์์
/**
* ๊ธฐ๋ฅ ์นด๋
*
* @param title ์ ๋ชฉ
* @param value ํ๋ฉด์ ๋ณด์ผ ๋ฌธ์์ด (์: "15.53")
* @param onClick ํญ ์ ํธ์ถ
* @param badge ์ค๋ฅธ์ชฝ ๋ฑ์ง. null ์ด๋ฉด ์จ๊น
*/
@Composable
fun RouteeFeatureCard(
title: String, // ํ์ โ modifier โ ์ ํ โ content ์์
value: String,
onClick: () -> Unit,
modifier: Modifier = Modifier, // modifier๋ @param ์๋ต
badge: String? = null,
)
| KDoc |
Rule |
| Title |
Short noun phrase. Feature module: ์ค๋ช
(figma_name) |
| Behavior |
Aligned @param lines with short phrases (ํญ ์ ํธ์ถ, null ์ด๋ฉด ์จ๊น, true ์ด๋ฉด ~ ํ์) |
| Skip |
modifier, width/size notes (ํญ์ [modifier]๋ก ์ ํ๋ค) |
| Value |
Use |
| Color |
RouteeTheme.colors |
| Text style |
RouteeTheme.typography |
| Spacing |
RouteeTheme.spacing |
| Corner radius |
RouteeTheme.radius (Full for pills) |
| Icon size, Figma-only gap |
private val Xxx = 28.dp in the file |
| Drawable size mismatch |
Modifier.size(). Don't edit the drawable |
| Text |
Use |
Example |
| Must keep meaning, one line in a fixed cell |
RouteeAutoSizeText |
Numbers in a card, short labels |
| Must keep meaning, free height |
Text (wrap) |
Guide text, dialog body |
| Can be cut |
Text + maxLines = 1 + TextOverflow.Ellipsis |
Chip, button, address, tab |
RouteeAutoSizeText(text = value, style = RouteeTheme.typography.displaySb28) // ๋์น๋ฉด 12sp๊น์ง ์ค์. ์ปค์ง์ง๋ ์์
// 200% ๊ธ์์์ ๊ฒน์น๊ฑฐ๋ ์ฌ๋ผ์ง๋ ๊ฒ ์์ผ๋ฉด ํต๊ณผ
| Target |
Annotation |
| Component |
@PreviewFontSizes (default + 200% font) |
| Screen |
@PreviewDeviceSizes (phone, 200% font, short phone, foldable. No system bars) |
// ์ปดํฌ๋ํธ: @Preview ๋์ . ํฐํธ ํฌ๊ธฐ ํ์ธ์ฉ
@PreviewFontSizes
@Composable
private fun FeatureButtonPreview() {
RouteePreviewTheme {
Column { // ์ํ๊ฐ ์ฌ๋ฌ ๊ฐ๋ฉด ํ Preview์ ๋์ด
FeatureButton(isSelected = false, onClick = {})
FeatureButton(isSelected = true, onClick = {})
}
}
}
// ํ๋ฉด: Route๊ฐ ์๋ Screen์ ๋ฏธ๋ฆฌ๋ณด๊ธฐ. ํ์์ ์ฌ์ฉ
@PreviewDeviceSizes
@Composable
private fun FeatureScreenPreview() {
RouteePreviewTheme {
FeatureScreen(uiState = FeatureUiState())
}
}
| Item |
Rule |
| Function |
private, <Component>Preview, <Screen>Preview |
| Annotations |
core/designsystem/.../preview/ |
| Theme |
RouteeTheme, or RouteePreviewTheme when the app background helps |