Forked in order to do this: kanety#1
Since then I've also changed the behavior (and tests) so that toggling one section open does not automatically close the others, unless you set data-accordion-autoclose-param='on'
in the containing div.
First, rebase our fork on the latest stable version.
If you update this fork you'll need to remember two things to make sure your project is actually using it:
- Run
npm run build
in this repo and include the resulting builds in your update. - Update the commit sha in the other project's package.json to point to the one you want to use (if you are using the commit-sha way of specifying the version).
A stimulus controller for simple accordion menu.
- @hotwired/stimulus 3.0
Install from npm:
$ npm install @kanety/stimulus-accordion --save
Register controller:
import { Application } from '@hotwired/stimulus';
import AccordionController from '@kanety/stimulus-accordion';
const application = Application.start();
application.register('accordion', AccordionController);
Import css:
@import '@kanety/stimulus-accordion';
Build html as follows:
<div class="st-accordion" data-controller="accordion">
<div><a href="#content1" class="st-accordion__icon" data-action="accordion#toggle">Content 1</a></div>
<div class="st-accordion__content" data-accordion-id="content1">
<p>content 1</p>
</div>
<div><a href="#content2" class="st-accordion__icon" data-action="accordion#toggle">Content 2</a></div>
<div class="st-accordion__content" data-accordion-id="content2">
<p>content 2</p>
</div>
</div>
Save opened state to sessionStorage
:
<div data-controller="accordion"
data-accordion-store-key-value="YOUR_KEY">
</div>
You can change header text of accordion when opened or closed:
<div data-controller="accordion">
<div><a href="#content1"
data-action="accordion#toggle"
data-accordion-opened-text-param="Opened Content 1"
data-accordion-closed-text-param="Closed Content 1">Content 1</a></div>
</div>
Run callbacks when a content is opened or closed:
let element = document.querySelector('[data-controller="accordion"]');
element.addEventListener('accordion:opened', (e) => {
// e.detail.toggler: clicked element
// e.detail.content: opened content
console.log('opened: ' + e.detail.content.getAttribute('data-accordion-id'));
});
element.addEventListener('accordion:closed', (e) => {
// e.detail.toggler: clicked element
// e.detail.content: closed content
console.log('closed: ' + e.detail.content.getAttribute('data-accordion-id'));
});
The library is available as open source under the terms of the MIT License.