Use privacyConsent only for privacy notices or consent prompts. This feature is separate from announcements and campaigns because privacy consent can require accept, reject, customize, category-level preferences, policy links, expiration, and optional script or embed gating.
Q-Press keeps this static-host friendly, but it cannot provide legal advice. Site owners remain responsible for local privacy, cookie, and consent requirements.
Layout Wiring
Q-Press templates render privacy consent from the generated MarkdownLayout. Configure it in src/siteConfig/index.ts; do not add the component to individual Markdown pages.
<MarkdownPrivacyConsent :config="qpressShellConfig.privacyConsent" />Basic Config
const const config: {
privacyConsent: {
enabled: boolean;
id: string;
mode: string;
title: string;
message: string;
policyLink: string;
expirationDays: number;
categories: ({
id: string;
label: string;
required: boolean;
} | {
id: string;
label: string;
required?: undefined;
})[];
};
}
privacyConsent: {
enabled: boolean;
id: string;
mode: string;
title: string;
message: string;
policyLink: string;
expirationDays: number;
categories: ({
id: string;
label: string;
required: boolean;
} | {
id: string;
label: string;
})[];
}
enabled: booleanenabled: true,
id: stringid: 'privacy-consent-v1',
mode: stringmode: 'consent',
title: stringtitle: 'Privacy preferences',
message: stringmessage:
'Choose whether this documentation site can enable optional analytics or third-party embeds.',
policyLink: stringpolicyLink: '/privacy-policy',
expirationDays: numberexpirationDays: 180,
categories: ({
id: string;
label: string;
required: boolean;
} | {
id: string;
label: string;
})[]
id: stringid: 'necessary', label: stringlabel: 'Necessary', required: booleanrequired: true },
{ id: stringid: 'analytics', label: stringlabel: 'Analytics' },
{ id: stringid: 'embeds', label: stringlabel: 'Third-party embeds' },
],
},
}expirationDays starts when the visitor saves their choice. Q-Press stores both savedAt and a computed expiresAt, then asks again after the saved choice expires.
Consent Event
When a consent choice is read or saved, Q-Press dispatches a qpress:privacy-consent event on window. Site owners can listen for this event before loading optional analytics, marketing pixels, or third-party embeds:
window.addEventListener('qpress:privacy-consent', (event) => {
const consent = event.detail
if (consent.categories.analytics === true) {
// Load optional analytics here.
}
})Boundaries
Privacy consent should not become a general marketing or campaign mechanism. Use:
announcementfor calm site-wide noticescampaignsfor restrained opt-in calls to actionprivacyConsentfor privacy notice, consent, and optional category choices
If a future campaign or docs component can load third-party content, it should honor the saved privacy consent state instead of bypassing it.
Styling
Use Q-Press theme tokens when a project needs a focused override:
.qpress-consent {
color: var(--qpress-text-primary);
background: var(--qpress-surface-raised-strong);
border-color: var(--qpress-border-strong);
}