SVG 2 Android Vector Plugin

A simple, Gradle plugin for automatic conversion of SVGs to Android Vector drawables during the build using Android's official conversion tool.

Android does not support SVG drawables out of the box because it does not implement the full SVG spec. Instead, it has its own XML-based, vector format. Android Studio contains an SVG to Android vector conversion tool named Vector Asset Studio. That tool is a one-time tool that converts the SVGs to the new format, which is then checked in. This means the source of truth for the drawable is no longer the general SVG file a designer might produce, but the converted file. To ensure the source and the artifact stay in sync, this plugin allows you to check in just the SVG and produce the Android Vector at build time.

Consuming

build.gradle

plugins {
    id 'com.quittle.svg-2-android-vector' version '0.0.1'
}

Resouce layout

Put your SVGs in the raw Android resource folder and consume them as if they were in the drawable. You will not be able to consume the original SVGs as their names would conflict.

src
└── main
    ├── java
    │   └── com
    │       └── example
    │           └── project
    │               └── MyActivity.java // mView.setBackground(R.drawable.ic_foobar);
    └── res
        └── raw
            └── ic_foobar.svg

Building

# Build the plugin and run static analysis tools
./gradlew -p svg-2-android-vector

# Publish it the local maven
TEST_PLUGIN_ID_OVERRIDE=plugin-id-override ./gradlew -p svg-2-android-vector publishToMavenLocal

# Apply the plugin locally in a test project that validates it runs.
TEST_PLUGIN_ID_OVERRIDE=plugin-id-override ./gradlew -p example-android-project assemble

Publishing

This package is deployed via GitHub Actions on the main branch. See .github/workflows/gradle.yml for the CI/CD setup.

This repository has GRADLE_PUBLISH_KEY and GRADLE_PUBLISH_SECRET secrets set up from https://plugins.gradle.org injected into the build.

Upon check-in to the main branch, GitHub Actions checks out, builds, and deploys the plugin. Version numbers are determined by tag names.

quittle / gradle-svg-2-android-vector