Components

Components that are included with the module, including OgImage and OgImageScreenshot.

Introduction

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

Render a customisable OG Image.

Uses the defineOgImage composable.

<template>
  <OgImage />
</template>

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

<template>
  <OgImageScreenshot />
</template>

Did this page help you?

defineOgImageScreenshot()

Define an OG Image that takes a screenshot of the page.

Nuxt Config

The Nuxt OG Image module configuration.