Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "frontend-packages/react-cookie-banner/src/types/customize"

Index

Type aliases

ButtonFunctionality

ButtonFunctionality: "all" | "essential" | "individual" | "save"

ButtonType

ButtonType: "button" | "link" | "hide"

Customize

Customize: { bodyDesign: CustomizeBodyDesign; customCss: CustomizeCustomCss; decision: CustomizeDecision; design: CustomizeDesign; footerDesign: CustomizeFooterDesign; group: CustomizeGroup; headerDesign: CustomizeHeaderDesign; individualLayout: CustomizeIndividualLayout; individualTexts: CustomizeIndividualTexts; layout: CustomizeLayout; legal: CustomizeLegal; mobile: CustomizeMobile; saveButton: CustomizeSaveButton; texts: CustomizeTexts }

Type declaration

CustomizeBodyDesign

CustomizeBodyDesign: { acceptAllBg: CSSProperties["backgroundColor"]; acceptAllBorderColor: CSSProperties["borderColor"]; acceptAllBorderWidth: number; acceptAllFontColor: CSSProperties["color"]; acceptAllFontSize: number; acceptAllFontWeight: CSSProperties["fontWeight"]; acceptAllHoverBg: CSSProperties["backgroundColor"]; acceptAllHoverBorderColor: CSSProperties["borderColor"]; acceptAllHoverFontColor: CSSProperties["color"]; acceptAllOneRowLayout: boolean; acceptAllPadding: MarginOrPadding; acceptAllTextAlign: CSSProperties["textAlign"]; acceptEssentialsBg: CSSProperties["backgroundColor"]; acceptEssentialsBorderColor: CSSProperties["borderColor"]; acceptEssentialsBorderWidth: number; acceptEssentialsButtonType: ButtonType; acceptEssentialsFontColor: CSSProperties["color"]; acceptEssentialsFontSize: number; acceptEssentialsFontWeight: CSSProperties["fontWeight"]; acceptEssentialsHoverBg: CSSProperties["backgroundColor"]; acceptEssentialsHoverBorderColor: CSSProperties["borderColor"]; acceptEssentialsHoverFontColor: CSSProperties["color"]; acceptEssentialsPadding: MarginOrPadding; acceptEssentialsTextAlign: CSSProperties["textAlign"]; acceptEssentialsUseAcceptAll: boolean; acceptIndividualBg: CSSProperties["backgroundColor"]; acceptIndividualBorderColor: CSSProperties["borderColor"]; acceptIndividualBorderWidth: number; acceptIndividualFontColor: CSSProperties["color"]; acceptIndividualFontSize: number; acceptIndividualFontWeight: CSSProperties["fontWeight"]; acceptIndividualHoverBg: CSSProperties["backgroundColor"]; acceptIndividualHoverBorderColor: CSSProperties["borderColor"]; acceptIndividualHoverFontColor: CSSProperties["color"]; acceptIndividualPadding: MarginOrPadding; acceptIndividualTextAlign: CSSProperties["textAlign"]; descriptionFontSize: number; descriptionInheritFontSize: boolean; dottedGroupsBulletColor: CSSProperties["color"]; dottedGroupsFontSize: number; dottedGroupsInheritFontSize: boolean; padding: MarginOrPadding; tcfStacksActiveBg: CSSProperties["backgroundColor"]; tcfStacksArrowColor: CSSProperties["color"]; tcfStacksArrowType: "none" | "filled" | "outlined"; tcfStacksBg: CSSProperties["backgroundColor"]; tcfStacksBorderColor: CSSProperties["borderColor"]; tcfStacksBorderWidth: number; tcfStacksDescriptionFontColor: CSSProperties["color"]; tcfStacksDescriptionFontSize: number; tcfStacksDescriptionFontWeight: CSSProperties["fontWeight"]; tcfStacksDescriptionMargin: MarginOrPadding; tcfStacksHoverBg: CSSProperties["backgroundColor"]; tcfStacksMargin: MarginOrPadding; tcfStacksPadding: MarginOrPadding; tcfStacksTitleFontColor: CSSProperties["color"]; tcfStacksTitleFontSize: number; tcfStacksTitleFontWeight: CSSProperties["fontWeight"]; teachingsFontColor: CSSProperties["color"]; teachingsFontSize: number; teachingsInheritFontColor: boolean; teachingsInheritFontSize: boolean; teachingsInheritTextAlign: boolean; teachingsSeparatorActive: boolean; teachingsSeparatorColor: CSSProperties["backgroundColor"]; teachingsSeparatorHeight: number; teachingsSeparatorWidth: number; teachingsTextAlign: CSSProperties["textAlign"] }

