README
Dynamic, flexible and accessible AngularJS tabs.
- Easy to use and customize
- Keyboard accessible
- Works with (or without)
ng-repeat
Demos
Usage
If you use bower or npm, just
bower/npm install v-tabs
. If not, download files from the github repo.Include
angular.js
,angular-animate.js
,v-tabs.js
, andv-tabs.css
:
<link href="v-tabs.css" rel="stylesheet" />
<script src="angular.js"></script>
<script src="angular-animate.js"></script>
<script src="v-tabs.js"></script>
- Add
ngAnimate
andvTabs
as dependencies to your application module:
var myApp = angular.module('myApp', ['ngAnimate', 'vTabs']);
- And put the following markup in your template:
<v-tabs class="vTabs--default" horizontal active="activeTabIndex">
<v-tab>Tab 1</v-tab>
<v-tab>Tab 2</v-tab>
<v-tab>Tab 3</v-tab>
</v-tabs>
<v-pages class="vPages--default" active="activeTabIndex">
<v-page>
<h3>Page 1</h3>
<p>Lorem ipsum dolor sit amet enim. Etiam ullamcorper. Suspendisse a pellentesque dui, non felis.</p>
</v-page>
<v-page>
<h3>Page 2</h3>
<p>Maecenas malesuada elit lectus felis, malesuada ultricies.</p>
</v-page>
<v-page>
<h3>Page 3</h3>
<p>Curabitur et ligula. Ut molestie a, ultricies porta urna.</p>
</v-page>
</v-pages>
- You can also use
v-tabs
withng-repeat
:
<v-tabs class="vTabs--default" horizontal active="activeTabIndex">
<v-tab ng-repeat="page in pages" ng-bind="page.title"></v-tab>
</v-tabs>
<v-pages class="vPages--default" active="activeTabIndex">
<v-page ng-repeat="page in pages" ng-bind="page.content"></v-page>
</v-pages>
API
Control
Use the attribute to control vTabs or vPages from it's parent scope. Here are some of the available methods:
activate(indexOrId)
next()
previous()
<v-tabs class="vTabs--default" control="tabs" active="tabs.active">
<v-tab ng-repeat="page in pages" ng-bind="page.title"></v-tab>
</v-tabs>
<v-pages class="vPages--default" active="tabs.active">
<v-page ng-repeat="page in pages" ng-bind="page.content"></v-page>
</v-pages>
<button type="button" ng-click="tabs.previous()">Previous</button>
<button type="button" ng-click="tabs.next()">Next</button>
Scope
To control the directive from it's transcluded scope, use the following properties and mathods:
$tabs
next()
previous()
activate(indexOrId)
$tab
isActive()
activate()
$pages
next()
previous()
activate(indexOrId)
$page
isActive()
activate()
Events
The directive emits the following events:
vTabs:onReady
oryourTabsId:onReady
vPages:onReady
oryourPagesId:onReady
Configuration
SCSS
If you are using SASS, you can import vTabs.scss file and override the following variables:
// Tabs
$v-tabs-default-theme: true !default;
$v-tabs-spacing: 20px !default;
$v-tabs-default-color: #D8D8D8 !default;
$v-tabs-active-color: #2196F3 !default;
$v-tabs-tab-min-width: 100px !default;
$v-tabs-hover-animation-duration: 0.25s !default;
$v-tabs-enter-animation-duration: 0.5s !default;
$v-tabs-leave-animation-duration: 0.25s !default;
$v-tabs-disabled-opacity: 0.6 !default;
// Pages
$v-pages-default-theme: true !default;
$v-pages-spacing: 20px !default;
$v-pages-enter-animation-duration: 0.5s !default;
$v-pages-leave-animation-duration: 0.25s !default;
Accessibility
vTabs manages keyboard focus and adds some common aria-* attributes. BUT you should additionally place the aria-controls
and aria-labelledby
:
<v-tabs class="vTabs--default" horizontal control="tabs" active="tabs.active">
<v-tab id="tab0{{$index}}" aria-controls="page0{{$index}}" ng-repeat="page in pages" ng-bind="page.title"></v-tab>
</v-tabs>
<v-pages class="vPages--default" active="tabs.active">
<v-page id="page0{{$index}}" aria-labelledby="tab0{{$index}}" ng-repeat="page in pages" ng-bind="page.content"></v-page>
</v-pages>