Developers
Start building
Themes/Theme SDK/Modules/consent

consent

Cookie consent: the shopper's choice and the actions that record it.

On this page
import { … } from '@poltura/theme-sdk/consent';

Hooks

NameWhat it is
useConsentThe shopper's cookie consent.

Parts

NameWhat it is
ConsentBannerThe cookie banner.
ConsentPreferencesThe preferences panel.
ConsentToggleOne category's switch.
ConsentSettingsLinkOpens the preferences panel.
ConsentCookieTableThe store's cookies.

Defaults

NameWhat it is
ConsentThe complete cookie consent: the banner until the shopper chooses and the preferences panel while it is open.

Types

NameWhat it is
ConsentCategoryA cookie category.
ConsentChoiceA choice per category.
ConsentLinkA link the banner offers, such as the cookie policy.
ConsentCookieTableTextsA cookie table's headings.
ConsentTextsThe banner and panel texts.
ConsentLayoutThe banner's shape.
ConsentPositionWhere the banner sits.
ConsentColorsThe banner's colours.
ConsentAppearanceThe banner's settings.
ConsentCookieA cookie the store may set, listed under its category in the preferences panel.
ConsentCategoryInfoA category as listed.
ConsentStateThe shopper's consent, the banner's wording and look, and the actions that record a choice.
ConsentBannerClassKeyThe banner's stylable parts.
ConsentBannerPropsProps of ConsentBanner.
ConsentPreferencesClassKeyThe panel's stylable parts.
ConsentPreferencesPropsProps of ConsentPreferences.
ConsentTogglePropsProps of ConsentToggle.
ConsentSettingsLinkPropsProps of ConsentSettingsLink.
ConsentCookieTableClassKeyTable parts to style.
ConsentCookieTablePropsProps of ConsentCookieTable.
ConsentPropsProps of Consent.
Last updated