react-cookie

  • Version 8.0.1
  • Published
  • 71.3 kB
  • 3 dependencies
  • MIT license

Install

npm i react-cookie
yarn add react-cookie
pnpm add react-cookie

Overview

Universal cookies for React

Index

Variables

variable CookiesProvider

const CookiesProvider: React.FC<ReactCookieProps>;

    Functions

    function useCookies

    useCookies: <T extends string, U = { [K in T]?: any }>(
    dependencies?: T[],
    options?: CookieGetOptions
    ) => [
    U,
    (name: T, value: Cookie, options?: CookieSetOptions) => void,
    (name: T, options?: CookieSetOptions) => void,
    () => void
    ];

      function withCookies

      withCookies: <T extends ReactCookieProps>(
      WrappedComponent: React.ComponentType<T>
      ) => React.ComponentType<Omit<T, keyof ReactCookieProps>>;

        Type Aliases

        type ReactCookieProps

        type ReactCookieProps = {
        cookies?: Cookies;
        defaultSetOptions?: CookieSetOptions;
        allCookies?: {
        [name: string]: Cookie;
        };
        children?: any;
        ref?: React.RefObject<{}>;
        };

          Package Files (5)

          Dependencies (3)

          Dev Dependencies (6)

          Peer Dependencies (1)

          Badge

          To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

          You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/react-cookie.

          • Markdown
            [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/react-cookie)
          • HTML
            <a href="https://www.jsdocs.io/package/react-cookie"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>