Global

Methods

"jQuery.fn.linearNavigation"(itemsSelector, optionsopt) → {Object}

Parameters:
Name Type Attributes Description
itemsSelector Object collection of navigable elements
options Object <optional>
Properties
Name Type Attributes Description
axis string <optional>
 set arrow key axis to x, y or both (default: both)
activeIndex string <optional>
 specify the initial active item by index position (default: 0)
autoInit string <optional>
 initialise the model before a key is pressed (default: false)
autoInitOnDomChange string <optional>
 initialise the model when DOM changes (default: false)
autoReset string <optional>
 reset the model when focus is lost (default: false)
autoWrap boolean <optional>
 keyboard focus wraps from last to first & vice versa (default: false)
disableHomeAndEndKeys boolean <optional>
 disable HOME and END key functionality (default: false)
Source:
Fires:
  • event:linearNavigationChange - when the current item changes
  • event:linearNavigationReset - when the model resets
  • event:linearNavigationInit - when the model inits
  • event:linearNavigationItemsChange - when descendant items change
Listens to Events:
  • event:domChange - for changes to widget DOM
Returns:
chainable jQuery class
Type
Object

Events

linearNavigationChange

linearNavigationChange event
Type:
  • object
Parameters:
Name Type Attributes Description
data.fromIndex string <optional>
 old collection idx position
data.toIndex string <optional>
 new collection idx position
Properties:
Name Type Description
event object event object
data object event data params
Source:

linearNavigationInit

linearNavigationInit event
Type:
  • object
Parameters:
Name Type Attributes Description
data.fromIndex string <optional>
 old collection idx position
data.toIndex string <optional>
 new collection idx position
Properties:
Name Type Description
event object event object
data object event data params
Source:

linearNavigationItemsChange

linearNavigationItemsChange event
Type:
  • object
Properties:
Name Type Description
event object event object
Source:

linearNavigationReset

linearNavigationReset event
Type:
  • object
Parameters:
Name Type Attributes Description
data.fromIndex string <optional>
 old collection idx position
data.toIndex string <optional>
 new collection idx position
Properties:
Name Type Description
event object event object
data object event data params
Source: