Documentation Frappe Framework

Frappe Framework

Action personnalisée dans un champ Link

On ajoute une option au champ Lien standard en affectant une fonction à ControlLink.link_options.

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

Une option supplémentaire se greffe sur le champ Lien (Link) standard en définissant une fonction dans l’espace de noms frappe.ui.form.ControlLink.link_options. Cette fonction reçoit l’objet du champ Lien.

Mise en place

La fonction renvoie une liste d’options. Chaque option de l’exemple porte :

CléRôle dans l’exemple
htmlFragment affiché. Le texte publié concatène le libellé traduit « Custom Link Option ».
labelLibellé traduit, le même texte.
valuecustom__link_option
actionFonction appelée au choix de l’option. L’exemple la laisse vide.
javascript
frappe.ui.form.ControlLink.link_options = function (link) {
  return [
    {
      html: __("Custom Link Option"),
      label: __("Custom Link Option"),
      value: "custom__link_option",
      action: () => {},
    },
  ];
};

Dès qu’une fonction est affectée à frappe.ui.form.ControlLink.link_options, le champ Lien propose cette nouvelle option.

Point d’attention

L’affectation remplace le contenu de link_options. L’exemple ne montre pas comment empiler cette option avec celles qui existent déjà. Le HTML publié par la source est incomplet : les balises ont été retirées du texte, il ne reste que le libellé.