Frappe Framework
Utilitaires communs
Cinq fonctions du bureau lisent la route, la changent, formatent une valeur, préparent un espace de noms et chargent un asset.
Route courante
frappe.get_route() renvoie la route courante sous forme de tableau. L’exemple ["List", "Task", "List"] correspond à la vue liste des tâches.
Changer de route
frappe.set_route(route) remplace la route courante. La source montre quatre formes :
- des segments :
frappe.set_route("List", "Task", "List"); - un tableau :
frappe.set_route(["List", "Task", "Gantt"]); - une chaîne :
frappe.set_route("List/Event/Calendar"); - un tableau plus des options :
frappe.set_route(["List", "Task", "Task"], { status: "Open" }).
Formater une valeur
frappe.format(value, df, options, doc) présente une valeur brute. Une date 2019-09-08 avec fieldtype: "Date" devient "09-08-2019". Un montant 2399 de type Currency, avec options: "currency" et { inline: true }, devient "2,399.00".
Espace de noms
frappe.provide(namespace) crée sur window l’espace de noms s’il n’existe pas. frappe.provide("frappe.ui.form") équivaut à créer window.frappe.ui.form.
Charger un asset
frappe.require(asset_path, callback) charge un JS ou un CSS de façon asynchrone, pour une bibliothèque peu utilisée. Un chemin unique ou un tableau de chemins sont acceptés. Le rappel part quand les fichiers sont chargés. L’exemple utilise /assets/frappe/chat.js et chat.css.
Point d’attention
Ces méthodes vivent dans le bureau (Desk). frappe.format prend la définition de champ en deuxième argument : la source ne détaille pas doc, le quatrième paramètre.