Wizard

appmixer.ui.Wizard

The appmixer.ui.Wizard is a UI widget that creates a custom integration instance.

Method

Description

appmixer.ui.Wizard(config)

Constructor function that accepts config object. The config object must contain at least the el property that points to a container DOM element where the Wizard will be rendered.

open()

Render the Wizard inside its container.

close()

Close the Wizard.

on(event, handler)

React on events of the Wizard widget. See below for the list of events the Wizard widget supports.

off([event, handler])

Remove event listeners. If no arguments are provided, remove all event listeners. If only the event is provided, remove all listeners for that event. If both event and handler are given, remove the listener for that specific handler only.

reload()

Refresh the Wizard.

Wizard Events

Event

Callback

Triggered when ...

flow:start

function(flowId)

The user clicked the submit button and the integration was started.

cancel

function()

The user clicked the cancel button.

Example

var wizard = appmixer.ui.Wizard({
el: '#your-wizard-div',
flowId: 'your-integration-id',
});
wizard.on('flow:start', function(flowId) {
wizard.close();
});
wizard.open();