> For the complete Lynkow documentation index in agent-friendly format, see [llms.txt](/llms.txt). # SDK Types: Cookies & Consent **Publié le** : 2026-08-20 **Catégorie** : Types # SDK Types: Cookies & Consent > **Related services:** **CookiesService** — `lynkow.cookies.getConfig()`, `lynkow.cookies.logConsent()` | **ConsentService** — `lynkow.consent.acceptAll()`, `lynkow.consent.destroy()`, `lynkow.consent.getCategories()`, `lynkow.consent.getConfig()`, `lynkow.consent.hasConsented()`, `lynkow.consent.hide()`, `lynkow.consent.logConsent()`, `lynkow.consent.rejectAll()`, `lynkow.consent.reset()`, `lynkow.consent.setCategories()`, `lynkow.consent.show()`, `lynkow.consent.showPreferences()` ## `ConsentCategories` *Interface* User consent state for each cookie category Lynkow manages. Used as input to ConsentService.setCategories and emitted as the payload of the `'consent-changed'` client event. A category set to `false` means the corresponding scripts (from the site's cookie configuration) MUST NOT be loaded; a category set to `true` authorises them. | Property | Type | Optional | Description | | --- | --- | --- | --- | | `analytics` | `boolean` | No | Consent to first-party and third-party analytics (e.g. the Lynkow
tracker, Google Analytics). When `false`, the analytics service
automatically becomes a no-op. | | `marketing` | `boolean` | No | Consent to marketing and advertising cookies (ad networks,
retargeting). Required before loading scripts classified as
`marketing` in the site's cookie config. | | `necessary` | `boolean` | No | Strictly necessary cookies (session, CSRF). Always `true`: users
cannot opt out because the site would be non-functional without them.
Included in the type so consent payloads remain uniform. | | `preferences` | `boolean` | No | Consent to personalization and preference cookies (theme, language,
non-essential UI state). Required before loading scripts classified
as `preferences` in the site's cookie config. | --- ## `CookieCategory` *Interface* A cookie consent category grouping related cookies and scripts. Users accept or reject entire categories (not individual cookies). | Property | Type | Optional | Description | | --- | --- | --- | --- | | `description` | `string` | No | Description explaining what cookies in this category do.
Displayed in the consent banner's detailed/customize view. | | `id` | `string` | No | Machine-readable category identifier.
Standard values: `'necessary'`, `'analytics'`, `'marketing'`, `'preferences'`.
Used as the key in CookiePreferences when recording consent. | | `name` | `string` | No | Human-readable category name displayed in the consent banner. | | `required` | `boolean` | No | Whether this category is required and cannot be toggled off by the user.
Always `true` for the `'necessary'` category (essential cookies).
When `true`, the toggle is disabled/checked in the consent UI.
When `false`, the user can opt in or out of this category. | --- ## `CookieConfig` *Interface* Full cookie consent banner configuration. Returned by `cookies.getConfig()`. Contains all settings needed to render and manage a GDPR-compliant consent banner. | Property | Type | Optional | Description | | --- | --- | --- | --- | | `borderRadius` | `number` | Yes | Border radius in pixels for the banner container and buttons.
Use `0` for sharp corners, `8`-`12` for rounded, `9999` for pill-shaped buttons. | | `categories` | `CookieCategory[]` | No | Cookie categories that users can accept or reject.
Always includes at least a `'necessary'` category with `required: true`.
Order matches the display order in the preferences UI. | | `consentMode` | `"opt-in" \| "opt-out"` | Yes | How consent is handled:
- `'opt-in'`: all non-necessary cookies are blocked until the user explicitly accepts.
This is the GDPR-compliant default for EU sites.
- `'opt-out'`: all cookies are active by default; user can reject them.
Less restrictive, suitable for non-EU sites.

