Skip to content

A Kotlin Multiplatform library to generate compose.ui.graphics.vector.ImageVector from XML files

Notifications You must be signed in to change notification settings

serbelga/compose-vectorize

Repository files navigation

Compose Vectorize

Maven Central

A Kotlin Multiplatform library to generate compose.ui.graphics.vector.ImageVector from .xml files.

Visit the project website for documentation.

Usage

Create a folder called xml-images in the module folder.

:module/xml-images

Android

Captura de pantalla 2024-01-05 a las 16 57 56

Multiplatform

Captura de pantalla 2024-01-05 a las 17 10 28

Generate images

You can manually generate ImageVector for these XML files by calling gradle generateImages. This will create a Kotlin file for each XML file containing the ImageVector in the build folder.

Captura de pantalla 2024-01-05 a las 17 00 45

Now, you can use reference this image in the Compose code:

Icon(Images.Icons.Add, contentDescription = null)

Note that automatically a category called "Icons" has been created. A category is created for each subfolder in xml-images folder.


Themed Attributes

It also supports theme attributes. If you are using theme color attributes, like ?attr/colorPrimary or ?attr/colorSecondary, they can be converted to Compose MaterialTheme tokens, which means that you can update illustration colors based on the token values. It is also compatible with Material3 dynamic colors.

It also supports theme attributes. If you are using theme color attributes, like ?attr/colorPrimary or ?attr/colorSecondary, they can be converted to Compose MaterialTheme tokens, which means that you can update illustration colors based on the token values. It is also compatible with Material3 dynamic colors.

    <path
        android:pathData="..."
        android:fillColor="?attr/colorPrimary"/>
Screenshot_20240310_145842 Screenshot_20240310_145842-2 Screenshot_20240310_145842-1

Note

It requires use Compose Material 3 dependency.


License

   Copyright 2024 Sergio Belda

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.