jquery-roving-tabindex

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>JSDoc: Global</title> <script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/lang-css.js"> </script>  <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> </head> <body> <div id="main"> <h1 class="page-title">Global</h1> <section> <header> <h2></h2> </header> <article> <div class="container-overview"> <dl class="details"> </dl> </div> <h3 class="subsection-title">Methods</h3> <h4 class="name" id="%22jQuery.fn.rovingTabindex%22"><span class="type-signature"></span>"jQuery.fn.rovingTabindex"<span class="signature">(rovingItems, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Object}</span></h4> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>rovingItems</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="attributes"> </td> <td class="description last">descendant items that will receive roving tabindex state</td> </tr> <tr> <td class="name"><code>options</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"> <h6>Properties</h6> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>activeIndex</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">specify the initial active item by index position (default: 0)</td> </tr> <tr> <td class="name"><code>autoFocus</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">set focus when roving tab index changes (default: true)</td> </tr> <tr> <td class="name"><code>autoInit</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">set initial tabindex when plugin executes (default: true)</td> </tr> <tr> <td class="name"><code>autoReset</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">reset tabindex state when focus leaves widget (default: false)</td> </tr> <tr> <td class="name"><code>axis</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">set arrow key axis to x, y or both (default: both)</td> </tr> <tr> <td class="name"><code>autoWrap</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">keyboard focus wraps from last to first & vice versa (default: true)</td> </tr> <tr> <td class="name"><code>setFocusDelay</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">time in millieseconds to delay setting focus (default: 0)</td> </tr> </tbody> </table> </td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="jquery.rovingtabindex.js.html">jquery.rovingtabindex.js</a>, <a href="jquery.rovingtabindex.js.html#line14">line 14</a> </li></ul></dd> </dl> <h5>Fires:</h5> <ul> <li>event:rovingTabindexChange - when roving tabindex changes</li> </ul> <h5>Listens to Events:</h5> <ul> <li>event:rovingTabindexItemsChange - when DOM has changed</li> </ul> <h5>Returns:</h5> <div class="param-desc"> chainable jQuery class </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Object</span> </dd> </dl> <h3 class="subsection-title">Events</h3> <h4 class="name" id="event:rovingTabindexChange">rovingTabindexChange</h4> <div class="description"> rovingTabindexChange event </div> <h5>Type:</h5> <ul> <li> <span class="param-type">object</span> </li> </ul> <h5 class="subsection-title">Properties:</h5> <table class="props"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>event</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last">event object</td> </tr> <tr> <td class="name"><code>data</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last">event data</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="jquery.rovingtabindex.js.html">jquery.rovingtabindex.js</a>, <a href="jquery.rovingtabindex.js.html#line113">line 113</a> </li></ul></dd> </dl> <h4 class="name" id="event:rovingTabindexItemsChange">rovingTabindexItemsChange</h4> <div class="description"> rovingTabindexItemsChange event </div> <h5>Type:</h5> <ul> <li> <span class="param-type">object</span> </li> </ul> <h5 class="subsection-title">Properties:</h5> <table class="props"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>event</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last">event object</td> </tr> <tr> <td class="name"><code>data</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last">event data</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="jquery.rovingtabindex.js.html">jquery.rovingtabindex.js</a>, <a href="jquery.rovingtabindex.js.html#line121">line 121</a> </li></ul></dd> </dl> </article> </section> </div> <nav> <h2><a href="index.html">Home</a></h2><h3>Externals</h3><ul><li><a href="external-_jQuery.fn_.html">jQuery.fn</a></li></ul><h3>Events</h3><ul><li><a href="global.html#event:rovingTabindexChange">rovingTabindexChange</a></li><li><a href="global.html#event:rovingTabindexItemsChange">rovingTabindexItemsChange</a></li></ul><h3>Global</h3><ul><li><a href="global.html#%2522jQuery.fn.rovingTabindex%2522">"jQuery.fn.rovingTabindex"</a></li></ul> </nav> <br class="clear"> <footer> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Oct 19 2017 10:14:37 GMT-0700 (PDT) </footer> <script> prettyPrint(); </script> <script src="scripts/linenumber.js"> </script> </body> </html>