trmnl/trmnl-android
0
0
Fork 0
mirror of https://github.com/usetrmnl/trmnl-android.git synced 2026-04-29 13:35:26 -07:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #230 from usetrmnl/docs/update-icons-guidance

Browse Source 
docs: Add guidance for Icons class and vector drawables
This commit is contained in:
Hossain Khan
2025-12-06 15:30:31 -05:00
committed by GitHub
parent 09cc78b17c cdd095f223
commit f9b736b5ad
2 changed files with 30 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/copilot-instructions.md
+11
View File
@@ -170,6 +170,17 @@ See `RELEASE_CHECKLIST.md` for complete release process.
- **Always run:** `./gradlew formatKotlin` before committing
- **Check only:** `./gradlew lintKotlin` (doesn't modify files)
## Icons & Vector Drawables
- **Custom Icons Class:** `ink.trmnl.android.ui.icons.Icons` (replaces deprecated `androidx.compose.material.icons`)
- **Adding New Icons:**
1. Download icon from [Material Symbols](https://fonts.google.com/icons)
2. Convert to Android Vector Drawable (use Vector Asset Studio in Android Studio)
3. Add drawable to `app/src/main/res/drawable/`
4. Expose via `Icons` class with appropriate category (Default, Outlined, AutoMirrored)
- **Usage:** `Icons.Default.Settings`, `Icons.Outlined.Warning`, `Icons.AutoMirrored.Filled.ArrowBack`
- **Never use:** `androidx.compose.material.icons.Icons` (deprecated package)
## Testing
- **Unit Tests:** `app/src/test/` (Robolectric, MockK, Truth assertions)
CLAUDE.md
+19
View File
@@ -216,6 +216,25 @@ The project uses optimized Gradle settings based on best practices from the [Now
- Check: `./gradlew lintKotlin` (no modifications)
- Only customization: Allow PascalCase for `@Composable` functions
## Icons & Vector Drawables
**Custom Icons Class:** `ink.trmnl.android.ui.icons.Icons` replaces deprecated `androidx.compose.material.icons`
- **Location:** `app/src/main/java/ink/trmnl/android/ui/icons/Icons.kt`
- **Structure:** Nested objects matching Material Icons API
- `Icons.Default.*` - Filled icons (CheckCircle, Clear, DateRange, PlayArrow, Refresh, Settings, Share, Warning)
- `Icons.Outlined.*` - Outlined variants (Info, Warning)
- `Icons.AutoMirrored.Filled.*` - Auto-mirrored for RTL (ArrowBack, ArrowForward, List)
**Adding New Icons:**
1. Download from [Google Fonts Material Symbols](https://fonts.google.com/icons)
2. Convert to Android Vector Drawable (use Vector Asset Studio in Android Studio)
3. Save to `app/src/main/res/drawable/ic_[name]_[size]dp.xml`
4. Expose in `Icons.kt` with `@Composable get() = ImageVector.vectorResource(id = R.drawable.ic_name)`
5. Place in appropriate category (Default/Outlined/AutoMirrored)
**Never use:** `androidx.compose.material.icons.Icons` (deprecated, issue #226)
## Testing
- Unit tests: `app/src/test/` (Robolectric 4.14.1, MockK 1.14.2, Truth 1.4.4)