Only present when enabled is `true`. | | `cookiePolicyUrl` | `string \| null` | Yes | URL to a dedicated cookie policy page (separate from the privacy policy).
`null` when no cookie policy URL has been configured.
Some sites use a single privacy policy; others maintain a separate cookie policy. | | `enabled` | `boolean` | No | Whether the cookie consent banner is enabled for this site.
When `false`, no banner should be shown and no consent logic is needed. | | `fontSize` | `number` | Yes | Font size in pixels for the banner text.
Constrained to the range 11-17. Values outside this range are clamped. | | `layout` | `"floating"` | No | Banner layout style. Currently only `'floating'` is supported
(a dismissable card overlay, not a full-width bar). | | `maxWidth` | `number` | Yes | Maximum banner width in pixels on desktop. Range 280–1200, default 580.
Applies to both `'auto'` and `'column'` orientations. Below 600px viewport
width this value is ignored and the banner expands to `calc(100vw - 20px)`
so it never overflows the screen on mobile. | | `orientation` | `"auto" \| "column"` | Yes | Banner layout orientation.
- `'auto'` (default): row layout on screens at least 600px wide,
automatically stacked into a column under 600px.
- `'column'`: forced column layout at every screen size.

In every mode the banner is height-capped to the viewport with internal
scrolling, so it never overflows the screen. | | `position` | `"bottom-left" \| "bottom-right"` | No | Screen position of the floating consent banner.
- `'bottom-left'`: anchored to the bottom-left corner
- `'bottom-right'`: anchored to the bottom-right corner | | `primaryColor` | `string` | Yes | Primary accent color for buttons and interactive elements.
Format: 6-digit hex with `#` prefix (e.g. `'#3b82f6'`).
Applied to the "Accept All" button and toggle switches. | | `privacyPolicyUrl` | `string \| null` | Yes | URL to the site's privacy policy page.
`null` when no privacy policy URL has been configured.
Should be rendered as a clickable link in the banner. | | `showCustomizeButton` | `boolean` | Yes | Whether to show the "Customize" button that lets users pick categories individually.
When `false`, only "Accept All" and "Reject All" buttons are shown. | | `showOnFirstVisit` | `boolean` | Yes | Whether to automatically show the banner on the user's first visit.
When `false`, the banner must be triggered manually (e.g. via a footer link).
Only present when enabled is `true`. | | `texts` | `CookieTexts` | No | Localized text strings for the banner UI.
All strings are ready for display without further formatting. | | `theme` | `"light" \| "dark" \| "auto"` | No | Color theme for the banner:
- `'light'`: white/light background with dark text
- `'dark'`: dark background with light text
- `'auto'`: follows the user's OS/browser color scheme preference

When `'auto'`, use themeStyles to get the exact colors for each scheme. | | `themeStyles` | `{ dark: { bgColor: string; primaryColor: string; textColor: string }; light: { bgColor: string; primaryColor: string; textColor: string } }` | Yes | Per-theme color overrides for light and dark modes.
Only relevant when theme is `'auto'`.
When theme is `'light'` or `'dark'`, use the corresponding sub-object. | | `thirdPartyScripts` | `ThirdPartyScript[]` | Yes | Third-party scripts to inject based on the user's consent preferences.
Each script is tied to a category; only inject scripts whose category
the user has accepted. Empty array when no scripts are configured. | --- ## `CookiePreferences` *TypeAlias* Map of cookie category IDs to the user's consent decision. `true` means the user accepted that category; `false` means rejected. Used when calling `cookies.logConsent()` to record preferences. ```typescript type CookiePreferences = Record ``` --- ## `CookieTexts` *Interface* Localized text strings for the cookie consent banner. All fields are pre-configured by the site admin and ready for display. | Property | Type | Optional | Description | | --- | --- | --- | --- | | `acceptAll` | `string` | No | Label for the "Accept All" button that grants consent for all categories. | | `customize` | `string` | No | Label for the "Customize" button that opens the detailed category preferences. | | `description` | `string` | No | Main description/message shown in the cookie banner.
Typically explains that the site uses cookies and links to the privacy policy. | | `privacyPolicy` | `string` | No | Link text pointing to the privacy/cookie policy page. | | `rejectAll` | `string` | No | Label for the "Reject All" button that only allows necessary cookies. | | `save` | `string` | No | Label for the "Save" button in the detailed preferences view.
Saves the user's per-category choices. |