defineOgImageScreenshot() · Nuxt OG Image · Nuxt SEO

[NuxtSEO](https://nuxtseo.com/ "Home")

- [Modules](https://nuxtseo.com/docs/nuxt-seo/getting-started/introduction)
- [Tools](https://nuxtseo.com/tools)
- [Pro](https://nuxtseo.com/pro)
- [Learn SEO](https://nuxtseo.com/learn-seo/nuxt) [Releases](https://nuxtseo.com/releases)

[1.4K](https://github.com/harlan-zw/nuxt-seo)

[Nuxt SEO on GitHub](https://github.com/harlan-zw/nuxt-seo)

**OG Image v6** is here! Looking for an older version? [View v5 docs](https://nuxtseo.com/docs/og-image/v5/getting-started/introduction).

[User Guides](https://nuxtseo.com/docs/og-image/getting-started/introduction)

[API](https://nuxtseo.com/docs/og-image/api/define-og-image)

[Releases](https://nuxtseo.com/docs/og-image/releases/v6)

OG Image

- [Switch to OG Image](https://nuxtseo.com/docs/og-image/getting-started/introduction)
- [Switch to Nuxt SEO](https://nuxtseo.com/docs/nuxt-seo/getting-started/introduction)
- [Switch to Robots](https://nuxtseo.com/docs/robots/getting-started/introduction)
- [Switch to Sitemap](https://nuxtseo.com/docs/sitemap/getting-started/introduction)
- [Switch to Schema.org](https://nuxtseo.com/docs/schema-org/getting-started/introduction)
- [Switch to Link Checker](https://nuxtseo.com/docs/link-checker/getting-started/introduction)
- [Switch to SEO Utils](https://nuxtseo.com/docs/seo-utils/getting-started/introduction)
- [Switch to Site Config](https://nuxtseo.com/docs/site-config/getting-started/introduction)
- [Switch to Skew Protection](https://nuxtseo.com/docs/skew-protection/getting-started/introduction)
- [Switch to AI Ready](https://nuxtseo.com/docs/ai-ready/getting-started/introduction)

Search…```k`` /`

v6 (latest)

- Playgrounds
- [Discord Support](https://discord.com/invite/275MBUBvgP)

### Nuxt API

- [`defineOgImage()`](https://nuxtseo.com/docs/og-image/api/define-og-image)
- [`defineOgImageComponent()`](https://nuxtseo.com/docs/og-image/api/define-og-image-component)
- [`defineOgImageScreenshot()`](https://nuxtseo.com/docs/og-image/api/define-og-image-screenshot)
- [Components](https://nuxtseo.com/docs/og-image/api/components)
- [nuxt.config.ts](https://nuxtseo.com/docs/og-image/api/config)
- [Nuxt Hooks](https://nuxtseo.com/docs/og-image/api/nuxt-hooks)

### Nitro API

- [Nitro Hooks](https://nuxtseo.com/docs/og-image/nitro-api/nitro-hooks)

Nuxt API

# defineOgImageScreenshot()

[Copy for LLMs](https://nuxtseo.com/docs/og-image/api/define-og-image-screenshot.md)

## [Introduction](#introduction)

The `defineOgImageScreenshot()` composable allows you to take a screenshot of the page and use it as the image.

This requires the `browser` renderer, check the [Browser](https://nuxtseo.com/docs/og-image/renderers/browser) guide for more information.

Screenshots require the Browser renderer which is **not available on most serverless platforms** (Vercel, [Netlify](https://netlify.com), AWS Lambda) due to binary size limits. [Cloudflare Workers/Pages](https://nuxtseo.com/docs/og-image/renderers/browser#cloudflare-browser-rendering) are an exception via Browser Rendering bindings. Otherwise, you must either [prerender](https://nuxtseo.com/docs/og-image/guides/zero-runtime) your images at build time or use [Satori](https://nuxtseo.com/docs/og-image/renderers/satori) / [Takumi](https://nuxtseo.com/docs/og-image/renderers/takumi) with a custom component instead.

## [Props](#props)

### [`colorScheme`](#colorscheme)

- Type: `'dark' | 'light'`
- Default: `'light'`

The color scheme to use when generating the image. This is useful for generating dark mode images.

```
defineOgImageScreenshot({
  colorScheme: 'dark'
})
```

### [`delay`](#delay)

- Type: `number`
- Default: `0`

The delay to wait before taking the screenshot. This is useful if you want to wait for animations to complete.

```
defineOgImageScreenshot({
  // wait 2 seconds
  delay: 2000
})
```

### [`mask`](#mask)

- Type: `string`
- Default: `undefined`

HTML selectors the module should remove from the image. Useful for removing popup banners or other elements that may be in the way.

```
defineOgImageScreenshot({
  mask: '.popup-banner, .cookie-banner'
})
```

### [`selector`](#selector)

- Type: `string`
- Default: `undefined`

The selector to take a screenshot of. This is useful if you want to exclude header / footer elements.

```
defineOgImageScreenshot({
  selector: '.page-content'
})
```

[Edit this page](https://github.com/nuxt-modules/og-image/edit/main/docs/content/4.api/0.define-og-image-screenshot.md)

[Markdown For LLMs](https://nuxtseo.com/docs/og-image/api/define-og-image-screenshot.md)

Did this page help you?

[defineOgImageComponent() Define an og:image for the current page with type safety.](https://nuxtseo.com/docs/og-image/api/define-og-image-component) [Components The OgImage and OgImageScreenshot components have been removed in v6.](https://nuxtseo.com/docs/og-image/api/components)

On this page

- [Introduction](#introduction)
- [Props](#props)

[GitHub](https://github.com/harlan-zw/nuxt-seo) [ Discord](https://discord.com/invite/275MBUBvgP)

### [NuxtSEO](https://nuxtseo.com/ "Home")

- [Getting Started](https://nuxtseo.com/docs/nuxt-seo/getting-started/introduction)
- [MCP](https://nuxtseo.com/docs/nuxt-seo/guides/mcp)

Modules

- [Robots](https://nuxtseo.com/docs/robots/getting-started/introduction)
- [Sitemap](https://nuxtseo.com/docs/sitemap/getting-started/introduction)
- [OG Image](https://nuxtseo.com/docs/og-image/getting-started/introduction)
- [Schema.org](https://nuxtseo.com/docs/schema-org/getting-started/introduction)
- [Link Checker](https://nuxtseo.com/docs/link-checker/getting-started/introduction)
- [SEO Utils](https://nuxtseo.com/docs/seo-utils/getting-started/introduction)
- [Site Config](https://nuxtseo.com/docs/site-config/getting-started/introduction)
- [Skew Protection](https://nuxtseo.com/docs/skew-protection/getting-started/introduction)
- [AI Ready](https://nuxtseo.com/docs/ai-ready/getting-started/introduction)

### [NuxtSEO Pro](https://nuxtseo.com/pro "Home")

- [Getting Started](https://nuxtseo.com/pro)
- [Dashboard](https://nuxtseo.com/pro/dashboard)
- [Pro MCP](https://nuxtseo.com/docs/nuxt-seo-pro/mcp/installation)

### [Learn SEO](https://nuxtseo.com/learn-seo "Learn SEO")

Nuxt

- [Mastering Meta](https://nuxtseo.com/learn-seo/nuxt/mastering-meta)
- [Controlling Crawlers](https://nuxtseo.com/learn-seo/nuxt/controlling-crawlers)
- [Launch & Listen](https://nuxtseo.com/learn-seo/nuxt/launch-and-listen)
- [Routes & Rendering](https://nuxtseo.com/learn-seo/nuxt/routes-and-rendering)
- [Staying Secure](https://nuxtseo.com/learn-seo/nuxt/routes-and-rendering/security)

Vue

- [Vue SEO Guide](https://nuxtseo.com/learn-seo/vue)
- [Mastering Meta](https://nuxtseo.com/learn-seo/vue/mastering-meta)
- [Controlling Crawlers](https://nuxtseo.com/learn-seo/vue/controlling-crawlers)
- [SPA SEO](https://nuxtseo.com/learn-seo/vue/spa)
- [SSR Frameworks](https://nuxtseo.com/learn-seo/vue/ssr-frameworks)
- [SEO Checklist](https://nuxtseo.com/learn-seo/checklist)
- [Pre-Launch Warmup](https://nuxtseo.com/learn-seo/pre-launch-warmup)
- [Backlinks & Authority](https://nuxtseo.com/learn-seo/backlinks)

### [Tools](https://nuxtseo.com/tools "SEO Tools")

- [Social Share Debugger](https://nuxtseo.com/tools/social-share-debugger)
- [Robots.txt Generator](https://nuxtseo.com/tools/robots-txt-generator)
- [Meta Tag Checker](https://nuxtseo.com/tools/meta-tag-checker)
- [HTML to Markdown](https://nuxtseo.com/tools/html-to-markdown)
- [XML Sitemap Validator](https://nuxtseo.com/tools/xml-sitemap-validator)
- [Schema.org Validator](https://nuxtseo.com/tools/schema-validator)
- [Keyword Research Pro](https://nuxtseo.com/tools/keyword-research)
- [SERP Analyzer Pro](https://nuxtseo.com/tools/serp-analyzer)
- [Domain Rankings Pro](https://nuxtseo.com/tools/domain-rankings)

Copyright © 2023-2026 Harlan Wilton - [MIT License](https://github.com/harlan-zw/nuxt-seo/blob/main/license) · [mdream](https://mdream.dev)