name: compose-agent description: "Helps AI coding assistants write modern Jetpack Compose: correct state, side effects, performance-aware modifiers, Navigation 3, coroutines on lifecycle, animations, UI tests, focus/keyboard navigation, Compose Multiplatform boundaries, idiomatic Kotlin, and well-shaped composable APIs. Targets the mistakes LLMs actually make in Compose code. Use when reading, writing, or reviewing Compose projects." license: MIT allowed-tools: Read, Glob, Grep, Edit, Write, Bash argument-hint: "[focus area, e.g. 'state', 'effects', 'navigation', 'lifecycle', 'animation', 'testing', 'focus', 'kmp']" metadata: author: Ivan Morgillo version: "4.1.2"
Compose Agent
Review, write, or modify Jetpack Compose code for correctness, modern API usage, and adherence to the official AndroidX guidelines. Report only genuine problems — do not nitpick or invent issues.
Target track (unless the repo says otherwise):
- Kotlin
2.0.20+with Compose Compiler1.5.4+(Strong Skipping Mode on by default). - Jetpack Compose BOM current, Material 3,
androidx.lifecyclewithcollectAsStateWithLifecycle(). - Navigation 3 (
androidx.navigation3) when the project can adopt it; otherwise Navigation 2.8+. - Coroutines + Flow as the async primitives. Do not reach for RxJava or blocking I/O.
If the repo pins older versions, match the repo — but call out what the modern path would look like in a one-line note.
Review Process
- Check for deprecated or soft-deprecated API using
references/api.md. - Validate state and data flow using
references/state.md. - Validate side-effect choice (
LaunchedEffect,DisposableEffect,produceState,snapshotFlow,rememberUpdatedState) usingreferences/effects.md. - Review composable performance — stability, lambda modifiers, lazy list keys, deferred reads — using
references/performance.md. - Review modifier usage — ordering, lambda-form,
Modifier.Nodeovercomposed { }— usingreferences/modifiers.md. - Review navigation using
references/navigation.md. - Review coroutines and lifecycle collection using
references/concurrency.md. - Review Flow operators and StateFlow / SharedFlow shape (
stateIn,shareIn,flatMapvariants,combine, error handling, backpressure,asStateFlow()) usingreferences/flows.md. - Review composable API shape (parameter order, slots, naming, defaults) using
references/component-api.md. - Review UI testing patterns using
references/testing.mdwhen tests, semantics, screenshots, previews, or fake UI dependencies are in scope. - Review focus and keyboard / D-pad navigation using
references/focus.mdwhen the UI uses focus APIs, keyboard input, TV, desktop, ChromeOS, or accessibility focus behavior. - Review Compose Multiplatform / KMP boundaries using
references/kmp.mdwhen common code,expect/actual, platform services, native views, or shared UI targets are in scope. - Review animation API choice and lifecycle — declarative vs imperative,
rememberedAnimatable, target-driven launches,springovertween, deferred animated reads,AnimatedContentkeys — usingreferences/animation.mdwhen anyanimate*,Animatable,Transition,AnimatedVisibility,AnimatedContent, or infinite-transition API is in scope. - Final Kotlin style pass using
references/kotlin.md.
If doing a partial review, load only the relevant reference files — each references file is designed to be read in isolation.
Core Instructions
- Keep composables side-effect free in composition. All I/O, state mutation outside remembered objects, analytics, etc. belong in
LaunchedEffect,DisposableEffect,produceState, the ViewModel, or — for event/gesture-driven work only —rememberCoroutineScope().launchinside a handler. Target-driven animation belongs inLaunchedEffector declarativeanimate*AsState/updateTransition, not inscope.launchfrom the composition body. Seereferences/animation.mdandreferences/effects.md. - Every composable that takes a
Modifiernames the parametermodifier, types itModifier = Modifier, and applies it to the outermost layout only. Never create amodifierparameter you do not forward. - Parameter order for a component: required data →
modifier: Modifier = Modifier→ other optional parameters with defaults → trailingcontent: @Composable () -> Unitslots last. Onemodifierparameter per component. - For stateful APIs, expose a stateless overload plus a stateful convenience that hoists
remember. Seereferences/component-api.md. - Collect Flows with
collectAsStateWithLifecycle()in UI code. PlaincollectAsState()keeps collecting when the screen is not visible and burns battery and bandwidth. - Prefer
rememberSaveableoverrememberfor UI state that should survive configuration change or process death, unless the value is unserializable or derivable. - Use the typed state factories (
mutableIntStateOf,mutableLongStateOf,mutableFloatStateOf,mutableDoubleStateOf) for primitive state. RawmutableStateOf<Int>(...)boxes. - Never put a lambda in a
CompositionLocal. Use explicit parameters. - Do not introduce third-party libraries without asking first. The Accompanist libraries covering pager, swipe-refresh, flow layout, and system UI controller are deprecated — the functionality is in AndroidX now (
HorizontalPager,PullToRefreshBox,FlowRow/FlowColumn,enableEdgeToEdge()). - When an element's background reads from
MaterialTheme.colorScheme.*(directly or via a blend), its text and icon colors must read from the same theming source. Hard-codedColor.Black/Color.White/ raw ARGB literals over theme-driven backgrounds are dark-mode regressions. Seereferences/component-api.md. - Animate declaratively first. Use
animate*AsStatefor single state-driven values andupdateTransitionfor synchronized ones; reach forAnimatableonly when you need imperative control (gesture, fling, sequence). AlwaysrememberanAnimatable, launch target-driven animations fromLaunchedEffect(neverscope.launchin composition to react to state), preferspring()overtweenfor interruptible motion, and read animated values in the layout/draw phase (lambda modifiers /graphicsLayer) so the animation does not recompose every frame. Seereferences/animation.md.
Output Format (review mode)
Organize findings by file. For each issue:
- State the file and relevant line(s).
- Name the rule being violated (e.g., "Use
collectAsStateWithLifecycle()instead ofcollectAsState()"). - Show a brief before/after code fix.
- Link the official source (
developer.android.com/...or AndroidX component guidelines).
Skip files with no issues. End with a prioritized summary — three items max, highest impact first.
Example Output
feature/profile/ProfileScreen.kt
Line 34: Use collectAsStateWithLifecycle() — UI Flows must stop collecting when the screen is not STARTED.
// Before
val user by viewModel.user.collectAsState()
// After
val user by viewModel.user.collectAsStateWithLifecycle()
https://developer.android.com/topic/architecture/ui-layer/state-production#continuous-vs-discrete
Line 58: Pass modifier to the outermost layout, not to inner content.
// Before
@Composable
fun UserCard(user: User, modifier: Modifier = Modifier) {
Column {
Text(user.name, modifier = modifier) // modifier swallowed here
Text(user.email)
}
}
// After
@Composable
fun UserCard(user: User, modifier: Modifier = Modifier) {
Column(modifier = modifier) {
Text(user.name)
Text(user.email)
}
}
https://developer.android.com/develop/ui/compose/api-guidelines#naming-modifiers
Line 72: Defer the animated offset read to the layout phase using the lambda form.
// Before
val dx by animateDpAsState(targetValue = if (expanded) 0.dp else (-200).dp, label = "drawerOffset")
Box(modifier = Modifier.offset(x = dx))
// After — layout-phase read, skips recomposition on every frame
val dx by animateDpAsState(targetValue = if (expanded) 0.dp else (-200).dp, label = "drawerOffset")
Box(modifier = Modifier.offset { IntOffset(dx.roundToPx(), 0) })
Summary
- Performance (high): Non-deferred animated reads on
ProfileScreen.kt:72,HomeScreen.kt:110,DetailScreen.kt:88recompose every frame. Switch to lambda-form modifiers. - Lifecycle (high): Three screens use
collectAsState()— replace withcollectAsStateWithLifecycle()to avoid collecting in the background. - API shape (medium):
UserCardswallows itsmodifierparameter. Forward it to the outermost layout.
End of example.
Authoring Mode
When the agent is writing new code rather than reviewing, the same rules apply as guardrails. Before generating a composable, silently check:
- Does it take
modifier: Modifier = Modifier? - Is state hoisted, or is there a clear reason to own it here?
- If it renders a list, does it use a stable
key =? - If it launches work, is that work in a
LaunchedEffect,produceState, or the ViewModel — not in the composition body? - If it collects a Flow, is it
collectAsStateWithLifecycle()? - Is the parameter order: data → modifier → other → content slot last?
- If it animates, is the API declarative first, remembered where needed, lifecycle-aware, and phase-correct?
- If it needs focus, testing, or platform-specific behavior, did you load the focused reference before judging?
If any answer is no and there is no deliberate reason, fix it before returning the code.
What This Skill Does Not Cover
Out of scope in v1 — delegate elsewhere or scope down explicitly:
- Material 3 compliance, theming, and design tokens — use the
material-3skill. - Scoring an existing codebase with numeric grades — use the sibling
jetpack-compose-auditskill in the same repo. - Wear OS / TV / Auto / Glance deep platform review — this skill now covers focus and keyboard/D-pad basics, but not full platform certification.
- Accessibility deep review — we flag obvious gaps (missing
contentDescription, icon-only buttons without labels, touch targets under 48dp) but do not grade.
If the user needs any of the above, narrow the scope and say so.
References
references/api.md— deprecated and soft-deprecated Compose APIs and their modern replacements.references/state.md— hoisting,remembervsrememberSaveable, ViewModel boundaries,derivedStateOf.references/effects.md—LaunchedEffect,DisposableEffect,SideEffect,produceState,snapshotFlow,rememberUpdatedState.references/performance.md— stability, Strong Skipping Mode, lambda modifiers, lazy keys, typed state factories, deferred reads.references/modifiers.md— modifier ordering, lambda form,Modifier.Nodeovercomposed { }.references/navigation.md— Navigation 3 (and what to replace from Navigation 2).references/concurrency.md— coroutines, Flow,collectAsStateWithLifecycle,repeatOnLifecycle, scope choice.references/flows.md— operator selection:StateFlowvsSharedFlowvs coldFlow,stateIn(WhileSubscribed),shareIn,flatMapvariants,combine/merge/zip, error handling, backpressure,asStateFlow()exposure.references/component-api.md— composable API guidelines: parameter order, slots, naming, defaults, state hoisting shape.references/testing.md— Compose UI tests, semantics assertions, screenshot tests, fake image/platform services, previews.references/focus.md—FocusRequester, focus restoration, keyboard / D-pad input, key handlers, and focus tests.references/kmp.md— Kotlin Multiplatform and Compose Multiplatform boundaries,expect/actual, interfaces, platform leaf composables.references/animation.md— animation API selection (animate*AsStatevsupdateTransitionvsAnimatable),remembered animation state, target-driven launches, gesture-drivensnapTo/animateDecay,spring/tween/keyframes, reduced motion, deferred animated reads,AnimatedContent/AnimatedVisibility,animateItem(), off-screen infinite transitions.references/kotlin.md— Kotlin coding conventions and Android Kotlin style the LLM keeps missing.
Primary Sources
Every rule in this skill traces back to one of:
https://developer.android.com/develop/ui/composeand its subpageshttps://developer.android.com/kotlin/style-guidehttps://kotlinlang.org/docs/coding-conventions.htmlhttps://www.jetbrains.com/help/kotlin-multiplatform-dev/https://android.googlesource.com/platform/frameworks/support/+/androidx-main/compose/docs/compose-api-guidelines.mdhttps://android.googlesource.com/platform/frameworks/support/+/androidx-main/compose/docs/compose-component-api-guidelines.md
When a supplemental source (blog post, conference talk) disagrees with these, the primary sources win.