Tabs

Create tabbable panes of local content.

Basic usage

<b-tabs>
  <b-tab title="first" active>
    <br>I'm the first fading tab
  </b-tab>
  <b-tab title="second" >
    <br>I'm the second tab content
  </b-tab>
  <b-tab title="disabled" disabled>
    <br>Disabled tab!
  </b-tab>
</b-tabs>

<!-- basic.vue -->

Cards Integration

Tabs support integrating with bootstrap cards. Just add the card property to <b-tabs>. and place it inside a <b-card> component. Note that you should add no-body prop on <b-card> component in order to propertly decorate the card header and remove the extra padding introduced by card-body.

<b-card no-body>
  <b-tabs card>
    <b-tab title="Tab 1" active>
      Tab Contents 1
    </b-tab>
    <b-tab title="Tab 2">
      Tab Contents 2
    </b-tab>
  </b-tabs>
</b-card>

<!-- with-card.vue -->

When <b-tabs> is in card mode, each <b-tab> sub-component will automatically have the card-body class applied (this class provides the padding around the tab content). To disable the card-body class, set the no-body prop on <b-tab> sub component.

<b-card no-body>
  <b-tabs card>
    <b-tab no-body title="Picture 1" active>
      <b-card-img bottom src="https://picsum.photos/600/200/?image=21" />
      <b-card-footer>Picture 1 footer</b-card-footer>
    </b-tab>
    <b-tab no-body title="Picture 2">
      <b-card-img bottom src="https://picsum.photos/600/200/?image=25" />
      <b-card-footer>Picture 2 footer</b-card-footer>
    </b-tab>
    <b-tab no-body title="Picture 3">
      <b-card-img bottom src="https://picsum.photos/600/200/?image=26" />
      <b-card-footer>Picture 3 footer</b-card-footer>
    </b-tab>
    <b-tab title="Text">
      <h5>This tab does not have the <code>no-body</code> prop set</h5>
      Quis magna Lorem anim amet ipsum do mollit sit cillum voluptate ex nulla
      tempor. Laborum consequat non elit enim exercitation cillum aliqua consequat
      id aliqua. Esse ex consectetur mollit voluptate est in duis laboris ad sit
      ipsum anim Lorem. Incididunt veniam velit elit elit veniam Lorem aliqua quis
      ullamco deserunt sit enim elit aliqua esse irure.
    </b-tab>
  </b-tabs>
</b-card>

<!-- with-card-nobody.vue -->

Setting the no-body prop on <b-tab> will have no affect when <b-tabs> is not in card mode (as the card-body class is only set when in card mode).

Pills variant

Tabs use the tabs styling by default. Just add pills property to <b-tabs> for the pill style variant.

<b-card no-body>
  <b-tabs pills card>
    <b-tab title="Tab 1" active>
      Tab Contents 1
    </b-tab>
    <b-tab title="Tab 2">
      Tab Contents 2
    </b-tab>
  </b-tabs>
</b-card>

<!-- tabs-pills.vue -->

Bottom placement of tab controls

Visually move the tab controls to the bottom by setting the prop end

<b-card no-body>
  <b-tabs pills card end>
    <b-tab title="Tab 1" active>
      Tab Contents 1
    </b-tab>
    <b-tab title="Tab 2">
      Tab Contents 2
    </b-tab>
  </b-tabs>
</b-card>

<!-- tabs-bottom.vue -->

Caveats:

  • Bottom placement visually works best with the pills variant. When using the default tabs vairiant, you may want to provided your own custom styling classes, as Bootstrap V4 CSS assumes the tabs will always be placed on the top of the tabs content.
  • To provide a better user experience with bottom palced controls, ensure that the content of each tab pane is the same height and fits completely within the visible viewport, otherwise the user will need to scroll up to read the start of the tabed content.

Note: the bottom prop has been deprecated in favor of the end prop.

Vertical tabs

Have the tab controls placed on the lefthand side by setting the vertical prop to true. Vertical tabs work with or without card mode enabled.

<b-card no-body>
  <b-tabs pills card vertical>
    <b-tab title="Tab 1" active>
      Tab Contents 1
    </b-tab>
    <b-tab title="Tab 2">
      Tab Contents 2
    </b-tab>
    <b-tab title="Tab 3">
      Tab Contents 3
    </b-tab>
  </b-tabs>
