Skip to content

Commit

Permalink
Added cancel button functionality
Browse files Browse the repository at this point in the history
  • Loading branch information
@rstaib
rstaib committed Apr 27, 2014
1 parent 080e5c8 commit bdfa21f
Show file tree
Hide file tree
Showing 7 changed files with 133 additions and 65 deletions.
Binary file modified build/jQuery.Steps.1.0.5.nupkg
View file
Binary file not shown.
Binary file modified build/jquery.steps-1.0.5.zip
View file
Binary file not shown.
98 changes: 66 additions & 32 deletions build/jquery.steps.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -200,6 +200,19 @@ function analyzeData(wizard, options, state)
});
}

/**
* Triggers the onCanceled event.
*
* @static
* @private
* @method cancel
* @param wizard {Object} The jQuery wizard object
**/
function cancel(wizard)
{
wizard.triggerHandler("canceled");
}

function decreaseCurrentIndexBy(state, decreaseBy)
{
return state.currentIndex - decreaseBy;
Expand Down Expand Up @@ -765,17 +778,21 @@ function paginationClickHandler(event)
state = getState(wizard),
href = anchor.attr("href");

switch (href.substring(href.lastIndexOf("#")))
switch (href.substring(href.lastIndexOf("#") + 1))
{
case "#finish":
case "cancel":
cancel(wizard);
break;

case "finish":
finishStep(wizard, state);
break;

case "#next":
case "next":
goToNextStep(wizard, options, state);
break;

case "#previous":
case "previous":
goToPreviousStep(wizard, options, state);
break;
}
Expand Down Expand Up @@ -811,7 +828,7 @@ function refreshPagination(wizard, options, state)
}
else
{
finish._showAria(options.enableFinishButton && state.stepCount > (state.currentIndex + 1));
finish._showAria(options.enableFinishButton && state.stepCount >= (state.currentIndex + 1));
next._showAria(state.stepCount === 0 || state.stepCount > (state.currentIndex + 1)).
_enableAria(state.stepCount > (state.currentIndex + 1) || !options.enableFinishButton);
}
Expand Down Expand Up @@ -882,6 +899,7 @@ function registerEvents(wizard, options)
{
var eventNamespace = getEventNamespace(wizard);

wizard.bind("canceled" + eventNamespace, options.onCanceled);
wizard.bind("finishing" + eventNamespace, options.onFinishing);
wizard.bind("finished" + eventNamespace, options.onFinished);
wizard.bind("stepChanging" + eventNamespace, options.onStepChanging);
Expand Down Expand Up @@ -1044,6 +1062,11 @@ function renderPagination(wizard, options, state)
buttons += buttonTemplate.format("finish", options.labels.finish);
}

if (options.enableCancelButton)
{
buttons += buttonTemplate.format("cancel", options.labels.cancel);
}

wizard.append(pagination.format(options.actionContainerTag, options.clearFixCssClass,
options.labels.pagination, buttons));

Expand Down Expand Up @@ -1305,10 +1328,8 @@ $.fn.steps = function (method)
**/
$.fn.steps.add = function (step)
{
var options = getOptions(this),
state = getState(this);

return insertStep(this, options, state, state.stepCount, step);
var state = getState(this);
return insertStep(this, getOptions(this), state, state.stepCount, step);
};

/**
Expand All @@ -1319,9 +1340,7 @@ $.fn.steps.add = function (step)
**/
$.fn.steps.destroy = function ()
{
var options = getOptions(this);

return destroy(this, options);
return destroy(this, getOptions(this));
};

/**
Expand All @@ -1331,9 +1350,7 @@ $.fn.steps.destroy = function ()
**/
$.fn.steps.finish = function ()
{
var state = getState(this);

finishStep(this, state);
finishStep(this, getState(this));
};

/**
Expand Down Expand Up @@ -1388,10 +1405,7 @@ $.fn.steps.getStep = function (index)
**/
$.fn.steps.insert = function (index, step)
{
var options = getOptions(this),
state = getState(this);

return insertStep(this, options, state, index, step);
return insertStep(this, getOptions(this), getState(this), index, step);
};

/**
Expand All @@ -1402,11 +1416,7 @@ $.fn.steps.insert = function (index, step)
**/
$.fn.steps.next = function ()
{
var options = getOptions(this),
state = getState(this);


return goToNextStep(this, options, state);
return goToNextStep(this, getOptions(this), getState(this));
};

/**
Expand All @@ -1417,10 +1427,7 @@ $.fn.steps.next = function ()
**/
$.fn.steps.previous = function ()
{
var options = getOptions(this),
state = getState(this);

return goToPreviousStep(this, options, state);
return goToPreviousStep(this, getOptions(this), getState(this));
};

/**
Expand All @@ -1432,10 +1439,7 @@ $.fn.steps.previous = function ()
**/
$.fn.steps.remove = function (index)
{
var options = getOptions(this),
state = getState(this);

return removeStep(this, options, state, index);
return removeStep(this, getOptions(this), getState(this), index);
};

