Framework guide

Dynamic Open Graph images for React

React apps can use OGKit from the server, framework metadata layer, or static generation step. Build a full HTTPS image URL and place it in `og:image` plus `twitter:image`.

Every framework only needs a stable, absolute HTTPS og:image. OGKit gives you one URL, production templates, and query parameters for titles, images, logos, authors, products, events, jobs, and code snippets.

Server-rendered metadata is the SEO boundary

Open Graph images only help distribution when the final HTML response already contains the metadata. Most scrapers do not wait for client-side JavaScript, so React hydration, client routers, and analytics callbacks are too late. Build the OGKit URL in the server route, loader, layout, view helper, or static generation step that owns the document head.

Use one deterministic image URL per canonical page

The strongest pattern is one stable 1200x630 image URL for each canonical URL. Put the same image in Open Graph and Twitter/X metadata, keep the title aligned with the visible H1, and include page-specific context such as author, product name, release version, or docs section. That gives Slack, Discord, LinkedIn, iMessage, and browser-assisted LLM crawlers the same topic signal as the page body.

When to choose hosted templates over custom renderers

Custom Satori, Puppeteer, or screenshot routes make sense when you need arbitrary layout control. Hosted templates make more sense when the business need is repeatable: blog cards, launch pages, changelogs, docs pages, product pages, and comparison pages that should look consistent without a renderer living in every codebase.

Implementation pattern

Generate the OGKit URL before the crawler sees the HTML. That can happen during static generation, in a server route, or in the framework metadata layer. Start with the API reference, deep guides, test the URL in the Playground, then validate the deployed page with the preview debugging tools.

// Prefer your host's SSR/SSG metadata — not a client effect
const og = new URL("https://www.webmorp.art/api/og/minimal");
og.searchParams.set("key", process.env.OGKIT_KEY);
og.searchParams.set("title", pageTitle);
// Emit in the document head from Remix/Next/Astro/etc:
// <meta property="og:image" content={og.toString()} />

Deeper React notes

React alone does not own <head>

A client-only React SPA cannot reliably set Open Graph tags for Slack or LinkedIn. Pair React with Next.js, Remix, Astro islands, or a server that renders meta tags into the first HTML response. OGKit then becomes a plain HTTPS URL you inject from that server.

Vite / CRA production pattern

If you must stay on a static host, generate OGKit URLs at build time for each content entry (CMS export or markdown) and write them into prerendered HTML or a meta plugin. Do not call the OG API from the browser with a production key.

Worked steps

Choose the server or SSG layer that emits HTML.
Build an OGKit URL with title/subtitle for that route.
Set og:image and twitter:image to the same absolute URL.
Validate with /tools debuggers after deploy.

Checklist

Set metadata from your hosting framework, CMS, or SSR layer — not useEffect.
Generate the URL before HTML is served to crawlers.
Use one image per important route; mirror twitter:image.
Keep OGKIT_KEY in server env only.

Common pitfalls

Trying to update OG tags after hydration
Expecting crawlers to run client-side React
Using one generic image for every route
Shipping the API key in Create React App / Vite public env

When a hosted OG API makes sense

A hosted Open Graph image API is useful when you need consistent cards across many pages but do not want to maintain a custom renderer in every app. It is especially useful for docs, changelogs, launch pages, public customer pages, and content collections where the title and summary change often. For HMAC signing and rescrape workflows, see signed URLs and caching & rescrape.

Frequently asked questions

How do I add dynamic Open Graph images to React?

Build an absolute OGKit image URL on the server or during static generation, then place it in og:image and twitter:image metadata for each important page.

Can I use OGKit with React without a custom image route?

Yes. OGKit returns a normal 1200x630 PNG URL from template and query parameters, so you do not need to maintain a Satori, Puppeteer, or screenshot pipeline.

Where should I keep the OGKit API key?

Keep the API key in server-side environment variables, framework runtime config, or build-time secrets. Do not bundle it into client-side JavaScript.

I changed the title but Slack still shows the old card — what now?

Rebuild/redeploy so HTML has the new OGKit query, confirm with curl, then rescrape Facebook/LinkedIn. Slack often needs a new image URL (updated fields or v=). See /guides/troubleshooting.