Type declaration

  • acceptAllBg: CSSProperties["backgroundColor"]
  • acceptAllBorderColor: CSSProperties["borderColor"]
  • acceptAllBorderWidth: number
  • acceptAllFontColor: CSSProperties["color"]
  • acceptAllFontSize: number
  • acceptAllFontWeight: CSSProperties["fontWeight"]
  • acceptAllHoverBg: CSSProperties["backgroundColor"]
  • acceptAllHoverBorderColor: CSSProperties["borderColor"]
  • acceptAllHoverFontColor: CSSProperties["color"]
  • acceptAllOneRowLayout: boolean
  • acceptAllPadding: MarginOrPadding
  • acceptAllTextAlign: CSSProperties["textAlign"]
  • acceptEssentialsBg: CSSProperties["backgroundColor"]
  • acceptEssentialsBorderColor: CSSProperties["borderColor"]
  • acceptEssentialsBorderWidth: number
  • acceptEssentialsButtonType: ButtonType
  • acceptEssentialsFontColor: CSSProperties["color"]
  • acceptEssentialsFontSize: number
  • acceptEssentialsFontWeight: CSSProperties["fontWeight"]
  • acceptEssentialsHoverBg: CSSProperties["backgroundColor"]
  • acceptEssentialsHoverBorderColor: CSSProperties["borderColor"]
  • acceptEssentialsHoverFontColor: CSSProperties["color"]
  • acceptEssentialsPadding: MarginOrPadding
  • acceptEssentialsTextAlign: CSSProperties["textAlign"]
  • acceptEssentialsUseAcceptAll: boolean
  • acceptIndividualBg: CSSProperties["backgroundColor"]
  • acceptIndividualBorderColor: CSSProperties["borderColor"]
  • acceptIndividualBorderWidth: number
  • acceptIndividualFontColor: CSSProperties["color"]
  • acceptIndividualFontSize: number
  • acceptIndividualFontWeight: CSSProperties["fontWeight"]
  • acceptIndividualHoverBg: CSSProperties["backgroundColor"]
  • acceptIndividualHoverBorderColor: CSSProperties["borderColor"]
  • acceptIndividualHoverFontColor: CSSProperties["color"]
  • acceptIndividualPadding: MarginOrPadding
  • acceptIndividualTextAlign: CSSProperties["textAlign"]
  • descriptionFontSize: number
  • descriptionInheritFontSize: boolean
  • dottedGroupsBulletColor: CSSProperties["color"]
  • dottedGroupsFontSize: number
  • dottedGroupsInheritFontSize: boolean
  • padding: MarginOrPadding
  • tcfStacksActiveBg: CSSProperties["backgroundColor"]
  • tcfStacksArrowColor: CSSProperties["color"]
  • tcfStacksArrowType: "none" | "filled" | "outlined"
  • tcfStacksBg: CSSProperties["backgroundColor"]
  • tcfStacksBorderColor: CSSProperties["borderColor"]
  • tcfStacksBorderWidth: number
  • tcfStacksDescriptionFontColor: CSSProperties["color"]
  • tcfStacksDescriptionFontSize: number
  • tcfStacksDescriptionFontWeight: CSSProperties["fontWeight"]
  • tcfStacksDescriptionMargin: MarginOrPadding
  • tcfStacksHoverBg: CSSProperties["backgroundColor"]
  • tcfStacksMargin: MarginOrPadding
  • tcfStacksPadding: MarginOrPadding
  • tcfStacksTitleFontColor: CSSProperties["color"]
  • tcfStacksTitleFontSize: number
  • tcfStacksTitleFontWeight: CSSProperties["fontWeight"]
  • teachingsFontColor: CSSProperties["color"]
  • teachingsFontSize: number
  • teachingsInheritFontColor: boolean
  • teachingsInheritFontSize: boolean
  • teachingsInheritTextAlign: boolean
  • teachingsSeparatorActive: boolean
  • teachingsSeparatorColor: CSSProperties["backgroundColor"]
  • teachingsSeparatorHeight: number
  • teachingsSeparatorWidth: number
  • teachingsTextAlign: CSSProperties["textAlign"]

