Vaadin Addon for creating Product Tours
Product Tour is a UI component add-on for Vaadin 7.
Product Tour provides the possibility to create a product tour for your web application and introduce the user to your user interface.
You can attach the single steps of the tour to every component of your UI.
CREDITS
The addon is based on Shepherd, a JavaScript library to create product tours.
Try the add-on demo at https://product-tour-demo.herokuapp.com/
Official releases of this add-on are available at Vaadin Directory. For Maven instructions, download and reviews, go to http://vaadin.com/addon/product-tour
git clone
mvn clean install
cd demo
mvn jetty:run
To see the demo, navigate to http://localhost:8080/
For further development of this add-on, the following tool-chain is recommended:
Choose File > Import… > Existing Maven Projects
Note that Eclipse may give “Plugin execution not covered by lifecycle configuration” errors for pom.xml. Use “Permanently mark goal resources in pom.xml as ignored in Eclipse build” quick-fix to mark these errors as permanently ignored in your project. Do not worry, the project still works fine.
If you have not already compiled the widgetset, do it now by running vaadin:install Maven target for product-tour-root project.
If you have a JRebel license, it makes on the fly code changes faster. Just add JRebel nature to your product-tour-demo project by clicking project with right mouse button and choosing JRebel > Add JRebel Nature
To debug project and make code modifications on the fly in the server-side, right-click the product-tour-demo project and choose Debug As > Debug on Server. Navigate to http://localhost:8080/product-tour-demo/ to see the application.
Debugging client side code in the product-tour-demo project:
This component is developed as a hobby with no public roadmap or any guarantees of upcoming releases. That said, the following features are planned for upcoming releases:
The issues for this add-on are tracked on its github.com page. All bug reports and feature requests are appreciated.
Contributions are welcome, but there are no guarantees that they are accepted as such. Process for contributing is the following:
Add-on is distributed under Apache License 2.0. For license terms, see LICENSE.txt.
Tour is written by Julien Charpenel
Here is a simple example on how to try out the add-on component:
@Theme("default")
@Title("Product Tour Add-on Demo")
@SuppressWarnings("serial")
public class DemoUI2 extends UI {
@Override
protected void init(VaadinRequest request) {
HorizontalLayout layout = new HorizontalLayout();
layout.setDefaultComponentAlignment(Alignment.MIDDLE_CENTER);
layout.setSizeFull();
setContent(layout);
Tour tour = new Tour();
Button button = new Button("Click to start tour", e -> tour.start());
layout.addComponent(button);
tour.addStep(new StepBuilder()
.withAttachTo(button)
.withTitle("Step 1: title")
.withText("Step text")
.addButton(new StepButton("Back", TourActions::back))
.addButton(new StepButton("Next", ValoTheme.BUTTON_PRIMARY, TourActions::next))
.build());
tour.addStep(new StepBuilder()
.withAttachTo(button)
.withTitle("Step 2: title")
.withText("Step text")
.addButton(new StepButton("Back", TourActions::back))
.addButton(new StepButton("Finish", ValoTheme.BUTTON_PRIMARY, TourActions::next))
.build());
}
@WebServlet(value = "/*", asyncSupported = true)
@VaadinServletConfiguration(productionMode = false, ui = DemoUI2.class)
public static class Servlet extends VaadinServlet {
}
}
For a more comprehensive example, see product-tour-demo/src/main/org/vaadin/addons/producttour/demo/DemoUI.java
The steps of a tour can be attached to any AbstractCompomponent
.
The look and feel of the steps will be adapted to your theme automatically by using the valo theme engine.
Additionally the buttons used for steps can be styled using the valo button styles.
You can set various options for the single step like e.g. modality, text, title, anchor position, what buttons are shown.
The steps and tour fire different events for you to be able to react if needed (e.g. showing of a step, completion of a tour, etc.).