Platform-aware Open Graph image helpers with sane aspect-ratio defaults, locale-aware font loading, and adapters for Next.js, Edge runtimes, Workers, and TanStack Start.

How do I use Better OG?

Better-og provides easy-to-use helpers for generating Open Graph images. You can integrate it with Next.js, Edge runtimes, Workers, and TanStack Start using our dedicated adapters.

Yes, Better OG is completely free and open-source under the MIT license.

Introducao

Renderizacao Open Graph consciente da plataforma com layout adaptativo e fontes multilingues.

Visao geral

better-og e um toolkit para imagens Open Graph que ajusta automaticamente o tamanho e o layout de acordo com a plataforma que requisita a imagem.

Deteccao de plataforma com sinais reais do request.
Proporcoes e safe areas prontas para uso.
Adaptadores para Next.js, Workers e TanStack Start.

Instalacao

Instale apenas os pacotes do runtime alvo e reutilize o mesmo componente OG em qualquer ambiente.

pnpm add @better-og/core next react

Primeira rota

Crie um handler OG, carregue as fontes e retorne o componente que deve ser renderizado como imagem.

app/og/[lang]/route.tsx

import { resolveFontSetup } from "@better-og/core";
import {
  createOgRouteHandler,
  loadGoogleFontForImageResponse,
} from "@better-og/next";

export const runtime = "nodejs";
export const revalidate = false;

const fontSetup = await resolveFontSetup({
  baseFonts: await loadGoogleFontForImageResponse({
    family: "Geist",
    weights: [400, 700],
  }),
  fallbackLocales: ["ja"],
});

export const GET = createOgRouteHandler({
  component: (ogContext) => (
    <div
      style={{
        display: "flex",
        width: "100%",
        height: "100%",
        alignItems: "center",
        justifyContent: "center",
        fontFamily: fontSetup.families.base,
        paddingBottom: 32 + ogContext.safeArea.bottom,
        background: "linear-gradient(135deg, #0d192c, #174a70, #4993d6)",
        color: "white",
      }}
    >
      <div style={{ fontSize: 64, fontWeight: 700 }}>Hello from better-og</div>
    </div>
  ),
  baseFonts: fontSetup.fonts,
});

Adicionar o proxy

Adicione withOgRewrite para preencher automaticamente platform, layout e aspect_ratio.

proxy.ts

import { withOgRewrite } from "@better-og/next";
import type { NextRequest } from "next/server";

export async function proxy(request: NextRequest) {
  return await withOgRewrite(request);
}

export const config = {
  matcher: ["/og/:path*"],
};

Configuracao do Next.js

Se usar Takumi no Node, mantenha o pacote como externo no Next.js.

next.config.ts

import type { NextConfig } from "next";

const nextConfig: NextConfig = {
  serverExternalPackages: ["@takumi-rs/image-response"],
};

export default nextConfig;

Edit on GitHub

Last updated on