CustomizeCustomCss

CustomizeCustomCss: { antiAdBlocker: YesNo; css: string }

Type declaration

  • antiAdBlocker: YesNo
  • css: string

CustomizeDecision

CustomizeDecision: { acceptAll: ButtonType; acceptEssentials: ButtonType; acceptIndividual: ButtonType; buttonOrder: string; groupsFirstView: boolean; saveButton: "always" | "afterChange" | "afterChangeAll"; showCloseIcon: boolean; showGroups: boolean }

Type declaration

  • acceptAll: ButtonType
  • acceptEssentials: ButtonType
  • acceptIndividual: ButtonType
  • buttonOrder: string
  • groupsFirstView: boolean
  • saveButton: "always" | "afterChange" | "afterChangeAll"
  • showCloseIcon: boolean
  • showGroups: boolean

CustomizeDesign

CustomizeDesign: { bg: CSSProperties["backgroundColor"]; borderColor: CSSProperties["borderColor"]; borderWidth: number; boxShadowBlurRadius: number; boxShadowColor: CSSProperties["backgroundColor"]; boxShadowColorAlpha: number; boxShadowEnabled: boolean; boxShadowOffsetX: number; boxShadowOffsetY: number; boxShadowSpreadRadius: number; fontColor: CSSProperties["color"]; fontFamily: string; fontInheritFamily: boolean; fontSize: number; fontWeight: CSSProperties["fontWeight"]; linkTextDecoration: CSSProperties["textDecoration"]; textAlign: CSSProperties["textAlign"] }

Type declaration

  • bg: CSSProperties["backgroundColor"]
  • borderColor: CSSProperties["borderColor"]
  • borderWidth: number
  • boxShadowBlurRadius: number
  • boxShadowColor: CSSProperties["backgroundColor"]
  • boxShadowColorAlpha: number
  • boxShadowEnabled: boolean
  • boxShadowOffsetX: number
  • boxShadowOffsetY: number
  • boxShadowSpreadRadius: number
  • fontColor: CSSProperties["color"]
  • fontFamily: string
  • fontInheritFamily: boolean
  • fontSize: number
  • fontWeight: CSSProperties["fontWeight"]
  • linkTextDecoration: CSSProperties["textDecoration"]
  • textAlign: CSSProperties["textAlign"]

CustomizeFooterDesign

CustomizeFooterDesign: { bg: CSSProperties["backgroundColor"]; borderColor: CSSProperties["borderColor"]; borderWidth: number; fontColor: CSSProperties["color"]; fontFamily: string; fontInheritFamily: boolean; fontSize: number; fontWeight: CSSProperties["fontWeight"]; hoverFontColor: CSSProperties["color"]; inheritBg: boolean; inheritTextAlign: boolean; linkTarget: AnchorHTMLAttributes<HTMLAnchorElement>["target"]; padding: MarginOrPadding; poweredByLink: boolean; textAlign: CSSProperties["textAlign"] }

Type declaration

  • bg: CSSProperties["backgroundColor"]
  • borderColor: CSSProperties["borderColor"]
  • borderWidth: number
  • fontColor: CSSProperties["color"]
  • fontFamily: string
  • fontInheritFamily: boolean
  • fontSize: number
  • fontWeight: CSSProperties["fontWeight"]
  • hoverFontColor: CSSProperties["color"]
  • inheritBg: boolean
  • inheritTextAlign: boolean
  • linkTarget: AnchorHTMLAttributes<HTMLAnchorElement>["target"]
  • padding: MarginOrPadding
  • poweredByLink: boolean
  • textAlign: CSSProperties["textAlign"]

CustomizeGroup

CustomizeGroup: { checkboxActiveBg: CSSProperties["backgroundColor"]; checkboxActiveBorderColor: CSSProperties["borderColor"]; checkboxActiveColor: CSSProperties["color"]; checkboxBg: CSSProperties["backgroundColor"]; checkboxBorderColor: CSSProperties["borderColor"]; checkboxBorderWidth: number; descriptionFontColor: CSSProperties["color"]; descriptionFontSize: number; groupBg: CSSProperties["backgroundColor"]; groupBorderColor: CSSProperties["borderColor"]; groupBorderRadius: number; groupBorderWidth: number; groupInheritBg: boolean; groupPadding: MarginOrPadding; groupSpacing: number; headlineFontColor: CSSProperties["color"]; headlineFontSize: number; headlineFontWeight: CSSProperties["fontWeight"]; linkColor: CSSProperties["color"]; linkHoverColor: CSSProperties["color"] }

