Documentation Frappe Framework

Frappe Framework

Formateur pour les champs Link

Un formateur de champ Lien affiche l’identifiant et le libellé, quand les deux figurent sur le document.

1 min de lectureMis à jour le Source : docs.frappe.io

À quoi sert le formateur

Quand une fiche garde à la fois un code et un nom, par exemple un code employé et un nom d’employé (Employee), un champ Lien (Link) peut montrer les deux. On enregistre pour cela un formateur dans frappe.form.link_formatters.

Exemple

javascript
frappe.form.link_formatters["Employee"] = function (value, doc) {
  if (doc.employee_name && doc.employee_name !== value) {
    return value + ": " + doc.employee_name;
  } else {
    return value;
  }
};

Si employee_name est présent et différent de la valeur du lien, l’affichage devient code : nom. Sinon, seule la valeur du lien est renvoyée.

Points d’attention

  1. La clé primaire (name) et le nom descriptif (ici employee_name) doivent être présents sur le document. Le champ descriptif peut être masqué.
  2. Le formateur doit être chargé avant le document. Il peut être réutilisé sur tous les formulaires. On peut aussi l’ajouter dans build.json.