API Page

Créer

Chaque écran du bureau est un objet frappe.ui.Page. frappe.ui.make_app_page en crée une et l’attache au parent. L’exemple passe title (« My Page »), parent (élément DOM ou objet jQuery) et single_column: true pour une page sans barre latérale. Dans le snippet publié, il n’y a pas de virgule entre parent et single_column. Une page Vue s’appuie sur le même appel : Utiliser Vue dans une page du bureau.

Titre et indicateur

set_title fixe le titre de la page et celui de l’onglet du navigateur. set_title_sub pose un sous-titre à droite de l’en-tête. set_indicator(libellé, couleur) affiche un indicateur, par exemple Pending en orange. clear_indicator l’enlève.

Actions

set_primary_action(libellé, handler, icône) pose le bouton principal. Le troisième argument est la classe d’icône vue sur mobile. L’exemple renvoie $btn, libellé New, icône octicon octicon-plus. clear_primary_action retire bouton et handler. set_secondary_action et clear_secondary_action font de même. L’exemple secondaire est Refresh, icône octicon octicon-sync.

add_menu_item(libellé, handler) ajoute une entrée au menu Menu. Un troisième argument true en fait une entrée standard. clear_menu retire le menu. add_action_item alimente le menu Actions. L’exemple est Delete. clear_actions_menu retire ce menu.

Barre interne

add_inner_button(libellé, handler) ajoute un bouton. Un troisième argument, par exemple 'Make', le range dans un groupe déroulant. Le titre publié change_custom*button*type correspond au code change_inner_button_type(libellé, groupe, type). Sans groupe, le deuxième argument est null. Les exemples passent le type primary ou danger. remove_inner_button(libellé) ou avec le groupe retire un bouton. clear_inner_toolbar vide la barre.

Champs

add_field pose un contrôle dans la barre de formulaire. L’exemple est un Select Status, options Open, Closed, Cancelled, dont change affiche field.get_value(). get_form_values renvoie un objet, par exemple { status: 'Open', priority: 'Low' }. clear_fields retire tous les champs de cette barre.

Point d’attention

Menu et Actions se vident par deux méthodes distinctes. Retirer un bouton de groupe demande le libellé et le nom du groupe, comme à la création.