Allow external javascript in the detailed view

[dominicchinkh]

Allow external javascript in the detailed view

Description

Allow including external javascript in the detailed view by adding viewdefs[]['DetailView']['templateMeta']['javascript'] configuration, such as
"""
'javascript' => '{sugar_getscript file="custom/modules/Opportunities/views/test.js"}',
"""

Motivation and Context

This allows customizing the detailed view using a javascript. This is consistent with how we currently customizing the edit view with a javascript.

How To Test This

Add a configuration as described in the Description session. Add a javascript such as
"""
$( document ).ready(function() {
console.log("Hello Dominic!");
});
"""
as custom/modules/Opportunities/views/test.js. Go to Opportunities detailed view

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)

Final checklist

• My code follows the code style of this project found here.
• My change requires a change to the documentation.
• I have read the How to Contribute guidelines.

[codecov-commenter]

Codecov Report

Merging #8430 into hotfix-7.10.x will not change coverage.
The diff coverage is n/a.

@@              Coverage Diff               @@
##           hotfix-7.10.x    #8430   +/-   ##
==============================================
  Coverage          10.69%   10.69%           
==============================================
  Files               3230     3230           
  Lines             241063   241063           
==============================================
  Hits               25792    25792           
  Misses            215271   215271           

[pgorod]

Doesn't it work to add an templateMeta\includes section to the viewdefs? I know that works for ListView. but maybe not for DetailView.

Even so, it might be better to emulate that same mechanism, instead of creating a new one...

Example:

custom/modules/Accounts/metadata/listviewdefs.php

<?php
// include all the $listViewDefs[$module] field and search definitions from parent:
require_once 'modules/Accounts/metadata/listviewdefs.php';

$viewdefs[$module]['ListView'] = [
    'templateMeta' => [
        'form' => [
            'actions' => [
                [
                    'customCode' => '<a onclick="bulkActionRunWorkflows()" title="Do it!">Do it!</a>'
                ],
            ],
        ],
        'includes' => [
            [
                'file' => 'custom/pgr/js/DoThingsFromViews.js',
            ],
        ],
    ]
];

See https://github.com/salesagility/SuiteCRM/blob/master/include/ListView/ListViewSmarty.php#L167
and https://github.com/salesagility/SuiteCRM/blob/master/themes/SuiteP/include/ListView/ListViewGeneric.tpl#L41

[dominicchinkh]

Hi @pgorod, this change applies to all DetailView. It is in consistent with how EditView allow external JS file

See https://github.com/salesagility/SuiteCRM/blob/master/include/EditView/footer.tpl#L88

[SuiteBot]

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ dominicchinkh
❌ Dominic Chin

---

Dominic Chin seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}