Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TCFUISettings

Hierarchy

  • BaseUISettings
    • TCFUISettings

Index

Properties

Properties

buttons

buttons: { acceptAll: { label: string }; denyAll: { isEnabled: boolean; label: string }; manageSettings: { label: string }; save: { label: string }; showVendorTab: { label: string } }

Type declaration

  • acceptAll: { label: string }
    • label: string
  • denyAll: { isEnabled: boolean; label: string }
    • isEnabled: boolean
    • label: string
  • manageSettings: { label: string }
    • label: string
  • save: { label: string }
    • label: string
  • showVendorTab: { label: string }
    • label: string

customization

customization: { color: { primary: string }; font: { family: string; size: number }; theme: THEME }

Type declaration

  • color: { primary: string }
    • primary: string

      Currently hard-coded as "#0045A5"

  • font: { family: string; size: number }
    • family: string

      Currently hard-coded as ""

    • size: number

      Currently hard-coded as 14

  • theme: THEME

    Currently hard-coded as THEME.LIGHT

firstLayer

firstLayer: { description: { additionalInfo: string | null; default: string }; hideToggles: boolean; isOverlayEnabled: boolean; title: string }

Type declaration

  • description: { additionalInfo: string | null; default: string }
    • additionalInfo: string | null
    • default: string
  • hideToggles: boolean
  • isOverlayEnabled: boolean
  • title: string

    Currently hard-coded as "Privacy Settings" (translated)

labels

labels: { general: { disclaimer: string; features: string; iabVendors: string; nonIabPurposes: string; nonIabVendors: string; purposes: string }; nonTCFLabels: DefaultUILabels; vendor: { features: string; legitimateInterest: string; privacyPolicy: string; purposes: string; specialFeatures: string; specialPurposes: string } }

Type declaration

  • general: { disclaimer: string; features: string; iabVendors: string; nonIabPurposes: string; nonIabVendors: string; purposes: string }
    • disclaimer: string
    • features: string
    • iabVendors: string
    • nonIabPurposes: string
    • nonIabVendors: string
    • purposes: string
  • nonTCFLabels: DefaultUILabels
  • vendor: { features: string; legitimateInterest: string; privacyPolicy: string; purposes: string; specialFeatures: string; specialPurposes: string }
    • features: string
    • legitimateInterest: string
    • privacyPolicy: string
    • purposes: string
    • specialFeatures: string
    • specialPurposes: string

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 }

    Currently doesn't exist in Settings app

    • 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 hard-coded as: "Powered by"

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

    Currently hard-coded as: "Usercentrics Consent Management"

privacyButton

privacyButton: { isEnabled: boolean }

Type declaration

  • isEnabled: boolean

secondLayer

secondLayer: { description: string; isOverlayEnabled: boolean; tabs: { purposes: { label: string }; vendors: { label: string } }; title: string }

Type declaration

  • description: string
  • isOverlayEnabled: boolean
  • tabs: { purposes: { label: string }; vendors: { label: string } }
    • purposes: { label: string }
      • label: string
    • vendors: { label: string }
      • label: string
  • title: string

toggles

toggles: { consent: { label: string }; legitimateInterest: { label: string }; specialFeaturesToggle: { offLabel: string; onLabel: string } }

Type declaration

  • consent: { label: string }
    • label: string
  • legitimateInterest: { label: string }
    • label: string
  • specialFeaturesToggle: { offLabel: string; onLabel: string }
    • offLabel: string
    • onLabel: string