README.md

jQuery Tab Cycle

This plugin fills in gaps when creating more complicated tab logic. The out-of-the-box implementation of tabindex has no support for scoping the behavior to arbitrary containers. This plugin allows a developer to scope tabbing behavior and confine it to a container (with some advanced functionality to boot). Look at the examples and options for more detail.

Installation

• Include jQuery as a dependency in your solution.
• Include ./dist/tabCycle-min.js in your solution. Only 2kb minified.

Usage

A more complete set of live examples can be found on codepen

HTML

<nav>
  <a href="..." tabIndex="5">Home</a>
  <a href="..." tabIndex="5">Blog</a>
  <input type="text" tabIndex="10" placeholder="username"/>
  <input type="text" tabIndex="10" placeholder="password"/>
  <button tabIndex="10">Login</button>
</nav>

Javascript

$(function() {
  $.tabCycle.init($('nav'));
});

Options

Example:

$.tabCycle.options = {
  ignoreSelector: ':hidden, :disabled',
  focusClass: '',
  focusElement: true,
  selectAllText: true,
  stopTabPropagation: true,
  stopArrowPropagation: true
};

• ignoreSelector - Use this option to ignore specific jQuery selectors within your tabindex set. For example, a button among the set may be currently in a disabled state.

• Default: ':hidden, :disabled'

• focusClass - an optional CSS class to be applied and removed when focused from the tabCycle plugin

• Default: ''

• focusElement - Indicates if $.focus() should be called on the cycled element.

• Default: true

• selectAllText - Indicates if $.select() should be called to select all text on the cycled element, when it's an input or textarea.

• Default: true

• stopTabPropagation - Indicates if e.stopPropagation() should be called when cycling that was triggered by the TAB keypress.

• Default: true

• stopArrowPropagation - Indicates if e.stopPropagation() should be called when cycling that was triggered by the ARROW keypress.

  • Default: true

  Tested

  • Latest Chrome
  • TBD