Global

Methods

"jQuery.fn.gridNavigation"(cellsSelector, optionsopt) → {Object}

Parameters:
Name Type Attributes Description
cellsSelector Object collection of navigable grid cells
options Object <optional>
Properties
Name Type Attributes Description
activeIndex string <optional>
 the initial active index (default: 0)
autoInit boolean <optional>
 initialise the model before a key is pressed (default: false)
autoInitOnDomChange string <optional>
 initialise the model when DOM changes (default: false)
autoReset boolean <optional>
 reset the model when focus is lost (default: false)
autoWrap boolean <optional>
 keyboard focus wraps from last to first & vice versa (default: false)
debug boolean <optional>
 log debug info to console (default: false)
Source:
Fires:
  • event:gridNavigationInit - when the model intialises
  • event:gridNavigationChange - when the current item changes
  • event:gridNavigationReset - when the model resets
  • event:gridNavigationBoundary - when a grid boundary is hit
  • event:gridNavigationItemsChange - when descendant items change
Listens to Events:
  • event:domChange - for changes to widget DOM
Returns:
chainable jQuery class
Type
Object

Events

gridNavigationBoundary

gridNavigationBoundary event
Type:
  • object
Parameters:
Name Type Attributes Description
data.boundary string <optional>
 top, bottom, left or right
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:

gridNavigationChange

gridNavigationChange 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:

gridNavigationInit

gridNavigationInit 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:

gridNavigationReset

gridNavigationReset 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: