Visites guidées de formulaire (Form Tours)

Une visite guidée explique un formulaire en quelques étapes. On la crée depuis l’AwesomeBar, puis on la démarre avec frm.tour.start.

2 min de lectureMis à jour le 5 octobre 2026Source : docs.frappe.io

À quoi sert une visite

Frappe génère des tutoriels de formulaire pour un DocType complexe, avec peu de configuration.

Créer la visite

Dans l’AwesomeBar, saisissez « new form tour ».

Titre, par exemple « Creating a Custom Field ».
DocType de référence.
Étapes qui décrivent chaque champ.
Enregistrez.

Options du tour

Option	Effet
Is Standard	Tour standard stocké en JSON. Réglable seulement en mode développeur.
Save on Completion	La dernière étape propose d’enregistrer le document.
Show First Document Tour	Visite du premier document déjà créé, au lieu d’un nouveau formulaire.
Include Name Field	Si l’utilisateur fixe le nom, ce champ devient la première étape.

Options d’une étape

Option	Effet
Field	Champ mis en évidence, avec titre et description
Title et Description	Usage, effet et ressorts du champ
Position	Place de l’infobulle selon l’emplacement du champ
Next Condition	Condition JavaScript sur le document. Exemple pour une tâche : `eval: doc.priority != ""`
Is Table Field	Le champ est dans une table enfant
Parent Field	Champ table du DocType. Visible seulement si Is Table Field est coché.

Déclencher

Initialisez le tour avec tour_name, puis appelez frm.tour.start() :

javascript

frappe.ui.form.on("Your DocType", {
  onload: function (frm) {
    const tour_name = "Your Form Tour Name";
    frm.tour.init({ tour_name }).then(() => frm.tour.start());
  },
});

Point d’attention

Next Condition doit être une condition JavaScript valide sur le document. Sans Is Standard, et hors mode développeur, le tour n’est pas exporté en JSON. Show First Document Tour vise le tout premier document du DocType, pas le document ouvert.