Added 'async' optional param to 'regClientScript' and 'regClientStartupScript' #14527
Conversation
…ientStartupScript'
|
Need to update UnitTests for this PR |
| * @return void | ||
| */ | ||
| public function regClientStartupScript($src, $plaintext= false) { | ||
| public function regClientStartupScript($src, $plaintext= false, $async='') { |
There was a problem hiding this comment.
Only two params allowed - async and defer, so we should add check if passed param is correct or just make it possible to turn it into a boolean parameter.
There was a problem hiding this comment.
fixed. now params checks correct values
There was a problem hiding this comment.
We should add an attributes parameter. The script tag can also have other attributes like id.
There was a problem hiding this comment.
There are also other methods available (e.g. regClientHTML) so I don't think we need an option for every possibility here.
There was a problem hiding this comment.
I was thinking about something like this:
public function regClientStartupScript($src, $plaintext= false, $attributes = [])
$attributes = ['async', 'defer', 'id' => ['test'], 'etc'];
There was a problem hiding this comment.
but for what? i opened w3 specs for 'script' tag:
we see:
There was a problem hiding this comment.
You are referring to W3 schools. Not the w3 specs.
See this list of supported attributes.
This also includes all global attributes.
|
This just needs the tests to be updated to get my approval. |
Mark-H
added
the
blocked
|
@DettRoxx if you need any help fixing the test please let us know 👍 |
|
Closing due to lack of interaction - if someone wants to pitch in to get this up to speed again that'd be awesome. |
What does it do?
Added optional param 'async' for methods regClientScript and regClientStartupScript of modx object, which allows to get
<script type="text/javascript" src="/assets/js/script.js" async></script>or
<script type="text/javascript" src="/assets/js/script.js" defer></script>instead of
<script type="text/javascript" src="/assets/js/script.js"></script>Why is it needed?
to avoid "blocking-like" synchronous behaviour when browser builds DOM and stops and execute scripts tags, allows to use asynchronous behaviour instead
Related issue(s)/PR(s)
#14520