Documentation

All the things you want to know about Wicket but are afraid to ask

No matter how you want to learn about Wicket, there's something available for you. If you want a quick reference, use the User Guide. If you rather prefer a book, there's a couple waiting for you. And if you rather watch a video or presentation, we have that covered too.

News Archive

Every release is announced through our mailing lists and the official Apache announcements list. We also publish a news item on our website with the announcement, and it is also published in our RSS feed (handy for RSS readers).

Here are the most recent headlines:

The complete articles and all other news items are available in the archives.


Wicket User Guide

Learn building web applications with Wicket from scratch reading its 200+ page user guide. The guide gradually introduces you to the various features of the framework with many real-world examples. It covers subjects such as models, behaviours, testing and integration with other projects.

The guide is available as PDF or html file for the following versions:

  1. Wicket 8.x
  2. Wicket 7.x
  3. Wicket 6.x

You can use the guide for older releases even though there will be differences. We urge you however to upgrade your project to the latest stable release rather than sticking on an older version.


API Documentation

Each release of Wicket comes with sources, including JavaDocs. When you use Maven for dependency management, your IDE will automatically download the source JARs and when you hover on a Wicket class or method, show you the corresponding documentation.

For reference we also publish the API documentation online so you can link to it from emails or websites:


Migration Guides

When you upgrade your application from an older Wicket version to a newer version you can run into all of the changes that were applied to Wicket’s API. We have done our best to document all the changes and provide migration paths between the different Wicket versions.

Here’s a list of the migration guides:

If you encounter a change that was not in the migration guide, don’t hesitate to notify us.


Getting help

Stuck with a problem? See how you can find support!


IDE Support

Wicket is well supported by the three main Java IDEs (NetBeans, IntelliJ and Eclipse). Find here how to work with Wicket projects with your favourite IDE.


Examples

  • Examples - Browse a vast collection of examples in live action without having to install anything!
  • Wicket 6 examples / Wicket 7 examples - A special subset of live examples to show you how to use Wicket components.