Installation

Before you start, make sure you have StimulusBundle configured in your app. Then install the bundle using Composer and Symfony Flex:

1

$ composer require symfony/ux-react

The Flex recipe will automatically set things up for you, like adding .enableReactPreset() to your webpack.config.js file and adding code to load your React components inside assets/app.js.

Next, install a package to help React:

1
2
3
4
5
6

$ npm install -D @babel/preset-react --force
$ npm run watch

# or use yarn
$ yarn add @babel/preset-react --dev --force
$ yarn watch

That's it! Any files inside assets/react/controllers/ can now be rendered as React components.

Usage

The Flex recipe will have already added the registerReactControllerComponents() code to your assets/app.js file:

1
2
3
4

// assets/app.js
import { registerReactControllerComponents } from '@symfony/ux-react';

registerReactControllerComponents(require.context('./react/controllers', true, /\.(j|t)sx?$/));

This will load all React components located in the assets/react/controllers directory. These are known as React controller components: top-level components that are meant to be rendered from Twig.

You can render any React controller component in Twig using the react_component().

For example:

1
2
3
4
5
6

// assets/react/controllers/Hello.jsx
import React from 'react';

export default function (props) {
    return <div>Hello {props.fullName}</div>;
}

1
2
3
4
5
6
7
8
9
10
11

{# templates/home.html.twig #}
{% extends 'base.html.twig' %}

{% block body %}
    <div {{ react_component('Hello', { 'fullName': number }) }}>
        Loading... <i class="fas fa-cog fa-spin fa-3x"></i>
    </div>

    {# Component living in a subdirectory: "assets/react/controllers/Admin/OtherComponent" #}
    <div {{ react_component('Admin/OtherComponent') }}></div>
{% endblock %}

Using with AssetMapper

Because the JSX format isn't pure JavaScript, using this library with AssetMapper requires some extra steps.

1. Compile your .jsx files to pure JavaScript files. This can be done by installing Babel and the @babel/preset-react preset. Example: https://github.com/symfony/ux/blob/2.x/ux.symfony.com/package.json
2. Point this library at the "built" controllers directory that contains the final JavaScript files:

1
2
3

# config/packages/react.yaml
react:
    controllers_path: '%kernel.project_dir%/assets/build/react/controllers'

Also, inside of your .jsx files, when importing another component, use the .js extension:

1
2

// use PackageList.js even though the file is named PackageList.jsx
import PackageList from '../components/PackageList.js';

Backward Compatibility promise

This bundle aims at following the same Backward Compatibility promise as the Symfony framework: https://symfony.com/doc/current/contributing/code/bc.html