Skip to content

Enums

This page documents the public enums exposed by the CMP API. These enums are used as values on specific fields of the configuration objects described in Interfaces and Types.

CLOSE_OPTION

CLOSE_OPTION controls how the first layer (banner) of the GDPR CMP can be dismissed. It is passed as the closeOption field of the first layer configuration (e.g. firstLayer.closeOption in the settings/theme configuration).

enum CLOSE_OPTION {
    ICON = "ICON",
    LINK = "LINK"
}
Value Description
ICON Shows a close ("X") icon on the first layer. Dismissing the banner via this icon denies all consents.
LINK Replaces the close icon with a text link on the first layer. Clicking the link also denies all consents.

Usage

{
  firstLayer: {
    closeOption: CLOSE_OPTION.ICON,
    // ...other first layer configuration
  }
}