Documentation Frappe Framework

Frappe Framework

Liste

Pas de liste pour une table enfant ni un Single. Le fichier {doctype}_list.js ou un Client Script règle l’affichage.

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

Rôle

La vue liste existe pour tous les DocTypes, sauf les tables enfants et les Single. Elle filtre, trie, pagine, filtre par étiquettes, et bascule vers Report, Calendar, Gantt ou Kanban.

Fichier standard

Le fichier {doctype}_list.js dans le dossier du DocType alimente frappe.listview_settings. Pour Note, c’est note_list.js.

CléRôle dans l’exemple
add_fieldsChamps à charger, title et public
filtersFiltre par défaut, public égal à 1
hide_name_columnCache la colonne du nom
hide_name_filterCache le filtre de cette colonne
onloadUne fois, avant le chargement
before_renderAvant chaque rendu des lignes
has_indicator_for_draftSi vrai, l’indicateur s’applique aussi aux brouillons. Faux dans l’exemple.
get_indicatorCouple libellé, couleur et filtre. Public en vert, Private en darkgrey.
primary_actionClic sur l’action principale
get_form_linkRemplace la route du formulaire
buttonBouton de ligne : show, get_label, get_description, action
formattersAffichage d’un champ. title en gras, public en Yes ou No.

Le bouton de Note n’apparaît que si reference_name est rempli. Son action ouvre Form du type et du nom référencés.

Client Script

Pour une logique propre au site : Home, Customization, Client Script, New. Pour partager la liste entre sites, il faut une application.

Plusieurs boutons

Sur la version develop seulement, dropdown_button ajoute un menu sur la ligne. L’exemple ToDo cache la colonne du nom, charge reference_type et reference_name, garde un bouton Open, et un menu Dropdown à trois entrées. Button 2 est masqué si le statut est Closed, Button 3 s’il est Cancelled. Chaque action appelle frappe.msgprint.

Point d’attention

dropdown_button n’est pas décrit pour une version publiée autre que develop. get_indicator renvoie aussi le filtre, troisième élément, pas seulement la couleur.

Vue liste JavaScript de Frappe | ERPNext Lab