getCldImageUrl Configuration

Configuration for getCldImageUrl is the same as CldImage, which both use the same underlying API @cloudinary-util/url-loader (opens in a new tab).

The function takes two main arguments: options and config.

The function also accepts a third argument of analytics that's intended to be used configure analytics properties for usage statistics.

Basic Options

The basic options available to use with getCldImageUrl include:

Basic Transformations

The getCldImageUrl helper exposes many of Cloudinary's transformations in an easy-to-use way right inside of Next.js.

background

Applies a background to empty or transparent areas.

Examples

background: 'blue'

Learn more about the background transformation (opens in a new tab) on the Cloudinary docs.

crop

Changes the size of the delivered asset according to the requested width & height dimensions.

The crop prop can either be a string, which can accept any valid Cloudinary crop mode (opens in a new tab), or it can accept an object or an array of objects which can take the following options:

Dynamic Crop Modes

When using a dynamic crop mode, such as thumb, the resulting image may be visually different based on the given dimensions. For instance, an image cropped using the thumb crop mode with dimensions 600x600 will give different results than 1200x1200 (assuming a gravity of auto or similar, which is the default for getCldImageUrl).

This is especially important in the context of Responsive Images where due to the resize mechanism, different device sizes may result in different looking images, which doesn't provide a great experience.

To resolve this, when using dynamic crop modes you may want to opt into a two-stage crop, first cropping the original source image, then allowing the the resize mechanism to handle resizing that to the appropriate device size. See examples below.

Examples

Cropping an image and filling the containing space:

crop: 'fill'

Using a crop of thumb on the original source image:

crop: {
  width: 1200,
  height: 1200,
  type: 'thumb',
  source: true
}

Learn more about the crop transformation (opens in a new tab) on the Cloudinary docs.

fillBackground

Automatically fills the padded area using generative AI to extend the image seamlessly.

The fillBackground prop can either be a boolean, which will use a set of safe defaults to produce a background, or an object, which can take the following options:

Examples

Applying Generative Fill with defaults:

fillBackground: true

Customizing options:

fillBackground: {
  crop: 'clpad',
  gravity: 'south',
  prompt: 'cupcakes'
}

Learn more about the Generative Fill transformation (opens in a new tab) on the Cloudinary docs.

gravity

Determines which part of an asset to focus on, and thus which part of the asset to keep, when any part of the asset is cropped

Examples

gravity: 'face'

Learn more about gravity (opens in a new tab) on the Cloudinary docs.

recolor

Uses generative AI to recolor parts of your image, maintaining the relative shading.

The recolor prop can either be an array with the objects to be replaced or an object with the following options:

Examples

Recoloring an object with an array:

recolor: ['duck', 'blue']

Or using the object format:

recolor: {
  prompt: 'duck',
  to: 'blue',
  multiple; true
}

Learn more about the Generative Recolor transformation (opens in a new tab) on the Cloudinary docs.

remove

Uses generative AI to remove unwanted parts of your image, replacing the area with realistic pixels.

The remove prop can either be a string, an array, or an object with the following options:

Examples

Removing an object by string:

remove: 'apple'

Removing multiple objects by array:

remove: ['apple', 'banana', 'orange']

Removing multiple instances of an object and their shadow with object configuration:

remove: {
  prompt: 'apple',
  multiple: true,
  removeShadow: true
}

Removing a region:

remove: {
  region: [300, 200, 1900, 3500]
}

Removing multiple regions:

remove: {
  region: [
    [300, 200, 1900, 3500],
    [123, 321, 750, 500]
  ]
}

Learn more about the Generative Remove transformation (opens in a new tab) on the Cloudinary docs.

removeBackground

Uses the Cloudinary AI Background Removal add-on (opens in a new tab) to make the background of an image transparent.

Examples

removeBackground: true

Learn more about background removal transformation (opens in a new tab) on the Cloudinary docs.

replace

Uses generative AI to replace parts of your image with something else.

The replace prop can either be an array with the objects to be replaced or an object with the following options:

Examples

Replacing an object with an array:

replace: ['apple', 'banana']

Or using the object format:

replace: {
  from: 'apple',
  to: 'banana',
  preserveGeometry; true
}

Learn more about the Generative Replace transformation (opens in a new tab) on the Cloudinary docs.

restore

Uses generative AI to restore details in poor quality images or images that may have become degraded through repeated processing and compression.

The restore prop can be used as a boolean.

Examples

restore: true

Learn more about the Generative Restore transformation (opens in a new tab) on the Cloudinary docs.

zoom

Controls how close to crop to the detected coordinates when using face-detection, custom-coordinate, or object-specific gravity.

Examples

zoom: '0.75'

Learn more about the zoom transformation (opens in a new tab) on the Cloudinary docs.

zoompan

Also known as the Ken Burns effect, this transformation applies zooming and/or panning to an image, resulting in a video or animated GIF.

zoompan can be applied with safe defaults as a boolean, a string, or an object for advanced customization.

As a string, you can pass in "loop" to automatically loop, or you can pass in raw configuration using the Cloudinary Transformation syntax.

