Integrating React into Atomic Frontend

Edit on GitHub

This guide aims to illustrate how to integrate React within Spryker frontend.

Setup

  1. Install React, ReactDOM, and relative types. Add required dependencies to the project by running the following command from the root folder:

    npm install react react-dom @types/react @types/react-dom --save
    
`./package.json` is updated as follows:
"dependencies": {
  ...
  "@types/react": "~16.7.18",
  "@types/react-dom": "~16.0.11",
  "react": "~16.7.0",
  "react-dom": "~16.7.0"
  ...
}
  1. Update webpack configuration. React relies on .jsx (or .tsx) files. As they must be specifically transpiled into Javascript, you need to tell Webpack to read them. Add the following to ./frontend/configs/development.js:
resolve: {
  extensions: ['.ts', '.tsx', '.js', '.jsx', '.json', '.css', '.scss'], // add .jsx and tsx here
  ...
},

module: {
  rules: [
    {
      test: /\.tsx?$/, // change from /\.ts$/ to /\.tsx?$/
      loader: 'ts-loader',
      ...
    }
  },
  ...
}
  1. Add the following into ./tsconfig.json to make Typescript transpile React:
{
  "compilerOptions": {
    ...
    "jsx": "react",
    ...
  }
}
  1. Add the following lines to ./src/Pyz/Yves/ShopUi/Theme/default/vendor.ts to make sure that React is included into the final output:
import 'react';
import 'react-dom';

By doing this, Webpack will know to place React source code inside the vendor chunk and require it from there whenever needed.

Usage

  1. Create your first React component. a. Create the example folder ./src/Pyz/Yves/ShopUi/Theme/default/components/molecules/react-component. b. In this folder, create 2 files:

    • index.ts - will be used as the component entry point, automatically globbed by the application and injected into the DOM;
    import(/* webpackMode: "lazy" */'./react-component');
    
    • react-component.tsx - contains the component implementation.
import * as React from 'react';
import { render } from 'react-dom';

export const ReactComponent = () => <h1>Hello from React!</h1>;

document
  .querySelectorAll('.react-component')
  .forEach(element => render(<ReactComponent />, element));

  1. Run the command from the project root folder to rebuild frontend, including React and every new created component:
npm run yves
  1. To use the component, add an html element with the class name .react-component anywhere in your twig files to see the React component <div class="react-component"></div>.