Tabs
Example
<ul class="nav nav-tabs" role="tablist">
<li class="nav-item">
<bs-button tabindex="-1">
<a class="nav-link active" data-toggle="tab" href="#tab1" role="tab" aria-controls="home" aria-selected="true">Tab 1</a>
</bs-button>
</li>
<li class="nav-item">
<bs-button tabindex="-1">
<a class="nav-link" data-toggle="tab" href="#tab2" role="tab" aria-controls="profile" aria-selected="false">Tab 2</a>
</bs-button>
</li>
<li class="nav-item">
<bs-button tabindex="-1">
<a class="nav-link" data-toggle="tab" href="#tab3" role="tab" aria-controls="contact" aria-selected="false">Tab 3</a>
</bs-button>
</li>
</ul>
<div class="tab-content">
<bs-tab class="tab-pane fade show active" id="tab1" role="tabpanel" aria-labelledby="tab1-tab">
Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.
</bs-tab>
<bs-tab class="tab-pane fade" id="tab2" role="tabpanel" aria-labelledby="tab2-tab">
Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots in a piece of classical Latin literature from 45 BC, making it over 2000 years old. Richard McClintock, a Latin professor at Hampden-Sydney College in Virginia, looked up one of the more obscure Latin words, consectetur, from a Lorem Ipsum passage, and going through the cites of the word in classical literature, discovered the undoubtable source. Lorem Ipsum comes from sections 1.10.32 and 1.10.33 of "de Finibus Bonorum et Malorum" (The Extremes of Good and Evil) by Cicero, written in 45 BC. This book is a treatise on the theory of ethics, very popular during the Renaissance. The first line of Lorem Ipsum, "Lorem ipsum dolor sit amet..", comes from a line in section 1.10.32.
</bs-tab>
<bs-tab class="tab-pane fade" id="tab3" role="tabpanel" aria-labelledby="tab3-tab">
It is a long established fact that a reader will be distracted by the readable content of a page when looking at its layout. The point of using Lorem Ipsum is that it has a more-or-less normal distribution of letters, as opposed to using 'Content here, content here', making it look like readable English. Many desktop publishing packages and web page editors now use Lorem Ipsum as their default model text, and a search for 'lorem ipsum' will uncover many web sites still in their infancy. Various versions have evolved over the years, sometimes by accident, sometimes on purpose (injected humour and the like).
</bs-tab>
</div>
Without bs-components
Without the bs-tab tag a tab will not open or close by itself. Without the bs-button tag the tab data-togglers will not automatically trigger the tabs to change.
Attributes
Attribute | Type | Default | Description |
---|---|---|---|
show-tab | boolean | false | when set to true the tab will toggle itself open and any other currently open tab closed |
ignore-data-toggles | boolean | false | if set to true the tab will not toggle the add the active or show classes to the data-toggle for the currently open tab. also the area-selected attribute will not be set to true |
dispatch-events-on-tab | boolean | false | Normally the events are fired on the data-toggle tags. This is how it works normally in jQuery bootstrap (events fire on the togglers). If the dispatch-events-on-tab attribute is set to true then the events will instead be dispatched on the bs-tab tag instead of the togglers. |
Example js how to set an attribute true:
document.querySelector('#my-tab').setAttribute('show-tab', true);
Example HTML with an attribute set to true. The 3rd tab (messages) will start opened even though the 1st tab (home) has the active classes (look for the show-tab
attribute).
<div class="row">
<div class="col-3">
<div class="nav flex-column nav-pills" id="v-pills-tab" role="tablist" aria-orientation="vertical">
<bs-button tabindex="-1"><a class="nav-link active" id="v-pills-home-tab" data-toggle="pill" href="#v-pills-home" role="tab" aria-controls="v-pills-home" aria-selected="true">Home</a></bs-button>
<bs-button tabindex="-1"><a class="nav-link" id="v-pills-profile-tab" data-toggle="pill" href="#v-pills-profile" role="tab" aria-controls="v-pills-profile" aria-selected="false">Profile</a></bs-button>
<bs-button tabindex="-1"><a class="nav-link" id="v-pills-messages-tab" data-toggle="pill" href="#v-pills-messages" role="tab" aria-controls="v-pills-messages" aria-selected="false">Messages</a></bs-button>
<bs-button tabindex="-1"><a class="nav-link" id="v-pills-settings-tab" data-toggle="pill" href="#v-pills-settings" role="tab" aria-controls="v-pills-settings" aria-selected="false">Settings</a></bs-button>
</div>
</div>
<div class="col-9">
<div class="tab-content" id="v-pills-tabContent">
<bs-tab class="tab-pane fade show active" id="v-pills-home" role="tabpanel" aria-labelledby="v-pills-home-tab">tab1</bs-tab>
<bs-tab class="tab-pane fade" id="v-pills-profile" role="tabpanel" aria-labelledby="v-pills-profile-tab">tab2</bs-tab>
<bs-tab show-tab class="tab-pane fade" id="v-pills-messages" role="tabpanel" aria-labelledby="v-pills-messages-tab">tab3</bs-tab>
<bs-tab class="tab-pane fade" id="v-pills-settings" role="tabpanel" aria-labelledby="v-pills-settings-tab">tab4</bs-tab>
</div>
</div>
</div>
Methods
.tab('show');
will open the tab. Note: this can be run on the bs-button
tag that has the tab data-toggle as well as the bs-tab
tag itself. The method will not work on items nested within the tags it must be run on the bs-tab
or bs-button
tags themselves.
<bs-button tabindex="-1" id="home-tab-toggle-wrapper">
<a class="nav-item nav-link active" id="nav-home-tab" data-toggle="tab" href="#nav-home" role="tab" aria-controls="nav-home" aria-selected="true">Home</a>
</bs-button>
document.querySelector('#home-tab-toggle-wrapper').tab('show');
Events
Note: You have the ability to use the attribute dispatch-events-on-tab
to change where the events are dispatched (either data-togglers or tabs).
Event Type | Description |
---|---|
show.bs.tab | This event fires on tab show, but before the new tab has been shown. Use event.target and event.relatedTarget to target the active tab and the previous active tab (if available) respectively. |
shown.bs.tab | This event fires on tab show after a tab has been shown. Use event.target and event.relatedTarget to target the active tab and the previous active tab (if available) respectively. |
hide.bs.tab | This event fires when a new tab is to be shown (and thus the previous active tab is to be hidden). Use event.target and event.relatedTarget to target the current active tab and the new soon-to-be-active tab, respectively. |
hidden.bs.tab | This event fires after a new tab is shown (and thus the previous active tab is hidden). Use event.target and event.relatedTarget to target the previous active tab and the new active tab, respectively. |
function handleTabShown(event) {
console.log('newly activated tab: ', event.target);
console.log('previous active tab: ', event.relatedTarget);
}
const allTabTogglersOnThePage = document.querySelectorAll('[data-toggle="tab"], [data-toggle="pill"], [data-toggle="list"]');
Array.prototype.forEach.call(allTabTogglersOnThePage, function(element, index) {
element.addEventListener('shown.bs.tab', handleTabShown);
});
Event Renaming Attributes
Attribute | Default |
---|---|
show-event-name | show.bs.tab |
shown-event-name | shown.bs.tab |
hide-event-name | hide.bs.tab |
hidden-event-name | hidden.bs.tab |
<nav>
<div class="nav nav-tabs" id="nav-tab" role="tablist">
<bs-button tabindex="-1">
<a class="nav-item nav-link active" id="nav-home-tab" data-toggle="tab" href="#nav-home" role="tab" aria-controls="nav-home" aria-selected="true">Home</a>
</bs-button>
<bs-button tabindex="-1">
<a class="nav-item nav-link" id="nav-profile-tab" data-toggle="tab" href="#nav-profile" role="tab" aria-controls="nav-profile" aria-selected="false">Profile</a>
</bs-button>
<bs-button tabindex="-1">
<a class="nav-item nav-link" id="nav-contact-tab" data-toggle="tab" href="#nav-contact" role="tab" aria-controls="nav-contact" aria-selected="false">Contact</a>
</bs-button>
</div>
</nav>
<div class="tab-content" id="nav-tabContent">
<bs-tab hidden-event-name="home-tab-hidden" class="tab-pane fade show active" id="nav-home" role="tabpanel" aria-labelledby="nav-home-tab">
Home Tab Content
</bs-tab>
<bs-tab class="tab-pane fade" id="nav-profile" role="tabpanel" aria-labelledby="nav-profile-tab">
Profile Tab Content
</bs-tab>
<bs-tab shown-event-name="contact-tab-shown" class="tab-pane fade" id="nav-contact" role="tabpanel" aria-labelledby="nav-contact-tab">
Contact Tab Content
</bs-tab>
</div>
document.getElementById("#nav-home-tab").addEventListener('home-tab-hidden', function(event) {
console.log('The home tab is hidden');
});
document.getElementById("#nav-contact-tab").addEventListener('contact-tab-shown', function(event) {
console.log('The contact tab is shown');
});
Virtual DOM example
Note: This example uses Vue but the same thing is possible in React, Angular, and plain JavaScript.
Toggle Home Tab Open using show-tab attribute
Toggle Profile Tab Open using show-tab attribute
Toggle Contact Tab Open using show-tab attribute
Home Tab is shown
Profile Tab is hidden
Contact Tab is hidden
<template>
<div>
<ul class="nav nav-tabs" role="tablist">
<li class="nav-item">
<bs-button tabindex="-1">
<a class="nav-link" data-toggle="tab" href="#home" role="tab" aria-controls="home" aria-selected="true">Home</a>
</bs-button>
</li>
<li class="nav-item">
<bs-button tabindex="-1">
<a class="nav-link" data-toggle="tab" href="#profile" role="tab" aria-controls="profile" aria-selected="false">Profile</a>
</bs-button>
</li>
<li class="nav-item">
<bs-button tabindex="-1">
<a class="nav-link" data-toggle="tab" href="#contact" role="tab" aria-controls="contact" aria-selected="false">Contact</a>
</bs-button>
</li>
</ul>
<div class="tab-content" id="myTabContent">
<bs-tab class="tab-pane fade" id="home" role="tabpanel" aria-labelledby="home-tab"
v-bind:show-tab="this.toggleActiveState.homeTab"
dispatch-events-on-tab
shown-event-name="tab-shown" v-on:tab-shown="(event) => this.$set(this.toggleActiveState, 'homeTab', true)"
hide-event-name="tab-hide" v-on:tab-hide="(event) => this.$set(this.toggleActiveState, 'homeTab', false)"
>
Lorem ipsum dolor sit amet
</bs-tab>
<bs-tab class="tab-pane fade" id="profile" role="tabpanel" aria-labelledby="profile-tab"
v-bind:show-tab="this.toggleActiveState.profileTab"
dispatch-events-on-tab
shown-event-name="tab-shown" v-on:tab-shown="(event) => this.$set(this.toggleActiveState, 'profileTab', true)"
hide-event-name="tab-hide" v-on:tab-hide="(event) => this.$set(this.toggleActiveState, 'profileTab', false)"
>
Sed ut perspiciatis unde omnis
</bs-tab>
<bs-tab class="tab-pane fade" id="contact" role="tabpanel" aria-labelledby="contact-tab"
v-bind:show-tab="this.toggleActiveState.contactTab"
dispatch-events-on-tab
shown-event-name="tab-shown" v-on:tab-shown="(event) => this.$set(this.toggleActiveState, 'contactTab', true)"
hide-event-name="tab-hide" v-on:tab-hide="(event) => this.$set(this.toggleActiveState, 'contactTab', false)"
>
At vero eos et accusamus et iusto odio
</bs-tab>
</div>
<hr>
<p>
<a class="btn btn-link" v-bind:class="{ disabled: this.toggleActiveState.homeTab }" href="#" role="button" v-on:click.stop.prevent="toggleActiveState.homeTab = true">
Toggle Home Tab Open using show-tab attribute
</a>
</p>
<p>
<a class="btn btn-link" v-bind:class="{ disabled: this.toggleActiveState.profileTab }" href="#" role="button" v-on:click.stop.prevent="toggleActiveState.profileTab = true">
Toggle Profile Tab Open using show-tab attribute
</a>
</p>
<p>
<a class="btn btn-link" v-bind:class="{ disabled: this.toggleActiveState.contactTab }" href="#" role="button" v-on:click.stop.prevent="toggleActiveState.contactTab = true">
Toggle Contact Tab Open using show-tab attribute
</a>
</p>
<hr>
<p>Home Tab is <span v-if="this.toggleActiveState.homeTab">shown</span><span v-else>hidden</span></p>
<p>Profile Tab is <span v-if="this.toggleActiveState.profileTab">shown</span><span v-else>hidden</span></p>
<p>Contact Tab is <span v-if="this.toggleActiveState.contactTab">shown</span><span v-else>hidden</span></p>
</div>
</template>
<script>
export default {
name: 'toggle-tab',
data() {
return {
toggleActiveState: {
homeTab: true,
profileTab: false,
contactTab: false,
},
};
},
}
</script>