Favicon Generator

favicon-generator

Use Favicon Generator through the Zavilo SDK. Check input limits, parameters, output and supported modes below.

H · HeadlessI · InteractiveE · Embedded

Tool IDfavicon-generator

Version1

ExecutionCLIENT

WorkloadSTANDARD

ModesHeadless, Interactive, Embedded

Quick actions

Input files 1Output files 1–5

Result handling → Recipes → Integration examples → Playground →

Input

Accepted input contract for this Tool.

Kind	file
File count	1 – 1
Accepted MIME types	image/jpeg, image/png, image/webp

Parameters

Pass these values through request.options.

Parameter	Type	Required	Default	Allowed / Range	Description
`cropX`	integer	Optional	—	0 – 32768	Optional source crop X coordinate. Omit to center the crop.
`cropY`	integer	Optional	—	0 – 32768	Optional source crop Y coordinate. Omit to center the crop.
`cropSize`	integer	Optional	—	1 – 32768	Optional square crop size in source pixels. Omit to use the largest centered square.
`transparent`	boolean	Optional	`true`	—	Keep transparent pixels in generated PNG favicons.
`color`	string	Optional	`#ffffff`	—	Background color used when transparent is false.
`includeIco`	boolean	Optional	`true`	—	Also return favicon.ico built from available 16, 32 and 48 pixel PNG assets.

Output

Result contract returned after successful processing.

Type	files
File count	1 – 5
MIME types	image/png, image/x-icon
Metadata	width, height, inputBytes, outputBytes, cropX, cropY, cropSize, outputCount
ZIP archive	Yes · threshold 2

Basic usage

Choose a supported integration mode and copy the generated starter code.

Headless

const result = await client.run("favicon-generator", {
  file,
  options: { transparent: true }
});
console.log(result.files, result.data, result.metadata);

Interactive

await client.open({
  tool: "favicon-generator",
  input: { file },
  options: { transparent: true },
  onComplete(result) { console.log(result.files, result.data, result.metadata); }
});

Embedded

await client.mount({ tool: "favicon-generator", target: "#zavilo-tool", mode: "embedded" });

This page is generated from the SDK Tool Definition used by the runtime.