Skip to main content
OGify supports rendering emojis in your images by downloading vector or image assets from open-source emoji providers.

Configuration

You can specify the emojiProvider when defining a template. It is set per template during template definition.
import { defineTemplate } from "@ogify/core";

const template = defineTemplate({
  fonts: [{ name: "Inter", weight: 400 }],
  emojiProvider: "twemoji", // Default
  renderer: ({ params }) => {
    return `<div>${params.title}</div>`;
  },
});

Supported Providers

Twemoji

Twitter Emojis (Default) - Colorful, rounded style

Fluent

Microsoft Fluent Emojis - 3D style with color

Fluent Flat

Microsoft Fluent Emojis - Flat 2D variant

Noto

Google Noto Emojis - Current standard

Blobmoji

Blobmojis - Google’s blob-style emoji

OpenMoji

OpenMoji - Open-source with outlined style

Usage

Simply include the emoji character in your string content. The renderer will automatically detect it and replace it with the corresponding image asset during generation.
renderer: ({ params }) => `
  <div>
    <h1>${params.title}</h1> <!-- If title contains "👋", it will be rendered -->
    <p>🎉 🚀 ✨</p>
  </div>
`;
Emoji assets are automatically cached by the renderer’s cache system to avoid repeated network requests and improve performance.