Skip to content

Commit

Permalink
Cookie consent - documentation updates
Browse files Browse the repository at this point in the history
  • Loading branch information
oisa committed Dec 13, 2024
1 parent 3531169 commit eed2fbc
Showing 1 changed file with 1 addition and 6 deletions.
7 changes: 1 addition & 6 deletions src/components/cookie-consent/_guidance.hbs
Original file line number Diff line number Diff line change
Expand Up @@ -19,31 +19,27 @@ layout: blank-layout.hbs
<p>Do:</p>
<ul>
<li>Use clear, concise, and easy-to-understand language to minimise cognitive load</li>
<li>Ensure the cookie banner is visible at the bottom of the page when displayed</li>
<li>Include a link or button for users to manage their cookie preferences</li>
<li>Ensure accessibility and responsiveness to support a wide range of users</li>
</ul>

<p>Do not:</p>
<ul>
<li>Use the cookie banner for purposes unrelated to cookie consent</li>
<li>Display the banner in a way that obstructs important content</li>
<li>Make it difficult for users to reject or customise cookies</li>
</ul>

<h2>Cookie Consent States</h2>
<p>The Cookie Consent component has the following states:</p>
<ul>
<li><strong>Initial Banner</strong> - Displays a summary of cookie usage with options to accept all, reject all, or manage preferences.</li>
<li><strong>Preferences Dialog</strong> - Allows users to customise cookie categories (e.g., necessary, analytics, marketing).</li>
<li><strong>Confirmation Message</strong> - Confirms the user’s selection and provides an option to dismiss the message.</li>
<li><strong>Preferences Dialog</strong> - Allows users to customise cookie categories (e.g., necessary, analytics, marketing).</li>
</ul>

<h2>When to Avoid</h2>
<p>Do not use the Cookie Consent component if:</p>
<ul>
<li>The website does not use cookies or track user data</li>
<li>A similar consent mechanism is already implemented</li>
</ul>

<h2>Integration</h2>
Expand Down Expand Up @@ -155,7 +151,6 @@ waitForCookieConsent(() => {
<h2>Customisation</h2>
<p>The component is customisable via the configuration object, including:</p>
<ul>
<li>Language and translations</li>
<li>Cookie categories and descriptions</li>
<li>Button labels and actions</li>
</ul>
Expand Down

0 comments on commit eed2fbc

Please sign in to comment.