Premiers pas
Prérequis
Section intitulée « Prérequis »Connaître TypeScript, le CSS (ou SCSS) et un peu le HTML vous aidera, mais ce n’est pas indispensable pour commencer.
Si vous ne les connaissez pas encore, un assistant IA fait très bien l’affaire : x4js lui fournit de quoi écrire du code juste, et vous apprenez en lisant ce qu’il produit. Voir Travailler avec un assistant IA.
Outils :
- Node.js 24 ou plus récent est recommandé.
- Un éditeur qui comprend TypeScript, par exemple VS Code.
- Pour une application de bureau : rien de plus avec le modèle
electron; Go et la commande Wails avec le modèlewails. La même application tourne aussi dans le navigateur.
Il n’y a rien d’autre à installer : la ligne de commande x4js fait partie du paquet. Elle gère la création, la construction et le rechargement à chaud de vos projets.
Créer un projet
Section intitulée « Créer un projet »npx x4js create my-appLa commande crée le dossier my-app à partir d’un modèle et installe ses dépendances (--no-install pour ne pas les installer). Cinq modèles existent :
| Modèle | Contenu |
|---|---|
app |
Application x4js standard. C’est le modèle par défaut. |
minimal |
Application x4js minimale. |
hosted |
Application x4js prête pour Vercel, Netlify ou Cloudflare Pages. Voir Mettre en ligne. |
electron |
Application de bureau, dans une fenêtre Electron. |
wails |
Application de bureau avec Wails : le côté système est écrit en Go, le résultat est un seul exécutable. |
Pour en choisir un : npx x4js create my-app --template minimal. La liste à jour s’obtient avec npx x4js templates.
Les modèles electron et wails ont leur propre organisation et leurs propres commandes : leur README.md les décrit. La suite de cette page suit le modèle app.
Lancer le projet
Section intitulée « Lancer le projet »cd my-appnpm run devLe projet est construit, puis servi en local. L’adresse s’affiche dans le terminal :
x4js 2.3.29mode devconfig C:\work\my-app\x4.config.jsonoutdir C:\work\my-app\binserver http://127.0.0.1:9000Les modèles choisissent le port 9000 (dev.port dans x4.config.json). Sans ce réglage, x4js prend le premier port libre à partir de 8000.
La page se recharge à chaque modification d’un fichier source. Un changement qui ne touche que le CSS est appliqué sans rechargement.
Ce que contient un projet
Section intitulée « Ce que contient un projet »| Fichier | Rôle |
|---|---|
package.json |
Dépendance à x4js et scripts dev et build. |
x4.config.json |
Fichiers d’entrée, dossier de sortie, fichiers à copier, port du serveur de développement. |
tsconfig.json |
Réglages TypeScript. |
public/index.html |
La page, qui charge main.js et main.css. Le dossier public est copié tel quel dans la sortie. |
src/main.ts |
Le point d’entrée de l’application. |
src/main.scss |
Les styles de l’application. |
src/icons.ts, src/assets/ |
Les icônes SVG de l’application (pas dans le modèle minimal). |
src/global.d.ts |
Le type des fichiers .svg importés. |
Une première interface
Section intitulée « Une première interface »Tout part de src/main.ts. Voici une application complète : un libellé et un bouton qui le modifie.
import { Application, Button, Label, VBox } from 'x4js';
import "./main.scss";
class App extends Application { constructor( ) { super( );
const status = new Label( { text: "Ready" } );
this.setMainView( new VBox( { content: [ status, new Button( { label: "Run", click: ( ) => status.setText( "Done" ) } ), ] } ) ); }}
new App( );L’application dérive de Application et installe sa vue principale une seule fois, dans son constructeur.
Enregistrez le fichier : la page se met à jour toute seule.
Construire pour la production
Section intitulée « Construire pour la production »npm run buildLe résultat est écrit dans le dossier bin, minifié et sans cartes de source. Ce dossier est vidé avant chaque construction : n’y gardez aucun fichier écrit à la main.
Mettre en ligne
Section intitulée « Mettre en ligne »Une application x4js construite est un site statique : n’importe quel hébergeur peut servir le dossier bin.
Le modèle hosted est le modèle app avec, en plus, la configuration pour Vercel et Netlify. La page Mettre en ligne détaille la publication sur Vercel, Netlify, Cloudflare Pages ou un autre hébergeur.
Pour aller plus loin
Section intitulée « Pour aller plus loin »- Mettre en ligne : publier l’application chez un hébergeur.
- Design d’interfaces : découper un écran en conteneurs.
- Composants et événements : écrire ses propres vues.
- Ligne de commande : toutes les options de
x4jset les clés dex4.config.json(en anglais). - Référence de l’API.