This package has been deprecated

Author message:

WARNING: This project has been renamed to @accede-web/tablist. Install using @accede-web/tablist instead.

AcceDe Web - tablist

WAI-ARIA accordion and tab plugin without dependencies.

Requirements

HTML

Basic HTML structure with roles tablist, tab, and tabpanel. aria-multiselectable attribute on the tab list and aria-labelledby attribute on each tab panels when wanting an accordion instead of tabs. id attribute either on the tabs or the tab panel whether we want an accordion or tabs.

Example of accordion HTML structure

<div role="tablist" aria-multiselectable="true">
  <h3 id="tab1" role="tab">Header 1</h3>
  <div role="tabpanel" aria-labelledby="tab1">
    <p>---</p>
  </div>
  <h3 id="tab2" role="tab">Header 2</h3>
  <div role="tabpanel" aria-labelledby="tab2">
    <p>---</p>
  </div>
  <h3 id="tab3" role="tab">Header 3</h3>
  <div role="tabpanel" aria-labelledby="tab3">
    <p>---</p>
  </div>
  <h3 id="tab4" role="tab">Header 4</h3>
  <div role="tabpanel" aria-labelledby="tab4">
    <p>---</p>
  </div>
</div>

Example of tabs HTML structure

<ul role="tablist">
  <li role="tab" aria-controls="tab-1">Tab 1</li>
  <li role="tab" aria-controls="tab-2">Tab 2</li>
  <li role="tab" aria-disabled="true" aria-controls="tab-3">Tab 3</li>
  <li role="tab" aria-controls="tab-4">Tab 4</li>
</ul>
 
<div role="tabpanel" id="tab-1">
  <p>---</p>
</div>
<div role="tabpanel" id="tab-2">
  <p>---</p>
</div>
<div role="tabpanel" id="tab-3">
  <p>---</p>
</div>
<div role="tabpanel" id="tab-4">
  <p>---</p>
</div>

An aria-disabled attribute set to true on a tab will disable the tab and the associated tabpanel making them unfocusable and unselectable.

If you wish to open one or more specific tab when the script starts, just add the data-tab-open attribute on the desired tab:

<ul role="tablist">
  <li role="tab" aria-controls="tab-1">Tab 1</li>
  <li role="tab" aria-controls="tab-2" data-tab-open>Tab 2</li>
  <li role="tab" aria-controls="tab-3">Tab 3</li>
  <li role="tab" aria-controls="tab-4">Tab 4</li>
</ul>
 
<!-- -->

CSS

At least a CSS selector for panels to be hidden when not selected:

[role=tabpanel][aria-hidden=true] {
  display: none;
}

The selector can be anything you want, like a class, as the script allows callback when opening or closing a panel; you can add your own class using the callbacks.

JavaScript

The script itself, either from npm:

$ npm install accedeweb-tablist

and later in your code:

var Tablist = require( 'accedeweb-tablist' );
 
// or
 
import Tablist from accedeweb-tablist;

or downloaded from Github and added to the page (minified and non minified versions available in the dist folder)

<script src="./js/accedeweb-tablist.min.js"></script>

Using the later, the script will be available on window under the namespace Tablist.

Now to kick off the script:

var list = document.querySelector( '[role="tablist"]' );
var tablist = new window.Tablist( list );
 
// or you can pass callbacks
 
var tablist = new window.Tablist( list, {
  openTab: openTabCallback,
  closeTab: closeTabCallback
});

Parameters

The script takes two parameters:

• the tablist DOM element
• an optional object with two callbacks:
  • openTab callback will be executed when a new tab is open, passing the current tab DOM element as a parameter
  • closeTab callback will be executed when a tab is closed, passing the closed tab DOM element as a parameter

As the script takes only one tablist element as parameter you have to loop over each tablist to kick off the script on each of them.

var lists = document.querySelectorAll( '[role="tablist"]' );
 
Array.prototype.forEach.call( lists, function( list ) {
  new window.Tablist( list );
});

Methods

The Tablist constructor returns two methods:

• closeAll will allow you to close all the panels, except when in tab mode as at least one panel must be displayed
• openedTab will return an array of opened tabs

References

Each tab and tabpanel have references to the tablist element and tab or tabpanel:

function openCallback( openTab ){
  console.log( openTab.tabList );
  // -> returns the parent DOM element with the role 'tablist'
 
  console.log( opentTab.tabPanel );
  // -> returns the tabpanel DOM element linked to the tab
}

This allows you to add or remove your own class for CSS purposes or animate the opening or closing of the tab panel.

Keyboard Interaction

The keyboard interactions are based on Atalan's AcceDe Web guidelines (in French) and the WAI-AIRA 1.0 Authoring Practices

• Tab - only the active tab is in the tab order. The user reaches the tabbed panel component by pressing the tab key until the active tab title receives focus.
• Left Arrow - with focus on a tab, pressing the left arrow will move focus to the previous tab in the tab list and activate that tab. Pressing the left arrow when the focus is on the first tab in the tab list will move focus and activate the last tab in the list.
• Right Arrow - with focus on a tab, pressing the right arrow will move focus to the next tab in the tab list and activate that tab. Pressing the right arrow when the focus is on the last tab in the tab list will move focus to and activate the first tab in the list.
• Up arrow - behaves the same as left arrow in order to support vertical tabs.
• Down arrow - behaves the same as right arrow in order to support vertical tabs.
• Control+Up Arrow - with focus anywhere within the tab panel, pressing Control+Up Arrow will move focus to the tab for that panel. This is not standard behavior.
• Control+PageUp - When focus is inside of a tab panel, pressing Control+PageUp moves focus to the tab of the previous tab in the tab list and activates that tab. When focus is in the first tab panel in the tab list, pressing Control+PageUp will move focus to the last tab in the tab list and activate that tab.
• Control+PageDown When focus is inside of a tab panel, pressing Control+PageDown moves focus to the tab of the next tab in the tab list and activates that tab. When focus is in the last tab panel in the tab list, pressing Control+PageUpwill move focus to the first tab in the tab list and activate that tab.

Compatibilty

This plugin is tested against the following browsers:

• Internet Explorer 9 and higher
• Microsoft Edge
• Chrome
• Firefox
• Safari

Testing

Install the project dependencies:

  $ npm install

Run the automated test cases:

  $ npm test