/**
Expand Down Expand Up @@ -1774,6 +1778,16 @@ var defaults = $.fn.steps.defaults = {
**/
enableContentCache: true,

/**
* Shows the cancel button if enabled.
*
* @property enableCancelButton
* @type Boolean
* @default true
* @for defaults
**/
enableCancelButton: true,

/**
* Shows the finish button if enabled.
*
Expand Down Expand Up @@ -1885,6 +1899,16 @@ var defaults = $.fn.steps.defaults = {
**/
onStepChanged: function (event, currentIndex, priorIndex) { },

/**
* Fires after cancelation.
*
* @property onCanceled
* @type Event
* @default function (event) { }
* @for defaults
**/
onCanceled: function (event) { },

/**
* Fires before finishing and can be used to prevent completion by returning `false`.
* Very useful for form validation.
Expand Down Expand Up @@ -1914,6 +1938,16 @@ var defaults = $.fn.steps.defaults = {
* @for defaults
**/
labels: {
/**
* Label for the cancel button.
*
* @property cancel
* @type String
* @default "Cancel"
* @for defaults
**/
cancel: "Cancel",

/**
* This label is important for accessability reasons.
* Indicates which step is activated.
Expand Down
2 changes: 1 addition & 1 deletion build/jquery.steps.min.js
View file

Large diffs are not rendered by default.

30 changes: 30 additions & 0 deletions src/defaults.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,16 @@ var defaults = $.fn.steps.defaults = {
**/
enableContentCache: true,

/**
* Shows the cancel button if enabled.
*
* @property enableCancelButton
* @type Boolean
* @default true
* @for defaults
**/
enableCancelButton: true,

/**
* Shows the finish button if enabled.
*
Expand Down Expand Up @@ -299,6 +309,16 @@ var defaults = $.fn.steps.defaults = {
**/
onStepChanged: function (event, currentIndex, priorIndex) { },

/**
* Fires after cancelation.
*
* @property onCanceled
* @type Event
* @default function (event) { }
* @for defaults
**/
onCanceled: function (event) { },

/**
* Fires before finishing and can be used to prevent completion by returning `false`.
* Very useful for form validation.
Expand Down Expand Up @@ -328,6 +348,16 @@ var defaults = $.fn.steps.defaults = {
* @for defaults
**/
labels: {
/**
* Label for the cancel button.
*
* @property cancel
* @type String
* @default "Cancel"
* @for defaults
**/
cancel: "Cancel",

/**
* This label is important for accessability reasons.
* Indicates which step is activated.
Expand Down
33 changes: 28 additions & 5 deletions src/privates.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,19 @@ function analyzeData(wizard, options, state)
});
}

/**
* Triggers the onCanceled event.
*
* @static
* @private
* @method cancel
* @param wizard {Object} The jQuery wizard object
**/
function cancel(wizard)
{
wizard.triggerHandler("canceled");
}

function decreaseCurrentIndexBy(state, decreaseBy)
{
return state.currentIndex - decreaseBy;
Expand Down Expand Up @@ -705,17 +718,21 @@ function paginationClickHandler(event)
state = getState(wizard),
href = anchor.attr("href");

switch (href.substring(href.lastIndexOf("#")))
switch (href.substring(href.lastIndexOf("#") + 1))
{
case "#finish":
case "cancel":
cancel(wizard);
break;

case "finish":
finishStep(wizard, state);
break;

case "#next":
case "next":
goToNextStep(wizard, options, state);
break;

case "#previous":
case "previous":
goToPreviousStep(wizard, options, state);
break;
}
Expand Down Expand Up @@ -751,7 +768,7 @@ function refreshPagination(wizard, options, state)
}
else
{
finish._showAria(options.enableFinishButton && state.stepCount > (state.currentIndex + 1));
finish._showAria(options.enableFinishButton && state.stepCount >= (state.currentIndex + 1));
next._showAria(state.stepCount === 0 || state.stepCount > (state.currentIndex + 1)).
_enableAria(state.stepCount > (state.currentIndex + 1) || !options.enableFinishButton);
}
Expand Down Expand Up @@ -822,6 +839,7 @@ function registerEvents(wizard, options)
{
var eventNamespace = getEventNamespace(wizard);

wizard.bind("canceled" + eventNamespace, options.onCanceled);
wizard.bind("finishing" + eventNamespace, options.onFinishing);
wizard.bind("finished" + eventNamespace, options.onFinished);
wizard.bind("stepChanging" + eventNamespace, options.onStepChanging);
Expand Down Expand Up @@ -984,6 +1002,11 @@ function renderPagination(wizard, options, state)
buttons += buttonTemplate.format("finish", options.labels.finish);
}

if (options.enableCancelButton)
{
buttons += buttonTemplate.format("cancel", options.labels.cancel);
}

wizard.append(pagination.format(options.actionContainerTag, options.clearFixCssClass,
options.labels.pagination, buttons));

Expand Down
Loading

0 comments on commit bdfa21f

Please sign in to comment.