Easy to use tabs plugin for jQuery & Zepto.js
![Code climate](https://img.shields.io/codeclimate/github/elboletaire/tabbedcontent.svg?style=flat-square)
![Sauce labs](https://badges.herokuapp.com/sauce/elboletaire?name=tabbedcontent&style=flat-square)
TabbedContent is a lightweight* tabs plugin that uses the HTML5 history API to
add your tab navigation to your browser's history.
* 3 KB minified, 1.25 KB gzipped/deflated
It is compatible with both jQuery and Zepto.js libraries.
It also has an API that will let you switch between tabs externally.
Online Demos
Installation
Using bower
bower install --save tabbedcontent
Using npm
npm install tabbedcontent
Usage
Basic layout:
<ul>
<li><a href="#tab-1">Tab 1</a></li>
<li><a href="#tab-2">Tab 2</a></li>
<li><a href="#tab-3">Tab 3</a></li>
<li><a href="#tab-n">Tab N</a></li>
</ul>
<div class="tabscontent">
<div id="tab-1">
</div>
<div id="tab-2">
</div>
<div id="tab-3">
</div>
<div id="tab-n">
</div>
</div>
The links of the tabs should point to each tab id.
Basic javascript initialization:
$('.tabscontent').tabbedContent();
By default the plugin will take the links inside the previous wrapper related to the tabs layer; but you can specify your links selector, so you can put your links everywhere:
<ul class="tabs">
[...]
$('.tabscontent').tabbedContent({
links: 'ul.tabs li a'
})
Using with Zepto.js
You'll need the data
plugin if you want to use the tabbedcontent api.
Error Detector
This option is very practic if you're working with forms and want the tabs be opened on the first one containing an error.
Simply specify the errorSelector
selector:
$('.tabscontent').tabbedContent({
errorSelector : '.error-message'
});
When the plugin initializes it searches for errorSelector
inside tabs content, opening the first tab containing it.
Note that this only works when there's no hash present in the url. If a hash is present its tab will be opened.
Overwriting default tab
If you force a parent's link class to be the one set in options.currentClass
you will force that tab to be opened.
<ul>
<li class="active"><a href="#tab-1">Tab 1</a></li>
<li><a href="#tab-2">Tab 2</a></li>
<li><a href="#tab-3">Tab 3</a></li>
<li><a href="#tab-n">Tab N</a></li>
</ul>
This takes priority over .errorSelector
.
Callbacks & Events
TabbedContent has two callbacks that may be util to you: onInit
and onSwitch
.
$('.tabscontent').tabbedContent({
onInit: function(api) {
console.log('tabs initialized');
console.log('Current tab is ' + api.getCurrent());
},
onSwitch: function(tab, api) {
if (!$(tab + ' textarea').data('wysiwyg-initialized')) {
initWysiwyg(tab + ' textarea');
}
}
})
Additionally these events are emitted on the element, so you can use event listeners:
$('.tabscontent').tabbedContent();
$('.tabscontent').on('tabcontent.init', function(api) {
console.log('tabs initialized');
console.log('Current tab is ' + api.getCurrent());
});
$('.tabscontent').on('tabcontent.switch', function(tab, api) {
if (!$(tab + ' textarea').data('wysiwyg-initialized')) {
initWysiwyg(tab + ' textarea');
}
});
Full configuration
$('.tabscontent').tabbedContent({
links : '.tabs a',
errorSelector : '.error-message',
speed : false,
onSwitch : false,
onInit : false,
currentClass : 'current',
tabErrorClass : 'has-error',
history : true,
historyOnInit : true,
loop : false
});
API
TabbedContent has a simple API that will allow you to switch between tabs.
To use it simply call data('api')
:
var mytabs = $('.tabscontent').tabbedContent().data('api');
mytabs.switch('#tab-1');
mytabs.switch(0);
mytabs.switch('tab-1');
mytabs.switch($('.tabscontent div#tab-1'));
mytabs.next();
mytabs.prev();
var mytabs = $('.tabscontent').tabbedContent({loop: true}).data('api');
mytabs.next(true);
mytabs.prev(true);
if (mytabs.isFirst()) { }
if (mytabs.isLast()) { }
Full API
{
'switch' : function apiSwitch(tab) {},
'switchTab' : function apiSwitch(tab) {},
'getCurrent' : function getCurrent() {},
'getTab' : function getTab(tab) {},
'next' : function next(loop) {},
'prev' : function prev(loop) {},
'isFirst' : function isFirst() {},
'isLast' : function isLast() {}
};
License
The MIT License (MIT)
Copyright (c) 2015-2017 Òscar Casajuana <elboletaire at underave dot net>
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.