Badger Accordion

An accessible light weight, vanilla JavaScript accordion with an extensible API. Just 6.14kb and Gzipped 1.86kb!

• Demo site
• Codepen demo

Contents

• The idea
  • Key terminologies
• Basic setup
  • Download plugin
  • Markup
  • Styles
  • Create new instance of Badger Accordion
• Options
• Methods
• Sponsors
• Contributors
• Roadmap

The idea

• To make an accessible, animated, accordion with an extensible API.
• Make it using just plain vanilla JavaScript.
• Ensure that it has just plain simple css. Enough to get it to work. Not too much that you have to spend ages overwriting it.
• Ensure that it is accessible as possible.

Key terminologies

• panel - The section of the accordion than opens and closes
• header - The button that opens an accordion panel

Basic setup

Download plugin

You can download the plugin using NPM or direct download from Github

• NPM:npm i -D badger-accordion
• Yarn:yarn add badger-accordion
• Direct download:Direct download link

You'll need to import the plugin and create a new instance so you can use it. There is a working example in the example directory (shock horror!) if you'd like something to reference.

1. Create your markup
2. Include the basic styles (which are in dist/badger-accordion.css or dist/badger-accordion.css)
3. Import badger-accordion.js
4. Create new instance of the accordion

Markup

There is no fixed structure required for your markup, in my examples I have used a dl (as the WAI-ARIA Authoring Practices guide used it in their example). You will need to add 5 selectors for the plugin to work. The selectors listed below are the default selectors but can all be over written using the plugins options.

1. The containing element, dl, .js-badger-accordion
2. The header element, button, .js-badger-accordion-header
3. The panel element, dd, .js-badger-accordion-panel
4. The panel inner element, div, .js-badger-accordion-panel-inner
5. The panel element for targeting with CSS, div, .badger-accordion__panel .

While you could use the selector from point 3 I would not recommend doing this. For keeping everything nice and separated best to use a different selector for targeting with CSS & JS.

<dl class="js-badger-accordion">
    <dt>
        <button class="js-badger-accordion-header">
            Header Content
        </button>
    </dt>
    <dd class="badger-accordion__panel js-badger-accordion-panel">
        <div class="js-badger-accordion-panel-inner">
            Panel Content
        </div>
    </dd>
</dl>

Styles

I have created some simple CSS styles to help you with creating an accordion which are in dist/badger-accordion-demo.css or dist/badger-accordion-demo.scss. If you'd like some additional styles checkout the example dir.

.badger-accordion--initalised .badger-accordion__panel {
    max-height: 0;
}
.badger-accordion--initalised .badger-accordion__panel.is-active {
    max-height: 75vh;
}
.badger-accordion--initalised .badger-accordion__panel.is-hidden {
    max-height: 0 !important;
}
.badger-accordion--initalised .badger-accordion__panel {
    transition: all ease-in-out 0.2s;
}
.badger-accordion__panel {
    overflow: hidden;
}

Create new instance of Badger Accordion

Please note that currently the Array.from polyfill is being included as standard (but wrapped in a conditional check). If this is an issue for you or you have an awesome idea of how to include it please get in touch.

import BadgerAccordion from 'badger-accordion';

// Creating a new instance of the accordion
const accordion = new BadgerAccordion('.js-badger-accordion');

Options

The accordion has a selection of options that you can overwrite. For example if you wanted to open the first and 4th panel when the accordion is initalised;

new BadgerAccordion('.js-badger-accordion', {
    openHeadersOnLoad: [0, 3]    
});

Methods

The accordion has a series of methods allowing you to have full control over extending the plugin. For example if you wanted to close all your accordion's panels;

accordion.closeAll();

Sponsors

A massive thanks to BrowserStack for supporting me by allowing me to use their platform for free. BrowserStack is a cloud based testing tool that lets you test websites on a wide range web browsers and real mobiles devices. This removes all the hassle of installing chunky VM's. BrowserStack has some great tools such as automated testing, testing local sites (via a browser extension) and taking screenshots.

Contributors

I've had some awesome people help me out building the accordion. I worked in part on this while working at Mr B & Friends big shout out to the digital team there. This wouldn't be anywhere near as good if it wasn't for the wise words of Dave Smith. Finally my favourite digital designer Taavi Kelle who created the AWESOME logo and gave my demo styles some love ^{Steve Richardson™}.

Roadmap

• General performance & naming review
• Create some mixins to help making custom themes quicker & easier
• Create option for callback methods on each public method
• Export an IE9 safe version in the repo
• Create horizontal accordion option