OG Image v6 is in beta! Try the v6 docs .
Nuxt API

Components

Last updated by Harlan Wilton in fix!: drop component support.

Introduction

It's recommended to use composables over components, as they are more flexible and will provide better type safety.

OgImage

Render a customisable OG Image.

Uses the defineOgImage composable.

<template>
  <OgImage />
</template>

OgImageScreenshot

Takes a screenshot of the page and uses it as the image.

Uses the defineOgImageScreenshot composable.

<template>
  <OgImageScreenshot />
</template>
Did this page help you?