API Docs for:
Show:

Mask.WizardMenu Class

The main menu, where the available wizards are listed

Item Index

Methods

Methods

closes

() static

Stops and Closes Sideshow

heredoc

(
  • A
)
String static

Receives a function with just a multiline comment as body and converts to a here-document string

Parameters:

  • A Function

    function without body but a multiline comment

Returns:

String:

A multiline string

hide

(
  • callback
)
static

Hides the wizard menu

Parameters:

  • callback Function

    The callback to be called after hiding the menu

init

() static

Initializes Sideshow

registerWizard

(
  • onlyNew
)
Array static

Registers a wizard

Parameters:

  • onlyNew Boolean

    Checks only recently added wizards

Returns:

Array:

The eligible wizards list

registerWizard

(
  • wizardConfig
)
Object static

Registers a wizard

Parameters:

  • wizardConfig Object

Returns:

Object:

The wizard instance

render

(
  • wizards
)
static

Renders the wizard menu

Parameters:

  • wizards Array

    The wizards list

runWizard

() deprecated static

setEmptySubject

() static

A trick to use the composite mask to simulate the behavior of a solid mask, setting an empty subject

setSubject

(
  • subj
)
static

Sets the current subject

Parameters:

  • subj Object

show

(
  • wizards
)
static

Shows the wizard menu

Parameters:

  • wizards Array

    The wizards list

showRelatedWizardsList

(
  • completedWizard
)
Boolean static

Shows a list with the related wizards

Parameters:

  • completedWizard Object

    The recently completed wizard

Returns:

Boolean:

Returns a boolean indicating whether there is some related wizard available

showWizardsList

(
  • onlyNew
)
Boolean static

Checks if there are eligible wizards, if exists, shows the wizard menu

Parameters:

  • onlyNew Boolean

    Checks only recently added wizards

Returns:

Boolean:

Returns a boolean indicating whether there is some wizard available