Type declaration

  • checkboxActiveBg: CSSProperties["backgroundColor"]
  • checkboxActiveBorderColor: CSSProperties["borderColor"]
  • checkboxActiveColor: CSSProperties["color"]
  • checkboxBg: CSSProperties["backgroundColor"]
  • checkboxBorderColor: CSSProperties["borderColor"]
  • checkboxBorderWidth: number
  • descriptionFontColor: CSSProperties["color"]
  • descriptionFontSize: number
  • groupBg: CSSProperties["backgroundColor"]
  • groupBorderColor: CSSProperties["borderColor"]
  • groupBorderRadius: number
  • groupBorderWidth: number
  • groupInheritBg: boolean
  • groupPadding: MarginOrPadding
  • groupSpacing: number
  • headlineFontColor: CSSProperties["color"]
  • headlineFontSize: number
  • headlineFontWeight: CSSProperties["fontWeight"]
  • linkColor: CSSProperties["color"]
  • linkHoverColor: CSSProperties["color"]

CustomizeHeaderDesign

CustomizeHeaderDesign: { bg: CSSProperties["backgroundColor"]; borderColor: CSSProperties["borderColor"]; borderWidth: number; fontColor: CSSProperties["color"]; fontFamily: string; fontInheritFamily: boolean; fontSize: number; fontWeight: CSSProperties["fontWeight"]; inheritBg: boolean; inheritTextAlign: boolean; logo: string; logoAlt: string; logoFitDim?: [number, number]; logoMargin: MarginOrPadding; logoMaxHeight: number; logoPosition: "left" | "right" | "above"; logoRetina: string; logoRetinaFitDim?: [number, number]; padding: MarginOrPadding; textAlign: CSSProperties["textAlign"] }

Type declaration

  • bg: CSSProperties["backgroundColor"]
  • borderColor: CSSProperties["borderColor"]
  • borderWidth: number
  • fontColor: CSSProperties["color"]
  • fontFamily: string
  • fontInheritFamily: boolean
  • fontSize: number
  • fontWeight: CSSProperties["fontWeight"]
  • inheritBg: boolean
  • inheritTextAlign: boolean
  • logo: string
  • logoAlt: string
  • Optional logoFitDim?: [number, number]
  • logoMargin: MarginOrPadding
  • logoMaxHeight: number
  • logoPosition: "left" | "right" | "above"
  • logoRetina: string
  • Optional logoRetinaFitDim?: [number, number]
  • padding: MarginOrPadding
  • textAlign: CSSProperties["textAlign"]

CustomizeIndividualLayout

CustomizeIndividualLayout: { bannerMaxWidth: number; descriptionTextAlign: CSSProperties["textAlign"]; dialogMaxWidth: number; inheritBannerMaxWidth: boolean; inheritDialogMaxWidth: boolean }

Type declaration

  • bannerMaxWidth: number
  • descriptionTextAlign: CSSProperties["textAlign"]
  • dialogMaxWidth: number
  • inheritBannerMaxWidth: boolean
  • inheritDialogMaxWidth: boolean

CustomizeIndividualTexts

CustomizeIndividualTexts: { description: string; headline: string; hideMore: string; save: string; showMore: string }

Type declaration

  • description: string
  • headline: string
  • hideMore: string
  • save: string
  • showMore: string

CustomizeLayout

CustomizeLayout: { animationIn: string; animationInDuration: number; animationInOnlyMobile: boolean; animationOut: string; animationOutDuration: number; animationOutOnlyMobile: boolean; bannerMaxWidth: number; bannerPosition: "top" | "bottom"; borderRadius: number; dialogBorderRadius: number; dialogMargin: MarginOrPadding; dialogMaxWidth: number; dialogPosition: "topLeft" | "topCenter" | "topRight" | "middleLeft" | "middleCenter" | "middleRight" | "bottomLeft" | "bottomCenter" | "bottomRight"; overlay: boolean; overlayBg: CSSProperties["backgroundColor"]; overlayBgAlpha: number; overlayBlur: number; type: "dialog" | "banner" }

