Git Product home page Git Product logo

react-cookie's Introduction

react-cookie

npm version Build Status
Load, save and remove cookies on the browser or Node.js

Install

npm install react-cookie --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

Example

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

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.

react-cookie's People

Contributors

exon avatar cchamberlain avatar pjvds avatar p-j avatar rosskuyper avatar jmarceli avatar pixeleet avatar xpepermint avatar

Watchers

Scott Taylor avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.