Api

Components

Copy for LLMs
Last updated by
Harlan Wilton
 in doc: grammar.

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>
Edit this page
Markdown For LLMs
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.