Skip to content
Tickbox
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Getting started
Overview
Vanilla JS
React / Next.js
Vue
Nuxt
Default styled banner
Concepts
Jurisdictions
Consent modes
Script gating (PECR)
Google Consent Mode v2
AI training opt-out
Supported vendors
Recipes
Google Analytics (PECR-correct)
Plausible / GoatCounter
Multi-jurisdiction (UK + EU)
Cloudflare bot blocking
Internationalisation (i18n)
Migrations
From OneTrust
From Cookiebot
API reference
@tickboxhq/core
Classes
ConsentStore
Type Aliases
AiTxtOptions
ApplyOptions
CategoryDefinition
CategoryId
ConsentConfig
ConsentMode
ConsentModeMapping
ConsentModeRule
ConsentState
GtagConsentKey
Jurisdiction
JurisdictionId
ResolvedCategory
StorageOptions
StoredConsent
StoreOptions
Variables
ADVERTISING_VENDORS
AI_TRAINING_CRAWLERS
ALL_TRACKING_VENDORS
CDP_AND_PRODUCT_ANALYTICS
CHAT_WIDGETS
jurisdictions
MARKETING_AUTOMATION
PRIVACY_FRIENDLY_ANALYTICS
SESSION_REPLAY_VENDORS
TAG_ATTRIBUTE
Functions
applyConsent
clearConsent
defineConsent
generateAiBotRobotsRules
generateAiTxt
isGPCSignaled
parseConsentFromHeader
readConsent
resolveCategories
resolveJurisdictionByCountry
writeConsent
@tickboxhq/react
Type Aliases
CategoryApi
ConsentApi
ConsentBannerProps
ConsentNoticeProps
ConsentProviderProps
Functions
ConsentBanner
ConsentNotice
ConsentProvider
useConsent
@tickboxhq/vue
Type Aliases
CategoryApi
ConsentApi
ConsentSlotApi
Variables
ConsentBanner
ConsentNotice
ConsentProvider
ConsentStoreKey
Functions
useConsent
@tickboxhq/banner-default
react
Type Aliases
BannerCopy
ConsentBannerDefaultProps
ConsentNoticeDefaultProps
LocalePack
NoticeCopy
Variables
locales
Functions
ConsentBannerDefault
ConsentNoticeDefault
resolveLocalePack
vue
Type Aliases
ConsentBannerDefaultProps
ConsentNoticeDefaultProps
Variables
ConsentBannerDefault
ConsentNoticeDefault
References
BannerCopy
LocalePack
locales
NoticeCopy
resolveLocalePack
GitHub
Select theme
Dark
Light
Auto
@tickboxhq/banner-default
Modules
Module
Description
react
-
vue
-
