Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UISettings

Hierarchy

  • UISettings

Properties

buttons

buttons: object

Type declaration

  • acceptAll: object
    • label: string
  • denyAll: object
    • isEnabled: boolean
    • label: string
  • save: object
    • label: string
  • showSecondLayer: object
    • isEnabled: boolean
    • label: string
    • url: string | null

      If the url is null, open up the second layer (i.e. modal). If the url exists, open link in new tab.

customization

customization: object

Type declaration

  • color: object
    • primary: string
  • font: object
    • family: string
    • size: number
  • theme: THEME

    Currently non-customizable. Value set as: THEME.LIGHT

firstLayer

firstLayer: object

Type declaration

  • description: object
    • default: string
    • short: string | null
  • isCategoryTogglesEnabled: boolean

    Currently non-customizable. Value set as: false

  • isOverlayEnabled: boolean
  • title: string
  • variant: FIRST_LAYER_VARIANT

    Currently non-customizable. Value set as: FIRST_LAYER_VARIANT.BANNER

labels

labels: object

Type declaration

  • general: object
    • consentGiven: string
    • consentNotGiven: string
    • consentType: string

      Currently non-customizable. Value set as: "Consent type" (non-translated)

    • controllerId: string

      Permanently non-customizable. Value set as: "Controller ID" (non-translated)

    • copy: string
    • date: string
    • decision: string

      Currently non-customizable. Value set as: "Decision" (non-translated)

    • explicit: string

      Currently non-customizable. Value set as: "Explicit" (non-translated)

    • implicit: string

      Currently non-customizable. Value set as: "Implicit" (non-translated)

    • processorId: string

      Permanently non-customizable. Value set as: "Processor ID" (non-translated)

    • showMore: string

      Currently non-customizable. Value set as: "Show more" (non-translated)

  • service: object
    • dataCollected: object
      • description: string
      • title: string
    • dataDistribution: object
      • processingLocationTitle: string
      • thirdPartyCountriesTitle: string
    • dataPurposes: object
      • description: string
      • title: string
    • dataRecipientsTitle: string
    • descriptionTitle: string
    • history: object
      • description: string | null

        Currently non-customizable. Value set as: null

      • title: string
    • legalBasis: object
      • description: string
      • title: string
    • processingCompanyTitle: string
    • retentionPeriodTitle: string
    • technologiesUsed: object
      • description: string
      • title: string
    • urls: object
      • cookiePolicyTitle: string
      • optOutTitle: string
      • privacyPolicyTitle: string

language

language: object

Type declaration

  • available: string[]
  • isSelectorEnabled: boolean
  • selected: string

links

links: object

Type declaration

  • cookiePolicy: object

    Customizable in Admin Interface soon!

    • label: string
    • url: string | null
  • imprint: object
    • label: string | null
    • url: string | null
  • privacyPolicy: object
    • label: string
    • url: string | null

poweredBy

poweredBy: object

Type declaration

  • isEnabled: boolean
  • label: string

    Currently non-customizable. Value set as: "Powered by" (non-translated)

  • partnerUrl: string | null
  • partnerUrlLabel: string | null
  • url: string
  • urlLabel: string

    Currently non-customizable. Value set as: "Usercentrics Consent Management" (non-translated)

privacyButton

privacyButton: object

Type declaration

  • isEnabled: boolean

secondLayer

secondLayer: object

Type declaration

  • description: string
  • isOverlayEnabled: boolean
  • tabs: object
    • categories: object
      • isEnabled: boolean

        Currently non-customizable. Value set as: true

      • label: string
    • services: object
      • isEnabled: boolean

        Currently non-customizable. Value set as: true

      • label: string

        Currently non-customizable. Value set as: "Services" (non-translated)

  • title: string
  • variant: SECOND_LAYER_VARIANT

    Currently non-customizable. Value set as: SECOND_LAYER_VARIANT.CENTER