Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DefaultUISettings

Hierarchy

  • BaseUISettings
    • DefaultUISettings

Index

Properties

Properties

buttons

buttons: { acceptAll: { label: string }; denyAll: { isEnabled: boolean; label: string }; save: { label: string }; showSecondLayer: { isEnabled: boolean; label: string; url: string | null } }

Type declaration

  • acceptAll: { label: string }
    • label: string
  • denyAll: { isEnabled: boolean; label: string }
    • isEnabled: boolean
    • label: string
  • save: { label: string }
    • label: string
  • showSecondLayer: { isEnabled: boolean; label: string; url: string | null }
    • 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: { color: { primary: string }; font: { family: string; size: number }; logoUrl: string | null; theme: THEME }

Type declaration

  • color: { primary: string }
    • primary: string
  • font: { family: string; size: number }
    • family: string
    • size: number
  • logoUrl: string | null
  • theme: THEME

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

firstLayer

firstLayer: { description: { default: string; short: string | null }; isCategoryTogglesEnabled: boolean; isOverlayEnabled: boolean; title: string; variant: FIRST_LAYER_VARIANT }

Type declaration

  • description: { default: string; short: string | null }
    • default: string
    • short: string | null
  • isCategoryTogglesEnabled: boolean
  • isOverlayEnabled: boolean
  • title: string
  • variant: FIRST_LAYER_VARIANT

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

isEmbeddingsEnabled

isEmbeddingsEnabled: boolean

Customizable in Admin Interface soon! Value set as true

labels

labels: DefaultUILabels

language

language: { available: string[]; isSelectorEnabled: boolean; selected: string }

Type declaration

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

links

links: { cookiePolicy: { label: string; url: string | null }; imprint: { label: string | null; url: string | null }; privacyPolicy: { label: string; url: string | null } }

Type declaration

  • cookiePolicy: { label: string; url: string | null }

    Customizable in Admin Interface soon!

    • label: string
    • url: string | null
  • imprint: { label: string | null; url: string | null }
    • label: string | null
    • url: string | null
  • privacyPolicy: { label: string; url: string | null }
    • label: string
    • url: string | null

poweredBy

poweredBy: { isEnabled: boolean; label: string; partnerUrl: string | null; partnerUrlLabel: string | null; url: string; urlLabel: string }

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: { iconUrl: string | null; isEnabled: boolean; position: string }

Type declaration

  • iconUrl: string | null
  • isEnabled: boolean
  • position: string

secondLayer

secondLayer: { description: string; isOverlayEnabled: boolean; tabs: { categories: { isEnabled: boolean; label: string }; services: { isEnabled: boolean; label: string } }; title: string; variant: SECOND_LAYER_VARIANT }

Type declaration

  • description: string
  • isOverlayEnabled: boolean
  • tabs: { categories: { isEnabled: boolean; label: string }; services: { isEnabled: boolean; label: string } }
    • categories: { isEnabled: boolean; label: string }
      • isEnabled: boolean

        Currently non-customizable. Value set as: true

      • label: string
    • services: { isEnabled: boolean; label: string }
      • 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