RikkaIcons

KO | EN

gitlite — search

#python #react #ai #typescript #go #machine-learning #rust #macos #java #awesome #cli #security #pytorch #mcp

(★ 30)

RikkaIcons — Semantic icon tokens for Compose Multiplatform. One API, any icon pack. Built with & for Jetpack Compose.

RikkaIcons 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# RikkaIcons

Semantic icon tokens for Compose Multiplatform. One API, any icon pack. Built with & for Jetpack Compose.

</div>

---

Part of the **RikkaUI** (`dev.rikkaui`) ecosystem — a shadcn/ui-inspired design system for Compose Multiplatform.

`IconToken("heart")` is your stable API. The active `IconPack` decides whether it renders as a font glyph, SVG vector, outline, filled, or rounded — your UI code never changes.

</div>

---

## 🚀 Quick Start

```kotlin
// build.gradle.kts
dependencies {
    implementation("dev.rikkaui.icons:core:0.1.0")
    implementation("dev.rikkaui.icons:tokens-core:0.1.0")
    implementation("dev.rikkaui.icons:pack-lucide:0.1.0")
}
```

```kotlin
// Provide a pack at the root
ProvideIconPack(LucidePack) {
    App()
}

// Use icons anywhere
@Composable
fun LikeButton() {
    AppIcon(
        token = RikkaIcons.Heart,
        contentDescription = "Like",
    )
}
```

---

## 📦 Setup

```kotlin
// build.gradle.kts
dependencies {
    // Core (required)
    implementation("dev.rikkaui.icons:core:0.1.0")
    implementation("dev.rikkaui.icons:tokens-core:0.1.0")

// Extended tokens (optional — 238 extra tokens with broad pack coverage)
    implementation("dev.rikkaui.icons:tokens-extended:0.1.0")

// Loose tokens (optional — 341 pack-specific tokens)
    implementation("dev.rikkaui.icons:tokens-loose:0.1.0")

// Pick one (or more) icon packs
    implementation("dev.rikkaui.icons:pack-lucide:0.1.0")
    implementation("dev.rikkaui.icons:pack-tabler:0.1.0")
    implementation("dev.rikkaui.icons:pack-phosphor:0.1.0")
    implementation("dev.rikkaui.icons:pack-bootstrap:0.1.0")
    implementation("dev.rikkaui.icons:pack-material-symbols:0.1.0")
    implementation("dev.rikkaui.icons:pack-material-symbols-rounded:0.1.0")
    implementation("dev.rikkaui.icons:pack-material-symbols-sharp:0.1.0")
}
```

Works on **Android**, **iOS**, **Desktop (JVM)**, **JS**, and **WasmJs**.

---

## 🎨 Usage

### Provide an icon pack

```kotlin
// Vector packs — just use the object directly
ProvideIconPack(LucidePack) { App() }

// Packs with style variants
ProvideIconPack(TablerPack.Outline) { ... }
ProvideIconPack(PhosphorPack.Regular) { ... }
ProvideIconPack(BootstrapPack.Filled) { ... }

// Material Symbols — composable factory (loads variable font)
ProvideIconPack(rememberMaterialSymbolsPack()) { ... }
ProvideIconPack(rememberMaterialSymbolsPack(MaterialSymbolsVariant.Rounded)) { ... }
```

### Render icons

```kotlin
// Reads the pack from LocalIconPack automatically
AppIcon(
    token = RikkaIcons.Heart,
    contentDescription = "Like",
)

// Override per-icon if needed
AppIcon(
    token = RikkaIcons.Search,
    contentDescription = "Search",
    pack = LucidePack,
)

// Decorative (no accessibility semantics)
DecorativeAppIcon(token = RikkaIcons.Star)
```

### Fallback chains

If one pack is missing an icon, fall through to another:

```kotlin
val icons = TablerPack.Outline.withFallback(LucidePack)

ProvideIconPack(icons) {
    // tries Tabler first, then Lucide
    AppIcon(token = RikkaIcons.Heart, contentDescription = "Like")
}
```

---

## 🏗️ Three-Tier Token System

| Tier | Object | Tokens | Guarantee |
|------|--------|--------|-----------|
| **Core** | `RikkaIcons` | 229 | Resolves in all packs |
| **Extended** | `RikkaIconsExtended` | 238 | MS required + ≥3 of 4 vector pack families |
| **Loose** | `RikkaIconsLoose` | 341 | MS required + 1-2 vector packs, organized by pack |

