@shopify/react-csrf
TypeScript icon, indicating that this package has built-in type declarations

3.1.0 • Public • Published

@shopify/react-csrf

Build Status Build Status License: MIT npm version npm bundle size (minified + gzip)

Share CSRF tokens throughout a React application.

Installation

yarn add @shopify/react-csrf

Usage

Setup the Provider around all of the application that need to access csrf token.

// App.tsx
import * as React from 'react';
import {CsrfTokenContext} from '@shopify/react-csrf';

function App({token}: {token?: string}) {
  return (
    <CsrfTokenContext.Provider value={token}>
      {/* rest of the app */}
    </CsrfTokenContext.Provider>
  );
}

Access csrf token using useCsrfToken hook:

import React from 'react';
import {useCsrfToken} from '@shopify/react-csrf';

export default function MyToken() {
  const csrfToken = useCsrfToken();
  return <p>My CSRF Token is: {csrfToken}</p>;
}

Dependencies (0)

    Dev Dependencies (1)

    Package Sidebar

    Install

    npm i @shopify/react-csrf

    Weekly Downloads

    1,275

    Version

    3.1.0

    License

    MIT

    Unpacked Size

    5.49 kB

    Total Files

    20

    Last publish

    Collaborators

    • jaykay101
    • mishsmelle
    • shopify-dep
    • jaimie.rockburn
    • shopify-admin
    • maryharte
    • pmoloney89
    • netlohan