README.md

@localia/ngx-cookie-consent

Angular multi-language module to display a cookie consent banner without other dependencies.

Works since Angular v14!

Available languages: English, German, Italian, Portuguese, Francais and custom language ready.

Versions

Version	Angular Version
v1.1.0	Angular v14 (not maintained)
v1.2.0	Angular v15 (not maintained)
v1.3.0	Angular v16 (not maintained)
v2.0.0	Angular v17 (not maintained)
v3.0.0	Angular v18 (not maintained)
v4.0.0+	Angular v19 maintained

Installation

Install the package via npm:

npm install @localia/ngx-cookie-consent --save

Install the package with yarn:

yarn add @localia/ngx-cookie-consent

Usage

Import the module

import { NgxCookieConsentModule } from '@localia/ngx-cookie-consent';

// use your configuration or leave it empty
// const cookieConfig = {};

@NgModule({
    imports: [
        // using own configuration pass the config object  
        NgxCookieConsentModule.forRoot(),
    ],
})

Add the cookie consent component to your template at the top for all pages eg. app.component.html

<ngx-cookie-consent></ngx-cookie-consent>
<router-outlet></router-outlet>

Usage in templates to check if the user has accepted the cookie consent

<div *ngxIfConsent="'functional_google_maps'">
    This content is only visible if functional_google_maps consent is given.
    (In this example functional_google_maps is the name of the cookie configured in the config object)
</div>

Configuration

Name	Type	Default	Description
privacyPolicyUrl	string | TranslatableString	'#'	URL to your privacy policy ⚠ required ⚠
imprintUrl	string | TranslatableString	'#'	URL to your imprint ⚠ required ⚠
defaultLanguage	string	'en'	Default language for the cookie consent banner
availableLanguages	string[]	['en', 'de', 'it']	Available languages for the cookie consent banner
customLanguage	CustomLanguageConfig | null	null	Custom language for the cookie consent banner
showLanguageSwitcher	boolean	true	Show language switcher
showBadgeOpener	boolean	true	Show badge opener
openerPosition	enum	'left-bottom'	Position of the badge eg. 'left-top', 'right-top' , 'left-bottom' , 'right-bottom'
customOpenerClass	string	''	Custom class for the badge opener
customClass	string	''	Custom class for the cookie consent banner
cookiePrefix	string	'cookieconsent_'	Prefix for the cookie consent banner
cookieExpiryDays	number	365	Expiry days for the cookie consent banner
showCookieDetails	boolean	false	Show cookie details
showFunctionalCookies	boolean	true	Show functional cookies
functionalCookies	CookieItem[]	[]	Functional cookies
showMarketingCookies	boolean	true	Show marketing cookies
marketingCookies	CookieItem[]	[]	Marketing cookies
showEssentialCookies	boolean	true	Show essential cookies
essentialCookies	CookieItem[]	[]	Essential cookies
showOtherTools	boolean	true	Show other tools
otherTools	CookieItem[]	[]	Other tools
excludeRoutes	string[]	[]	Exclude routes eg. ['/privacy-policy']

CustomLanguageConfig interface

Name	Type	Description
languageKey	string	Key for the custom language eg. 'custom'
languageName	string	Name for the custom language eg. 'Custom'
customIconPath	string | null	Path to the custom icon eg. 'assets/images/custom-icon.svg'
translations	translations: { [key: string]: string };	Translations for the custom language as object please copy a example in languages folder.

CookieItem interface

Name	Type	Description
key	string	Key for the cookie eg. 'functional_google_analytics'
name	string | TranslatableString	Name for the cookie eg. 'Google Analytics'
description	string | TranslatableString	Description for the cookie eg. 'Google Analytics is a web analytics service offered by Google that tracks and reports website traffic.'
privacyPolicyUrl	string | TranslatableString	URL to the privacy policy for the cookie eg. 'https://policies.google.com/privacy'
cookies	CookieDetail[]	Cookie details for the cookie

CookieDetail interface

Name	Type	Description
name	string	Name for the saved cookie eg. '_ga'
description	string | TranslatableString	Description for the saved cookie eg. 'This cookie is used to distinguish users.'
duration	string | TranslatableString	Duration for the saved cookie eg. '2 years'

TranslatableString interface

The TranslatableString interface is used to define a string that can be translated into multiple languages. It is optional to use this interface. If you don't use it, the string will be used as it is.

⚠ The TranslatableString interface if used, will automatically fall back to defaultLanguage used if no translation key defined for the desired language.

Name	Type	Description
en	string	English string for the specified key
de	string	German string for the specified key
it	string	Italian string for the specified key
pt	string	Portuguese string for the specified key
fr	string	Francais string for the specified key

Contributing

This project has a maintainer that actively monitors its issue queue and responds in a timely manner. This means that bug reports, tasks, feature requests and support request posted in the project's issue should receive timely attention from project's maintainers. Other community members are also welcome to resolve issues posted to the issue queue.

License

ngx-cookie-consent is licensed under the MIT license.