`image`

Type: string | null | ((pageContext) => string | null | undefined)
Kind: overridable.
Environment: server.

Implemented by: vike-react/vike-vue/vike-solid.

You need vike-react/vike-vue/vike-solid to be able to use this setting.

See Guides > <head> tags for a general introduction about <head> tags.

The image setting sets the preview image upon URL sharing.

// pages/+config.js
 
import previewImage from './previewImage.jpg'
 
export default {
  image: previewImage
}

It adds the following tags to <head>:

<head>
  <meta property="og:image" content="/assets/previewImage.9d8ha1.jpg">
  <meta name="twitter:card" content="summary_large_image">
</head>

As shown at:

Guides > <head> tags > Page specific you can override it.
Guides > <head> tags > Data you can set it based on fetched data.

TypeScript

// pages/some-page/+image.js
// Environment: server
 
import type { Data } from './+data'
import type { PageContextServer } from 'vike/types'
 
export function image(pageContext: PageContextServer<Data>) {
  return pageContext.data.product.image
}

Under the hood

It only generates <head> tags while rendering the HTML of the first page the user visits: the <head> tags aren't updated upon client-side page navigation. The reason is that it's only meant for HTML crawlers (most notably search engine bots), see explanation at API > Head > Only HTML.

image

TypeScript

Under the hood

See also

`image`