Cookies is a small client-side javascript library that makes managing cookies easily and integrate with AngularJS.
Download the Production version or the Development version.
Or download it with bower: open terminal and run
bower install bower-angular-cookies
Include js files into your web page:
<script type="text/javascript" src="[...]/cookies[.min].js"></script>Add dependency to your app module:
angular.module('your-app-name', [
'angular-cookies'
]);The cookies module is now installed. It exposes the CookiesProvider provider and Cookies factory into your app.
angular.module('app', [
'angular-cookies'
]).config(function(CookiesProvider){
CookiesProvider.set('hello', 'moto', {
domain: 'www.example.com',
expires: 600,
secure: true
});
}).run(function(Cookies, $http){
Cookies.set('hello', 'moto', {
domain: 'www.example.com',
expires: 600,
secure: true
});
});Methods
Cookies.set(key, value [, options])
Cookies.get(key)
Cookies.expire(key [, options])
Properties
Cookies.enabled
Cookies.defaults
Alias: Cookies(key, value [, options])
Sets a cookie in the document. If the cookie does not already exist, it will be created. Returns the Cookies object.
| Option | Description | Default |
|---|---|---|
| path | A string value of the path of the cookie | "/" |
| domain | A string value of the domain of the cookie | undefined |
| expires | A number (of seconds), a date parsable string, or a Date object of when the cookie will expire |
undefined |
| secure | A boolean value of whether or not the cookie should only be available over SSL | false |
A default value for any option may be set in the Cookies.defaults object.
Example Usage
// Setting a cookie value
Cookies.set('key', 'value');
// Chaining sets together
Cookies.set('key', 'value').set('hello', 'world');
// Setting cookies with additional options
Cookies.set('key', 'value', { domain: 'www.example.com', secure: true });
// Setting cookies with expiration values
Cookies.set('key', 'value', { expires: 600 }); // Expires in 10 minutes
Cookies.set('key', 'value', { expires: '01/01/2012' });
Cookies.set('key', 'value', { expires: new Date(2012, 0, 1) });
// Using the alias
Cookies('key', 'value', { secure: true });Alias: Cookies(key)
Returns the value of the most locally scoped cookie with the specified key.
Example Usage
// First set a cookie
Cookies.set('key', 'value');
// Get the cookie value
Cookies.get('key'); // "value"
// Using the alias
Cookies('key'); // "value"Alias: Cookies(key, undefined [, options])
Expires a cookie, removing it from the document. Returns the Cookies object.
| Option | Description | Default |
|---|---|---|
| path | A string value of the path of the cookie | "/" |
| domain | A string value of the domain of the cookie | undefined |
A default value for any option may be set in the Cookies.defaults object.
Example Usage
// First set a cookie and get its value
Cookies.set('key', 'value').get('key'); // "value"
// Expire the cookie and try to get its value
Cookies.expire('key').get('key'); // undefined
// Using the alias
Cookies('key', undefined);A boolean value of whether or not the browser has cookies enabled.
Example Usage
if (Cookies.enabled) {
Cookies.set('key', 'value');
}An object representing default options to be used when setting and expiring cookie values.
| Option | Description | Default |
|---|---|---|
| path | A string value of the path of the cookie | "/" |
| domain | A string value of the domain of the cookie | undefined |
| expires | A number (of seconds), a date parsable string, or a Date object of when the cookie will expire |
undefined |
| secure | A boolean value of whether or not the cookie should only be available over SSL | false |
Example Usage
Cookies.defaults = {
path: '/',
secure: true
};
Cookies.set('key', 'value'); // Will be secure and have a path of '/'
Cookies.expire('key'); // Will expire the cookie with a path of '/'See Getting started
See CHANGELOG.md
See CONTRIBUTING.md
MIT - Copyright (c) 2014 Angularfiy.org & HenryTao.