Agent Skills › maxrave-dev/SimpMusic › android-viewmodel

android-viewmodel

GitHub

提供Android ViewModel最佳实践，指导使用StateFlow管理UI状态，SharedFlow处理一次性事件。涵盖初始化、线程安全更新及Compose/XML中的收集方式，确保配置变更存活。

.claude/skills/android-viewmodel/SKILL.md maxrave-dev/SimpMusic

Trigger Scenarios

实现Android ViewModel 处理UI状态管理配置StateFlow或SharedFlow

Install

npx skills add maxrave-dev/SimpMusic --skill android-viewmodel -g -y

More Options

Non-standard path

npx skills add https://github.com/maxrave-dev/SimpMusic/tree/dev/.claude/skills/android-viewmodel -g -y

Use without installing

npx skills use maxrave-dev/SimpMusic@android-viewmodel

指定 Agent (Claude Code)

npx skills add maxrave-dev/SimpMusic --skill android-viewmodel -a claude-code -g -y

安装 repo 全部 skill

npx skills add maxrave-dev/SimpMusic --all -g -y

预览 repo 内 skill

npx skills add maxrave-dev/SimpMusic --list

SKILL.md

Frontmatter

{
    "name": "android-viewmodel",
    "description": "Best practices for implementing Android ViewModels, specifically focused on StateFlow for UI state and SharedFlow for one-off events."
}

Android ViewModel & State Management

Instructions

Use ViewModel to hold state and business logic. It must outlive configuration changes.

1. UI State (StateFlow)

What: Represents the persistent state of the UI (e.g., Loading, Success(data), Error).
Type: StateFlow<UiState>.
Initialization: Must have an initial value.

Exposure: Expose as a read-only StateFlow backing a private MutableStateFlow.

private val _uiState = MutableStateFlow<UiState>(UiState.Loading)
val uiState: StateFlow<UiState> = _uiState.asStateFlow()

Updates: Update state using .update { oldState -> ... } for thread safety.

2. One-Off Events (SharedFlow)

What: Transient events like "Show Toast", "Navigate to Screen", "Show Snackbar".
Type: SharedFlow<UiEvent>.

Configuration: Must use replay = 0 to prevent events from re-triggering on screen rotation.

private val _uiEvent = MutableSharedFlow<UiEvent>(replay = 0)
val uiEvent: SharedFlow<UiEvent> = _uiEvent.asSharedFlow()

Sending: Use .emit(event) (suspend) or .tryEmit(event).

3. Collecting in UI

Compose: Use collectAsStateWithLifecycle() for StateFlow.
```
val state by viewModel.uiState.collectAsStateWithLifecycle()
```
For SharedFlow, use LaunchedEffect with LocalLifecycleOwner.
Views (XML): Use repeatOnLifecycle(Lifecycle.State.STARTED) within a coroutine.