comprehensive-ui-guide

A set of rules for organizing Android Jetpack Compose user interfaces. It keeps business logic in a ViewModel, a class that manages screen data and actions, instead of placing that logic directly in the visual code.

In plain words
What is it for?
Use it when structuring Compose screens, deciding how many ViewModels a feature needs, and connecting buttons or other interface actions to application logic.
Why use it?
It helps prevent screens from becoming difficult to test and maintain by separating what the interface displays from what the application does.

Cursor rule for Cursor

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add rules/heegyeong/composesample/comprehensive-ui-guide
Clone the repo
git clone --depth 1 https://github.com/HeeGyeong/ComposeSample

Made for: Cursor.

Per session 0 Nothing until a file matches its globs; then the whole rule loads.
When invoked 568 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00000 $0.00568
Opus 5 $0.00000 $0.00284
Sonnet 5 $0.00000 $0.00114
Haiku 4.5 $0.00000 $0.00057

Measured 2d ago against content hash 8f679062db44, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

comprehensive-ui-guide scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.cursor/rules/comprehensive-ui-guide.mdc · 103 lines

How it starts

The opening of the file, as written. The whole thing — 103 lines — stays where its author put it; the contents beside it link to each section on GitHub.


description: "Comprehensive UI System Guide for Android Jetpack Compose" globs: "" alwaysApply: true

Comprehensive UI System Guide

Overview

This rule defines comprehensive UI guidelines including business logic separation, component organization, and feature implementation. References UIRules.md.

Business Logic Separation

❌ Incorrect Pattern

@Composable
fun PlayerScreen() {
    Button(onClick = {
        // Business logic directly in UI - WRONG
    }) {
        Text("Button")
    }
}

✅ Correct Pattern

class PlayerViewModel() : ViewModel() {
    fun fetchPlayList() {
        // Business logic here
    }
}

@Composable
fun PlayerScreen(
    playerViewModel: PlayerViewModel
) {
    Button(onClick = {
        playerViewModel.fetchPlayList()
    }) {
        Text("Button")
    }
}

ViewModel Organization Rules

Higher-Level Feature Organization

Use one ViewModel per major feature, not per sub-feature.

✅ DO THIS: Single ViewModel for feature

class LiveViewModel {
    // One ViewModel handles all Live-related features
    fun handleStreaming() { ... }
    fun handleSettings() { ... }
    fun handleChat() { ... }
}

❌ DON'T DO THIS: Multiple ViewModels for sub-features

class LiveStreamViewModel { ... }  // WRONG
class LiveSettingViewModel { ... }  // WRONG
class LiveChatViewModel { ... }     // WRONG

Composable Components

  • Place reusable components in components/ directory
  • Each component must be independent
  • Follow theme system
  • Consider accessibility (ContentDescription required)
  • ViewModel naming: FunctionName + ViewModel
  • Register in ../di/ViewModelModule.kt using Koin

State Management

  • Manage state in ViewModel
  • Use StateFlow
  • Follow Unidirectional Data Flow (UDF)
  • Apply state hoisting pattern
  • Use remember and derivedStateOf for expensive calculations
  • Use Compose Navigation
  • Support Deep Links
  • Implement screen transition animations
  • Handle backstack management

Read the full file on GitHub · 103 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 103 lines · 0 tokens per session scan A 8f679062db44

Subscribe to this mod's changes

comprehensive-ui-guide is a cursor rule published in the GitHub repository HeeGyeong/ComposeSample (11 stars, last pushed 2d ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 568 tokens. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.