Étape 22: Styliser l’interface avec Webpack

5.0 version
Maintained

Styliser l’interface avec Webpack

Nous n’avons pas encore travaillé sur la conception de l’interface. Pour styliser comme un pro, nous utiliserons une stack moderne, basée sur Webpack. Et pour ajouter une touche de Symfony et faciliter son intégration avec l’application, installons Webpack Encore :

1
$ symfony composer req encore

Un environnement Webpack complet a été créé pour vous : les fichiers package.json et webpack.config.js ont été générés avec une bonne configuration par défaut. Ouvrez webpack.config.js, il utilise l’abstraction Encore pour configurer Webpack.

Le fichier package.json définit des commandes très pratiques que nous utiliserons sans arrêt.

Le répertoire assets contient les principaux points d’entrée des assets du projet : css/app.css et js/app.js.

Utiliser Sass

Au lieu de se contenter simplement de CSS, nous utiliserons Sass :

1
$ mv assets/css/app.css assets/css/app.scss
patch_file
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
--- a/assets/js/app.js
+++ b/assets/js/app.js
@@ -6,7 +6,7 @@
  */

 // any CSS you import will output into a single css file (app.css in this case)
-import '../css/app.css';
+import '../css/app.scss';

 // Need jQuery? Install it with "yarn add jquery", then uncomment to import it.
 // import $ from 'jquery';

Installez le loader Sass :

1
$ yarn add node-sass "[email protected]^7.0.1" --dev

Et activez-le dans webpack :

patch_file
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
--- a/webpack.config.js
+++ b/webpack.config.js
@@ -54,7 +54,7 @@ Encore
     })

     // enables Sass/SCSS support
-    //.enableSassLoader()
+    .enableSassLoader()

     // uncomment if you use TypeScript
     //.enableTypeScriptLoader()

Comment savoir quels paquets installer ? Si nous avions essayé de générer nos assets sans ceux-ci, Encore nous aurait donné un joli message d’erreur suggérant la commande yarn add à exécuter pour installer les dépendances servant à charger les fichiers .scss.

Tirer parti de Bootstrap

Pour commencer avec de bonnes bases et construire un site web responsive, un framework CSS comme Bootstrap sera très utile. Installez-le comme paquet :

1
$ yarn add bootstrap jquery popper.js bs-custom-file-input --dev

Ajoutez Bootstrap dans le fichier CSS (nous avons aussi nettoyé le fichier) :

patch_file
1
2
3
4
5
6
7
--- a/assets/css/app.scss
+++ b/assets/css/app.scss
@@ -1,3 +1 @@
-body {
-    background-color: lightgray;
-}
[email protected] '~bootstrap/scss/bootstrap';

Faites de même pour le fichier JS :

patch_file
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
--- a/assets/js/app.js
+++ b/assets/js/app.js
@@ -7,8 +7,7 @@

 // any CSS you import will output into a single css file (app.css in this case)
 import '../css/app.scss';
+import 'bootstrap';
+import bsCustomFileInput from 'bs-custom-file-input';

-// Need jQuery? Install it with "yarn add jquery", then uncomment to import it.
-// import $ from 'jquery';
-
-console.log('Hello Webpack Encore! Edit me in assets/js/app.js');
+bsCustomFileInput.init();

Le système de formulaire de Symfony supporte Bootstrap nativement avec un thème spécial. Activez-le :

config/packages/twig.yaml
1
2
twig:
    form_themes: ['bootstrap_4_layout.html.twig']

Styliser le HTML

Nous pouvons maintenant styliser l’application. Téléchargez et extrayez l’archive à la racine du projet :

1
2
3
$ php -r "copy('https://symfony.com/uploads/assets/guestbook.zip', 'guestbook.zip');"
$ unzip -o guestbook.zip
$ rm guestbook.zip

Jetez un coup d’œil aux templates, vous pourriez apprendre un truc ou deux sur Twig.

Générer les assets

Il y a une différence majeure quand on utilise Webpack : les fichiers CSS et JS ne sont pas utilisables directement par l’application. Ils doivent d’abord être « compilés ».

En développement, la compilation des ressources peut se faire avec la commande encore dev :

1
$ symfony run yarn encore dev

Au lieu d’exécuter la commande chaque fois qu’il y a une modification, exécutez-la en arrière-plan et laissez-la surveiller les changements des fichiers JS et CSS :

1
$ symfony run -d yarn encore dev --watch

Prenez le temps de découvrir les modifications visuelles. Jetez un coup d’œil au nouveau design dans un navigateur.

Étant donné que le Maker Bundle utilise les classes CSS de Bootstrap par défaut, le formulaire de connexion précédemment généré est maintenant automatiquement stylisé :

En production, SymfonyCloud détecte automatiquement que vous utilisez Encore et compile les ressources pour vous pendant la phase de build.


  • « Previous Étape 21: Mettre en cache pour la performance
  • Next » Étape 23: Redimensionner des images

This work, including the code samples, is licensed under a Creative Commons BY-NC-SA 4.0 license.