[SPIP][PLUGINS] v3.0-->v3.2
[lhc/web/www.git] / www / plugins-dist / compresseur / lib / jQl / README
diff --git a/www/plugins-dist/compresseur/lib/jQl/README b/www/plugins-dist/compresseur/lib/jQl/README
new file mode 100644 (file)
index 0000000..1d2e58c
--- /dev/null
@@ -0,0 +1,46 @@
+JQuery Loader
+=============
+
+Help to async load jQuery and supporting inline javascript with calls like:
+
+$(function(){})
+
+or
+
+$(document).ready(function(){})
+
+
+Include it, then just call:
+
+jQl.loadjQ('//ajax.googleapis.com/ajax/libs/jquery/1.7.2/jquery.min.js');
+
+You can also use it to load jQuery-dependent module in parallel,
+it will be queue and run after jQuery is loaded:
+
+jQl.loadjQ('//ajax.googleapis.com/ajax/libs/jquery/1.7.2/jquery.min.js');
+jQl.loadjQdep('my.example.com/js/myplugin.jquery.js');
+
+If you use a defer inline script, you have to manually call boot() function :
+
+<script defer="defer" type="text/javascript" src="//ajax.googleapis.com/ajax/libs/jquery/1.7.2/jquery.min.js"></script>
+<script type="text/javascript">jQl.boot();</script>
+
+jQuery will be loaded without blocking browser rendering,
+and during this all inline calls to $(document).ready() and $.getScript() will be queued.
+
+
+As soon as jQuery is ready,
+all queued inline calls will be run respecting their initial order.
+
+Be careful
+==========
+
+At the moment, inline call executions are not waiting jQuery-dependent modules,
+but only jQuery core.
+
+However, when jQuery is loaded, jQuery-dependent modules already loaded
+are run before inline scripts. But if some modules are longer to load and arrive
+after jQuery, they will be run after queued inline calls.
+
+v 1.2.0
+(c) 2010-2016 Cedric Morin licence GPL