
Lucide icon set provided as ImageVector icons for UI use; auto-generated from upstream releases and exposed as extension properties for easy lookup, sizing, tinting, and accessibility.
Lucide Compose provides the Lucide icon set as Compose Multiplatform ImageVector
values. Icons are exposed as extensions on Lucide, for example Lucide.Mail.
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.
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.
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.
The generated icon sources are updated from upstream Lucide releases by the repository's GitHub Actions workflow. They currently track upstream Lucide 1.75.0. Avoid editing generated icon files by hand.
See CONTRIBUTING.md for development and pull request guidance. Contributors are expected to follow the Code of Conduct.
Original project code is available under the MIT License. Generated Lucide icons retain their upstream license terms; see THIRD_PARTY_NOTICES.md.
Lucide Compose provides the Lucide icon set as Compose Multiplatform ImageVector
values. Icons are exposed as extensions on Lucide, for example Lucide.Mail.
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.
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.
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.
The generated icon sources are updated from upstream Lucide releases by the repository's GitHub Actions workflow. They currently track upstream Lucide 1.75.0. Avoid editing generated icon files by hand.
See CONTRIBUTING.md for development and pull request guidance. Contributors are expected to follow the Code of Conduct.
Original project code is available under the MIT License. Generated Lucide icons retain their upstream license terms; see THIRD_PARTY_NOTICES.md.