```kotlin
// Core — universal, works everywhere
RikkaIcons.Heart
RikkaIcons.Search
RikkaIcons.ArrowLeft  // autoMirror = true for RTL

// Extended — broad coverage across packs
RikkaIconsExtended.Palette

// Loose — pack-specific, dependency explicit at call site
RikkaIconsLoose.Lucide.WholeWord
RikkaIconsLoose.Tabler.Forklift
RikkaIconsLoose.Phosphor.Stethoscope
RikkaIconsLoose.Bootstrap.Bandaid
```

---

## 📚 Available Packs

| Pack | Icons | Styles | Type |
|------|-------|--------|------|
| **Material Symbols** | 810 mapped | Outlined, Filled | Font glyph |
| **Material Symbols Rounded** | 810 mapped | Rounded, Filled Rounded | Font glyph |
| **Material Symbols Sharp** | 810 mapped | Sharp, Filled Sharp | Font glyph |
| **Lucide** | 1,573 | Outline | ImageVector |
| **Tabler** | 5,039 + 1,053 | Outline, Filled | ImageVector |
| **Phosphor** | 1,512 × 3 | Regular, Bold, Fill | ImageVector |
| **Bootstrap** | 1,408 + 670 | Outline, Filled | ImageVector |

---

## 🧩 Modules

| Module | Description |
|--------|-------------|
| `core` | `IconToken`, `IconPack`, `AppIcon`, `ProvideIconPack` |
| `tokens-core` | 229 common icon tokens |
| `tokens-extended` | 238 extended tokens (MS + 3+ vector packs) |
| `tokens-loose` | 341 pack-specific tokens |
| `pack-lucide` | Lucide icon renditions |
| `pack-tabler` | Tabler Icons renditions (Outline + Filled) |
| `pack-phosphor` | Phosphor Icons renditions (Regular + Bold + Fill) |
| `pack-bootstrap` | Bootstrap Icons renditions (Outline + Filled) |
| `pack-material-symbols` | Material Symbols Outlined/Filled (variable font) |
| `pack-material-symbols-rounded` | Material Symbols Rounded/Filled Rounded |
| `pack-material-symbols-sharp` | Material Symbols Sharp/Filled Sharp |

---

## 🌍 Platform Support

| Platform | Status |
|----------|--------|
| Android (API 24+) | ✅ |
| Desktop (JVM) | ✅ |
| iOS arm64 | ✅ |
| iOS Simulator arm64 | ✅ |
| iOS x64 | ✅ |
| JavaScript (browser) | ✅ |
| WasmJs (browser) | ✅ |

Gradle resolves the correct artifact automatically — just add the dependency.

---

## 🖥️ Showcase App

A responsive web app for browsing and discovering the full icon catalog.

```bash
./gradlew :composeApp:wasmJsBrowserDevelopmentRun
```

- Browse all 466+ icon tokens with live rendering
- Search by name or token
- Filter by category
- Switch between 6 Material Symbols variants in real-time
- Responsive layout — adapts from mobile to desktop
- Detail pages with pack coverage, technical specs, and implementation examples

---

## 🔧 Build & Run

```bash
# Run the showcase web app
./gradlew :composeApp:wasmJsBrowserDevelopmentRun

# Publish all modules to local Maven
./gradlew publishToMavenLocal --no-configuration-cache -PRELEASE_SIGNING_ENABLED=false

# Run all tests
./gradlew allTests
```

---

## ✨ Key Design Decisions

- **Semantic tokens, not icon imports** — UI code references `RikkaIcons.Heart`, never a specific vector or font glyph. Swapping the entire icon set is a one-line change at `ProvideIconPack`.

- **Two rendition types** — `Glyph` (font-based, tiny bundle, variable axes) and `Vector` (ImageVector, pixel-perfect, no font loading).

- **Font glyph for Material Symbols** — Variable font supports weight/grade/opticalSize/fill axes at runtime. A single ~800KB font replaces thousands of individual SVG vectors.

- **Fallback chains with style mismatch detection** — `pack.withFallback(other)` enables graceful degradation. `hasStyleMismatch` warns when mixing Outline + Filled packs.

- **Zero Material3 dependency** — Built on `compose.foundation` + `compose.ui` only.

RikkaIcons

RikkaIcons 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

RikkaIcons

RikkaIcons 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README