Recipe — social share card (OG-style PNG) | Apexify.js Docs

v5.4.5

Recipes · recipe

Current Apexify.js 6.0.0 documentation for Recipe — social share card (OG-style PNG).

apexify.jsRuntime: nodeCURRENTSince 6.0.0

Goal: A 1200×630 Open-Graph-style card — dark background + headline — written to disk with painter.save.

Prerequisites: Node ≥16, apexify.js installed, writable ./out (or change directory).

Steps

Instantiate ApexPainter (constructor type optional here — we save raw PNG bytes).
createCanvas — wide banner / colorBg.
createText — large headline onto the CanvasResults.
save — timestamped / counter filename under directory.

Full example

1import { ApexPainter } from "apexify.js";2 3async function main() {4  const painter = new ApexPainter({ type: "buffer" });5 6  const canvas = await painter.createCanvas({7    width: 1200,8    height: 630,9    colorBg: "#0f172a",10  });11 12  const png = await painter.createText(13    [14      {15        text: "Ship graphics from Node",16        x: 72,17        y: 340,18        font: { size: 64, family: "Arial" },19        color: "#f8fafc",20        bold: true,21      },22      {23        text: "apexify.js · buffers · save · charts · GIF",24        x: 72,25        y: 420,26        font: { size: 28, family: "Arial" },27        color: "#94a3b8",28      },29    ],30    canvas31  );32 33  const meta = await painter.save(png, {34    directory: "./out",35    naming: "timestamp",36    prefix: "share-card-",37    format: "png",38  });39 40  console.log("Wrote:", meta.path);41}42 43main().catch(console.error);

Variations

Want	Change
Logo `/` avatar	Add `createImage` — Images overview
Gradient backdrop	`createCanvas` gradients `/` BG layers — Canvas overview
Return base64 for an API	`new ApexPainter({ type: 'base64' })` + `await painter.outPut(png)` — Output encoding

Next steps