lintel-contrib-navs

Navigation tools for lintel.

Getting Started

This module requires Lintel.

If you haven't used Lintel before, be sure to check out the Getting Started guide, as it explains how to install and use this module. Once you're familiar with that process, you may install this module with this command:

bower install lintel-contrib-navs --save

Once the module has been installed, you will have to load it in your main SASS file:

@import "bower_components/lintel-contrib-navs/sass/navs.scss"

This module also includes a JavaScript component, which you will have to load separately.

<script src="bower_components/lintel-contrib-navs/dist/navs.min.js" type="text/javascript"></script>

You can use wiredep or grunt-wiredep to automatically inject files in your build process.

Variables

Check the vars file in the sass folder to see the full list of variables you can customize.

$nav-padding-y

Default value: $cushion-y-md

Change the default padding-top and padding-bottom.

$nav-padding-x

Default value: $cushion-x-md

Change the default padding-left and padding-right.

$nav-margin-y

Default value: $cushion-y-md

Change the vertical space between nav items.

$nav-padding-x

Default value: 4px

Change the horizontal space between items.

Tab Variables

Tabs prefixed with $nav-tabs-* are tab specific.

$nav-tabs-bg

Tab background.

$nav-tabs-border

Tab border.

$nav-tabs-border-list

Tab-list border.

$nav-tabs-border-radius

Tab border-radius.

$nav-tabs-text

Tab text color.

Use $nav-tabs-active-bg, $nav-tabs-active-border, and $nav-tabs-active-text to customize active colors.

Use $nav-tabs-hover-bg, $nav-tabs-hover-border, and $nav-tabs-hover-text to customize hover colors.

Pills and Flat Variables

Same as tabs except $nav-pills-* and $nav-flat-*.

JavaScript

Options

Name | Type | Default | Description --------- | ------------------------------ | ------------------- | ----------- onShow | function | | Callback function to execute every time tab is shown. onHide | function | | Callback function to execute every time tab is hidden. show | boolean | true | Show tab when invoking .tab()

Events

Event | Description -------------------- | ------------------------------ show.lt.tab | Fires immediately before tab is shown. Can prevent tab from showing here. shown.lt.tab | Fires immediately after tab is shown. hide.lt.tab | Fires immediately before tab is hidden. Can prevent tab from hiding here. hidden.lt.tab | Fires immediately after tab is hidden.

Data-attr

Add data-toggle="tab" and data-target="#selector" to a tab. You can add additional options as data-attributes.

<ul class="nav-list nav-tabs" role="tablist">
  <li class="active" role="presentation">
    <a href="#home" data-toggle="tab" role="tab" aria-controls="#home" aria-expanded="true">Home</a>
  </li>
  <li role="presentation">
    <a href="#profile" data-toggle="tab" role="tab" aria-controls="#profile" aria-expanded="false">Profile</a>
  </li>
  <li role="presentation">
    <a href="#activity" data-toggle="tab" role="tab" aria-controls="#activity" aria-expanded="false">Activity</a>
  </li>
</ul>

<div class="tab-panel active" id="home" role="tabpanel">...</div>
<div class="tab-panel" id="profile" role="tabpanel" style="display: none;">...</div>
<div class="tab-panel" id="activity" role="tabpanel" style="display: none;">...</div>

jQuery

Call the jQuery plugin on the tab, passing in any options.

var options = {
  onShow: function(tab) {
    console.log('onShow', this, tab);
  },
  onHide: function(tab) {
    console.log('onHide', this, tab);
  }
};

$('#myTabButton').tab(options);

Alternatively, you can use the default options:

$('#myTab').tab('show');

Examples

Tabs

<ul class="nav-list nav-tabs" role="tablist">
  <li class="active" role="presentation">
    <a href="#" data-toggle="tab" role="tab">Home</a>
  </li>
  <li role="presentation">
    <a href="#" data-toggle="tab" role="tab">Profile</a>
  </li>
  <li role="presentation">
    <a href="#" data-toggle="tab" role="tab">Activity</a>
  </li>
</ul>

Vertical Tabs Left

<ul class="nav-list nav-tabs-y nav-tabs-y-left" role="tablist">...</div>

Vertical Tabs Right

<ul class="nav-list nav-tabs-y nav-tabs-y-right" role="tablist">...</div>

Pills

<ul class="nav-list nav-pills" role="tablist">...</div>

Flat

<ul class="nav-list nav-flat" role="tablist">...</div>

Tabs with Content

Keep the following in mind:

• <ul>s should have role="tablist"
• <li>s should have role="presentation"
  • class of .active if active
• <a>s should have data-toggle="tab" or be activated manually through js
  • href should point to the id of the tab it is for
  • role="tab" should be defined
  • aria-controls should point to the id of the tab it is for (same value as href)
  • aria-expanded should be true for the active tab, false for the others
• .tab-panel should have an id of role="tabpanel"
  • class of .active if active
  • style of display: none; if inactive

<ul class="nav-list nav-tabs" role="tablist">
  <li class="active" role="presentation">
    <a href="#home" role="tab" aria-controls="#home" aria-expanded="true">Home</a>
  </li>
  <li role="presentation">
    <a href="#profile" role="tab" aria-controls="#profile" aria-expanded="false">Profile</a>
  </li>
  <li role="presentation">
    <a href="#activity" role="tab" aria-controls="#activity" aria-expanded="false">Activity</a>
  </li>
</ul>

<div class="tab-panel active" id="home" role="tabpanel">
  ...
</div>
<div class="tab-panel" id="profile" role="tabpanel" style="display: none;">
  ...
</div>
<div class="tab-panel" id="activity" role="tabpanel" style="display: none;">
  ...
</div>

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

License

Copyright (c) 2015 Marius Craciunoiu. Licensed under the MIT license.