react-cookie

What is react-cookie?

The react-cookie package is a library for handling cookies in React applications. It provides hooks and components to easily set, get, and remove cookies, making it simple to manage user sessions and preferences.

What are react-cookie's main functionalities?

Setting a Cookie

This feature allows you to set a cookie using the `useCookies` hook. In this example, a cookie named 'user' is set with the value 'John Doe' when the login button is clicked.

import { useCookies } from 'react-cookie';

function App() {
  const [cookies, setCookie] = useCookies(['user']);

  const handleLogin = () => {
    setCookie('user', 'John Doe', { path: '/' });
  };

  return (
    <div>
      <button onClick={handleLogin}>Login</button>
    </div>
  );
}

Getting a Cookie

This feature allows you to get a cookie using the `useCookies` hook. In this example, the value of the 'user' cookie is displayed in a paragraph.

import { useCookies } from 'react-cookie';

function App() {
  const [cookies] = useCookies(['user']);

  return (
    <div>
      <p>User: {cookies.user}</p>
    </div>
  );
}

Removing a Cookie

This feature allows you to remove a cookie using the `useCookies` hook. In this example, the 'user' cookie is removed when the logout button is clicked.

import { useCookies } from 'react-cookie';

function App() {
  const [cookies, setCookie, removeCookie] = useCookies(['user']);

  const handleLogout = () => {
    removeCookie('user', { path: '/' });
  };

  return (
    <div>
      <button onClick={handleLogout}>Logout</button>
    </div>
  );
}

Other packages similar to react-cookie

js-cookie

js-cookie is a simple, lightweight JavaScript API for handling cookies. It is not specific to React but can be used in any JavaScript project. Compared to react-cookie, js-cookie requires more manual handling of cookies but offers more flexibility for non-React environments.

universal-cookie

universal-cookie is a library for handling cookies in both client and server environments. It provides a consistent API for managing cookies in JavaScript and is often used in conjunction with server-side rendering frameworks. Compared to react-cookie, universal-cookie is more versatile for isomorphic applications.

react-use-cookie

react-use-cookie is a React hook for managing cookies. It is similar to react-cookie but offers a simpler API with fewer features. It is suitable for projects that need basic cookie management without the additional functionality provided by react-cookie.

README

react-cookie

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 sub.domain.com if you want to access the cookie on a specific sub-domain only.
Use .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.