Type declaration

  • animationIn: string
  • animationInDuration: number
  • animationInOnlyMobile: boolean
  • animationOut: string
  • animationOutDuration: number
  • animationOutOnlyMobile: boolean
  • bannerMaxWidth: number
  • bannerPosition: "top" | "bottom"
  • borderRadius: number
  • dialogBorderRadius: number
  • dialogMargin: MarginOrPadding
  • dialogMaxWidth: number
  • dialogPosition: "topLeft" | "topCenter" | "topRight" | "middleLeft" | "middleCenter" | "middleRight" | "bottomLeft" | "bottomCenter" | "bottomRight"
  • overlay: boolean
  • overlayBg: CSSProperties["backgroundColor"]
  • overlayBgAlpha: number
  • overlayBlur: number
  • type: "dialog" | "banner"

CustomizeLegal

CustomizeLegal: { imprint: number; imprintExternalUrl: string; imprintHide: boolean; imprintIsExternalUrl: boolean; imprintLabel: string; privacyPolicy: number; privacyPolicyExternalUrl: string; privacyPolicyHide: boolean; privacyPolicyIsExternalUrl: boolean; privacyPolicyLabel: string }

Type declaration

  • imprint: number
  • imprintExternalUrl: string
  • imprintHide: boolean
  • imprintIsExternalUrl: boolean
  • imprintLabel: string
  • privacyPolicy: number
  • privacyPolicyExternalUrl: string
  • privacyPolicyHide: boolean
  • privacyPolicyIsExternalUrl: boolean
  • privacyPolicyLabel: string

CustomizeMobile

CustomizeMobile: { alignment: "top" | "center" | "bottom"; enabled: boolean; hideHeader: boolean; maxHeight: number; scalePercent: number; scalePercentVertical: number }

Type declaration

  • alignment: "top" | "center" | "bottom"
  • enabled: boolean
  • hideHeader: boolean
  • maxHeight: number
  • scalePercent: number
  • scalePercentVertical: number

CustomizeSaveButton

CustomizeSaveButton: { bg: CSSProperties["backgroundColor"]; borderColor: CSSProperties["borderColor"]; borderWidth: number; fontColor: CSSProperties["color"]; fontSize: number; fontWeight: CSSProperties["fontWeight"]; hoverBg: CSSProperties["backgroundColor"]; hoverBorderColor: CSSProperties["borderColor"]; hoverFontColor: CSSProperties["color"]; padding: MarginOrPadding; textAlign: CSSProperties["textAlign"]; type: "button" | "link"; useAcceptAll: boolean }

Type declaration

  • bg: CSSProperties["backgroundColor"]
  • borderColor: CSSProperties["borderColor"]
  • borderWidth: number
  • fontColor: CSSProperties["color"]
  • fontSize: number
  • fontWeight: CSSProperties["fontWeight"]
  • hoverBg: CSSProperties["backgroundColor"]
  • hoverBorderColor: CSSProperties["borderColor"]
  • hoverFontColor: CSSProperties["color"]
  • padding: MarginOrPadding
  • textAlign: CSSProperties["textAlign"]
  • type: "button" | "link"
  • useAcceptAll: boolean

CustomizeTexts

CustomizeTexts: { acceptAll: string; acceptEssentials: string; acceptIndividual: string; ageNoticeBanner: string; ageNoticeBlocker: string; blockerAcceptInfo: string; blockerHeadline: string; blockerLinkShowMissing: string; blockerLoadButton: string; consentForwardingExternalHosts: string; description: string; ePrivacyUSA: string; headline: string; listServicesNotice: string; poweredBy: number; tcfStacksCustomDescription: string; tcfStacksCustomName: string }

Type declaration

  • acceptAll: string
  • acceptEssentials: string
  • acceptIndividual: string
  • ageNoticeBanner: string
  • ageNoticeBlocker: string
  • blockerAcceptInfo: string
  • blockerHeadline: string
  • blockerLinkShowMissing: string
  • blockerLoadButton: string
  • consentForwardingExternalHosts: string
  • description: string
  • ePrivacyUSA: string
  • headline: string
  • listServicesNotice: string
  • poweredBy: number
  • tcfStacksCustomDescription: string
  • tcfStacksCustomName: string

MarginOrPadding

MarginOrPadding: [number, number, number, number]

YesNo

YesNo: "y" | "n"

Generated using TypeDoc