Class Tour

java.lang.Object
com.vaadin.flow.component.Component
org.vaadin.addons.antlerflow.tour.Tour
All Implemented Interfaces:
com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasStyle, Serializable
@Tag("antler-tour") @JsModule("./antlerflow/tour/core/tour-facade.ts") public class Tour extends com.vaadin.flow.component.Component
Represents a tour component that provides guided tours for user interfaces. A tour is a sequence of steps, each representing an instructional message or action aimed at guiding users through specific features or workflows in the application.

This class utilizes a pluggable TourEngine that defines the mechanics of how the tour is executed. The engine can be selected by setting the engineType. 

 Features include:
 - Option to show or hide a cancel button during the tour.
 - Ability to control whether the tour can be closed.
 - Events to listen for when a tour is canceled or completed.
 - Customizable options for configuring behavior and appearance.
The necessary sequence of steps for the tour should be defined through the steps field.
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    Tour()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    com.vaadin.flow.shared.Registration
    addTourCanceledListener(com.vaadin.flow.component.ComponentEventListener<TourCanceledEvent> listener)
     
    com.vaadin.flow.shared.Registration
    addTourCompletedListener(com.vaadin.flow.component.ComponentEventListener<TourCompletedEvent> listener)
     
    void
    cancel()
     
    void
    start()
     

    Methods inherited from class com.vaadin.flow.component.Component

    addListener, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, setVisible

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.vaadin.flow.component.AttachNotifier

    addAttachListener

    Methods inherited from interface com.vaadin.flow.component.DetachNotifier

    addDetachListener

    Methods inherited from interface com.vaadin.flow.component.HasStyle

    addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

  • Constructor Details

    • Tour

      public Tour()

  • Method Details

    • start

      public void start()

    • cancel

      public void cancel()

    • addTourCanceledListener

      public com.vaadin.flow.shared.Registration addTourCanceledListener(com.vaadin.flow.component.ComponentEventListener<TourCanceledEvent> listener)

    • addTourCompletedListener

      public com.vaadin.flow.shared.Registration addTourCompletedListener(com.vaadin.flow.component.ComponentEventListener<TourCompletedEvent> listener)