Communitygithub.com

Compose Multiplatform 模式

適用於 KMP 專案的 Compose Multiplatform 與 Jetpack Compose 模式,涵蓋狀態管理、導航、主題設定、效能最佳化及平台特定 UI。在建構 Compose 或 Jetpack Compose UI、狀態、導航或主題時使用。

Compose Multiplatform 模式 是什麼?

此技能提供了一系列經過驗證的模式與最佳實踐,專為使用 Compose Multiplatform 與 Jetpack Compose 在 KMP 專案中建構共享 UI 而設計。支援 Android、iOS、Desktop 及 Web 平台。涵蓋了狀態管理(例如 ViewModel 搭配單一狀態物件、Event Sink 模式)、型別安全導航、插槽式可組合項設計、修飾符正確排序、KMP 平台特定 UI 的 expect/actual 實作、效能最佳化(如穩定型別、Lazy 列表 key 與 derivedStateOf),以及 Material 3 動態主題設定。它還明確指出了常見的反模式,協助開發者避免陷阱,建立可維護、高效能且跨平台一致的 Compose UI。此技能基於 SKILL.md 檔案,為開發者提供了一套可直接套用的準則與程式碼範例。

相容平台~Claude Code~Codex CLI~Cursor
npx skills add https://github.com/affaan-m/everything-claude-code/tree/main/skills/compose-multiplatform-patterns

在你喜歡的 AI 中提問

開啟一個已預先載入此 Agent Skill 的新對話。

說明文件

Compose Multiplatform 模式 是做什麼的?

使用 Compose Multiplatform 與 Jetpack Compose 建構跨 Android、iOS、Desktop 及 Web 的共享 UI 模式。涵蓋狀態管理、導航、主題設定及效能最佳化。

啟用時機

  • 建構 Compose UI(Jetpack Compose 或 Compose Multiplatform)
  • 使用 ViewModel 與 Compose 狀態管理 UI 狀態
  • 在 KMP 或 Android 專案中實作導航
  • 設計可重複使用的可組合項與設計系統
  • 最佳化重組與渲染效能

狀態管理

ViewModel + 單一狀態物件

使用單一資料類別表示螢幕狀態。將其公開為 StateFlow 並在 Compose 中收集:

data class ItemListState(
    val items: List<Item> = emptyList(),
    val isLoading: Boolean = false,
    val error: String? = null,
    val searchQuery: String = ""
)

class ItemListViewModel(
    private val getItems: GetItemsUseCase
) : ViewModel() {
    private val _state = MutableStateFlow(ItemListState())
    val state: StateFlow<ItemListState> = _state.asStateFlow()

    fun onSearch(query: String) {
        _state.update { it.copy(searchQuery = query) }
        loadItems(query)
    }

    private fun loadItems(query: String) {
        viewModelScope.launch {
            _state.update { it.copy(isLoading = true) }
            getItems(query).fold(
                onSuccess = { items -> _state.update { it.copy(items = items, isLoading = false) } },
                onFailure = { e -> _state.update { it.copy(error = e.message, isLoading = false) } }
            )
        }
    }
}

在 Compose 中收集狀態

@Composable
fun ItemListScreen(viewModel: ItemListViewModel = koinViewModel()) {
    val state by viewModel.state.collectAsStateWithLifecycle()

    ItemListContent(
        state = state,
        onSearch = viewModel::onSearch
    )
}

@Composable
private fun ItemListContent(
    state: ItemListState,
    onSearch: (String) -> Unit
) {
    // 無狀態的可組合項 — 易於預覽與測試
}

Event Sink 模式

對於複雜螢幕,使用密封介面表示事件,而非多個回呼 lambda:

sealed interface ItemListEvent {
    data class Search(val query: String) : ItemListEvent
    data class Delete(val itemId: String) : ItemListEvent
    data object Refresh : ItemListEvent
}

// 在 ViewModel 中
fun onEvent(event: ItemListEvent) {
    when (event) {
        is ItemListEvent.Search -> onSearch(event.query)
        is ItemListEvent.Delete -> deleteItem(event.itemId)
        is ItemListEvent.Refresh -> loadItems(_state.value.searchQuery)
    }
}

// 在可組合項中 — 單一 lambda 取代多個
ItemListContent(
    state = state,
    onEvent = viewModel::onEvent
)

導航

型別安全導航 (Compose Navigation 2.8+)

將路由定義為 @Serializable 物件:

@Serializable data object HomeRoute
@Serializable data class DetailRoute(val id: String)
@Serializable data object SettingsRoute

