Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/DevSrSouza/svg-to-compose

Converts SVG and Android Vector Drawable in Compose Multiplatform source code
https://github.com/DevSrSouza/svg-to-compose

android compose-for-desktop compose-jb compose-multiplatform compose-multiplatform-library jetpack-compose kotlin svg

Last synced: 2 months ago
JSON representation

Converts SVG and Android Vector Drawable in Compose Multiplatform source code

Host: GitHub
URL: https://github.com/DevSrSouza/svg-to-compose
Owner: DevSrSouza
License: mit
Created: 2020-11-08T15:23:31.000Z (almost 4 years ago)
Default Branch: master
Last Pushed: 2024-05-28T10:26:44.000Z (5 months ago)
Last Synced: 2024-06-20T05:48:09.398Z (5 months ago)
Topics: android, compose-for-desktop, compose-jb, compose-multiplatform, compose-multiplatform-library, jetpack-compose, kotlin, svg
Language: Kotlin
Homepage:
Size: 115 KB
Stars: 396
Watchers: 5
Forks: 34
Open Issues: 15
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome - SVG to Compose - platform (Uncategorized / Uncategorized)

README

        # SVG to Compose [Experimental]

Converts SVG or Android Vector Drawable to Compose code.

- [Android Studio/IntelliJ plugin](https://plugins.jetbrains.com/plugin/18619-svg-to-compose) by [overpass](https://github.com/overpas)

### Why this project

On the start of the [Compose for Desktop](https://www.jetbrains.com/lp/compose/) it does not support SVG files and Android Vector Drawables. This also difficulties a migration of the App to Multiplatform (Desktop and Android).

Currently, it does support Android Vector Drawables in the Desktop allowing share your vectors. 

### Use cases

Now Compose for Desktop supports android vector drawables, this means that the first reason that the project was created does not apply anymore,

this does not mean that it is not useful anymore.

Use cases:

- Manipulate dynamic an SVG file in code, you can generate and do source code modifications.

- Create an Icon pack similar to how Material Icons works on Compose ([compose-icons](https://github.com/DevSrSouza/compose-icons) is build with SVG to Compose)

### How its work

The project uses Android's [Svg2Vector](https://android.googlesource.com/platform/tools/base/+/master/sdk-common/src/main/java/com/android/ide/common/vectordrawable/Svg2Vector.java) to convert SVG to Android Drawables and uses a customized material icon code generator from the Jetpack Compose [source code](https://cs.android.com/androidx/platform/frameworks/support/+/androidx-main:compose/material/material/icons/generator/) to generate the source code of the SVG file.

### Example 1: Running with Kotlin Scripting

file: `jetnews-drawables-to-compose.main.kts`

```kotlin

@file:Repository("https://jitpack.io")

@file:Repository("https://maven.google.com")

@file:Repository("https://jetbrains.bintray.com/trove4j")

@file:DependsOn("com.github.DevSrSouza:svg-to-compose:-SNAPSHOT")

@file:DependsOn("com.google.guava:guava:23.0")

@file:DependsOn("com.android.tools:sdk-common:27.2.0-alpha16")

@file:DependsOn("com.android.tools:common:27.2.0-alpha16")

@file:DependsOn("com.squareup:kotlinpoet:1.7.2")

@file:DependsOn("org.ogce:xpp3:1.1.6")

import br.com.devsrsouza.svg2compose.Svg2Compose

import br.com.devsrsouza.svg2compose.VectorType

import java.io.File

val assetsDir = File("assets")

val srcDir = File("src/main/kotlin")

Svg2Compose.parse(

    applicationIconPackage = "assets",

    accessorName = "JetnewsAssets",

    outputSourceDirectory = srcDir,

    vectorsDirectory = assetsDir,

    type = VectorType.DRAWABLE,

    allAssetsPropertyName = "AllAssets"

)

```

![](https://i.imgur.com/f7txCag.png)

Generating code by using executing `kotlin jetnews-drawables-to-compose`

![](https://i.imgur.com/5UTmT70.png)

**Using in code**: `JetnewsAssets.JetnewsLogo`

![](https://i.imgur.com/YAriDvV.png)

#### Svg

The only difference for SVG files is the `VectorType.SVG`.

### Example 2: Generating a whole Icon pack

For Icon Packs, subgroups is supported: `IconPack/group/icon.svg`

![](https://i.imgur.com/cunhmxl.png)

```kotlin

val assetsDir = File("linea-icons")

val srcDir = File("src/main/kotlin")

Svg2Compose.parse(

    applicationIconPackage = "assets",

    accessorName = "LineaIcons",

    outputSourceDirectory = srcDir,

    vectorsDirectory = assetsDir,

    type = VectorType.SVG,

    iconNameTransformer = { name, group -> name.removePrefix(group) },

    allAssetsPropertyName = "AllIcons"

)

```

**Using in code**: `LineaIcons.Arrows.Buhttps://github.com/overpas/svg-to-compose-intellijttonUp`

The project also generate an accessor for all yours assets, for the given example, it should be `LineaIcons.AllIcons` and it also generated for child groups `LineaIcons.Arrows.AllIcons`