Skip to content

Latest commit

 

History

History
139 lines (101 loc) · 5.65 KB

frontend.rst

File metadata and controls

139 lines (101 loc) · 5.65 KB
Raw

Front-end Tools: Handling CSS & JavaScript

Symfony gives you the flexibility to choose any front-end tools you want. There are generally two approaches:

  1. building your HTML with PHP & Twig <frontend-twig-php>;
  2. building your frontend with a JavaScript framework <frontend-js> like React, Vue, Svelte, etc.

Both work great - and are discussed below.

Using PHP & Twig

Symfony comes with two powerful options to help you build a modern and fast frontend:

  • AssetMapper <frontend-asset-mapper> (recommended for new projects) runs entirely in PHP, doesn't require any build step and leverages modern web standards.
  • Webpack Encore <frontend-webpack-encore> is built with Node.js on top of Webpack.
AssetMapper Encore
Production Ready? yes yes
Stable? yes yes
Requirements none Node.js
Requires a build step? no yes
Works in all browsers? yes yes
Supports Stimulus/UX yes yes
Supports Sass/Tailwind yes <asset-mapper-tailwind> yes
Supports React, Vue, Svelte? yes [1] <ux-note-1> yes
Supports TypeScript yes <asset-mapper-ts> yes
Removes comments from JavaScript no yes
Removes comments from CSS no no
Versioned assets always optional
Can update 3rd party packages yes no [2] <ux-note-2>

[1] Using JSX (React), Vue, etc with AssetMapper is possible, but you'll need to use their native tools for pre-compilation. Also, some features (like Vue single-file components) cannot be compiled down to pure JavaScript that can be executed by a browser.

[2] If you use npm, there are update checkers available (e.g. npm-check).

AssetMapper (Recommended)

AssetMapper is the recommended system for handling your assets. It runs entirely in PHP with no complex build step or dependencies. It does this by leveraging the importmap feature of your browser, which is available in all browsers thanks to a polyfill.

Read the AssetMapper Documentation </frontend/asset_mapper>

Webpack Encore

Do you prefer video tutorials? Check out the Webpack Encore screencast series.

Webpack Encore is a simpler way to integrate Webpack into your application. It wraps Webpack, giving you a clean & powerful API for bundling JavaScript modules, pre-processing CSS & JS and compiling and minifying assets.

Read the Encore Documentation </frontend/encore/index>

Switch from AssetMapper

By default, new Symfony webapp projects (created with symfony new --webapp myapp) use AssetMapper. If you still need to use Webpack Encore, use the following steps to switch. This is best done on a new project and provides the same features (Turbo/Stimulus) as the default webapp.

# Remove AssetMapper & Turbo/Stimulus temporarily
$ composer remove symfony/ux-turbo symfony/asset-mapper symfony/stimulus-bundle

# Add Webpack Encore & Turbo/Stimulus back
$ composer require symfony/webpack-encore-bundle symfony/ux-turbo symfony/stimulus-bundle

# Install & Build Assets
$ npm install
$ npm run dev

Stimulus & Symfony UX Components

Once you've installed AssetMapper or Webpack Encore, it's time to start building your front-end. You can write your JavaScript however you want, but we recommend using Stimulus, Turbo and a set of tools called Symfony UX.

To learn about Stimulus & the UX Components, see the StimulusBundle Documentation

Using a Front-end Framework (React, Vue, Svelte, etc)

If you want to use a front-end framework (Next.js, React, Vue, Svelte, etc), we recommend using their native tools and using Symfony as a pure API. A wonderful tool to do that is API Platform. Their standard distribution comes with a Symfony-powered API backend, frontend scaffolding in Next.js (other frameworks are also supported) and a React admin interface. It comes fully Dockerized and even contains a web server.

Other Front-End Articles

  • /frontend/create_ux_bundle
  • /frontend/custom_version_strategy
  • /frontend/server-data