Documentation Index

Fetch the complete documentation index at: https://usercentrics.document360.io/llms.txt

Use this file to discover all available pages before exploring further.

Welcome to our new beta documentation experience! Let us know what you think below, under "Was this article helpful?" 👍 👎

Types

Prev Next

ThemeType

type ThemeType = {
  colors: {
    black: string,
    white: string,
    layout: {
      mainPage: {
        left: {
          background: string,
        },
        right: {
          background: string,
        },
      },
      managePage: {
        left: {
          background: string,
        },
        right: {
          background: string,
        },
      },
      qrCode: {
        left: {
          background: string,
        },
        right: {
          background: string,
        },
      },
    },
    toggle: {
      on: {
        background: string,
      },
      off: {
        background: string,
      },
    },
    text: {
      color: string,
      color95: string,
      color90: string,
      color08: string,
    },
  },
  padding: {
    leftContainer: {
      mainPage: {
        vertical: number,
        horizontal: number,
      },
      managePage: {
        vertical: number,
        horizontal: number,
      },
      qrCode: {
        vertical: number,
        horizontal: number,
      },
    },
    rightContainer: {
      mainPage: {
        vertical: number,
        horizontal: number,
      },
      managePage: {
        vertical: number,
        horizontal: number,
      },
      qrCode: {
        vertical: number,
        horizontal: number,
      },
    },
    card: {
      vertical: number,
      horizontal: number,
    },
    dpsInfoCard: {
      vertical: number,
      horizontal: number,
    },
    qrCodeModal: {
      vertical: number,
      horizontal: number,
    },
  },
  font: {
    size: {
      layout: {
        large: number,
        medium: number,
      },
      button: {
        large: number,
        medium: number,
      },
      card: {
        large: number,
        medium: number,
      },
      cardList: {
        large: number,
        medium: number,
      },
      dpsInfoCard: {
        large: number,
        medium: number,
      },
      qrCodeModal: {
        large: number,
        medium: number,
      },
    },
    weight: {
      regular: number,
      semiBold: number,
    },
  },
  metrics: {
    mainPage: {
      leftContainer: {
        width: string,
      },
      rightContainer: {
        width: string,
      },
    },
    managePage: {
      leftContainer: {
        width: string,
      },
      rightContainer: {
        width: string,
      },
    },
  },
};

CmpButtonsType

type CmpButtonsType = 'accept' | 'deny' | 'more' | 'save' | 'ok';

OptionalSettingsData

type OptionalSettingsData = string | null | undefined;

EmbeddingsTheme

type EmbeddingsTheme = CmpTheme;

ConsentActionType

export type ConsentActionType = 'onAcceptAllServices' | 'onDenyAllServices' | 'onEssentialChange' | 'onInitialPageLoad' | 'onNonEURegion' | 'onSessionRestored' | 'onTcfStringChange' | 'onUpdateServices' | 'onMobileSessionRestore';

SettingType

type SettingType = 'TCF' | 'GDPR' | 'CCPA';

ConsentType

type ConsentType = 'IMPLICIT' | 'EXPLICIT';