https://github.com/ipatavatsizz/ionicons
Unofficial Jetpack Compose library integrating Ionicons—premium, open-source icons by Ionic—for seamless use in Compose-based Android applications.
https://github.com/ipatavatsizz/ionicons
android compose icon-pack icons ionic ionicons ionicons-android kotlin mobile webcomponents
Last synced: 10 months ago
JSON representation
Unofficial Jetpack Compose library integrating Ionicons—premium, open-source icons by Ionic—for seamless use in Compose-based Android applications.
- Host: GitHub
- URL: https://github.com/ipatavatsizz/ionicons
- Owner: ipatavatsizz
- Created: 2025-02-17T21:04:39.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2025-04-12T00:07:51.000Z (10 months ago)
- Last Synced: 2025-04-12T00:29:02.762Z (10 months ago)
- Topics: android, compose, icon-pack, icons, ionic, ionicons, ionicons-android, kotlin, mobile, webcomponents
- Language: Kotlin
- Homepage:
- Size: 3.11 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
> [!CAUTION]
> This project is an unofficial integration of [Ionicons](https://ionic.io/ionicons) into Jetpack
> Compose, developed to suit personal requirements. Right now, due to my focus is on another project, limiting the time I can dedicate to this one.
> However, once my current work is complete, I plan to allocate more time to this project and ensure it remains consistently updated.
# Ionicons Compose Integration
[Ionicons](https://ionic.io/ionicons) is an open-source icon set featuring over 1,300 handcrafted
icons designed for web, iOS, Android, and desktop applications. This repository offers a Jetpack
Compose library to seamlessly incorporate Ionicons into your Android Compose projects.
## Features
- **Comprehensive Icon Library**: Access a wide range of icons suitable for various applications.
- **Seamless Integration**: Effortlessly include icons in your Jetpack Compose UI components.
- **Customizable**: Adjust icon properties such as size, color, and style to meet your design needs.
## Installation
The Ionicons Compose library is available via JitPack. To add it to your project:
**Step 1: Add JitPack Repository (settings.gradle.kts)**
```kotlin
dependencyResolutionManagement {
repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
repositories {
google()
mavenCentral()
maven { url = uri("https://jitpack.io") } // Add JitPack repository
}
}
```
**Step 2: Add the Dependency (app/build.gradle.kts)**
```kotlin
dependencies {
// ... other dependencies
implementation("com.github.ipatavatsizz:ionicons:")
}
```
**Important:** Replace `` with the actual version you want to use. You can find the available version tags on the [Tags page](https://github.com/ipatavatsizz/ionicons/tags) of the repository (e.g., `v1.0.0`, `v1.0.1`).
## Usage
After adding the dependency, you can use Ionicons in your Compose UI as shown below:
```kotlin
import androidx.compose.material.Icon
import net.moonshred.ionicons.Ionicons
import net.moonshred.ionicons.Outline.Hammer
Icon(
Ionicons.Outline.Hammer,
contentDescription = "Hammer Icon"
)
```
## Icon Sets
> [!NOTE]
> You can browse icons at https://ionic.io/ionicons
>
> You can access cheatsheet at https://unpkg.com/ionicons/dist/cheatsheet.html
Ionicons provides three distinct icon styles:
- **Outline**: Icons with an outlined design.
- **Filled**: Solid icons with filled shapes.
- **Sharp**: Icons featuring sharp edges.
Access these sets through the `Ionicons` object:
```kotlin
Ionicons.Outline.IconName
Ionicons.Filled.IconName
Ionicons.Sharp.IconName
```
## Contributing
Contributions are welcomed but I would like to stick to the original repository.
If you'd like to report issues, or suggest enhancements, please open an issue or submit a pull request.
## License
This project is licensed under the MIT License. See
the [LICENSE](https://opensource.org/licenses/MIT) file for details.