Awesome

wicket-requirejs

Some helper to use require.js in your Apache Wicket application.

Current build status:

Dependencies

Apache Wicket 6.19.0
wicket-webjars 0.4.5
require.js 2.1.17

Usage

You can find a simple demo application in test package: de.agilecoders.wicket.demo

Maven: wicket-requirejs is available in Maven central repository. add the following maven dependency to your pom:

<pre><code><dependency> <groupId>de.agilecoders.wicket.requirejs</groupId> <artifactId>wicket-requirejs</artifactId> <version>0.1.2</version> </dependency> </code></pre>

First, you have to install an IRequireJsSettings implementation to your application in Application#init() method:

@Override
protected void init() {
    
    RequireJs.install(this); // use this if you want to use default settings.

    // or
    // WicketWebjars.install(this); // uncomment this line if MyRequireJsSettings is going to use webjars
    RequireJs.install(this, new MyRequireJsSettings()); // if you want to use your own configuration
}

Now you're able to use the RequireJsPanel to add all AmdJavaScriptHeaderItem to require.js configuration and the require.js file to your page where you want to use require.js.

public MyPage extends WebPage {
    public MyPage(PaeParameters params) {
        super(params);

        add(new RequireJsPanel("requireJs"));
    }

    @Override
    public void renderHead(IHeaderResponse response) {
        super.renderHead(response);

        response.render(AmdJavaScriptHeaderItem.forReference(new JavaScriptResourceReference(PageB.class, "pageB.js"), "pageB"));
    }
}

<!DOCTYPE html>
<html xmlns:wicket="http://wicket.apache.org">
<head>
    <title>Wicket - RequireJs demo application</title>
</head>
<body>
  Wicket - RequireJs integration

  <div wicket:id="requireJs"></div>

  <script type="text/javascript">
      require( ["pageB"], function(pageB) {
          pageB.demo();
      });
  </script>

    <div><a wicket:id="pageB">Page B</a></div>
</body>
</html>

The RequireJsPanel will render a special require.js script tag to the page that contains all added AmdJavaScriptHeaderItem and their dependencies:

<script>
   require.config({
     "paths": {
       "demo": "./wicket/resource/de.agilecoders.wicket.demo.RequireJsApplication/bundle-ver-1367476208000.js",
       "wicket-event": "./wicket/resource/org.apache.wicket.ajax.AbstractDefaultAjaxBehavior/res/js/wicket-event-jquery-ver-1366300990000.js",
       "pageB": "./wicket/resource/de.agilecoders.wicket.demo.RequireJsApplication/bundle-ver-1367476208000.js",
       "Wicket": "./wicket/resource/org.apache.wicket.ajax.AbstractDefaultAjaxBehavior/res/js/wicket-ajax-jquery-ver-1366300990000.js",
       "jquery": "./wicket/resource/org.apache.wicket.resource.JQueryResourceReference/jquery/jquery-ver-1366300990000.js"
     },
     "shim": {
       "wicket-event": {
         "exports": "wicket-event",
         "deps": ["jquery"]
       },
       "Wicket": {
         "exports": "Wicket",
         "deps": ["wicket-event"]
       }
     }
   });
</script>

None of the AMD resources will be loaded directly, instead they are loaded as requested.

<script type="text/javascript">
    require( ['pageB'], function(pageB) { // this will load the resource with id 'pageB' (./wicket/resource/de.agilecoders.wicket.demo.RequireJsApplication/bundle-ver-1367476208000.js)
        pageB.demo(); // this will be executed after 'pageB' was loaded
    });
</script>

How to get help and news

Keep up to date on announcements and more by following @l0rdn1kk0n or @mtgrigorov on Twitter
read more on my blog.

Bug tracker

Have a bug? Please create an issue here on GitHub!

https://github.com/l0rdn1kk0n/wicket-requirejs/issues

Versioning

wicket-requirejs will be maintained under the Semantic Versioning guidelines as much as possible.

Releases will be numbered with the follow format:

<major>.<minor>.<patch>

And constructed with the following guidelines:

Breaking backward compatibility bumps the major
New additions without breaking backward compatibility bumps the minor
Bug fixes and misc changes bump the patch

For more information on SemVer, please visit http://semver.org/.

Copyright and license

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this work except in compliance with the License. You may obtain a copy of the License in the LICENSE file, or at:

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.