IconsaxCompose

1.0.1indexed

Compose-first, lightweight icon library exposing the complete Iconsax set as strongly-typed, compile-time ImageVector icons in multiple styles; generated via Gradle for zero runtime parsing.

AndroidJVMNative·YohannesTz/IconsaxCompose

Stars

—

Used by

dependents

—

Health

/ 100

Iconsax Compose Multiplatform

A lightweight Compose Multiplatform icon library providing the complete Iconsax icon set as strongly-typed, composable-friendly icons.

✅ Supports Android, iOS, and Desktop (JVM).

Designed to feel native to Compose while staying simple, fast, and dependency-light.

Preview

https://github.com/user-attachments/assets/e8fe0bf7-3df9-4a61-bb9f-f5508ef134e7

Features

Full Iconsax icon set
Compose-first API
Strongly typed icons (no string lookups)
Zero runtime parsing (icons resolved at compile time)
Minimal overhead — pure Kotlin + Compose
Works with Material 3 (and Material 2–style themes)

Module Scope

This repository contains:

iconsaxcompose → the reusable icon library
A sample app exists only for preview and testing

This README documents the library, not the sample application.

Installation

This library is published to Maven Central.

Add the dependency

For Compose Multiplatform, add to the commonMain dependencies block:

kotlin {
    sourceSets {
        commonMain.dependencies {
            implementation("io.github.yohannestz:iconsax-compose:1.0.1")
        }
    }
}

For Android-only projects:

dependencies {
    implementation 'io.github.yohannestz:iconsax-compose:1.0.1'
}

Latest version shown in the badge above.

Icon Styles

Iconsax icons are grouped by style:

Linear
Bold
Outline
TwoTone
Bulk
Broken

Each style is exposed as a dedicated icon group for type safety and IDE discoverability.

Usage

Basic Icon

Icon(
    imageVector = Iconsax.Linear.Home,
    contentDescription = "Home"
)

With tint and size

Icon(
    imageVector = Iconsax.Bold.Notification,
    contentDescription = "Notifications",
    tint = Color(0xFF3DDC84),
    modifier = Modifier.size(24.dp)
)

Inside Compose layouts

Row(
    verticalAlignment = Alignment.CenterVertically
) {
    Icon(
        imageVector = Iconsax.Outline.SearchNormal,
        contentDescription = null
    )
    Spacer(Modifier.width(8.dp))
    Text("Search")
}

Theming

Iconsax Compose icons are standard ImageVectors and fully respect:

LocalContentColor
MaterialTheme.colorScheme
Alpha and tint modifiers

Example:

CompositionLocalProvider(
    LocalContentColor provides MaterialTheme.colorScheme.primary
) {
    Icon(
        imageVector = Iconsax.Linear.Heart,
        contentDescription = null
    )
}

Icon Generation

All icons in this library are generated automatically using a custom Gradle task, ensuring consistency and eliminating manual maintenance.

Source of Icons

SVG files are sourced from the official Iconsax repository
Icons originate from the Iconsax React icon set
Each icon style maps directly to its SVG directory

Generation Pipeline

The Gradle task clones the Iconsax repository (shallow clone)
SVGs are grouped by style (Bold, Linear, Outline, etc.)
Each SVG is converted into a Compose ImageVector using svg-to-compose (s2c)
Generated icons are written into structured Kotlin packages
Aggregated API objects (Iconsax, IconsaxBold, etc.) are generated automatically

Gradle Task

./gradlew generateIconsax

This task:

Uses the s2c CLI to convert SVGs
Produces optimized, minified Compose vectors
Generates strongly typed accessors
Requires no runtime SVG parsing

All generated code lives under src/main/java and is committed to the repository.

Package Structure (Simplified)

iconsaxcompose/
├── Iconsax.kt
├── IconsaxBold.kt
├── IconsaxLinear.kt
├── IconsaxOutline.kt
├── IconsaxTwoTone.kt
├── IconsaxBulk.kt
├── IconsaxBroken.kt
├── linear/
├── bold/
├── outline/
├── twotone/
├── bulk/
└── broken/

Each icon is generated as an ImageVector and grouped by style.