Giter Club home page Giter Club logo

compose-icons's Introduction

compose-icons

Compose icons is a pack of libraries that provide well known Icon Packs to use in Jetpack Compose Multiplatform. The library usage is inspired by Compose Material Icons.

Compose versions

  • Jetpack Compose (Android): 1.0.0
  • Jetbrains Compose (Desktop): 0.5.0-build235

Adding to your project

Add the project repository:

repositories {
    mavenCentral()
}

For Jetpack Compose (Android):

implementation("br.com.devsrsouza.compose.icons.android:ICON_PACK:1.0.0")

For Jetbrains Compose (Desktop):

implementation("br.com.devsrsouza.compose.icons.jetbrains:ICON_PACK:1.0.0")

Example

Icon(
    imageVector = FontAwesomeIcons.Brands.Github,
)

Icon Packs

Icon pack Icon Version Dependency All Icons Docs
Simple-Icons 4.14.0 simple-icons docs
Feather 4.28.0 feather docs
Tabler Icons 1.39.1 tabler-icons docs
Eva Icons 1.1.3 eva-icons docs
Font Awesome 5.15.2 font-awesome docs
Octicons 12.1.0 octicons docs
Linea 1.0 linea docs
Line Awesome 1.3.0 (a60f113) line-awesome docs
Weather Icons by Erik Flowers 2.0.12 erikflowers-weather-icons docs
css.gg 2.0.0 css-gg docs

How the project works

The project uses Kotlin Scripting (main.kts) to download and generate the icons into Compose source code, to generate the source code it uses the tooling library svg-to-compose.

Currently, the Jetpack Compose(Android) and Jetbrains Compose (Desktop/Multiplatform) are a separated artifact and builds, this means that for the library to support both is need artifacts for both.

In the future, when Compose Desktop and Android use the same artifact, the project will migrate to it and use only one artifact for both.

Contribution

If you know a icon pack that the project could support, please, submit an issue :D

License

The icon packs have their own license that you can find at the All Icons Docs

Project license:

MIT License

Copyright (c) 2021 DevSrSouza

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

compose-icons's People

Contributors

devsrsouza avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.