)
)
}
`

Then run next dev and access localhost:3000/api/og, the React element will be rendered and responded as a PNG from that endpoint:

!Rendered OG image

Read more about the API, supported features and check out the examples in the following sections.

API Reference

@vercel/og supports both Node.js Runtime and Edge Runtime.

The package exposes an ImageResponse constructor, with the following options available:

`jsx
import { ImageResponse } from '@vercel/og'

// ...
new ImageResponse(
element: ReactElement,
options: {
width?: number = 1200
height?: number = 630
emoji?: 'twemoji' | 'blobmoji' | 'noto' | 'openmoji' | 'fluent' | 'fluentFlat' = 'twemoji',
fonts?: {
name: string,
data: ArrayBuffer,
weight: number,
style: 'normal' | 'italic'
}[]
debug?: boolean = false

// Options that will be passed to the HTTP response
status?: number = 200
statusText?: string
headers?: Record
},
)
`

When running in production, these headers will be included by @vercel/og:

`jsx
'content-type': 'image/png',
'cache-control': 'public, immutable, no-transform, max-age=31536000',
`

During development, the cache-control: no-cache, no-store header is used instead.

$3

Please refer to Satori’s documentation for a list of supported HTML and CSS features.

By default, @vercel/og only has the Noto Sans font included. If you need to use other fonts, you can pass them in the fonts option. Check the Custom Font example below for more details.

Examples

- Basic · _source_ · _demo_
- Embed SVG Image · _source_ · _demo_
- Dynamic PNG Image Based on URL Queries · _source_ · _demo_
- Fetch External Data · _source_ · _demo_
- Custom Font · _source_ · _demo_
- Emoji · _source_ · _demo_
- Languages · _source_ · _demo_
- Encrypted Token · _source_ · _demo_




Development / Contributing

$3


- pnpm i inside the playground/ directory
- pnpm dev to start the Next.js app

$3

- pnpm i inside the root directory
- pnpm build` to build the library

Acknowledgements

This project will not be possible without the following projects:

- Satori
- Twemoji
- Google Fonts and Noto Sans
- Resvg and Resvg.js

---