Angular2+ component that provides a banner to inform users about cookie law
npm install angular2-cookie-law
> Angular2+ component that provides a banner to inform users about the cookie law now with Angular Universal support
Angular2 Cookie Law is an HTML
This documentation is for the latest version of angular2-cookie-law (>=6.x.x).
angular2-cookie-law@7 supports bot Angular v6 and v7
If you're using an older version of Angular (<6), please install angular2-cookie-law
in version 1 withnpm i --save angular2-cookie-law@1
and check out the documentation available here.
Live DEMO:
* Angular2 Cookie Law with Angular6
* Installation
* Setup
* Usage
* Example
* Demo App
* Options
* Attributes
* Properties
* Events
* Methods
* Custom template
* Contributing
* Changelog
* License
1. Install the component using npm
1. angular2-cookie-law depends on the Angular animations module in order to be able to do more advanced transitions. If you want these animations to work in your app, you have to install the @angular/animations module and include the BrowserAnimationsModule in your app.
``bash`
# To get the latest stable version and update package.json file:
$ npm install angular2-cookie-law@6 @angular/animations --save
or yarn with:
`bash`
$ yarn add angular2-cookie-law @angular/animations
angular2-cookie-law class is an Angular module therefore,
it needs to be registered in the modules array (encouraged way):
`js
// app.module.ts
import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { BrowserAnimationsModule } from '@angular/platform-browser/animations';
import { CookieLawModule } from 'angular2-cookie-law';
import { AppComponent } from './app.component';
@NgModule({
declarations: [ AppComponent ],
imports: [
BrowserModule,
BrowserAnimationsModule, // BrowserAnimationsModule is required
CookieLawModule // import Angular's CookieLaw modules
],
bootstrap: [ AppComponent ]
})
export class AppModule { }
`
Use the component anywhere around your application:
`js
// app.component.ts
import { Component } from '@angular/core';
@Component({
selector: 'app',
template:
})
export class AppComponent { }
`js
// app.component.ts
import { Component } from '@angular/core';
@Component({
selector: 'app',
template:
})
export class AppComponent { }
###### Output
Have a look at the demo app available in this repository for a real Angular application using the angular2-Cookie-Law library.
Clone this repo on you machine with
`sh`
$ git clone git@github.com:andreasonny83/angular2-cookie-law.git
Then install all the Node dependencies (Node v8 or later is required).
`sh`
$ npm install
And run the project with:
`bash`
$ npm start
Open your browser to http://localhost:4200/
to see the application running.
| Type | Default value |
| --- | --- |
| string | null |
If set to a valid absolute or relative URL, it will render an extra 'learn more' link pointing to the link.
###### Example
`html`
Font Awsome is required in your header for this feature to work.
`html`
| Type | Default value |
| --- | --- |
| string | null |
If set to a Font awsome Icon e.g. "fa-window-close" it will replace the standard SVG with the Font awsome Icon.
###### Example
`html`
| Type | Default value |
| --- | --- |
| string | _blank |
Set to _self if you want the external link not to be opened in a new tab.
###### Example
`html`
| Type | Default value |
| --- | --- |
| string | "bottom" |
Allows you to decide where in the page, the banner will be rendered.
Possible values are: "bottom" and "top".
###### Example
`html`
| Type | Default value |
| --- | --- |
| string | "cookieLawSeen" |
Allows you to decide which name will be used for storing the cookie in the client's browser.
###### Example
`html`
The previous example will generate a myShinyCookieLaw=true as soon as the user dismiss the banner.
| Type | Default value | Description |
| --- | --- | --- |
| number | - | Set a the cookie expiration time (in days) |
###### Example
`html`
| Name | Type | Description |
| --- | --- | --- |
| cookieLawSeen | boolean | true if the user has already dismissed the banner |
###### Example
`js
@Component({
selector: 'demo-app',
template:
,
})
export class AppComponent implements OnInit {
@ViewChild('cookieLaw')
private cookieLawEl: any;
private cookieLawSeen: boolean;
ngOnInit() {
this.cookieLawSeen = this.cookieLawEl.cookieLawSeen;
}
}
`
| Name | Type | Description |
| --- | --- | --- |
| isSeen | boolean | Triggered when the user dismiss the banner |
###### Example
`js
@Component({
selector: 'demo-app',
template:
,
})
export class AppComponent {
private cookieLawSeen: boolean;
public seen(evt: any) {
this.cookieLawSeen = evt;
}
}
`
| Name | Description |
| --- | --- |
| dismiss | Dismiss a banner |
###### Example
`js
@Component({
selector: 'demo-app',
template:
,
})
export class AppComponent implements OnInit {
@ViewChild('cookieLaw')
private cookieLawEl: any;
public dismiss(): void {
this.cookieLawEl.dismiss();
}
}
`
It is possible to overwrite our default cookie policy law text with a
custom template.
Just put your favorite html content between the component like in the
following example:
`html`
This website contains cookie.
Read more
This package is using the AngularJS commit messages as default way to contribute
with Commitizen node package integrated in this repository.
1. Fork it!
1. Create your feature branch: git checkout -b my-new-feature
1. Add your changes:
1. Commit your changes:
1. Push to the branch:
1. Submit a pull request :sunglasses:
Changelog available here
MIT License © Andrea SonnY