Skip to content

Configuring getCldOgImageUrl

The getCldOgImageUrl helper provides a wide range of options for being able to easily generate social cards for Open Graph images.

Configuration for getCldOgImageUrl is the same as getCldImageUrl. The only difference is getCldOgImageUrl provides the following default settings to make generating an OG image URL simpler.

Required Props

Prop Type Required Example
src string Yes my-public-id

Basic Transformations

Prop Type Default Example
crop string { type: 'fill', gravity: 'center', source: true } scale More Info
height number 630 630 More Info
width number 1200 1200 More Info

Find more configuration settings over at getCldImageUrl configuration.