Add Custom Script to all DocTypes

Frappe Framework Customization
1

Hi here,
I usually add my js client logic using a custom script for a single DocType. How I can add a custom script to ALL DocTypes? In other words: can I add a global script to an ERPNext application?
Thank you.

2

Yes, you can.
Add and build a js script with below codes in public js folder of your application :

$(document).on('app_ready', function() {
	$.each(["Opportunity", "Quotation", "Supplier Quotation", 
		"Sales Invoice", "Delivery Note",  "Sales Order",
		"Purchase Invoice", "Purchase Receipt", "Purchase Order"], function(i, doctype) {
		frappe.ui.form.on(doctype, "setup", function(frm) {
			// code for setup event
		});
		frappe.ui.form.on(doctype, "refresh", function(frm) {
                     // code for refresh event
		});
	});
});
6 Likes
3

Hi @sanjay thank you for your answer.
Iā€™ve a production site with the following tree:

\ sites
\ sites \ assets
\ sites \ assets \ js
\ sites \ mysite
\ sites \ mysite \ public
\ sites \ mysite \ public \ files

I think to put your code inside a file into \ sites \ assets \ js directory, but I can see the index.html file to add this new script to load.
Thank you for your support.

4

If you have a custom application then you can add a custom js file in custom_app/public/js folder to avoid making changes in core code.

add build.json file with below code:
ā€œjs/myapp.min.jsā€: [
ā€œpublic/js/myapp.jsā€,
]

in your custom application hook file add below code:
app_include_js = ā€œ/assets/js/myapp.min.jsā€

2 Likes
5

Thanks!

6

This is exactly what I want but how do I do it in the Cloud version? Any Custom Script needs to be assigned to a DocType, so how do I get it to run globally on every page?

7

It is not available in the cloud version (erpnext.com)

8

Well, darn.

9

Which app directory do you put your build.json file in?

10

@adam26d
frappe-bench/apps/my-app/my-app/public
For example:

The strategy is different for V14, because of the new build system. Migrating to Version 14 Ā· frappe/frappe Wiki Ā· GitHub

Example: check_run/check_run.bundle.js at version-14 Ā· agritheory/check_run Ā· GitHub

1 Like
11

Hello, this is for the form view. So is there any script for list view, applying it on all the list view of all the doctypes?

12

Thank you for the guidance Tyler.

I got it to work on v14