</b-card>

<!-- tabs-vertical.vue -->

Visually move the tab controls to the right hand side by setting the end prop:

<b-card no-body>
  <b-tabs pills card vertical end>
    <b-tab title="Tab 1" active>
      Tab Contents 1
    </b-tab>
    <b-tab title="Tab 2">
      Tab Contents 2
    </b-tab>
    <b-tab title="Tab 3">
      Tab Contents 3
    </b-tab>
  </b-tabs>
</b-card>

<!-- tabs-vertical-end.vue -->

The width of the vertical tab controls will expand to fit the width of the tab title. To control the width, set a width utility class via the prop nav-wrapper-class. You can use values such as w-25 (25% width), w-50 (50% width), etc., or column classes such as col-2, col-3, etc.

<b-card no-body>
  <b-tabs pills card vertical nav-wrapper-class="w-50">
    <b-tab title="Tab 1" active>
      Tab Contents 1
    </b-tab>
    <b-tab title="Tab 2">
      Tab Contents 2
    </b-tab>
    <b-tab title="Tab 3">
      Tab Contents 3
    </b-tab>
  </b-tabs>
</b-card>

<!-- tabs-vertical-width.vue -->

Vertical placement visually works best with the pills variant. When using the default tabs vairiant, you may want to provided your own custom styling classes, as Bootstrap V4 CSS assumes the tab controls will always be placed on the top of the tabs content.

Note: overflowing text may occur if your width is narrower than the tab title. You may need additional custom styling.

Fade animation

Fade is enabled by default when changing tabs. It can disabled with no-fade property. Note you should use the <b-nav-item> component when adding contentless-tabs to maintain correct sizing and alignment. See the advanced usage examples below for an example.

Add Tabs without content

If you want to add extra tabs that do not have any content, you can put them in tabs slot:

<b-tabs>
  <!-- Add your b-tab components here-->
  <template slot="tabs">
    <b-nav-item href="#" @click="()=>{}">Another tab</b-nav-item>
  </template>
</b-tabs>

<!-- tabs-item-slot.vue -->

Add custom content to tab title

If you want to add custom content to tab title, like HTML code, icons, or another Vue component, this possible by using title slot

<b-tabs>
 <b-tab active>
 <!-- Add your custom title here-->
   <template slot="title">
     i'm <i>Custom</i> <strong>Title</strong>
   </template>
      Tab Contents 1
    </b-tab>
</b-tabs>

<!-- tabs-title-slot.vue -->

Apply custom classes to the generated nav-tabs or pills

The tab selectors are based on Boostrap V4's nav markup ( i.e. ul.nav > li.nav-item > a.nav-link). In some situations, you may want to add classes to the <li> (nav-item) and/or the <a> (nav-link) on a per tab basis. To do so, simply supply the classname to the title-item-class prop (for the <li> element) or title-link-class prop (for the <a> element). Value's can be passed as a string or array of strings.

Note: The active class is automatically applied to the active tabs <a> element. You may need to accomodate your custom classes for this.

<template>
  <b-card no-body>
    <b-tabs card v-model="tabIndex">
      <b-tab title="Tab 1" :title-link-class="linkClass(0)">
        Tab Contents 1
      </b-tab>
      <b-tab title="Tab 2" :title-link-class="linkClass(1)">
        Tab Contents 2
      </b-tab>
      <b-tab title="Tab 3" :title-link-class="linkClass(2)">
        Tab Contents 3
      </b-tab>
    </b-tabs>
  </b-card>
</template>

<script>
export default {
  data () {
    return {
      tabIndex: 0
    }
  },
  methods: {
    linkClass (idx) {
      if (this.tabIndex === idx) {
        return ['bg-primary', 'text-light']
      } else {
        return ['bg-light', 'text-info']
      }
    }
  }
}
</script>

<!-- with-classes.vue -->

Keyboard Navigation

Keyboard navigation is enabled by default.

Keypress Action
LEFT or UP Move to the previous non-disabled tab
RIGHT or DOWN Move to the next non-disabled tab
SHIFT+LEFT or SHIFT+UP Move to the first non-disabled tab
SHIFT+RIGHT or SHIFT+DOWN Move to the last non-disabled tab
TAB Move to the next control on the page
SHIFT+TAB Move to the previous control on the page

Disable it by setting the prop no-key-nav. Behavior will now default to standard browser navigation with TAB key.

