LogoLogo
v4.2
  • Docs
  • Connector Configuration
  • Knowledge Base
  • Changelog
v4.2
  • Introduction
  • Migration from 4.1
  • Overview
    • Introduction
    • Component
    • Flow
    • End User Guide
  • Component Definition
    • Basic Structure
    • Manifest
      • name
      • label
      • icon
      • marker
      • author
      • description
      • auth
      • authConfig
      • quota
      • properties
      • inPorts
      • outPorts
      • firePatterns
      • tick
      • private
      • webhook
      • state
      • localization
    • Behaviour
    • Dependencies
    • Authentication
    • Quotas & Limits
    • Configuration
    • Example Component
  • Customizing UI
    • Custom Inspector Fields
    • Custom Theme
    • Custom Strings
    • Custom API
    • Custom Component Strings
    • Custom Component Shapes
  • Appmixer Self-Managed
    • Installation
    • Getting Started
    • Custom Component: HelloAppmixer
    • Using Appmixer SDK
    • Using Appmixer API
    • Using OAuth applications
    • Installation GCP
    • System Webhooks
    • Appmixer Architecture
  • API
    • ACL
    • Accounts
    • Apps
    • Authentication
    • Charts
    • Data Stores
    • Files
    • Flows
    • Insights
    • Modifiers
    • People Task
    • Service Configuration
    • Unprocessed Messages
  • Appmixer SDK
    • Getting Started
    • API Reference
      • Constructor
      • API
      • FlowManager
      • Designer
      • InsightsLogs
      • InsightsDashboard
      • InsightsChartEditor
      • Accounts
      • Storage
      • PeopleTasks
      • Components
      • Wizard
      • Integrations
    • Developer mode
  • Appmixer Backoffice
    • Getting Started
    • Services
  • Tutorials
    • Managing Authentication
    • Sharing Flows
    • Flows Metadata & Filtering
    • People Tasks
    • Customizing modifiers
    • Setting ACL
  • Appmixer CLI
    • Appmixer CLI
  • App Registration
    • Google
    • DeepAI
    • Highrise
    • Screenshot API
    • Slack
    • Trello
    • Typeform
    • Utilities
      • Email
      • Language
      • Tasks
      • Weather
Powered by GitBook
On this page
  • appmixer.ui.Wizard
  • Wizard Events
  • Example

Was this helpful?

Export as PDF
  1. Appmixer SDK
  2. API Reference

Wizard

PreviousComponentsNextIntegrations

Last updated 4 years ago

Was this helpful?

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();