Keyboard Accessible Accordion Plugin - jQuery wfAccordion

Keyboard Accessible Accordion Plugin - jQuery wfAccordion
File Size: 8.95 KB
Views Total:
Last Update:
Publish Date:
Official Website: Go to website
License: MIT
   

The jQuery wfAccordion plugin makes it easy to help developers create responsive, accessible accordions for sectioned content or FAQs.

How It Works:

  • Enhance triggers and panels with ARIA attributes: aria-expanded, aria-hidden, aria-disabled.
  • Create unique IDs for use in ARIA relationships: aria-controls, aria-labelledby.
  • Create ARIA relationships between headers and panels.
  • Update ARIA states on click/tap.
  • Enhance a given placeholder element with a <button> for better keyboard support.

Keyboard support:

  • Open/close accordion panels using up / down arrows as well as Ctrl + Page Up / Page Down keys
  • Focus the first accordion using End key.
  • Focus the last accordion using Home key.

How To Use It:

1. To get started, include the wf.accordion.js script after jQuery.

<script src="/path/to/jquery.min.js"></script>
<script src="/path/to/wf.accordion.js"></script>

2. Build the HTML structure for the accordion.

<div class="wf-accordion-group js-accordion-group">

  <div class="wf-accordion js-accordion">
    <div class="wf-accordion__header js-accordion__header">
      <h3 class="wf-accordion__trigger js-accordion__trigger">Accordion 1</h3>
    </div>
    <div class="wf-accordion__panel js-accordion__panel">
      Accordion Panel 1
    </div>
  </div>

  <div class="wf-accordion js-accordion">
    <div class="wf-accordion__header js-accordion__header">
      <h3 class="wf-accordion__trigger js-accordion__trigger">Accordion 2</h3>
    </div>
    <div class="wf-accordion__panel js-accordion__panel">
      Accordion Panel 2
    </div>
  </div>

  <div class="wf-accordion js-accordion">
    <div class="wf-accordion__header js-accordion__header">
      <h3 class="wf-accordion__trigger js-accordion__trigger">Accordion 3</h3>
    </div>
    <div class="wf-accordion__panel js-accordion__panel">
      Accordion Panel 3
    </div>
  </div>

  ...

</div>

3. Call the plugin on the top container.

$(function(){
  $('.js-accordion-group').wfAccordion();
});

4. Apply your own CSS styles to the accordion.

/**
* Accordion example styles
*/

.wf-accordion-group {
  margin-top: 15px;
}

/* All elements succeeding an accordion group use margin-top to create white space */
.wf-accordion-group + * {
  margin-top: 30px;
}

/* All accordions have borders… */
.wf-accordion {
  border-top: 1px solid #bfbfbf;
  border-bottom: 1px solid #bfbfbf;
}

/* …unless they directly succeed another accordion, in which case we reset the top-border
to avoid duplicate white space */
.wf-accordion + .wf-accordion {
  border-top-width: 0;
}

.wf-accordion__header {
  color: #616161;
}

/* Please note: The trigger element is a <button> create via JS. To achieve consistent aesthetics,
 the native button styles have to be resetted here */
.wf-accordion__trigger {
  /* baseline resets */
  background: transparent;
  border-width: 0;
  border-radius: 0;
  box-sizing: border-box;
  cursor: pointer;
  display: inline-block;
  font-size: inherit;
  letter-spacing: inherit;
  line-height: inherit;
  margin: 0;
  padding: 0;
  text-align: left;
  text-decoration: none;
  /* end of baseline resets */

  /* additional styles for the demo */
  display: block;
  padding: 10px 1.25em 10px 8px;
  position: relative;
  width: 100%;
}

.wf-accordion__trigger::after {
  content: '';
  border: solid #bfbfbf;
  border-width: 0 2px 2px 0;
  height: 0.5em;
  position: absolute;
  right: 10px;
  top: 50%;
  transform: translateY(-60%) rotate(45deg);
  width: 0.5em;
}

.wf-accordion__trigger[aria-disabled=true] {
  cursor: not-allowed;
  opacity: 0.5;
}

.wf-accordion__trigger[aria-expanded=true]::after {
  transform: translateY(-30%) rotate(-135deg);
}

.wf-accordion__trigger:hover,
.wf-accordion__trigger:focus {
  background: #f5f5f5;
  color: #161616;
}

.wf-accordion__trigger:hover::after,
.wf-accordion__trigger:focus::after {
  border-color: #161616;
}

.wf-accordion__panel {
  background-color: #fff;
  padding: 10px 8px;
}

.wf-accordion__panel[aria-hidden=true] {
  display: none;
}

5. Override the default CSS selectors.

$('.js-accordion-group').wfAccordion({
  accordionGroup: '.js-accordion-group',
  accordionHeader: '.js-accordion__header',
  accordionTrigger: '.js-accordion__trigger',
  accordionPanel: '.js-accordion__panel',
  accordionIsOpenClass: 'js-accordion--is-expanded'
});

Changelog:

2019-08-24

  • Avoid race condition and simplify selector

This awesome jQuery plugin is developed by webfactory. For more Advanced Usages, please check the demo page or visit the official website.