stimulus-tabs
A stimulus controller for simple tabs.
Dependencies
- @hotwired/stimulus 3.0
Installation
Install from npm:
$ npm install @kanety/stimulus-tabs --save
Usage
Register controller:
import { Application } from '@hotwired/stimulus';
import TabsController from '@kanety/stimulus-tabs';
const application = Application.start();
application.register('tabs', TabsController);Import css:
@import '@kanety/stimulus-tabs';Build html as follows:
<div class="st-tabs" data-controller="tabs">
<ul class="st-tabs__tabs" data-tabs-target="tabs">
<li><a href="#tab1"></li>
<li><a href="#tab2"></li>
</ul>
<div class="st-tabs__panes">
<div data-pane-id="tab1">
<p>tab1 content</p>
</div>
<div data-pane-id="tab2">
<p>tab2 content</p>
</div>
</div>
</div>Options
store-key
Save tab state to sessionStorage:
<div data-controller="tabs"
data-tabs-store-key-value="YOUR_KEY">
</div>Callbacks
let element = document.querySelector('[data-controller="tabs"]')
element.addEventListener('tabs:opened', (e) => {
console.log(e.detail.tab);
console.log(e.detail.pane);
});
element.addEventListener('tabs:closed', (e) => {
console.log(e.detail.tab);
console.log(e.detail.pane);
});License
The library is available as open source under the terms of the MIT License.