1. Home
  2. Classes
  3. WizardModule

new WizardModule()

Description

Base class to implement new Checkout Wizard Modules. See CheckoutComponent#addModuleToStep. Users need to extend this class to implement their custom checkout wizard modules

Members

errors :Array.<String>

error :WizardModuleError

Description

current module error if any

template :function|String

Description

The template for this view, in general a function that accepts this view context object and returns an HTML string.
If it is a string an AMD module with that name is tried to be loaded.
If it is undefined the view will be rendered without errors as an empty string

Details
function | String

View#template

events :Object|Object

Details
Object | Object

View#events

bindings :Object

Details
Object

View#bindings

Methods

disableInterface()

Description

General method to disable the module interface called at the moment of submitting the step

enableInterface()

Description

General method to re-enable the module interface called after getting an ERROR on submitting

refresh()

Description

Auxiliary method to refresh a module. For example, iIt is implemented by the OrderWizard to refresh titles

submit() → {Deferred}

Description

by default, a module returns it's validation promise.

Returns

resolved if this module was successfully submitted or rejected otherwise

cancel() → {Deferred}

Returns

isValid() → {Deferred}

Description

validate resolves a promise because maybe it needs to do some ajax for validation

Returns

isActive() → {Boolean}

Description

Determines is a module is active (can be submitted, rendered or just use) or not.

Returns

getTitle() → {String}

Description

returns the title of the module, can be overridden in the configuration file.

Returns

manageError( error ) → {undefined}

Parameters
Name Type Description
error WizardModuleError
Returns

showError() → {undefined}

Description

Shows the current error if any, see error

Returns

clearError() → {undefined}

Description

clear all error messages being shown

Returns

clearGeneralMessages() → {undefined}

Description

clear all general messages being shown

Returns

showGeneralMessage( message, type ) → {undefined}

Description

Notify a message (not just an error) at step level. Type can be a boolean (true: for errors, false: for success) or string to add a class alert-

Parameters
Name Type Description
message string
type string
Returns

initialize( ...options ) → {void}

Description

this is executed when a new view is instantiated - equivalent to the instance contructor.

Parameters
Name Type Attributes Description
options any <repeatable>
Returns
Details

View#initialize

render() → {void}

Returns
Details

View#render

getContext() → {Object}

Description

Returns the object which will be consumed by this view's template

Returns
Details

View#getContext

destroy() → {void}

Returns
Details

View#destroy

extend( view_definition )

Parameters
Name Type Description
view_definition View

an object with some of this class members.
Details

View#extend