Apps and development tools - jQuery Plugins

© 2020 Innovation Gate GmbH

The OpenWGA jquery plugins are contained in plugin "wga-application-framework".

jquery plugins are included in one of the following ways:

Static include:

<tml:include designdb="@afw" ref="include:jquery" o_jquery-plugins="<plugin-name(s)>"/>

Dynamic Include - using requirejs:

<script>

    requirejs(<array-of-plugin-names>, function(){...})

</script>

Some plugins provide a usefull global object to the callback function. Those are documented as "Global configuration options".

Sample:

requirejs(["jquery-modal"], function(Modal){

  Modal.effect="slide";

  // do something useful with the plugin ...

})

All plugins define itself to be depended on "jquery", so it is not necessary to include jquery itself. However you may specify this dependency explicitly if you prefere it:

requirejs(["jquery", "jquery-modal"], function($, Modal){

  // $ is available here to access jquery ...

  // Modal is avaliable here to access jquery-modal global ...

})

CSS

Both types includes jquery, the requested plugin and all required CSS.

The following documentation is based on OpenWGA 7.2.1.


Table of contents