Keypress Action
TAB Move to the next tab or control on the page
SHIFT+TAB Move to the previous tab or control on the page

Caution: If you have text or text-like inputs in your tabs, leave keyboard navigation off, as it is not possble to use key presses to jump out of a text (or test-like) inputs.

Advanced Examples

External controls

<template>
  <div>
    <!-- Tabs with card integration -->
    <b-card no-body>
      <b-tabs small card v-model="tabIndex">
        <b-tab title="General">
          I'm the first fading tab
        </b-tab>
        <b-tab title="Edit profile">
          I'm the second tab
          <b-card>I'm the card in tab</b-card>
        </b-tab>
        <b-tab title="Premium Plan" disabled>
          Sibzamini!
        </b-tab>
        <b-tab title="Info">
          I'm the last tab
        </b-tab>
      </b-tabs>
    </b-card>

    <!-- Control buttons-->
    <div class="text-center">
      <b-button-group class="mt-2">
        <b-btn @click="tabIndex--">Previous</b-btn>
        <b-btn @click="tabIndex++">Next</b-btn>
      </b-button-group>
      <br>
      <span class="text-muted">Current Tab: {{tabIndex}}</span>
    </div>
  </div>
</template>

<script>
export default {
  data () {
    return {
      tabIndex: 0
    }
  }
}
</script>

<!-- tabs-controls.vue -->

Dynamic Tabs

<template>
  <div>
    <b-card no-body>
      <b-tabs card>
        <!-- Render Tabs -->
        <b-tab :title="`Tab ${i}`" v-for="i in tabs" :key="i">
          Tab Contents {{i}}
          <b-btn size="sm" variant="danger" class="float-right" @click="()=>closeTab(i)">
            Close tab
          </b-btn>
        </b-tab>

        <!-- New Tab Button (Using tabs slot) -->
        <b-nav-item slot="tabs" @click.prevent="newTab" href="#">
          +
        </b-nav-item>

        <!-- Render this if no tabs -->
        <div slot="empty" class="text-center text-muted">
          There are no open tabs
          <br> Open a new tab using + button.
        </div>
      </b-tabs>
    </b-card>

  </div>
</template>

<script>
export default {
  data () {
    return {
      tabs: [],
      tabCounter: 0
    }
  },
  methods: {
    closeTab (x) {
      for (let i = 0; i < this.tabs.length; i++) {
        if (this.tabs[i] === x) {
          this.tabs.splice(i, 1)
        }
      }
    },
    newTab () {
      this.tabs.push(this.tabCounter++)
    }
  }
}
</script>

<!-- dynamic-tabs.vue -->

Component Reference

<b-tabs>

Properties

PropertyTypeDefault Value
idString
tagStringdiv
cardBooleanfalse
smallBooleanfalse
valueNumber
pillsBooleanfalse
verticalBooleanfalse
bottomBooleanfalse
endBooleanfalse
no-fadeBooleanfalse
no-nav-styleBooleanfalse
no-key-navBooleanfalse
lazyBooleanfalse
content-classString or Array or Object
nav-classString or Array or Object
nav-wrapper-classString or Array or Object

Slots

SlotDescription
tabsAdditional tabs without content
emptyRenders this slot if no tabs are present

Events

EventArgumentsDescription
input
tab_index
Emits when a tab is shown. Used to update the v-model
Trying to get native browser events working on your component? Use the .native modifier to capture browser native events such as: @click.native="...", @mouseover.native="...", etc. See the the official Vue.js documentation for more information.

<b-tab>

Properties

PropertyTypeDefault Value
idString
activeBooleanfalse
tagStringdiv
button-idString
titleString
title-item-classString or Array or Object
title-link-classString or Array or Object
head-htmlString
disabledBooleanfalse
no-bodyBooleanfalse
hrefString#

Importing Individual Components

ComponentImport Path
<b-tabs>bootstrap-vue/es/components/tabs/tabs
<b-tab>bootstrap-vue/es/components/tabs/tab

Example:

import bTabs from 'bootstrap-vue/es/components/tabs/tabs';
Vue.component('b-tabs', bTabs);

Importing Tabs as a Vue plugin

This plugin includes all of the above listed individual components. Plugins also include any component aliases.

import { Tabs } from 'bootstrap-vue/es/components';
Vue.use(Tabs);