angular2-cookie

Implementation of Angular 1.x $cookies service to Angular 2

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
angular2-cookie
111201.2.66 years ago7 years agoMinified + gzip package size for angular2-cookie in KB

Readme

angular2-cookie Build Status npm version Downloads
Implementation of Angular 1.x $cookies service to Angular 2 v1.2.6
Please use >=1.2.4 for Angular >2.0.0, 1.1.x versions for beta, 1.2.2 version is for release candidates earlier than rc.5 and 1.2.3 is for >rc.5.

Table of contents:

- Installation - Usage - Angular-universal - Examples
- [Angular2-quickstart](https://github.com/salemdar/angular2-cookie#quickstart)
- [Angular2-seed](https://github.com/salemdar/angular2-cookie#seed)
- [Angular-cli](https://github.com/salemdar/angular2-cookie#cli)
- [Angular2 Webpack Starter](https://github.com/salemdar/angular2-cookie#angular2-webpack-starter)
- get() - getObject() - getAll() - put() - putObject() - remove() - removeAll()

Get Started

Installation

You can install this package locally with npm. ```bash
To get the latest stable version and update package.json file:
npm install angular2-cookie --save ``` After installing the library, it should be included in the SystemJS configurations. ```javascript / System configuration for Angular 2 samples Adjust as necessary for your application needs. Taken from: https://github.com/angular/quickstart/blob/master/systemjs.config.js / (function (global) { System.config({
paths: {
// paths serve as alias
'npm:': 'node_modules/'
},
// map tells the System loader where to look for things
map: {
// our app is within the app folder
app: 'app',
// angular bundles
'@angular/core': 'npm:@angular/core/bundles/core.umd.js',
'@angular/common': 'npm:@angular/common/bundles/common.umd.js',
'@angular/compiler': 'npm:@angular/compiler/bundles/compiler.umd.js',
'@angular/platform-browser': 'npm:@angular/platform-browser/bundles/platform-browser.umd.js',
'@angular/platform-browser-dynamic': 'npm:@angular/platform-browser-dynamic/bundles/platform-browser-dynamic.umd.js',
'@angular/http': 'npm:@angular/http/bundles/http.umd.js',
'@angular/router': 'npm:@angular/router/bundles/router.umd.js',
'@angular/forms': 'npm:@angular/forms/bundles/forms.umd.js',
// other libraries
'rxjs':                       'npm:rxjs',
'angular2-in-memory-web-api': 'npm:angular2-in-memory-web-api',
'angular2-cookie':            'npm:angular2-cookie'
},
// packages tells the System loader how to load when no filename and/or no extension
packages: {
app: {
main: './main.js',
defaultExtension: 'js'
},
rxjs: {
defaultExtension: 'js'
},
'angular2-in-memory-web-api': {
main: './index.js',
defaultExtension: 'js'
},
'angular2-cookie': {
main: './core.js',
defaultExtension: 'js'
}
}
}); })(this); ```

Usage

CookieService class is an injectable service with angular @Injectable() decorator. Therefore, it needs to be registered in the providers array (encouraged way). Then, it will be available in the constructor of the component class. ```typescript import { NgModule } from '@angular/core'; import { BrowserModule } from '@angular/platform-browser'; import { CookieService } from 'angular2-cookie/services/cookies.service'; import { AppComponent } from './app.component'; @NgModule({ imports: BrowserModule , declarations: AppComponent , providers: CookieService , bootstrap: AppComponent }) export class AppModule { } ``` ```typescript import {Component} from 'angular2/core'; import {CookieService} from 'angular2-cookie/core'; @Component({
selector: 'my-very-cool-app',
template: '<h1>My Angular2 App with Cookies</h1>'
}) export class AppComponent { constructor(private cookieService:CookieService){} getCookie(key: string){
return this._cookieService.get(key);
} } ```