Package Exports

ionic2-super-tabs

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (ionic2-super-tabs) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Swipeable tabs for Ionic 2

Swipeable tabs that can be your main navigation, or just a part of your page.

To see this in action, checkout the example project here.

Example

Quick Example
How it works
Installation
Usage
Examples
Project goals

Quick Example

<super-tabs height="100%">
  <super-tab [tabRoot]="page1" title="First page"></super-tab>
  <super-tab [tabRoot]="page2" title="Second page"></super-tab>
  <super-tab [tabRoot]="page3" title="Third page"></super-tab>
</super-tabs>

How it works

This module combines ion-segment, ion-slides and some magic to give you swipeable tabs. Each tab has it's own ion-nav, which means they each have their own state, controller ...etc.

Installation

Install the module via NPM

npm i --save ionic2-super-tabs

Import it in your `@NgModule`

import { SuperTabsModule } from 'ionic2-super-tabs';

@NgModule({
    ...
    imports: [
      ...
      SuperTabsModule
      ],
    ...
})

Usage

`super-tabs` Inputs

selectedTabIndex

(optional) The index of the tab that is selected when the component is initialized. Defaults to 0.

rootNavCtrl

(optional) The NavController of the parent page. This is helpful if you want to push new views to the parent page instead of the child page.

toolbarColor

(optional) The color of the toolbar that contains the ion-segment. See colors for more information.

tabsColor

(optional) The color of the ion-segment component. See colors for more information.

sliderColor

(optional) The color of the slider. The slider is the line below the ion-segment that moves according to what tab is selected. See colors for more information. Defaults to primary.

height

The height of super-tabs component. Set this to 100% to fill the whole page, or any other value.

`super-tab` Inputs

tabRoot

The root page for this tab

navParams

(optional) An object containing the params you would like to pass to this tab's root page

title

(optional) The title of the tab to display in the ion-segment-button.

icon

(optional) The name of the icon to display in the ion-segment-button. This has to be a valid ion-icon name.

Colors

All color inputs takes color names like any other Ionic 2 component. Your color name must be defined in the $colors map in your variables.scss file.

Examples

Basic example

export class MyPage {

  page1: any = Page1Page;
  page2: any = Page2Page;
  page3: any = Page3Page;
  
}

<super-tabs height="100%">
  <super-tab [tabRoot]="page1" title="First page"></super-tab>
  <super-tab [tabRoot]="page2" title="Second page"></super-tab>
  <super-tab [tabRoot]="page3" title="Third page"></super-tab>
</super-tabs>

Example with icons

<super-tabs height="100%">
  <super-tab [tabRoot]="page1" title="First page" icon="home"></super-tab>
  <super-tab [tabRoot]="page2" title="Second page" icon="pin"></super-tab>
  <super-tab [tabRoot]="page3" title="Third page" icon="heart"></super-tab>
</super-tabs>

Example with all options

export class MyPage {

  page1: any = Page1Page;
  page2: any = Page2Page;
  page3: any = Page3Page;
  
  constructor(public navCtrl: NavController){}
  
}

<super-tabs height="100%" selectedTabIndex="1" [rootNavCtrl]="navCtrl" tabsColor="light" toolbarColor="dark" sliderColor="light">
  <super-tab [tabRoot]="page1" title="First page" icon="home"></super-tab>
  <super-tab [tabRoot]="page2" title="Second page" icon="pin"></super-tab>
  <super-tab [tabRoot]="page3" title="Third page" icon="heart"></super-tab>
</super-tabs>

Project goals

The main goal of this project is to provide a swipeable tabs component for Ionic 2 apps. The tabs must look and feel like the native material design tabs. The project has successfully achieved this goal, but there are a few improvements in mind:

Disallow "over-swiping" at the begining/end of the tabs. Example: if you are on the first tab and you swipe to the right, the page will move and you will see a blank white area. This is default behaviour of the ion-slides component (Swiper by iDangero.us).
Allow tab swiping. This is useful if you want to have a large number of tabs and there isn't enough room to have all the ion-segment-buttons to show up at the same time.
Experiment with using Angular 2 animations instead of pure CSS. (might provide better performance)
Add a mode option that will be passed to the ion-segment. Currently the mode is set to md to provide consistent experience over all platforms. Some might want to have ios segment buttons instead.

Suggestions and/or Pull Requests are welcome!

ionic2-super-tabs