wijwizard jQuery Widget

Display sections of content on separate, navigable pages.

Syntax

Javascript (Usage)
$(function () { var options; // Type: wijmo.wizard.wijwizard.options $(".selector").wijwizard(options); });

Javascript (Usage)

$(function () {
    var options; // Type:  wijmo.wizard.wijwizard.options
     
    $(".selector").wijwizard(options);
});

Javascript (Specification)
function wijwizard() : any;

Browser Compatibility

Options

	Name	Description
	ajaxOptions	Default value: null A value that indicates additional Ajax options to consider when loading panel content (see $.ajax).
	autoPlay	Default value: false The autoPlay option allows the panels to automatically display in order.
	backBtnText	Default value: 'back' The backBtnText option defines the text for the wizard back button.
	cache	Default value: false An option that determines whether to cache emote wijwizard content.
	cookie	Default value: null The cookie option is a value that stores the latest active index in a cookie. The cookie is then used to determine the initially active index if the activeIndex option is not defined.
	delay	Default value: 3000 The delay option determines the time span between displaying panels in autoplay mode.
	hideOption	The hideOption option defines the animation effects when hiding the panel content.
	loop	Default value: false The loop option allows the wijwizard to begin again from the first panel when reaching the last panel in autoPlay mode.
	navButtons	Default value: 'auto' The navButtons option defines the type of navigation buttons used with the wijwizard.
	nextBtnText	Default value: 'next' The nextBtnText option defines the text for the wijwizard next button.
	panelTemplate	Default value: "" The panelTemplate option is an HTML template from which a new panel is created. The new panel is created by adding a panel with the add method or when creating a panel from a remote panel on the fly.
	showOption	The showOption option defines the animation effects when showing the panel content.
	spinner	Default value: "" The HTML content of this string is shown in a panel while remote content is loading. Pass the option in empty string to deactivate that behavior.
	stepHeaderTemplate	Default value: "" The stepHeaderTemplate option creates an HTML template for the step header when a new panel is added with the add method or when creating a panel for a remote panel on the fly.

Top

Methods

	Name	Description
	abort	The abort method terminates all running panel ajax requests and animations.
	add	The add method adds a new panel.
	back	The back method moves to the previous panel.
	count	The count method retrieves the number panels.
	destroy	Removes the wijwizard functionality completely. This returns the element back to its pre-init state.
	load	The load method reload the content of an Ajax panel programmatically.
	next	The next method moves to the next panel.
	play	The play method begins displaying the panels in order automatically.
	remove	The remove method removes a panel.
	show	The show method selects an active panel and displays the panel at a specified position.
	stop	The stop method stops displaying the panels in order automatically.
	url	The url method changes the url from which an Ajax (remote) panel will be loaded.
	widget	Returns a jQuery object containing the original element or other relevant generated element.

Top

Events

	Name	Description
	activeIndexChanged	The activeIndexChanged event handler is a function called when the activeIndex is changed.
	add	The add event handler is a function called when a panel is added.
	load	The load event handler is a function called after the content of a remote panel has been loaded.
	remove	The remove event handler is a function called when a panel is removed.
	show	The show event handler is a function called when a panel is shown.
	validating	The validating event handler is a function called before moving to next panel. This event is Cancellable.

Top

See Also

Widgets

Reference