https://github.com/buyungsp/cordova-plugin-vector-smooth
The cordova-plugin-vector-smooth plugin is used to convert vector drawable files into base64 encoded images for use in Cordova applications. It supports XML vector drawable files, as well as PNG and BMP file formats.
https://github.com/buyungsp/cordova-plugin-vector-smooth
android cordova-plugin drawable image xml
Last synced: about 2 months ago
JSON representation
The cordova-plugin-vector-smooth plugin is used to convert vector drawable files into base64 encoded images for use in Cordova applications. It supports XML vector drawable files, as well as PNG and BMP file formats.
- Host: GitHub
- URL: https://github.com/buyungsp/cordova-plugin-vector-smooth
- Owner: buyungSP
- Created: 2023-06-14T14:17:02.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-11T23:19:38.000Z (about 2 years ago)
- Last Synced: 2025-02-01T01:19:23.297Z (over 1 year ago)
- Topics: android, cordova-plugin, drawable, image, xml
- Language: Java
- Homepage:
- Size: 5.86 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# cordova-plugin-vector-smooth
The **cordova-plugin-vector-smooth** plugin is used to convert vector drawable files into base64 encoded images for use in Cordova applications.
It supports **XML vector drawable files**, as well as **PNG and BMP file formats**.
It also allows retrieving the **application icon (app logo)** without modifying its color or size.
---
## Platform Support
- Android
---
## Installation
You can install this plugin through Cordova CLI by running the following command:
```
cordova plugin add cordova-plugin-vector-smooth
```
---
## Usage
### Function: `open`
```js
cordova.plugin.vector.smooth.open({
name: 'ic_vector',
color: '#FF0000'
}).then(function(result) {
console.log(result.src);
});
```
#### Parameters
- **name** *(string)* → the name of the vector drawable file in the `res/drawable` folder.
- **color** *(string)* → the color tint that will be applied to the vector drawable.
#### Output
The output of this function is a base64 encoded image (PNG or BMP), depending on the type of icon.
You can use the result in an `![]()
` tag or as a CSS background.
#### Example
```js
document.addEventListener('deviceready', onDeviceReady, false);
async function onDeviceReady() {
const imgContainer = document.createDocumentFragment();
const crop = await cordova.plugin.vector.smooth.open({
name: 'crop',
color: '#FF00FF'
});
const img = document.createElement('img');
img.src = crop.src;
imgContainer.appendChild(img);
document.body.appendChild(imgContainer);
}
```
---
### Function: `getAppLogo`
This function retrieves the **application logo (ic_launcher)** as base64 without any modification (original color and size).
```js
cordova.plugin.vector.smooth.getAppLogo()
.then(function(result) {
console.log(result.src);
document.getElementById("logo").src = result.src;
})
.catch(function(err) {
console.error(err);
});
```
#### Parameters
- No parameters required.
#### Output
Returns a base64 encoded PNG of the current app logo.
#### Example
```js
document.addEventListener('deviceready', async function() {
const logo = await cordova.plugin.vector.smooth.getAppLogo();
const img = document.createElement('img');
img.src = logo.src;
img.style.width = "100px"; // optional resize in HTML/CSS
document.body.appendChild(img);
});
```
---