ngx-cookie-service (2024)

Angular service to read, set and delete browser cookies. Originally based onthe ng2-cookies library. The experienced teambehind Studytube will take care of our cookie service from now on.

npm install ngx-cookie-service --save# oryarn add ngx-cookie-service

Add the cookie service to your app.module.ts as a provider:

import {CookieService} from 'ngx-cookie-service';@NgModule({ ... providers:[CookieService],...})export class AppModule {}

Then, import and inject it into a constructor:

constructor(privatecookieService: CookieService){ this.cookieService.set('Test', 'Hello World'); this.cookieValue = this.cookieService.get('Test');}

That's it!

1. Angular 14 introduced support for standalone components.If you are using just standalone components, you can import the service directly into the component

   import { CookieService } from 'ngx-cookie-service';import { Component } from '@angular/core';@Component({ selector: 'my-component', template: `<h1>Hello World</h1>`, providers: [CookieService],})export class HelloComponent { constructor(private cookieService: CookieService) { this.cookieService.set('Test', 'Hello World'); this.cookieValue = this.cookieService.get('Test'); }}

2. You can also use inject() method in v14+ to inject the service into the component

   import { CookieService } from 'ngx-cookie-service';import { Component, inject } from '@angular/core';@Component({ selector: 'my-component', template: `<h1>Hello World</h1>`, providers: [CookieService],})export class HelloComponent { cookieService = inject(CookieService); constructor() { this.cookieService.set('Test', 'Hello World'); this.cookieValue = this.cookieService.get('Test'); }}

   See Also

   GSK, Sanofi Exit Nigerian Market Amid Lingering Foreign Exchange CrisisAbout Us - Nigerian Exchange LimitedLong trail of exiting companies threatens Nigerian Exchange’s drive to grow listingsTrading Market Structure - Nigerian Exchange Limited

Ngx Cookie Service supports Server Side Rendering (SSR) via dedicatedlibrary ngx-cookie-service-ssr.Only install ngx-cookie-service-ssr library (and skip ngx-cookie-service) for SSR

1. Install the library using below command

    npm install ngx-cookie-service-ssr --save # or yarn add ngx-cookie-service-ssr

2. By default, browser cookies are notavailable in SSR because document object is not available. To overcome this, navigate to server.ts file in yourSSRproject, and replace the following code

   server.get('*', (req, res) => { res.render(indexHtml, { req, providers: [{ provide: APP_BASE_HREF, useValue: req.baseUrl }] });});

with this

server.get('*', (req, res) => { res.render(indexHtml, { req, providers: [ { provide: APP_BASE_HREF, useValue: req.baseUrl }, { provide: 'REQUEST', useValue: req }, { provide: 'RESPONSE', useValue: res }, ], });});

3. This will make sure the cookies are available in REQUEST object, and the ngx-cookie-service-ssr canuse REQUEST.cookies to access thecookies in SSR. Then proceed to use ngx-cookie-service as usual.
4. See the sample repo for more details.

https://stackblitz.com/edit/angular-ivy-1lrgdt?file=src%2Fapp%2Fapp.component.ts

ViewEngine support has been removed on 13.x.x. For Angular versions 13.x.x or later use the latest version of thelibrary. For versions <=12.x.x, use 12.0.3 version

const cookieExists: boolean = cookieService.check('test');

Checks if a cookie with the givenname can be accessed or found.

const value: string = cookieService.get('test');

Gets the value of the cookie with the specified name.

const allCookies: {} = cookieService.getAll();

Returns a map of key-value pairs for cookies that can be accessed.

cookieService.set('test', 'Hello World');cookieService.set('test', 'Hello World', { expires: 2, sameSite: 'Lax' });

Sets a cookie with the specified name and value. It is good practice to specify a path. If you are unsure about thepath value, use '/'. If no path or domain is explicitly defined, the current location is assumed. sameSite defaultsto Lax.

Important: For security reasons, it is not possible to define cookies for other domains. Browsers do not allow this.Read this and this StackOverflowanswer for a more in-depth explanation.

Important: Browsers do not accept cookies flagged sameSite = 'None' if secure flag isn't set as well. CookieServicewill override the secure flag to true if sameSite='None'.

cookieService.delete('test');

Deletes a cookie with the specified name. It is best practice to always define a path. If you are unsure about thepath value, use '/'.

Important: For security reasons, it is not possible to delete cookies for other domains. Browsers do not allow this.Read this and this StackOverflowanswer for a more in-depth explanation.

cookieService.deleteAll();

Deletes all cookies that can currently be accessed. It is best practice to always define a path. If you are unsure aboutthe path value, use '/'.

Checking out the following resources usually solves most of the problems people seem to have with this cookie service:

• article about cookies in general @MDN (recommended read!)
• common localhost problems @StackOverflow
• problems with secure cookies @StackOverflow
• how do browser cookie domains work? @StackOverflow
• get cookies from different paths

The following general steps are usually very helpful when debugging problems with this cookie service or cookies ingeneral:

• check out if there are any openor closed issues that answeryour question
• check out the actual value(s) of document.cookie
• does it work if you use document.cookie manually (i.e. in a console of your choice)?
• set explicit paths for your cookies
• explain to your local rubber duck why your code should work and why it (probably) does not

Package managers are a well known source of frustration. If you have "token missing" or "no provider" errors, a simplere-installation of your node modules might suffice:

rm -rf node_modulesyarn # or `npm install`

Please be aware that we cannot help you with problems that are out of scope. For example, we cannot debug a Symfony orSpringboot application for you. In that case, you are better off asking the nice folks overat StackOverflow for help.

There is an issue for that. Checkout this comment for more informationabout future support.

Please make sure to check out our FAQ before you open a new issue. Also, try to give us as much information as you canwhen you open an issue. Maybe you can even supply a test environment or test cases, if necessary?

We are happy to accept pull requests or test cases for things that do not work. Feel free to submit one of those.

However, we will only accept pull requests that pass all tests and include some new ones (as long as it makes sense toadd them, of course).

• Open a new pull request

This cookie service is brought to you by 7leads GmbH. We built it for one of our apps, becausethe other cookie packages we found were either not designed "the Angular way" or caused trouble during AOT compilation.

Thanks to all contributors:

• Pavan Kumar Jadda
• paroe
• CunningFatalist
• kthy
• JaredClemence
• flakolefluk
• mattbanks
• DBaker85
• mattlewis92
• IceBreakerG
• rojedalopez
• Nikel163

MIT