to select ↑↓ to navigate
Developer References

Developer References

Open in ChatGPT
Ask ChatGPT about this page
Open in Claude
Ask Claude about this page

List

frappe.breadcrumbs.add(breadcrumbs)

frappe.listview_settings["Yummy"] = {
    onload() {
        // Changing list breadcrumbs
        frappe.breadcrumbs.add("Yummy Page");
    },
};

Custom Button

listview.page.add_inner_button(label, function)

frappe.listview_settings["DocType"] = {
    refresh: function(listview) {      
        listview.page.add_inner_button("Label", function() {
            do_something(listview);
        });
    }
}

Dialog

Fields

{
    label: __("Foo Bar"),
    fieldname: "foo_bar",
    fieldtype: "Link",
    options: "DocType" // if fieldtype == "Link"
    options: ["All Foo", "All Bar"] // if fieldtype == "Select"
    options: [
        {value: 1, label: __("One")}
    ],
    description: "Description for the field",
    default: "Some Value" or 1,
    depends_on: "other_fieldname",
    reqd: 1,
    hidden: 1
}

Get Selected Transaction

listview.get_checked_items()

frappe.listview_settings["Yummy"] = {
    onload() {
        listview.page.add_action_item('Show Checked Items', () => {
            let selected = listview.get_checked_items();
            console.log(selected);
        });
    },
};
Last updated 2 months ago
Was this helpful?
Thanks!