makeup-roving-tabindex

makeup-roving-tabindex

Implements a roving tab index on given collection of elements

A vanilla JavaScript port of jquery-roving-tabindex.

Experimental

This module is still in an experimental state, until it reaches v1.0.0 you must consider all minor releases as breaking changes. Patch releases may introduce new features, but will be backwards compatible.

Install

// via npm
npm install makeup-roving-tabindex

// via yarn
yarn add makeup-roving-tabindex

Example

// require the module
const RovingTabindex = require('makeup-roving-tabindex');

// get an element reference
const widgetEl = document.querySelector('.widget');

// create a roving tabindex instance on the element
const rovingTabindex = RovingTabindex.createLinear(widgetEl, 'li');

// listen for events (optional)
widgetEl.addEventListener('rovingTabindexChange', function(e) {
    // console.log(e.detail);
})

Markup before:

<div class="widget">
    <ul>
        <li>Item 1</li>
        <li>Item 2</li>
        <li>Item 3</li>
    </ul>
</div>

Markup after:

<div class="widget">
    <ul>
        <li data-makeup-index="0" tabindex="0">Item 1</li>
        <li data-makeup-index="1" tabindex="-1">Item 2</li>
        <li data-makeup-index="2" tabindex="-1">Item 3</li>
    </ul>
</div>

Options

• autoReset: the index position that should receive the roving tabindex when model is reset (default: null)
• index: the initial index position of the roving tabindex (default: 0)
• wrap : specify whether arrow keys should wrap/loop (default: false)

Properties

• index: the index position of the roving tabindex (i.e. the element with tabindex="0")

Methods

• destroy: destroys all event listeners

Custom Events

• rovingTabindexChange
  • detail
    • fromIndex
    • toIndex

Dependencies

• makeup-navigation-emitter

Requirements

• CustomEvent polyfill for IE11 (included if bundling with Lasso)
• NodeList.forEach polyfill for IE11 (included if bundling with Lasso)

Development

• yarn start
• yarn test
• yarn lint
• yarn fix
• yarn build
• yarn clean

Test Reports

Each test run will generate the following reports:

• /reports/coverage contains Istanbul code coverage report
• /reports/html contains HTML test report

CI Build

https://travis-ci.org/makeup-js/makeup-roving-tabindex

Code Coverage

https://coveralls.io/github/makeup-js/makeup-roving-tabindex