compose-font-icons
2.2.0indexedEnables use of font-based icons in Compose Multiplatform, supporting variable fonts, multiplatform resources and platform-specific resources.
20
Stars
—
Used by
dependents
—
Health
/ 100
Compose Font Icons for Kotlin Multiplatform
Makes possible to use icons from a font in JetBrains Compose Multiplatform. Currently supported targets are Android, Desktop (JVM), Web (JS and WASM), macOS, and iOS.
[!NOTE] iOS and macOS are not tested as much as the other targets. There should not be any issue however, since they use the same rendering as every other non-Android target.
This library supports the Compose Multiplatform Common resources API alongside platform-specific resources like resource IDs for Android, classpath resources for JVM...
Variable fonts are supported, the optical size (opsz) and weight (wgth) axes will be set automatically depending on the
icon size and provided parameters.
[!IMPORTANT] Due to a limitation in the Android API, Android versions older than Oreo (API 26) don't support variable fonts.
Setup
This library is available on Maven Central and GitHub Packages. Snapshot versions are also available on Maven Central's Snapshot repository.
Add this to your build.gradle(.kts):
dependencies {
implementation("dev.tclement.fonticons:core:2.2.0")
// ...
}
Modules
core
The main module, providing the core functionality of the library.
glance
A module providing support for AndroidX Glance (Android App Widgets / WearOS Tiles). This module is only compatible with Android.
Usage
(Optional) Set the default icon parameters:
CompositionLocalProvider(
LocalIconFont provides yourFont,
LocalIconTintProvider provides LocalContentColor
) {
// icons here will have by default the params declared above
}
[!TIP] Providing the default parameters is recommended. Otherwise, the parameters
iconFontandtintmust be provided for each icon.
You can then use the FontIcon composable to display an icon:
FontIcon(
icon = MyIconFont.MyIcon,
contentDescription = null
)
An alternative function that takes a String instead of a Char is also available, for fonts that supports ligatures:
FontIcon(
iconName = "my_icon",
contentDescription = null
)
Go on the website for advanced usage and additional information.