react-cookie

Load, save and remove cookies on the browser or Node.js

Install

npm install javascript-cookies --save

Isomorphic cookies!

To be able to access user cookies while doing server-rendering, you can use plugToRequest or setRawCookie.

API

load(name, [doNotParse])

Load the cookie value. Returns undefined if the cookie does not exist. Deserialize any cookie starting with { or [ unless dotNotParse is true.

select([regex])

Find all the cookies with a name that match the regex. Returns an object with the cookie name as the key.

save(name, val, [options])

Set a cookie

remove(name, [options])

Remove a cookie

plugToRequest(req, res): unplug()

Load the user cookies so you can do server-rendering and match the same result. Also send back to the user the new cookies. Work with connect or express.js by using the cookieParser middleware first. Use const unplug = plugToRequest(req, res) just before your renderToString. Returns unplug() function so it stops setting cookies on the response.

setRawCookie(cookies)

Load the user cookies so you can do server-rendering and match the same result. Use setRawCookie(headers.cookie) just before your renderToString. Make sure it is the raw string from the request headers.

Options

Support all the cookie options from the RFC 6265.

path

cookie path Use / as the path if you want your cookie to be accessible on all pages.

expires

absolute expiration date for the cookie (Date object)

maxAge

relative max age of the cookie from when the client receives it (seconds)

domain

domain for the cookie Use https://*.yourdomain.com if you want to access the cookie in all your subdomains.

secure

Is only accessible through HTTPS? true or false

httpOnly

Is only the server can access the cookie? true or false

sameSite

Specifies the boolean or string to be the value for the SameSite Set-Cookie attribute.

• true will set the SameSite attribute to Strict for strict same site enforcement.
• false will not set the SameSite attribute.
• lax will set the SameSite attribute to Lax for lax same site enforcement.
• none will set the SameSite attribute to None for an explicit cross-site cookie.
• strict will set the SameSite attribute to Strict for strict same site enforcement.

Example

import { Component } from 'react';
import cookie from 'javascript-cookies';

import LoginPanel from './LoginPanel';
import Dashboard from './Dashboard';

export default class MyApp extends Component {
  componentWillMount() {
    this.state =  { userId: cookie.load('userId') };
  }

  onLogin(userId) {
    this.setState({ userId });
    cookie.save('userId', userId, { path: '/' });
  }

  onLogout() {
    cookie.remove('userId', { path: '/' });
  }

  render() {
    if (!this.state.userId) {
      return <LoginPanel onSuccess={this.onLogin.bind(this)} />;
    }

    return <Dashboard userId={this.state.userId} />;
  }
}

License

This project is under the MIT license. You are free to do whatever you want with it.