Skip to main content

Cookie manifest configuration options

{
  cookieManifest: [
    {
      categoryName: 'essential',
      optional: false,
      matchBy: 'exact',
      cookies: [
        'essential-cookie-one'
      ]
    },
    {
      categoryName: 'analytics',
      optional: true,
      cookies: [
        'analytics-cookie-one',
        'analytics-cookie-two',
      ]
    }
  ]
}

Options

Within the cookie-manager config `cookieManifest’ subsection. This section is an array of cookieManifest objects, which have the following options

categoryName

string

Required - The name used for this category. Used for matching preference form buttons and for storing the category preference within the preferences cookie.

optional

boolean, defaults to true

Specifies if a cookie category, and it`s cookies, are optional (non-essential). Optional categories require consent before their cookies are allowed.

matchBy

string, defaults to startsWith

Specifies the matching method used for associating a cookie with a category.
The following matching options are available:

  • exact - Matches provided cookie names exactly.
  • startsWith - Matches cookies with names that start with one of the strings provided.
  • includes - Matches cookies that include one of the strings provided.

cookies

string[]

Required - Specifies the strings to match cookies against, used in conjunction with the matchBy attribute.