Skip to content

Conversation

@harlan-zw
Copy link
Collaborator

@harlan-zw harlan-zw commented Jan 16, 2026

πŸ”— Linked issue

❓ Type of change

  • πŸ“– Documentation (updates to the documentation or readme)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • πŸ‘Œ Enhancement (improving an existing functionality)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

πŸ“š Description

Requires OG Image components to include a renderer suffix in their filename (.satori.vue, .takumi.vue, .chromium.vue).

Why?

  • Automatic renderer detection - the renderer is determined from the filename, no need to specify it in config
  • Multiple renderer variants - create optimized versions of templates for different renderers (e.g., a simplified Takumi version alongside a full Satori version)
  • Tree-shaking - unused renderer code is excluded from production builds
  • Clearer intent - the filename immediately tells you which renderer a component targets

Migration

npx nuxt-og-image migrate v6

Component files:

- components/OgImage/MyTemplate.vue
+ components/OgImage/MyTemplate.satori.vue

API calls:

- defineOgImageComponent('NuxtSeo', { title: 'Hello' })
+ defineOgImage('NuxtSeo', { title: 'Hello' })

Other changes

  • Deprecated defineOgImageComponent() in favor of defineOgImage(component, props, options)
  • Updated documentation with new component naming convention

harlan-zw and others added 6 commits January 16, 2026 17:34
…ession

Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>
@harlan-zw harlan-zw merged commit 357e325 into main Jan 16, 2026
4 checks passed
This was referenced Jan 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants