Globals

Members

---

defaults :FormPagesOptions

Details

Type

FormPagesOptions

Source

form-pages.js, line 87

Methods

---

init()

Description

Initializes the plugin.

Details

Source

form-pages.js, line 139

---

adaptContainerHeightOnChangePage()

Description

Adapts the container height when page changed.

Details

Source

form-pages.js, line 256

---

updateAdaptiveContainerHeight()

Description

If the adaptiveContainerHeight is set to true, this function recalculates the height of the container.

Details

Source

form-pages.js, line 267

Type Definitions

---

PaginationDirection

Details

Type

'horizontal' | 'vertical'

Source

form-pages.js, line 4

---

FormPagesOptions

Description

All properties which the suffix is "Class" can be an array, which will be joined and cleaned before being added to the elements. The value of this on all callbacks is the jQuery element you applied the plugin to.

Properties

Name	Type	Attributes	Default	Description
activePageClass	string		".form-pages__page--active"	The active page selector.
adaptiveContainerHeight	string		true	Tells if the form container height must be adaptive to the active page.
formPageClass	string		".form-pages__page"	The selector which will separate the form pages.
formPagesContainerAdaptiveHeightClass	string		".form-pages__page-container--adaptive-height"	The selector for the pages container when adaptiveContainerHeight is set to true.
nextButtonClass	string		".form-pages__next-button"	The selector for the "next" button.
prevButtonClass	string		".form-pages__prev-button"	The selector for the "previous" button.
submitButtonClass	string		".form-pages__submit-button"	The selector for the form submit button.
paginationDirection	PaginationDirection		"horizontal"	The direction that the form will move.
onInitialized	function	<nullable>		Callback for when plugin finishes loading.
onMovedPage	function	<nullable>		Callback for when page moves.
onNextPage	function	<nullable>		Callback for when the form goes to the next page.
onPrevPage	function	<nullable>		Callback for when the form goes to the previous page.
onSubmitForm	function	<nullable>		Callback for when the form gets submitted.
onRecalculateContainerHeight	function	<nullable>		Callback for when the form's container height is recalculated. Triggered only when adaptiveContainerHeight is true.
shouldMoveForwards	function	<nullable>		Callback to validate if the form should move forwards. Useful for validation.

Details

Type

Object

Source

form-pages.js, line 12

---

Dimensions

Properties

Name	Type	Description
width	number
height	number

Details

Source

form-pages.js, line 38

---

Direction

Details

Type

'next' | 'prev' | 'none'

Source

form-pages.js, line 8