@Composable
fun AppNavHost(navController: NavHostController = rememberNavController()) {
    NavHost(navController, startDestination = HomeRoute) {
        composable<HomeRoute> {
            HomeScreen(onNavigateToDetail = { id -> navController.navigate(DetailRoute(id)) })
        }
        composable<DetailRoute> { backStackEntry ->
            val route = backStackEntry.toRoute<DetailRoute>()
            DetailScreen(id = route.id)
        }
        composable<SettingsRoute> { SettingsScreen() }
    }
}

對話框與底部工作表導航

使用 dialog() 與疊加層模式,而非命令式的顯示/隱藏:

NavHost(navController, startDestination = HomeRoute) {
    composable<HomeRoute> { /* ... */ }
    dialog<ConfirmDeleteRoute> { backStackEntry ->
        val route = backStackEntry.toRoute<ConfirmDeleteRoute>()
        ConfirmDeleteDialog(
            itemId = route.itemId,
            onConfirm = { navController.popBackStack() },
            onDismiss = { navController.popBackStack() }
        )
    }
}

可組合項設計

插槽式 API

設計帶有插槽參數的可組合項,以增加靈活性:

@Composable
fun AppCard(
    modifier: Modifier = Modifier,
    header: @Composable () -> Unit = {},
    content: @Composable ColumnScope.() -> Unit,
    actions: @Composable RowScope.() -> Unit = {}
) {
    Card(modifier = modifier) {
        Column {
            header()
            Column(content = content)
            Row(horizontalArrangement = Arrangement.End, content = actions)
        }
    }
}

修飾符順序

修飾符順序很重要 — 依此順序套用:

Text(
    text = "Hello",
    modifier = Modifier
        .padding(16.dp)          // 1. 佈局 (padding, size)
        .clip(RoundedCornerShape(8.dp))  // 2. 形狀
        .background(Color.White) // 3. 繪製 (background, border)
        .clickable { }           // 4. 互動
)

KMP 平台特定 UI

expect/actual 用於平台可組合項

// commonMain
@Composable
expect fun PlatformStatusBar(darkIcons: Boolean)

// androidMain
@Composable
actual fun PlatformStatusBar(darkIcons: Boolean) {
    val systemUiController = rememberSystemUiController()
    SideEffect { systemUiController.setStatusBarColor(Color.Transparent, darkIcons) }
}

// iosMain
@Composable
actual fun PlatformStatusBar(darkIcons: Boolean) {
    // iOS 透過 UIKit 互操作性或 Info.plist 處理
}

效能

穩定型別以實現可跳過重組

當所有屬性都穩定時,將類別標記為 @Stable 或 @Immutable:

@Immutable
data class ItemUiModel(
    val id: String,
    val title: String,
    val description: String,
    val progress: Float
)

正確使用 key() 與 Lazy 列表

LazyColumn {
    items(
        items = items,
        key = { it.id }  // 穩定鍵可啟用項目重複使用與動畫
    ) { item ->
        ItemRow(item = item)
    }
}

使用 derivedStateOf 延後讀取

val listState = rememberLazyListState()
val showScrollToTop by remember {
    derivedStateOf { listState.firstVisibleItemIndex > 5 }
}

避免在重組中進行分配

// 不好 — 每次重組都會建立新的 lambda 與列表
items.filter { it.isActive }.forEach { ActiveItem(it, onClick = { handle(it) }) }

// 好 — 對每個項目使用 key,讓回呼保持與正確的行數關聯
val activeItems = remember(items) { items.filter { it.isActive } }
activeItems.forEach { item ->
    key(item.id) {
        ActiveItem(item, onClick = { handle(item) })
    }
}

主題設定

Material 3 動態主題

@Composable
fun AppTheme(
    darkTheme: Boolean = isSystemInDarkTheme(),
    dynamicColor: Boolean = true,
    content: @Composable () -> Unit
) {
    val colorScheme = when {
        dynamicColor && Build.VERSION.SDK_INT >= Build.VERSION_CODES.S -> {
            if (darkTheme) dynamicDarkColorScheme(LocalContext.current)
            else dynamicLightColorScheme(LocalContext.current)
        }
        darkTheme -> darkColorScheme()
        else -> lightColorScheme()
    }

    MaterialTheme(colorScheme = colorScheme, content = content)
}

應避免的反模式

  • 在 ViewModel 中使用 mutableStateOf,而應使用生命週期更安全的 MutableStateFlow 搭配 collectAsStateWithLifecycle
  • 將 NavController 傳入深層的可組合項中 — 改為傳遞 lambda 回呼
  • 在 @Composable 函式中進行繁重計算 — 移至 ViewModel 或 remember {}
  • 使用 LaunchedEffect(Unit) 作為 ViewModel 初始化的替代方案 — 在某些設定下會因配置變更而重新執行
  • 在可組合項參數中建立新的物件實例 — 會導致不必要的重組