As an object, you can use advanced configuration with the following options:

Examples

With defaults:

zoompan: true

Add looping:

zoompan: 'loop'

Customize options:

zoompan: {
  loop: 'loop:2', // Will loop twice
  options: 'mode_ztr;maxzoom_6.5;du_10'
}

Learn more about the zoompan transformation (opens in a new tab) on the Cloudinary docs.

Filters & Effects

Cloudinary supports a wide variety of effects and artistic filters that help to easily change the appearance of an image.

Examples

Make an image black and white:

blackwhite: true

Pixelate an image:

pixelate: true

Sharpen an image:

sharpen: 50

View the Cloudinary docs (opens in a new tab) to see learn more about using effects.

Overlays & Underlays

Cloudinary gives you the ability to add layers above or below your primary asset using Overlays and Underlays.

Customizing Overlays & Underlays

Note: The API for Underlays is similar to Overlays except they do not support text.

Examples

Adding an overlay:

overlays: [{
  publicId: 'images/earth',
  position: {
    x: 50,
    y: 50,
    gravity: 'north_west',
  },
  appliedEffects: [
    {
      multiply: true
    }
  ]
}]

Adding an underlay:

underlays: [{
  publicId: 'images/earth',
}]

Advanced

Configuration & Delivery

assetType

Configures the asset type for the delivered resource.

This defaults to an image for the getCldImageUrl helper.

Examples

Create an image thumbnail from a video asset:

assetType: 'video'

Learn more about Asset Types (opens in a new tab) on the Cloudinary docs.

config

Allows configuration for the Cloudinary environment.

Examples

config: {
  cloud: {
    cloudName: 'my-cloud'
  }
}

Learn more about configuration parameters (opens in a new tab) on the Cloudinary docs.

deliveryType

Controls the delivery type of the image.

Examples

deliveryType: 'fetch'

Learn more about Delivery Types (opens in a new tab) on the Cloudinary docs.

defaultImage

Configures the default image to use in case the given public ID is not available.

Examples

defaultImage: 'myimage.jpg'

Learn more about Default Images (opens in a new tab) on the Cloudinary docs.

flags

Alters the regular behavior of another transformation or the overall delivery behavior.

Examples

flags: ['keep_iptc'],
quality: 'default'

Learn more about Flags (opens in a new tab) on the Cloudinary docs.

seoSuffix

Adds a dynamic, descriptive suffix to the Public ID for greater SEO control of image URLs.

Examples

seoSuffix: 'jellyfish-in-space'

Learn more about Dynamic SEO Suffixes (opens in a new tab) on the Cloudinary docs.

version

Controls the version defined in the delivery URL.

Examples

version: '1234'

Learn more about Asset Versions (opens in a new tab) on the Cloudinary docs.

Managing Transformations

Most transformations and effects are exposed as top-level props to enable you to easily apply what you need, but you can also use the following props for more advanced and organized ways of applying transformations and effects.

effects

Applies a chain of transformation sets to an image.

Examples

effects: [
  {
    width: 100,
    height: 100,
    crop: 'fill'
  },
  {
    opacity: 50
  }
]

namedTransformations

Applies named transformations to the image.

Examples

namedTransformations: ['my-transformation']

Learn more about Named Transformations (opens in a new tab) on the Cloudinary docs.

preserveTransformations

Preserves transformations already applied to an image when passing in a Cloudinary URL as the src.

Examples

preserveTransformations: true

rawTransformations

Provides the ability to pass in an array of "raw" Cloudinary transformations using the Transformation URL API (opens in a new tab)

Examples

rawTransformations: ['w_100', 'b_blue', 'f_auto']

strictTransformations

Strict Transformations (opens in a new tab) gives you the ability to have more control over what transformations are permitted to be used from your Cloudinary account.

By enabling Strict Transformations, you restrict the ability to generate transformations on-the-fly requiring explicit approval through the Cloudinary dashboard.

Note: This disables optimization and responsive sizing only allowing named transformations to be applied. The width and height are not applied to the URL, but are still included on the image tag rendered to the DOM.

Examples

strictTransformations: true,
transformations: ['my-transformation']

Learn more about Strict Transformations (opens in a new tab) on the Cloudinary docs.

transformations - Deprecated

Use namedTransformations instead

Optimization

By default, getCldImageUrl opts in any image to f_auto and q_auto which provide automatic optimization through intelligent compression and by automatically delivering the most efficient format based on the browser and device requesting the image.

You can customize and manage these properties using the options below:

dpr

Sets the device pixel ratio (DPR) for the delivered image or video using a specified value or automatically based on the requesting device.

Examples

dpr: '2.0'

Learn more about configuring DPR (opens in a new tab) on the Cloudinary docs.

format

Converts (if necessary) and delivers an asset in the specified format regardless of the file extension used in the delivery URL.

Examples

format: 'png'

Learn more about format (opens in a new tab) on the Cloudinary docs.

quality

Controls the quality of the delivered asset. Reducing the quality is a trade-off between visual quality and file size.

Examples

quality: 10

Learn more about quality (opens in a new tab) on the Cloudinary docs.