Note:

If you want to create a new page for developers, you should create it on the Moodle Developer Resource site.

Javascript FAQ: Difference between revisions

From MoodleDocs
(Remove notes about yui_module() as the information isn't really relevant here.)
(This is not the place to learn what JS is.)
 
(28 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{obsolete}}
== What is JavaScript? ==
== What is JavaScript? ==


JavaScript is a scripting language widely used for client-side web development. It is also known by a number of other names including ECMAScript, and JScript (these are all the same thing but exist due to issues over the licensing of these names).
JavaScript is a scripting language widely used for client-side web development. It is also known as ECMAScript and has been progressively improved over the years.


If you have a spare 27 minutes and would like a quick background on JavaScript and it's origins, see this video from Douglas Crockford '[http://www.youtube.com/watch?v=gz7KL7ZirZc JSeverywhere: Douglas Crockford - JavaScript, The World's Most Misunderstood Language]'.
Since Moodle 3.8 we recommend the use of Native JavaScript rather than through a library such as jQuery or YUI, and require that all new JavaScript be written in the style of ES 2015 modules. These should be placed in the amd/src directory of a component and are transpiled at development time to be compatable with a wide range of browsers.


== Where do I find general information about JavaScript? ==
== Where do I find general information about JavaScript? ==
Line 9: Line 11:
=== Online resources: ===
=== Online resources: ===
* [http://en.wikipedia.org/wiki/JavaScript JavaScript (Wikipedia)]
* [http://en.wikipedia.org/wiki/JavaScript JavaScript (Wikipedia)]
* [http://www.w3schools.com/JS/ JavaScript Tutorial] at W3Schools.com
* [https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide Mozilla JavaScript guide]
* [http://articles.sitepoint.com/category/javascript Sitepoint JavaScript tutorials]


=== Books: ===
=== Books: ===
Line 19: Line 20:
== How is JavaScript used by Moodle? ==
== How is JavaScript used by Moodle? ==


* See [https://docs.moodle.org/en/Category:Javascript Category:Javascript].
* See [[Javascript]].


== Where do I find more information about JavaScript in Moodle? ==
== Where do I find more information about JavaScript in Moodle? ==
Line 27: Line 28:


== What JavaScript library does Moodle use? ==
== What JavaScript library does Moodle use? ==
=== JQuery ===
{{Deprecated|version=3.8}}
As of Moodle 3.8, the user of [[jQuery]] is generally discouraged and the use of Native or Vanilla Javascript is recommended.


=== Yahoo! User Interface Library (YUI) ===  
=== Yahoo! User Interface Library (YUI) ===
Moodle uses the Yahoo! User Interface Library (YUI).
{{Deprecated|version=2.9}}
As of Moodle 2.9, the user of YUI is generally discouraged.


==== Online resources: ====
==== Online resources: ====
* [http://yuilibrary.com Yahoo! User Interface Library (YUI)]
* [http://yuilibrary.com Yahoo! User Interface Library (YUI)]
* [[YUI]] in the Moodle documentation
* [[YUI]] in the Moodle documentation
* [https://alloyui.com/rosetta-stone/ Migrating YUI code to jQuery]


==== Books: ====
==== Books: ====
* [http://shop.oreilly.com/product/0636920013303.do YUI 3 Cookbook] by Evan Goer
* [http://shop.oreilly.com/product/0636920013303.do YUI 3 Cookbook] by Evan Goer
* [http://shop.oreilly.com/product/0636920025245.do Maintainable JavaScript] by Nicholas C. Zakas
* [http://shop.oreilly.com/product/0636920025245.do Maintainable JavaScript] by Nicholas C. Zakas
 
==== Why are we moving away from YUI ? ====
The decision to begin the transition from YUI to JQuery was made here:


==== How/Why was YUI chosen for Moodle? ====
https://tracker.moodle.org/browse/MDL-47036
 
The decision was made in [http://moodle.org/mod/forum/discuss.php?d=48478 this thread in the General Developer Forum].
 
Since this decision was made, it's continued use has been questioned several times. Some of the main reasons for it's use include:
 
* good documentation;
* an active developer community;
* code modularity;
* a powerful loader system separating loading from execution and adding dependency resolution; and
* sandboxing of code as standard.
 
Most other major libraries do not offer many of these major features including the powerful loader and dependency system which are particularly useful in the modular environment of Moodle.
 
== What other JavaScript libraries are around? ==
 
* A nice comparison chart: [http://wiki.freaks-unidos.net/javascript-libraries Evaluation of JavaScript Libraries]
 
=== jQuery ===
 
jQuery is another popular JavaScript library, used among others by Drupal, Joomla and WordPress.
 
==== Online resources: ====
* [http://jquery.com/ jQuery]
* [http://visualjquery.com Visual jQuery]
* [http://jqueryfordesigners.com jQuery for Designers]
 
==== Books: ====
* [http://www.manning.com/bibeault/ jQuery in Action] by Bear Bibeault and Yehuda Katz
* [http://www.packtpub.com/jQuery/book Learning jQuery] by Karl Swedberg and Jonathan Chaffer
* [http://www.packtpub.com/jquery-reference-guide-Open-Source/book jQuery Reference Guide] by Jonathan Chaffer and Karl Swedberg
 
==== Moodle Docs ====
* [[Using jQuery with Moodle 2.0]]
 
== What does AJAX mean? ==
AJAX means "Asynchronous JavaScript and XML". It is a group of interrelated web development techniques used to create interactive web applications or rich Internet applications.
Although XML is included in the acronym, AJAX is not a single technology but a group of technologies. In reality with modern JS, this tends to be JSON which is much more lightweight and easy to produce in PHP than XML.
 
See [http://en.wikipedia.org/wiki/Ajax_(programming) AJAX (Wikipedia)] for general information and [[AJAX]] for information on AJAX and Moodle.


See also [[Firebug#Debugging AJAX_with_Firebug|Firebug > Debugging AJAX with Firebug]].
This is in response to Yahoos announcement that they will be ceasing all further development on YUI (although it is still maintained).  
http://yahooeng.tumblr.com/post/96098168666/important-announcement-regarding-yui


== See also ==
== See also ==


* [[User:Frank_Ralf/JavaScript1]] compares different solutions (plain JavaScript, YUI, and jQuery) to a simple enhancement to a form.
* [[jQuery]]
* [[Using jQuery with Moodle 2.0]]
* [[Javascript and YUI 3 FAQ]]


[[Category:FAQ]]
[[Category:FAQ]]
[[Category:Javascript]]
[[Category:Javascript]]
[[Category:AJAX]]
[[Category:AJAX]]

Latest revision as of 15:21, 5 December 2022

Warning: This page is no longer in use. The information contained on the page should NOT be seen as relevant or reliable.


What is JavaScript?

JavaScript is a scripting language widely used for client-side web development. It is also known as ECMAScript and has been progressively improved over the years.

Since Moodle 3.8 we recommend the use of Native JavaScript rather than through a library such as jQuery or YUI, and require that all new JavaScript be written in the style of ES 2015 modules. These should be placed in the amd/src directory of a component and are transpiled at development time to be compatable with a wide range of browsers.

Where do I find general information about JavaScript?

Online resources:

Books:

How is JavaScript used by Moodle?

Where do I find more information about JavaScript in Moodle?

What JavaScript library does Moodle use?

JQuery

This feature has been marked as deprecated since Moodle 3.8

As of Moodle 3.8, the user of jQuery is generally discouraged and the use of Native or Vanilla Javascript is recommended.

Yahoo! User Interface Library (YUI)

This feature has been marked as deprecated since Moodle 2.9

As of Moodle 2.9, the user of YUI is generally discouraged.

Online resources:

Books:

Why are we moving away from YUI ?

The decision to begin the transition from YUI to JQuery was made here:

https://tracker.moodle.org/browse/MDL-47036

This is in response to Yahoos announcement that they will be ceasing all further development on YUI (although it is still maintained). http://yahooeng.tumblr.com/post/96098168666/important-announcement-regarding-yui

See also