agy-superpowers 5.0.8 → 5.0.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/template/agent/rules/superpowers.md +54 -0
- package/template/agent/skills/frontend-developer/SKILL.md +39 -0
- package/template/agent/skills/frontend-developer/references/react-nextjs.md +343 -0
- package/template/agent/skills/frontend-developer/references/react-rules/_sections.md +46 -0
- package/template/agent/skills/frontend-developer/references/react-rules/_template.md +28 -0
- package/template/agent/skills/frontend-developer/references/react-rules/advanced-event-handler-refs.md +55 -0
- package/template/agent/skills/frontend-developer/references/react-rules/advanced-init-once.md +42 -0
- package/template/agent/skills/frontend-developer/references/react-rules/advanced-use-latest.md +39 -0
- package/template/agent/skills/frontend-developer/references/react-rules/async-api-routes.md +38 -0
- package/template/agent/skills/frontend-developer/references/react-rules/async-defer-await.md +80 -0
- package/template/agent/skills/frontend-developer/references/react-rules/async-dependencies.md +51 -0
- package/template/agent/skills/frontend-developer/references/react-rules/async-parallel.md +28 -0
- package/template/agent/skills/frontend-developer/references/react-rules/async-suspense-boundaries.md +99 -0
- package/template/agent/skills/frontend-developer/references/react-rules/bundle-barrel-imports.md +59 -0
- package/template/agent/skills/frontend-developer/references/react-rules/bundle-conditional.md +31 -0
- package/template/agent/skills/frontend-developer/references/react-rules/bundle-defer-third-party.md +49 -0
- package/template/agent/skills/frontend-developer/references/react-rules/bundle-dynamic-imports.md +35 -0
- package/template/agent/skills/frontend-developer/references/react-rules/bundle-preload.md +50 -0
- package/template/agent/skills/frontend-developer/references/react-rules/client-event-listeners.md +74 -0
- package/template/agent/skills/frontend-developer/references/react-rules/client-localstorage-schema.md +71 -0
- package/template/agent/skills/frontend-developer/references/react-rules/client-passive-event-listeners.md +48 -0
- package/template/agent/skills/frontend-developer/references/react-rules/client-swr-dedup.md +56 -0
- package/template/agent/skills/frontend-developer/references/react-rules/js-batch-dom-css.md +107 -0
- package/template/agent/skills/frontend-developer/references/react-rules/js-cache-function-results.md +80 -0
- package/template/agent/skills/frontend-developer/references/react-rules/js-cache-property-access.md +28 -0
- package/template/agent/skills/frontend-developer/references/react-rules/js-cache-storage.md +70 -0
- package/template/agent/skills/frontend-developer/references/react-rules/js-combine-iterations.md +32 -0
- package/template/agent/skills/frontend-developer/references/react-rules/js-early-exit.md +50 -0
- package/template/agent/skills/frontend-developer/references/react-rules/js-flatmap-filter.md +60 -0
- package/template/agent/skills/frontend-developer/references/react-rules/js-hoist-regexp.md +45 -0
- package/template/agent/skills/frontend-developer/references/react-rules/js-index-maps.md +37 -0
- package/template/agent/skills/frontend-developer/references/react-rules/js-length-check-first.md +49 -0
- package/template/agent/skills/frontend-developer/references/react-rules/js-min-max-loop.md +82 -0
- package/template/agent/skills/frontend-developer/references/react-rules/js-set-map-lookups.md +24 -0
- package/template/agent/skills/frontend-developer/references/react-rules/js-tosorted-immutable.md +57 -0
- package/template/agent/skills/frontend-developer/references/react-rules/rendering-activity.md +26 -0
- package/template/agent/skills/frontend-developer/references/react-rules/rendering-animate-svg-wrapper.md +47 -0
- package/template/agent/skills/frontend-developer/references/react-rules/rendering-conditional-render.md +40 -0
- package/template/agent/skills/frontend-developer/references/react-rules/rendering-content-visibility.md +38 -0
- package/template/agent/skills/frontend-developer/references/react-rules/rendering-hoist-jsx.md +46 -0
- package/template/agent/skills/frontend-developer/references/react-rules/rendering-hydration-no-flicker.md +82 -0
- package/template/agent/skills/frontend-developer/references/react-rules/rendering-hydration-suppress-warning.md +30 -0
- package/template/agent/skills/frontend-developer/references/react-rules/rendering-resource-hints.md +85 -0
- package/template/agent/skills/frontend-developer/references/react-rules/rendering-script-defer-async.md +68 -0
- package/template/agent/skills/frontend-developer/references/react-rules/rendering-svg-precision.md +28 -0
- package/template/agent/skills/frontend-developer/references/react-rules/rendering-usetransition-loading.md +75 -0
- package/template/agent/skills/frontend-developer/references/react-rules/rerender-defer-reads.md +39 -0
- package/template/agent/skills/frontend-developer/references/react-rules/rerender-dependencies.md +45 -0
- package/template/agent/skills/frontend-developer/references/react-rules/rerender-derived-state-no-effect.md +40 -0
- package/template/agent/skills/frontend-developer/references/react-rules/rerender-derived-state.md +29 -0
- package/template/agent/skills/frontend-developer/references/react-rules/rerender-functional-setstate.md +74 -0
- package/template/agent/skills/frontend-developer/references/react-rules/rerender-lazy-state-init.md +58 -0
- package/template/agent/skills/frontend-developer/references/react-rules/rerender-memo-with-default-value.md +38 -0
- package/template/agent/skills/frontend-developer/references/react-rules/rerender-memo.md +44 -0
- package/template/agent/skills/frontend-developer/references/react-rules/rerender-move-effect-to-event.md +45 -0
- package/template/agent/skills/frontend-developer/references/react-rules/rerender-no-inline-components.md +82 -0
- package/template/agent/skills/frontend-developer/references/react-rules/rerender-simple-expression-in-memo.md +35 -0
- package/template/agent/skills/frontend-developer/references/react-rules/rerender-split-combined-hooks.md +64 -0
- package/template/agent/skills/frontend-developer/references/react-rules/rerender-transitions.md +40 -0
- package/template/agent/skills/frontend-developer/references/react-rules/rerender-use-deferred-value.md +59 -0
- package/template/agent/skills/frontend-developer/references/react-rules/rerender-use-ref-transient-values.md +73 -0
- package/template/agent/skills/frontend-developer/references/react-rules/server-after-nonblocking.md +73 -0
- package/template/agent/skills/frontend-developer/references/react-rules/server-auth-actions.md +96 -0
- package/template/agent/skills/frontend-developer/references/react-rules/server-cache-lru.md +41 -0
- package/template/agent/skills/frontend-developer/references/react-rules/server-cache-react.md +76 -0
- package/template/agent/skills/frontend-developer/references/react-rules/server-dedup-props.md +65 -0
- package/template/agent/skills/frontend-developer/references/react-rules/server-hoist-static-io.md +142 -0
- package/template/agent/skills/frontend-developer/references/react-rules/server-parallel-fetching.md +83 -0
- package/template/agent/skills/frontend-developer/references/react-rules/server-serialization.md +38 -0
- package/template/agent/skills/frontend-developer/references/svelte-sveltekit.md +220 -0
- package/template/agent/skills/frontend-developer/references/vanilla.md +275 -0
- package/template/agent/skills/frontend-developer/references/vue-nuxt.md +289 -0
- package/template/agent/skills/frontend-developer/references/vue-rules/best-practices/_index.md +154 -0
- package/template/agent/skills/frontend-developer/references/vue-rules/best-practices/animation-class-based-technique.md +254 -0
- package/template/agent/skills/frontend-developer/references/vue-rules/best-practices/animation-state-driven-technique.md +291 -0
- package/template/agent/skills/frontend-developer/references/vue-rules/best-practices/component-async.md +97 -0
- package/template/agent/skills/frontend-developer/references/vue-rules/best-practices/component-data-flow.md +307 -0
- package/template/agent/skills/frontend-developer/references/vue-rules/best-practices/component-fallthrough-attrs.md +174 -0
- package/template/agent/skills/frontend-developer/references/vue-rules/best-practices/component-keep-alive.md +137 -0
- package/template/agent/skills/frontend-developer/references/vue-rules/best-practices/component-slots.md +216 -0
- package/template/agent/skills/frontend-developer/references/vue-rules/best-practices/component-suspense.md +228 -0
- package/template/agent/skills/frontend-developer/references/vue-rules/best-practices/component-teleport.md +108 -0
- package/template/agent/skills/frontend-developer/references/vue-rules/best-practices/component-transition-group.md +128 -0
- package/template/agent/skills/frontend-developer/references/vue-rules/best-practices/component-transition.md +125 -0
- package/template/agent/skills/frontend-developer/references/vue-rules/best-practices/composables.md +290 -0
- package/template/agent/skills/frontend-developer/references/vue-rules/best-practices/directives.md +162 -0
- package/template/agent/skills/frontend-developer/references/vue-rules/best-practices/perf-avoid-component-abstraction-in-lists.md +159 -0
- package/template/agent/skills/frontend-developer/references/vue-rules/best-practices/perf-v-once-v-memo-directives.md +182 -0
- package/template/agent/skills/frontend-developer/references/vue-rules/best-practices/perf-virtualize-large-lists.md +187 -0
- package/template/agent/skills/frontend-developer/references/vue-rules/best-practices/plugins.md +166 -0
- package/template/agent/skills/frontend-developer/references/vue-rules/best-practices/reactivity.md +344 -0
- package/template/agent/skills/frontend-developer/references/vue-rules/best-practices/render-functions.md +201 -0
- package/template/agent/skills/frontend-developer/references/vue-rules/best-practices/sfc.md +310 -0
- package/template/agent/skills/frontend-developer/references/vue-rules/best-practices/state-management.md +135 -0
- package/template/agent/skills/frontend-developer/references/vue-rules/best-practices/updated-hook-performance.md +187 -0
- package/template/agent/skills/frontend-developer/references/vue-rules/router/_index.md +23 -0
- package/template/agent/skills/frontend-developer/references/vue-rules/router/router-beforeenter-no-param-trigger.md +167 -0
- package/template/agent/skills/frontend-developer/references/vue-rules/router/router-beforerouteenter-no-this.md +176 -0
- package/template/agent/skills/frontend-developer/references/vue-rules/router/router-guard-async-await-pattern.md +227 -0
- package/template/agent/skills/frontend-developer/references/vue-rules/router/router-navigation-guard-infinite-loop.md +187 -0
- package/template/agent/skills/frontend-developer/references/vue-rules/router/router-navigation-guard-next-deprecated.md +150 -0
- package/template/agent/skills/frontend-developer/references/vue-rules/router/router-param-change-no-lifecycle.md +181 -0
- package/template/agent/skills/frontend-developer/references/vue-rules/router/router-simple-routing-cleanup.md +209 -0
- package/template/agent/skills/frontend-developer/references/vue-rules/router/router-use-vue-router-for-production.md +183 -0
- package/template/agent/skills/frontend-developer/references/vue-rules/testing/_index.md +29 -0
- package/template/agent/skills/frontend-developer/references/vue-rules/testing/async-component-testing.md +163 -0
- package/template/agent/skills/frontend-developer/references/vue-rules/testing/teleport-testing-complexity.md +158 -0
- package/template/agent/skills/frontend-developer/references/vue-rules/testing/testing-async-await-flushpromises.md +175 -0
- package/template/agent/skills/frontend-developer/references/vue-rules/testing/testing-browser-vs-node-runners.md +208 -0
- package/template/agent/skills/frontend-developer/references/vue-rules/testing/testing-component-blackbox-approach.md +144 -0
- package/template/agent/skills/frontend-developer/references/vue-rules/testing/testing-composables-helper-wrapper.md +238 -0
- package/template/agent/skills/frontend-developer/references/vue-rules/testing/testing-e2e-playwright-recommended.md +242 -0
- package/template/agent/skills/frontend-developer/references/vue-rules/testing/testing-no-snapshot-only.md +197 -0
- package/template/agent/skills/frontend-developer/references/vue-rules/testing/testing-pinia-store-setup.md +228 -0
- package/template/agent/skills/frontend-developer/references/vue-rules/testing/testing-suspense-async-components.md +229 -0
- package/template/agent/skills/frontend-developer/references/vue-rules/testing/testing-vitest-recommended-for-vue.md +204 -0
- package/template/agent/skills/mobile-developer/SKILL.md +52 -0
- package/template/agent/skills/mobile-developer/references/android-native.md +396 -0
- package/template/agent/skills/mobile-developer/references/android-rules/android-accessibility.md +36 -0
- package/template/agent/skills/mobile-developer/references/android-rules/android-architecture.md +52 -0
- package/template/agent/skills/mobile-developer/references/android-rules/android-coroutines.md +139 -0
- package/template/agent/skills/mobile-developer/references/android-rules/android-data-layer.md +51 -0
- package/template/agent/skills/mobile-developer/references/android-rules/android-emulator-skill.md +108 -0
- package/template/agent/skills/mobile-developer/references/android-rules/android-gradle-logic.md +126 -0
- package/template/agent/skills/mobile-developer/references/android-rules/android-retrofit.md +142 -0
- package/template/agent/skills/mobile-developer/references/android-rules/android-testing.md +102 -0
- package/template/agent/skills/mobile-developer/references/android-rules/android-viewmodel.md +43 -0
- package/template/agent/skills/mobile-developer/references/android-rules/coil-compose.md +74 -0
- package/template/agent/skills/mobile-developer/references/android-rules/compose-navigation.md +422 -0
- package/template/agent/skills/mobile-developer/references/android-rules/compose-performance-audit.md +199 -0
- package/template/agent/skills/mobile-developer/references/android-rules/compose-ui.md +49 -0
- package/template/agent/skills/mobile-developer/references/android-rules/gradle-build-performance.md +346 -0
- package/template/agent/skills/mobile-developer/references/android-rules/kotlin-concurrency-expert.md +169 -0
- package/template/agent/skills/mobile-developer/references/android-rules/rxjava-to-coroutines-migration.md +101 -0
- package/template/agent/skills/mobile-developer/references/android-rules/xml-to-compose-migration.md +338 -0
- package/template/agent/skills/mobile-developer/references/flutter-rules/dart-best-practices.md +52 -0
- package/template/agent/skills/mobile-developer/references/flutter-rules/dart-checks-migration.md +134 -0
- package/template/agent/skills/mobile-developer/references/flutter-rules/dart-cli-app-best-practices.md +123 -0
- package/template/agent/skills/mobile-developer/references/flutter-rules/dart-doc-validation.md +45 -0
- package/template/agent/skills/mobile-developer/references/flutter-rules/dart-matcher-best-practices.md +106 -0
- package/template/agent/skills/mobile-developer/references/flutter-rules/dart-modern-features.md +241 -0
- package/template/agent/skills/mobile-developer/references/flutter-rules/dart-package-maintenance.md +75 -0
- package/template/agent/skills/mobile-developer/references/flutter-rules/dart-test-fundamentals.md +124 -0
- package/template/agent/skills/mobile-developer/references/flutter.md +291 -0
- package/template/agent/skills/mobile-developer/references/ios-native.md +358 -0
- package/template/agent/skills/mobile-developer/references/ios-rules/accessibility-patterns.md +215 -0
- package/template/agent/skills/mobile-developer/references/ios-rules/animation-advanced.md +403 -0
- package/template/agent/skills/mobile-developer/references/ios-rules/animation-basics.md +284 -0
- package/template/agent/skills/mobile-developer/references/ios-rules/animation-transitions.md +326 -0
- package/template/agent/skills/mobile-developer/references/ios-rules/charts-accessibility.md +135 -0
- package/template/agent/skills/mobile-developer/references/ios-rules/charts.md +602 -0
- package/template/agent/skills/mobile-developer/references/ios-rules/image-optimization.md +203 -0
- package/template/agent/skills/mobile-developer/references/ios-rules/latest-apis.md +464 -0
- package/template/agent/skills/mobile-developer/references/ios-rules/layout-best-practices.md +266 -0
- package/template/agent/skills/mobile-developer/references/ios-rules/liquid-glass.md +416 -0
- package/template/agent/skills/mobile-developer/references/ios-rules/list-patterns.md +394 -0
- package/template/agent/skills/mobile-developer/references/ios-rules/macos-scenes.md +318 -0
- package/template/agent/skills/mobile-developer/references/ios-rules/macos-views.md +357 -0
- package/template/agent/skills/mobile-developer/references/ios-rules/macos-window-styling.md +303 -0
- package/template/agent/skills/mobile-developer/references/ios-rules/performance-patterns.md +403 -0
- package/template/agent/skills/mobile-developer/references/ios-rules/scroll-patterns.md +293 -0
- package/template/agent/skills/mobile-developer/references/ios-rules/sheet-navigation-patterns.md +363 -0
- package/template/agent/skills/mobile-developer/references/ios-rules/state-management.md +417 -0
- package/template/agent/skills/mobile-developer/references/ios-rules/view-structure.md +389 -0
- package/template/agent/skills/mobile-developer/references/react-native-rules/_sections.md +86 -0
- package/template/agent/skills/mobile-developer/references/react-native-rules/_template.md +28 -0
- package/template/agent/skills/mobile-developer/references/react-native-rules/animation-derived-value.md +53 -0
- package/template/agent/skills/mobile-developer/references/react-native-rules/animation-gesture-detector-press.md +95 -0
- package/template/agent/skills/mobile-developer/references/react-native-rules/animation-gpu-properties.md +65 -0
- package/template/agent/skills/mobile-developer/references/react-native-rules/design-system-compound-components.md +66 -0
- package/template/agent/skills/mobile-developer/references/react-native-rules/fonts-config-plugin.md +71 -0
- package/template/agent/skills/mobile-developer/references/react-native-rules/imports-design-system-folder.md +68 -0
- package/template/agent/skills/mobile-developer/references/react-native-rules/js-hoist-intl.md +61 -0
- package/template/agent/skills/mobile-developer/references/react-native-rules/list-performance-callbacks.md +44 -0
- package/template/agent/skills/mobile-developer/references/react-native-rules/list-performance-function-references.md +132 -0
- package/template/agent/skills/mobile-developer/references/react-native-rules/list-performance-images.md +53 -0
- package/template/agent/skills/mobile-developer/references/react-native-rules/list-performance-inline-objects.md +97 -0
- package/template/agent/skills/mobile-developer/references/react-native-rules/list-performance-item-expensive.md +94 -0
- package/template/agent/skills/mobile-developer/references/react-native-rules/list-performance-item-memo.md +82 -0
- package/template/agent/skills/mobile-developer/references/react-native-rules/list-performance-item-types.md +104 -0
- package/template/agent/skills/mobile-developer/references/react-native-rules/list-performance-virtualize.md +67 -0
- package/template/agent/skills/mobile-developer/references/react-native-rules/monorepo-native-deps-in-app.md +46 -0
- package/template/agent/skills/mobile-developer/references/react-native-rules/monorepo-single-dependency-versions.md +63 -0
- package/template/agent/skills/mobile-developer/references/react-native-rules/navigation-native-navigators.md +188 -0
- package/template/agent/skills/mobile-developer/references/react-native-rules/react-compiler-destructure-functions.md +50 -0
- package/template/agent/skills/mobile-developer/references/react-native-rules/react-compiler-reanimated-shared-values.md +48 -0
- package/template/agent/skills/mobile-developer/references/react-native-rules/react-state-dispatcher.md +91 -0
- package/template/agent/skills/mobile-developer/references/react-native-rules/react-state-fallback.md +56 -0
- package/template/agent/skills/mobile-developer/references/react-native-rules/react-state-minimize.md +65 -0
- package/template/agent/skills/mobile-developer/references/react-native-rules/rendering-no-falsy-and.md +74 -0
- package/template/agent/skills/mobile-developer/references/react-native-rules/rendering-text-in-text-component.md +36 -0
- package/template/agent/skills/mobile-developer/references/react-native-rules/scroll-position-no-state.md +82 -0
- package/template/agent/skills/mobile-developer/references/react-native-rules/state-ground-truth.md +80 -0
- package/template/agent/skills/mobile-developer/references/react-native-rules/ui-expo-image.md +66 -0
- package/template/agent/skills/mobile-developer/references/react-native-rules/ui-image-gallery.md +104 -0
- package/template/agent/skills/mobile-developer/references/react-native-rules/ui-measure-views.md +78 -0
- package/template/agent/skills/mobile-developer/references/react-native-rules/ui-menus.md +174 -0
- package/template/agent/skills/mobile-developer/references/react-native-rules/ui-native-modals.md +77 -0
- package/template/agent/skills/mobile-developer/references/react-native-rules/ui-pressable.md +61 -0
- package/template/agent/skills/mobile-developer/references/react-native-rules/ui-safe-area-scroll.md +65 -0
- package/template/agent/skills/mobile-developer/references/react-native-rules/ui-scrollview-content-inset.md +45 -0
- package/template/agent/skills/mobile-developer/references/react-native-rules/ui-styling.md +87 -0
- package/template/agent/skills/mobile-developer/references/react-native.md +345 -0
|
@@ -0,0 +1,422 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: compose-navigation
|
|
3
|
+
description: Implement navigation in Jetpack Compose using Navigation Compose. Use when asked to set up navigation, pass arguments between screens, handle deep links, or structure multi-screen apps.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Compose Navigation
|
|
7
|
+
|
|
8
|
+
## Overview
|
|
9
|
+
|
|
10
|
+
Implement type-safe navigation in Jetpack Compose applications using the Navigation Compose library. This skill covers NavHost setup, argument passing, deep links, nested graphs, adaptive navigation, and testing.
|
|
11
|
+
|
|
12
|
+
## Setup
|
|
13
|
+
|
|
14
|
+
Add the Navigation Compose dependency:
|
|
15
|
+
|
|
16
|
+
```kotlin
|
|
17
|
+
// build.gradle.kts
|
|
18
|
+
dependencies {
|
|
19
|
+
implementation("androidx.navigation:navigation-compose:2.8.5")
|
|
20
|
+
|
|
21
|
+
// For type-safe navigation (recommended)
|
|
22
|
+
implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.7.3")
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
// Enable serialization plugin
|
|
26
|
+
plugins {
|
|
27
|
+
kotlin("plugin.serialization") version "2.0.21"
|
|
28
|
+
}
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
---
|
|
32
|
+
|
|
33
|
+
## Core Concepts
|
|
34
|
+
|
|
35
|
+
### 1. Define Routes (Type-Safe)
|
|
36
|
+
|
|
37
|
+
Use `@Serializable` data classes/objects for type-safe routes:
|
|
38
|
+
|
|
39
|
+
```kotlin
|
|
40
|
+
import kotlinx.serialization.Serializable
|
|
41
|
+
|
|
42
|
+
// Simple screen (no arguments)
|
|
43
|
+
@Serializable
|
|
44
|
+
object Home
|
|
45
|
+
|
|
46
|
+
// Screen with required argument
|
|
47
|
+
@Serializable
|
|
48
|
+
data class Profile(val userId: String)
|
|
49
|
+
|
|
50
|
+
// Screen with optional argument
|
|
51
|
+
@Serializable
|
|
52
|
+
data class Settings(val section: String? = null)
|
|
53
|
+
|
|
54
|
+
// Screen with multiple arguments
|
|
55
|
+
@Serializable
|
|
56
|
+
data class ProductDetail(val productId: String, val showReviews: Boolean = false)
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
### 2. Create NavController
|
|
60
|
+
|
|
61
|
+
```kotlin
|
|
62
|
+
@Composable
|
|
63
|
+
fun MyApp() {
|
|
64
|
+
val navController = rememberNavController()
|
|
65
|
+
|
|
66
|
+
AppNavHost(navController = navController)
|
|
67
|
+
}
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
### 3. Create NavHost
|
|
71
|
+
|
|
72
|
+
```kotlin
|
|
73
|
+
@Composable
|
|
74
|
+
fun AppNavHost(
|
|
75
|
+
navController: NavHostController,
|
|
76
|
+
modifier: Modifier = Modifier
|
|
77
|
+
) {
|
|
78
|
+
NavHost(
|
|
79
|
+
navController = navController,
|
|
80
|
+
startDestination = Home,
|
|
81
|
+
modifier = modifier
|
|
82
|
+
) {
|
|
83
|
+
composable<Home> {
|
|
84
|
+
HomeScreen(
|
|
85
|
+
onNavigateToProfile = { userId ->
|
|
86
|
+
navController.navigate(Profile(userId))
|
|
87
|
+
}
|
|
88
|
+
)
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
composable<Profile> { backStackEntry ->
|
|
92
|
+
val profile: Profile = backStackEntry.toRoute()
|
|
93
|
+
ProfileScreen(userId = profile.userId)
|
|
94
|
+
}
|
|
95
|
+
|
|
96
|
+
composable<Settings> { backStackEntry ->
|
|
97
|
+
val settings: Settings = backStackEntry.toRoute()
|
|
98
|
+
SettingsScreen(section = settings.section)
|
|
99
|
+
}
|
|
100
|
+
}
|
|
101
|
+
}
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
---
|
|
105
|
+
|
|
106
|
+
## Navigation Patterns
|
|
107
|
+
|
|
108
|
+
### Basic Navigation
|
|
109
|
+
|
|
110
|
+
```kotlin
|
|
111
|
+
// Navigate forward
|
|
112
|
+
navController.navigate(Profile(userId = "user123"))
|
|
113
|
+
|
|
114
|
+
// Navigate and pop current screen
|
|
115
|
+
navController.navigate(Home) {
|
|
116
|
+
popUpTo<Home> { inclusive = true }
|
|
117
|
+
}
|
|
118
|
+
|
|
119
|
+
// Navigate back
|
|
120
|
+
navController.popBackStack()
|
|
121
|
+
|
|
122
|
+
// Navigate back to specific destination
|
|
123
|
+
navController.popBackStack<Home>(inclusive = false)
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
### Navigate with Options
|
|
127
|
+
|
|
128
|
+
```kotlin
|
|
129
|
+
navController.navigate(Profile(userId = "user123")) {
|
|
130
|
+
// Pop up to destination (clear back stack)
|
|
131
|
+
popUpTo<Home> {
|
|
132
|
+
inclusive = false // Keep Home in stack
|
|
133
|
+
saveState = true // Save state of popped screens
|
|
134
|
+
}
|
|
135
|
+
|
|
136
|
+
// Avoid multiple copies of same destination
|
|
137
|
+
launchSingleTop = true
|
|
138
|
+
|
|
139
|
+
// Restore state when navigating to this destination
|
|
140
|
+
restoreState = true
|
|
141
|
+
}
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
### Bottom Navigation Pattern
|
|
145
|
+
|
|
146
|
+
```kotlin
|
|
147
|
+
@Composable
|
|
148
|
+
fun MainScreen() {
|
|
149
|
+
val navController = rememberNavController()
|
|
150
|
+
|
|
151
|
+
Scaffold(
|
|
152
|
+
bottomBar = {
|
|
153
|
+
NavigationBar {
|
|
154
|
+
val navBackStackEntry by navController.currentBackStackEntryAsState()
|
|
155
|
+
val currentDestination = navBackStackEntry?.destination
|
|
156
|
+
|
|
157
|
+
NavigationBarItem(
|
|
158
|
+
icon = { Icon(Icons.Default.Home, contentDescription = "Home") },
|
|
159
|
+
label = { Text("Home") },
|
|
160
|
+
selected = currentDestination?.hasRoute<Home>() == true,
|
|
161
|
+
onClick = {
|
|
162
|
+
navController.navigate(Home) {
|
|
163
|
+
popUpTo(navController.graph.findStartDestination().id) {
|
|
164
|
+
saveState = true
|
|
165
|
+
}
|
|
166
|
+
launchSingleTop = true
|
|
167
|
+
restoreState = true
|
|
168
|
+
}
|
|
169
|
+
}
|
|
170
|
+
)
|
|
171
|
+
// Add more items...
|
|
172
|
+
}
|
|
173
|
+
}
|
|
174
|
+
) { innerPadding ->
|
|
175
|
+
AppNavHost(
|
|
176
|
+
navController = navController,
|
|
177
|
+
modifier = Modifier.padding(innerPadding)
|
|
178
|
+
)
|
|
179
|
+
}
|
|
180
|
+
}
|
|
181
|
+
```
|
|
182
|
+
|
|
183
|
+
---
|
|
184
|
+
|
|
185
|
+
## Argument Handling
|
|
186
|
+
|
|
187
|
+
### Retrieve Arguments in Composable
|
|
188
|
+
|
|
189
|
+
```kotlin
|
|
190
|
+
composable<Profile> { backStackEntry ->
|
|
191
|
+
val profile: Profile = backStackEntry.toRoute()
|
|
192
|
+
ProfileScreen(userId = profile.userId)
|
|
193
|
+
}
|
|
194
|
+
```
|
|
195
|
+
|
|
196
|
+
### Retrieve Arguments in ViewModel
|
|
197
|
+
|
|
198
|
+
```kotlin
|
|
199
|
+
@HiltViewModel
|
|
200
|
+
class ProfileViewModel @Inject constructor(
|
|
201
|
+
savedStateHandle: SavedStateHandle,
|
|
202
|
+
private val userRepository: UserRepository
|
|
203
|
+
) : ViewModel() {
|
|
204
|
+
|
|
205
|
+
private val profile: Profile = savedStateHandle.toRoute<Profile>()
|
|
206
|
+
|
|
207
|
+
val user: StateFlow<User?> = userRepository
|
|
208
|
+
.getUser(profile.userId)
|
|
209
|
+
.stateIn(viewModelScope, SharingStarted.WhileSubscribed(5000), null)
|
|
210
|
+
}
|
|
211
|
+
```
|
|
212
|
+
|
|
213
|
+
### Complex Data: Pass IDs, Not Objects
|
|
214
|
+
|
|
215
|
+
```kotlin
|
|
216
|
+
// CORRECT: Pass only the ID
|
|
217
|
+
navController.navigate(Profile(userId = "user123"))
|
|
218
|
+
|
|
219
|
+
// In ViewModel, fetch from repository
|
|
220
|
+
class ProfileViewModel(savedStateHandle: SavedStateHandle) : ViewModel() {
|
|
221
|
+
private val profile = savedStateHandle.toRoute<Profile>()
|
|
222
|
+
val user = userRepository.getUser(profile.userId)
|
|
223
|
+
}
|
|
224
|
+
|
|
225
|
+
// INCORRECT: Don't pass complex objects
|
|
226
|
+
// navController.navigate(Profile(user = complexUserObject)) // BAD!
|
|
227
|
+
```
|
|
228
|
+
|
|
229
|
+
---
|
|
230
|
+
|
|
231
|
+
## Deep Links
|
|
232
|
+
|
|
233
|
+
### Define Deep Links
|
|
234
|
+
|
|
235
|
+
```kotlin
|
|
236
|
+
@Serializable
|
|
237
|
+
data class Profile(val userId: String)
|
|
238
|
+
|
|
239
|
+
composable<Profile>(
|
|
240
|
+
deepLinks = listOf(
|
|
241
|
+
navDeepLink<Profile>(basePath = "https://example.com/profile")
|
|
242
|
+
)
|
|
243
|
+
) { backStackEntry ->
|
|
244
|
+
val profile: Profile = backStackEntry.toRoute()
|
|
245
|
+
ProfileScreen(userId = profile.userId)
|
|
246
|
+
}
|
|
247
|
+
```
|
|
248
|
+
|
|
249
|
+
### Manifest Configuration
|
|
250
|
+
|
|
251
|
+
```xml
|
|
252
|
+
<activity android:name=".MainActivity">
|
|
253
|
+
<intent-filter>
|
|
254
|
+
<action android:name="android.intent.action.VIEW" />
|
|
255
|
+
<category android:name="android.intent.category.DEFAULT" />
|
|
256
|
+
<category android:name="android.intent.category.BROWSABLE" />
|
|
257
|
+
<data android:scheme="https" android:host="example.com" />
|
|
258
|
+
</intent-filter>
|
|
259
|
+
</activity>
|
|
260
|
+
```
|
|
261
|
+
|
|
262
|
+
### Create PendingIntent for Notifications
|
|
263
|
+
|
|
264
|
+
```kotlin
|
|
265
|
+
val context = LocalContext.current
|
|
266
|
+
val deepLinkIntent = Intent(
|
|
267
|
+
Intent.ACTION_VIEW,
|
|
268
|
+
"https://example.com/profile/user123".toUri(),
|
|
269
|
+
context,
|
|
270
|
+
MainActivity::class.java
|
|
271
|
+
)
|
|
272
|
+
|
|
273
|
+
val pendingIntent = TaskStackBuilder.create(context).run {
|
|
274
|
+
addNextIntentWithParentStack(deepLinkIntent)
|
|
275
|
+
getPendingIntent(0, PendingIntent.FLAG_UPDATE_CURRENT or PendingIntent.FLAG_IMMUTABLE)
|
|
276
|
+
}
|
|
277
|
+
```
|
|
278
|
+
|
|
279
|
+
---
|
|
280
|
+
|
|
281
|
+
## Nested Navigation
|
|
282
|
+
|
|
283
|
+
### Create Nested Graph
|
|
284
|
+
|
|
285
|
+
```kotlin
|
|
286
|
+
NavHost(navController = navController, startDestination = Home) {
|
|
287
|
+
composable<Home> { HomeScreen() }
|
|
288
|
+
|
|
289
|
+
// Nested graph for authentication flow
|
|
290
|
+
navigation<AuthGraph>(startDestination = Login) {
|
|
291
|
+
composable<Login> {
|
|
292
|
+
LoginScreen(
|
|
293
|
+
onLoginSuccess = {
|
|
294
|
+
navController.navigate(Home) {
|
|
295
|
+
popUpTo<AuthGraph> { inclusive = true }
|
|
296
|
+
}
|
|
297
|
+
}
|
|
298
|
+
)
|
|
299
|
+
}
|
|
300
|
+
composable<Register> { RegisterScreen() }
|
|
301
|
+
composable<ForgotPassword> { ForgotPasswordScreen() }
|
|
302
|
+
}
|
|
303
|
+
}
|
|
304
|
+
|
|
305
|
+
// Route definitions
|
|
306
|
+
@Serializable object AuthGraph
|
|
307
|
+
@Serializable object Login
|
|
308
|
+
@Serializable object Register
|
|
309
|
+
@Serializable object ForgotPassword
|
|
310
|
+
```
|
|
311
|
+
|
|
312
|
+
---
|
|
313
|
+
|
|
314
|
+
## Adaptive Navigation
|
|
315
|
+
|
|
316
|
+
Use `NavigationSuiteScaffold` for responsive navigation (bottom bar on phones, rail on tablets):
|
|
317
|
+
|
|
318
|
+
```kotlin
|
|
319
|
+
@Composable
|
|
320
|
+
fun AdaptiveApp() {
|
|
321
|
+
val navController = rememberNavController()
|
|
322
|
+
val navBackStackEntry by navController.currentBackStackEntryAsState()
|
|
323
|
+
val currentDestination = navBackStackEntry?.destination
|
|
324
|
+
|
|
325
|
+
NavigationSuiteScaffold(
|
|
326
|
+
navigationSuiteItems = {
|
|
327
|
+
item(
|
|
328
|
+
icon = { Icon(Icons.Default.Home, contentDescription = "Home") },
|
|
329
|
+
label = { Text("Home") },
|
|
330
|
+
selected = currentDestination?.hasRoute<Home>() == true,
|
|
331
|
+
onClick = { navController.navigate(Home) }
|
|
332
|
+
)
|
|
333
|
+
item(
|
|
334
|
+
icon = { Icon(Icons.Default.Settings, contentDescription = "Settings") },
|
|
335
|
+
label = { Text("Settings") },
|
|
336
|
+
selected = currentDestination?.hasRoute<Settings>() == true,
|
|
337
|
+
onClick = { navController.navigate(Settings()) }
|
|
338
|
+
)
|
|
339
|
+
}
|
|
340
|
+
) {
|
|
341
|
+
AppNavHost(navController = navController)
|
|
342
|
+
}
|
|
343
|
+
}
|
|
344
|
+
```
|
|
345
|
+
|
|
346
|
+
---
|
|
347
|
+
|
|
348
|
+
## Testing
|
|
349
|
+
|
|
350
|
+
### Setup
|
|
351
|
+
|
|
352
|
+
```kotlin
|
|
353
|
+
// build.gradle.kts
|
|
354
|
+
androidTestImplementation("androidx.navigation:navigation-testing:2.8.5")
|
|
355
|
+
```
|
|
356
|
+
|
|
357
|
+
### Test Navigation
|
|
358
|
+
|
|
359
|
+
```kotlin
|
|
360
|
+
class NavigationTest {
|
|
361
|
+
@get:Rule
|
|
362
|
+
val composeTestRule = createComposeRule()
|
|
363
|
+
|
|
364
|
+
private lateinit var navController: TestNavHostController
|
|
365
|
+
|
|
366
|
+
@Before
|
|
367
|
+
fun setup() {
|
|
368
|
+
composeTestRule.setContent {
|
|
369
|
+
navController = TestNavHostController(LocalContext.current)
|
|
370
|
+
navController.navigatorProvider.addNavigator(ComposeNavigator())
|
|
371
|
+
AppNavHost(navController = navController)
|
|
372
|
+
}
|
|
373
|
+
}
|
|
374
|
+
|
|
375
|
+
@Test
|
|
376
|
+
fun verifyStartDestination() {
|
|
377
|
+
composeTestRule
|
|
378
|
+
.onNodeWithText("Welcome")
|
|
379
|
+
.assertIsDisplayed()
|
|
380
|
+
}
|
|
381
|
+
|
|
382
|
+
@Test
|
|
383
|
+
fun navigateToProfile_displaysProfileScreen() {
|
|
384
|
+
composeTestRule
|
|
385
|
+
.onNodeWithText("View Profile")
|
|
386
|
+
.performClick()
|
|
387
|
+
|
|
388
|
+
assertTrue(
|
|
389
|
+
navController.currentBackStackEntry?.destination?.hasRoute<Profile>() == true
|
|
390
|
+
)
|
|
391
|
+
}
|
|
392
|
+
}
|
|
393
|
+
```
|
|
394
|
+
|
|
395
|
+
---
|
|
396
|
+
|
|
397
|
+
## Critical Rules
|
|
398
|
+
|
|
399
|
+
### DO
|
|
400
|
+
|
|
401
|
+
- Use `@Serializable` routes for type safety
|
|
402
|
+
- Pass only IDs/primitives as arguments
|
|
403
|
+
- Use `popUpTo` with `launchSingleTop` for bottom navigation
|
|
404
|
+
- Extract `NavHost` to a separate composable for testability
|
|
405
|
+
- Use `SavedStateHandle.toRoute<T>()` in ViewModels
|
|
406
|
+
|
|
407
|
+
### DON'T
|
|
408
|
+
|
|
409
|
+
- Pass complex objects as navigation arguments
|
|
410
|
+
- Create `NavController` inside `NavHost`
|
|
411
|
+
- Navigate in `LaunchedEffect` without proper keys
|
|
412
|
+
- Forget `FLAG_IMMUTABLE` for PendingIntents (Android 12+)
|
|
413
|
+
- Use string-based routes (legacy pattern)
|
|
414
|
+
|
|
415
|
+
---
|
|
416
|
+
|
|
417
|
+
## References
|
|
418
|
+
|
|
419
|
+
- [Navigation with Compose](https://developer.android.com/develop/ui/compose/navigation)
|
|
420
|
+
- [Type-Safe Navigation](https://developer.android.com/guide/navigation/design#compose)
|
|
421
|
+
- [Pass Data Between Destinations](https://developer.android.com/guide/navigation/navigation-pass-data)
|
|
422
|
+
- [Test Navigation](https://developer.android.com/guide/navigation/navigation-testing)
|
package/template/agent/skills/mobile-developer/references/android-rules/compose-performance-audit.md
ADDED
|
@@ -0,0 +1,199 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: compose-performance-audit
|
|
3
|
+
description: Audit and improve Jetpack Compose runtime performance from code review and architecture. Use when asked to diagnose slow rendering, janky scrolling, excessive recompositions, or performance issues in Compose UI.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Compose Performance Audit
|
|
7
|
+
|
|
8
|
+
## Overview
|
|
9
|
+
|
|
10
|
+
Audit Jetpack Compose view performance end-to-end, from instrumentation and baselining to root-cause analysis and concrete remediation steps.
|
|
11
|
+
|
|
12
|
+
## Workflow Decision Tree
|
|
13
|
+
|
|
14
|
+
- If the user provides code, start with "Code-First Review."
|
|
15
|
+
- If the user only describes symptoms, ask for minimal code/context, then do "Code-First Review."
|
|
16
|
+
- If code review is inconclusive, go to "Guide the User to Profile" and ask for Layout Inspector output or Perfetto traces.
|
|
17
|
+
|
|
18
|
+
## 1. Code-First Review
|
|
19
|
+
|
|
20
|
+
Collect:
|
|
21
|
+
- Target Composable code.
|
|
22
|
+
- Data flow: state, remember, derived state, ViewModel connections.
|
|
23
|
+
- Symptoms and reproduction steps.
|
|
24
|
+
|
|
25
|
+
Focus on:
|
|
26
|
+
- **Recomposition storms** from unstable parameters or broad state changes.
|
|
27
|
+
- **Unstable keys** in `LazyColumn`/`LazyRow` (`key` churn, missing keys).
|
|
28
|
+
- **Heavy work in composition** (formatting, sorting, filtering, object allocation).
|
|
29
|
+
- **Unnecessary recompositions** (missing `remember`, unstable classes, lambdas).
|
|
30
|
+
- **Large images** without proper sizing or async loading.
|
|
31
|
+
- **Layout thrash** (deep nesting, intrinsic measurements, `SubcomposeLayout` misuse).
|
|
32
|
+
|
|
33
|
+
Provide:
|
|
34
|
+
- Likely root causes with code references.
|
|
35
|
+
- Suggested fixes and refactors.
|
|
36
|
+
- If needed, a minimal repro or instrumentation suggestion.
|
|
37
|
+
|
|
38
|
+
## 2. Guide the User to Profile
|
|
39
|
+
|
|
40
|
+
Explain how to collect data:
|
|
41
|
+
- Use **Layout Inspector** in Android Studio to see recomposition counts.
|
|
42
|
+
- Enable **Recomposition Highlights** in Compose tooling.
|
|
43
|
+
- Use **Perfetto** or **System Trace** for frame timing analysis.
|
|
44
|
+
- Check **Macrobenchmark** results for startup/scroll metrics.
|
|
45
|
+
|
|
46
|
+
Ask for:
|
|
47
|
+
- Layout Inspector screenshot showing recomposition counts.
|
|
48
|
+
- Perfetto trace or System Trace export.
|
|
49
|
+
- Device/OS/build configuration (debug vs release).
|
|
50
|
+
|
|
51
|
+
> **Important**: Ensure profiling is done on a **release build** with R8 enabled. Debug builds have significant overhead.
|
|
52
|
+
|
|
53
|
+
## 3. Analyze and Diagnose
|
|
54
|
+
|
|
55
|
+
Prioritize likely Compose culprits:
|
|
56
|
+
- **Recomposition storms** from unstable parameters or broad state changes.
|
|
57
|
+
- **Unstable keys** in lazy lists (`key` churn, index-based keys).
|
|
58
|
+
- **Heavy work in composition** (formatting, sorting, object allocation).
|
|
59
|
+
- **Missing `remember`** causing recreations on every recomposition.
|
|
60
|
+
- **Large images** without `Modifier.size()` constraints.
|
|
61
|
+
- **Unnecessary state reads** in wrong composition phases.
|
|
62
|
+
|
|
63
|
+
Summarize findings with evidence from traces/Layout Inspector.
|
|
64
|
+
|
|
65
|
+
## 4. Remediate
|
|
66
|
+
|
|
67
|
+
Apply targeted fixes:
|
|
68
|
+
- **Stabilize parameters**: Use `@Stable` or `@Immutable` annotations on data classes.
|
|
69
|
+
- **Stabilize keys**: Use stable, unique IDs for `LazyColumn`/`LazyRow` items.
|
|
70
|
+
- **Defer state reads**: Use `derivedStateOf`, lambda-based modifiers, or `Modifier.drawBehind`.
|
|
71
|
+
- **Remember expensive computations**: Wrap in `remember { }` or `remember(key) { }`.
|
|
72
|
+
- **Skip recomposition**: Extract stable composables, use `key()` to control identity.
|
|
73
|
+
- **Async image loading**: Use Coil/Glide with proper sizing constraints.
|
|
74
|
+
- **Reduce layout complexity**: Flatten hierarchies, avoid deep nesting.
|
|
75
|
+
|
|
76
|
+
## Common Code Smells (and Fixes)
|
|
77
|
+
|
|
78
|
+
### Unstable lambda captures
|
|
79
|
+
|
|
80
|
+
```kotlin
|
|
81
|
+
// BAD: New lambda instance every recomposition
|
|
82
|
+
Button(onClick = { viewModel.doSomething(item) }) { ... }
|
|
83
|
+
|
|
84
|
+
// GOOD: Use remember or method reference
|
|
85
|
+
val onClick = remember(item) { { viewModel.doSomething(item) } }
|
|
86
|
+
Button(onClick = onClick) { ... }
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
### Expensive work in composition
|
|
90
|
+
|
|
91
|
+
```kotlin
|
|
92
|
+
// BAD: Sorting on every recomposition
|
|
93
|
+
@Composable
|
|
94
|
+
fun ItemList(items: List<Item>) {
|
|
95
|
+
val sorted = items.sortedBy { it.name } // Runs every recomposition
|
|
96
|
+
LazyColumn { items(sorted) { ... } }
|
|
97
|
+
}
|
|
98
|
+
|
|
99
|
+
// GOOD: Use remember with key
|
|
100
|
+
@Composable
|
|
101
|
+
fun ItemList(items: List<Item>) {
|
|
102
|
+
val sorted = remember(items) { items.sortedBy { it.name } }
|
|
103
|
+
LazyColumn { items(sorted) { ... } }
|
|
104
|
+
}
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
### Missing keys in LazyColumn
|
|
108
|
+
|
|
109
|
+
```kotlin
|
|
110
|
+
// BAD: Index-based identity (causes recomposition on list changes)
|
|
111
|
+
LazyColumn {
|
|
112
|
+
items(items) { item -> ItemRow(item) }
|
|
113
|
+
}
|
|
114
|
+
|
|
115
|
+
// GOOD: Stable key-based identity
|
|
116
|
+
LazyColumn {
|
|
117
|
+
items(items, key = { it.id }) { item -> ItemRow(item) }
|
|
118
|
+
}
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
### Unstable data classes
|
|
122
|
+
|
|
123
|
+
```kotlin
|
|
124
|
+
// BAD: Unstable (contains List, which is not stable)
|
|
125
|
+
data class UiState(
|
|
126
|
+
val items: List<Item>,
|
|
127
|
+
val isLoading: Boolean
|
|
128
|
+
)
|
|
129
|
+
|
|
130
|
+
// GOOD: Mark as Immutable if truly immutable
|
|
131
|
+
@Immutable
|
|
132
|
+
data class UiState(
|
|
133
|
+
val items: ImmutableList<Item>, // kotlinx.collections.immutable
|
|
134
|
+
val isLoading: Boolean
|
|
135
|
+
)
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
### Reading state too early
|
|
139
|
+
|
|
140
|
+
```kotlin
|
|
141
|
+
// BAD: State read during composition (recomposes whole tree)
|
|
142
|
+
@Composable
|
|
143
|
+
fun AnimatedBox(scrollState: ScrollState) {
|
|
144
|
+
val offset = scrollState.value // Recomposes on every scroll
|
|
145
|
+
Box(modifier = Modifier.offset(y = offset.dp)) { ... }
|
|
146
|
+
}
|
|
147
|
+
|
|
148
|
+
// GOOD: Defer state read to layout/draw phase
|
|
149
|
+
@Composable
|
|
150
|
+
fun AnimatedBox(scrollState: ScrollState) {
|
|
151
|
+
Box(modifier = Modifier.offset {
|
|
152
|
+
IntOffset(0, scrollState.value) // Read in layout phase
|
|
153
|
+
}) { ... }
|
|
154
|
+
}
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
### Object allocation in composition
|
|
158
|
+
|
|
159
|
+
```kotlin
|
|
160
|
+
// BAD: Creates new Modifier chain every recomposition
|
|
161
|
+
Box(modifier = Modifier.padding(16.dp).background(Color.Red))
|
|
162
|
+
|
|
163
|
+
// GOOD for dynamic modifiers: Remember the modifier
|
|
164
|
+
val modifier = remember { Modifier.padding(16.dp).background(Color.Red) }
|
|
165
|
+
Box(modifier = modifier)
|
|
166
|
+
```
|
|
167
|
+
|
|
168
|
+
## Stability Checklist
|
|
169
|
+
|
|
170
|
+
| Type | Stable by Default? | Fix |
|
|
171
|
+
|------|-------------------|-----|
|
|
172
|
+
| Primitives (`Int`, `String`, `Boolean`) | Yes | N/A |
|
|
173
|
+
| `data class` with stable fields | Yes* | Ensure all fields are stable |
|
|
174
|
+
| `List`, `Map`, `Set` | **No** | Use `ImmutableList` from kotlinx |
|
|
175
|
+
| Classes with `var` properties | **No** | Use `@Stable` if externally stable |
|
|
176
|
+
| Lambdas | **No** | Use `remember { }` |
|
|
177
|
+
|
|
178
|
+
## 5. Verify
|
|
179
|
+
|
|
180
|
+
Ask the user to:
|
|
181
|
+
- Re-run Layout Inspector and compare recomposition counts.
|
|
182
|
+
- Run Macrobenchmark and compare frame timing.
|
|
183
|
+
- Test on a real device with release build.
|
|
184
|
+
|
|
185
|
+
Summarize the delta (recomposition count, frame drops, jank) if provided.
|
|
186
|
+
|
|
187
|
+
## Outputs
|
|
188
|
+
|
|
189
|
+
Provide:
|
|
190
|
+
- A short metrics table (before/after if available).
|
|
191
|
+
- Top issues (ordered by impact).
|
|
192
|
+
- Proposed fixes with estimated effort.
|
|
193
|
+
|
|
194
|
+
## References
|
|
195
|
+
|
|
196
|
+
- [Jetpack Compose Performance](https://developer.android.com/develop/ui/compose/performance)
|
|
197
|
+
- [Compose Stability Explained](https://developer.android.com/develop/ui/compose/performance/stability)
|
|
198
|
+
- [Debugging Recomposition](https://developer.android.com/develop/ui/compose/tooling/layout-inspector)
|
|
199
|
+
- [Macrobenchmark](https://developer.android.com/topic/performance/benchmarking/macrobenchmark-overview)
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: compose-ui
|
|
3
|
+
description: Best practices for building UI with Jetpack Compose, focusing on state hoisting, detailed performance optimizations, and theming. Use this when writing or refactoring Composable functions.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Jetpack Compose Best Practices
|
|
7
|
+
|
|
8
|
+
## Instructions
|
|
9
|
+
|
|
10
|
+
Follow these guidelines to create performant, reusable, and testable Composables.
|
|
11
|
+
|
|
12
|
+
### 1. State Hoisting (Unidirectional Data Flow)
|
|
13
|
+
Make Composables **stateless** whenever possible by moving state to the caller.
|
|
14
|
+
|
|
15
|
+
* **Pattern**: Function signature should usually look like:
|
|
16
|
+
```kotlin
|
|
17
|
+
@Composable
|
|
18
|
+
fun MyComponent(
|
|
19
|
+
value: String, // State flows down
|
|
20
|
+
onValueChange: (String) -> Unit, // Events flow up
|
|
21
|
+
modifier: Modifier = Modifier // Standard modifier parameter
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
* **Benefit**: Decouples the UI from simple state storage, making it easier to preview and test.
|
|
25
|
+
* **ViewModel Integration**: The screen-level Composable retrieves state from the ViewModel (`viewModel.uiState.collectAsStateWithLifecycle()`) and passes it down.
|
|
26
|
+
|
|
27
|
+
### 2. Modifiers
|
|
28
|
+
* **Default Parameter**: Always provide a `modifier: Modifier = Modifier` as the first optional parameter.
|
|
29
|
+
* **Application**: Apply this `modifier` to the *root* layout element of your Composable.
|
|
30
|
+
* **Ordering matters**: `padding().clickable()` is different from `clickable().padding()`. Generally apply layout-affecting modifiers (like padding) *after* click listeners if you want the padding to be clickable.
|
|
31
|
+
|
|
32
|
+
### 3. Performance Optimization
|
|
33
|
+
* **`remember`**: Use `remember { ... }` to cache expensive calculations across recompositions.
|
|
34
|
+
* **`derivedStateOf`**: Use `derivedStateOf { ... }` when a state changes frequently (like scroll position) but the UI only needs to react to a threshold or summary (e.g., show "Jump to Top" button). This prevents unnecessary recompositions.
|
|
35
|
+
```kotlin
|
|
36
|
+
val showButton by remember {
|
|
37
|
+
derivedStateOf { listState.firstVisibleItemIndex > 0 }
|
|
38
|
+
}
|
|
39
|
+
```
|
|
40
|
+
* **Lambda Stability**: Prefer method references (e.g., `viewModel::onEvent`) or remembered lambdas to prevent unstable types from triggering recomposition of children.
|
|
41
|
+
|
|
42
|
+
### 4. Theming and Resources
|
|
43
|
+
* Use `MaterialTheme.colorScheme` and `MaterialTheme.typography` instead of hardcoded colors or text styles.
|
|
44
|
+
* Organize simple UI components into specific files (e.g., `DesignSystem.kt` or `Components.kt`) if they are shared across features.
|
|
45
|
+
|
|
46
|
+
### 5. Previews
|
|
47
|
+
* Create a private preview function for every public Composable.
|
|
48
|
+
* Use `@Preview(showBackground = true)` and include Light/Dark mode previews if applicable.
|
|
49
|
+
* Pass dummy data (static) to the stateless Composable for the preview.
|