Mask.WizardMenu Class
The main menu, where the available wizards are listed
Item Index
Methods
- closes static
- heredoc static
- hide static
- init static
- registerWizard static
- registerWizard static
- render static
- runWizard static deprecated
- setEmptySubject static
- setSubject static
- show static
- showRelatedWizardsList static
- showWizardsList static
Methods
closes
()
static
Stops and Closes Sideshow
heredoc
-
A
Receives a function with just a multiline comment as body and converts to a here-document string
Parameters:
-
A
Functionfunction without body but a multiline comment
Returns:
A multiline string
hide
-
callback
Hides the wizard menu
Parameters:
-
callback
FunctionThe callback to be called after hiding the menu
init
()
static
Initializes Sideshow
registerWizard
-
onlyNew
Registers a wizard
Parameters:
-
onlyNew
BooleanChecks only recently added wizards
Returns:
The eligible wizards list
registerWizard
-
wizardConfig
Registers a wizard
Parameters:
-
wizardConfig
Object
Returns:
The wizard instance
render
-
wizards
Renders the wizard menu
Parameters:
-
wizards
ArrayThe 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
Sets the current subject
Parameters:
-
subj
Object
show
-
wizards
Shows the wizard menu
Parameters:
-
wizards
ArrayThe wizards list
showRelatedWizardsList
-
completedWizard
Shows a list with the related wizards
Parameters:
-
completedWizard
ObjectThe recently completed wizard
Returns:
Returns a boolean indicating whether there is some related wizard available
showWizardsList
-
onlyNew
Checks if there are eligible wizards, if exists, shows the wizard menu
Parameters:
-
onlyNew
BooleanChecks only recently added wizards
Returns:
Returns a boolean indicating whether there is some wizard available