參考資料

請參閱技能:android-clean-architecture 了解模組結構與分層。 請參閱技能:kotlin-coroutines-flows 了解協程與 Flow 模式。

Individual skills in this repo

This repo contains 20 individual skills — each has its own dedicated page.

accessibility

Design, implement, and audit inclusive digital products using WCAG 2.2 Level AA. Use when building or auditing UI that must meet WCAG 2.2 Level AA, or when reviewing a change for keyboard, contrast, or screen-reader support.

affaan-m/claude-api

Anthropic Claude API patterns for Python and TypeScript. Covers Messages API, streaming, tool use, vision, extended thinking, batches, prompt caching, and Claude Agent SDK. Use when building applications with the Claude API or Anthropic SDKs.

affaan-m/everything-claude-code

End-to-end marketing campaign planning and execution. Covers audience research, positioning, campaign angle definition, landing page copy, email sequences, social posts, ad copy, short-form video scripts, and content calendars. Use as the orchestration layer for multi-channel product launches. Use when planning or executing a multi-channel product launch, or producing landing page, email, social, or ad copy.

affaan-m/everything-claude-code

Development conventions and patterns for everything-claude-code. JavaScript project with conventional commits.

affaan-m/everything-claude-code-conventions

Development conventions and patterns for everything-claude-code. JavaScript project with conventional commits.

affaan-m/frontend-design

Create distinctive, production-grade frontend interfaces with high design quality. Use when the user asks to build web components, pages, or applications and the visual direction matters as much as the code quality.

affaan-m/gget

gget CLI and Python workflow for quick genomic database queries, sequence lookup, BLAST-style searches, enrichment checks, and reproducible bioinformatics evidence logs.

affaan-m/literature-review

Systematic literature-review workflow for academic, biomedical, technical, and scientific topics, including search planning, source screening, synthesis, citation checks, and evidence logging.

affaan-m/motion-ui

Production-ready UI motion system for React/Next.js. Use when implementing animations, transitions, or motion patterns.

affaan-m/project-guidelines-example

Example project-specific skill template based on a real production application.

affaan-m/pubmed-database

Direct PubMed and NCBI E-utilities search workflows for biomedical literature, MeSH queries, PMID lookup, citation retrieval, and API-backed literature monitoring.

affaan-m/scholar-evaluation

Structured scholarly-work evaluation for papers, proposals, literature reviews, methods sections, evidence quality, citation support, and research-writing feedback.

affaan-m/uspto-database

USPTO patent and trademark data workflow for official record lookup, PatentSearch queries, TSDR checks, assignment data, and reproducible IP research logs.

agent-architecture-audit

Full-stack diagnostic for agent and LLM applications. Audits the 12-layer agent stack for wrapper regression, memory pollution, tool discipline failures, hidden repair loops, and rendering corruption. Produces severity-ranked findings with code-first fixes. Essential for developers building agent applications, autonomous loops, or any LLM-powered feature. Use when an agent or LLM feature misbehaves and the failing layer is unknown, or before shipping an agent stack.

agent-eval

Head-to-head comparison of coding agents (Claude Code, Aider, Codex, etc.) on custom tasks with pass rate, cost, time, and consistency metrics. Use when choosing between coding agents, or when a change to an agent setup needs measured pass rate, cost, and time rather than an impression.

agent-harness-construction

Design and optimize AI agent action spaces, tool definitions, and observation formatting for higher completion rates. Use when defining or revising an agent

agentic-engineering

Operate as an agentic engineer using eval-first execution, decomposition, and cost-aware model routing. Use when planning or executing engineering work that agents will carry out end to end.

agentic-os

Build persistent multi-agent operating systems on Claude Code. Covers kernel architecture, specialist agents, slash commands, file-based memory, scheduled automation, and state management without external databases. Use when building a persistent multi-agent system on Claude Code with its own memory, commands, and scheduling.

agent-introspection-debugging

Structured self-debugging workflow for AI agent failures using capture, diagnosis, contained recovery, and introspection reports. Use when an agent run fails and you need a reproducible diagnosis instead of a retry.

agent-payment-x402

Add x402 payment execution to AI agents with per-task budgets, spending controls, and non-custodial wallets. Supports Base through agentwallet-sdk and X Layer through OKX Payments / OKX Agent Payments Protocol. Use when an agent must pay for something itself and needs per-task budgets, spending controls, and a non-custodial wallet.

相關技能