@usercentrics/cmp-browser-sdk

Usercentrics CMP Browser SDK

With the Usercentrics CMP Browser SDK our aim is to provide a lightweight library which enables you to build your own fully customized Consent Solution while still leveraging the Usercentrics service database and tools.

We also offer collaboration possibilities with Usercentrics Partners who are able to support you in building your own customized solution. Contact our sales team for more information.

Installing the dependency

npm install @usercentrics/cmp-browser-sdk --save

NOTE: We currently offer the SDK only as a CommonJS package.

Initialization

import Usercentrics, { INITIAL_VIEW } from '@usercentrics/cmp-browser-sdk';

const UC = new Usercentrics('YOUR_USERCENTRICS_SETTINGS_ID');

UC.init().then(initialView => {
  // getCategories() returns all categories' and data processing services' information
  const categories = UC.getCategories();
  // getSettings() returns all Usercentrics settings you need for your custom solution
  const settings = UC.getSettings();

  switch (initialView) {
    case INITIAL_VIEW.FIRST_LAYER:
      // Show first layer (i.e. privacy banner)
      return;
    case INITIAL_VIEW.PRIVACY_BUTTON:
      // Show privacy button
      return;
    case INITIAL_VIEW.NONE:
    default:
      // Show nothing
      return;
  }
});

The constructor also supports an optional Options parameter.

Changing the language

import Usercentrics, { INITIAL_VIEW } from '@usercentrics/cmp-browser-sdk';

const UC = new Usercentrics('YOUR_USERCENTRICS_SETTINGS_ID');

UC.init().then(initialView => {
  /**
   * ...
   */

  UC.changeLanguage('NEW_LANGUAGE').then(() => {
    // Remember to fetch new categories and settings
    const categories = UC.getCategories();
    const settings = UC.getSettings();
  });
});

Documentation

Documentation can be found on our documentation website.