Skip to content

This application component let's you create UI wizards through a specific UI component DSL

License

Notifications You must be signed in to change notification settings

stxoce/cuba-component-wizard

 
 

Repository files navigation

Build Status Download license

CUBA component - Wizard

This application component let's you create UI wizards through a specific UI component DSL.

checkout-wizard-step-1

A UI wizard should be used in case of:

  • multi step input
  • complex decision workflows
  • the user needs to be guided through the process

For more information on this topic see: http://ui-patterns.com/patterns/Wizard

Installation

  1. wizard is available in the CUBA marketplace
  2. Select a version of the add-on which is compatible with the platform version used in your project:
Platform Version Add-on Version
7.1.x 0.5.x
7.0.x 0.4.x
6.10.x 0.3.x
6.9.x 0.2.x
6.8.x 0.1.x

The latest version is: Download

Add custom application component to your project:

  • Artifact group: de.diedavids.cuba.wizard
  • Artifact name: wizard-global
  • Version: add-on version
dependencies {
  appComponent("de.diedavids.cuba.wizard:wizard-global:*addon-version*")
}

Using the application component

Add a XML namespace wizard to the window tag of your screen like this:

<window xmlns="http://schemas.haulmont.com/cuba/window.xsd"
    xmlns:wizard="http://schemas.diedavids.de/wizard/0.1/ui-component.xsd">

Then add your wizard component to the screen:

    <wizard:wizard id="myWizard">
        <wizard:step caption="Step 1" screen="example-1-step-1" />
        <wizard:step caption="Step 2" screen="example-1-step-2" />
    </wizard:wizard>

Example usage

To see this application component in action, check out this example: cuba-example-using-wizard.

Example: Checkout Wizard

checkout-wizard-step-1

checkout-wizard-step-2

checkout-wizard-step-3

checkout-wizard-step-4

About

This application component let's you create UI wizards through a specific UI component DSL

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Java 77.5%
  • Shell 22.5%