Skip to content

About

No description, website, or topics provided.

Resources

Code of conduct

Contributing

Stars

1 star

Watchers

0 watching

Forks

Repository files navigation

Lucide Compose

Lucide Compose provides the Lucide icon set as Compose Multiplatform ImageVector values. Icons are exposed as extensions on Lucide, for example Lucide.Mail.

Installation

Add Maven Central to the repositories in your project's settings.gradle.kts:

dependencyResolutionManagement {
    repositories {
        google()
        mavenCentral()
    }
}

Add the library to the source set or module that uses it. For a Kotlin Multiplatform project:

commonMain.dependencies {
    implementation("io.github.cinnakentoast:lucide-icons:0.1.0")
}

For an Android Compose project:

dependencies {
    implementation("io.github.cinnakentoast:lucide-icons:0.1.0")
}

The Maven Central coordinate will be usable after the first release is published.

Usage

import androidx.compose.material3.Icon
import com.shipsco.lucide_compose.Lucide
import com.shipsco.lucide_compose.Mail

Icon(
    imageVector = Lucide.Mail,
    contentDescription = "Mail"
)

The icons are ImageVector values, so they work with Compose's standard Icon composable and its sizing, tint, and accessibility parameters.

Supported targets

The library publishes Android, iOS, JVM, JavaScript, and WebAssembly variants. Use Compose Multiplatform on each target. Native SwiftUI code cannot directly consume Compose ImageVector values.

Lucide icon updates

The generated icon sources are updated from upstream Lucide releases by the repository's GitHub Actions workflow. They currently track upstream Lucide 1.77.0. Avoid editing generated icon files by hand.

Contributing

See CONTRIBUTING.md for development and pull request guidance. Contributors are expected to follow the Code of Conduct.

License

Original project code is available under the MIT License. Generated Lucide icons retain their upstream license terms; see THIRD_PARTY_NOTICES.md.

About

No description, website, or topics provided.

Resources

Code of conduct

Contributing

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages