import { ChangeDetectorRef, Component, ComponentFactoryResolver, ComponentRef, ElementRef, EventEmitter, Input, NgZone, Optional, Output, Renderer, ViewChild, ViewEncapsulation, ViewContainerRef } from '@angular/core'; import { App } from '../app/app'; import { Config } from '../../config/config'; import { DeepLinker } from '../../navigation/deep-linker'; import { DomController } from '../../platform/dom-controller'; import { GestureController } from '../../gestures/gesture-controller'; import { isTrueProperty } from '../../util/util'; import { Keyboard } from '../../platform/keyboard'; import { NavControllerBase } from '../../navigation/nav-controller-base'; import { NavOptions } from '../../navigation/nav-util'; import { Platform } from '../../platform/platform'; import { TabButton } from './tab-button'; import { Tabs } from './tabs'; import { TransitionController } from '../../transitions/transition-controller'; import { ViewController } from '../../navigation/view-controller'; /** * @name Tab * @description * The Tab component, written ``, is styled based on the mode and should * be used in conjunction with the [Tabs](../Tabs/) component. * * Each `ion-tab` is a declarative component for a [NavController](../../../navigation/NavController/). * Basically, each tab is a `NavController`. For more information on using * navigation controllers take a look at the [NavController API Docs](../../../navigation/NavController/). * * See the [Tabs API Docs](../Tabs/) for more details on configuring Tabs. * * @usage * * To add a basic tab, you can use the following markup where the `root` property * is the page you want to load for that tab, `tabTitle` is the optional text to * display on the tab, and `tabIcon` is the optional [icon](../../icon/Icon/). * * ```html * * * * ``` * * Then, in your class you can set `chatRoot` to an imported class: * * ```ts * import { ChatPage } from '../chat/chat'; * * export class Tabs { * // here we'll set the property of chatRoot to * // the imported class of ChatPage * chatRoot = ChatPage; * * constructor() { * * } * } * ``` * * You can also pass some parameters to the root page of the tab through * `rootParams`. Below we pass `chatParams` to the Chat tab: * * ```html * * * * ``` * * ```ts * export class Tabs { * chatRoot = ChatPage; * * // set some user information on chatParams * chatParams = { * user1: "admin", * user2: "ionic" * }; * * constructor() { * * } * } * ``` * * And in `ChatPage` you can get the data from `NavParams`: * * ```ts * export class ChatPage { * constructor(navParams: NavParams) { * console.log("Passed params", navParams.data); * } * } * ``` * * Sometimes you may want to call a method instead of navigating to a new * page. You can use the `(ionSelect)` event to call a method on your class when * the tab is selected. Below is an example of presenting a modal from one of * the tabs. * * ```html * * * * ``` * * ```ts * export class Tabs { * constructor(public modalCtrl: ModalController) { * * } * * chat() { * let modal = this.modalCtrl.create(ChatPage); * modal.present(); * } * } * ``` * * * @demo /docs/demos/src/tabs/ * @see {@link /docs/components#tabs Tabs Component Docs} * @see {@link ../../tabs/Tabs Tabs API Docs} * @see {@link ../../nav/Nav Nav API Docs} * @see {@link ../../nav/NavController NavController API Docs} */ @Component({ selector: 'ion-tab', template: '
', host: { '[attr.id]': '_tabId', '[attr.aria-labelledby]': '_btnId', 'role': 'tabpanel' }, encapsulation: ViewEncapsulation.None, }) export class Tab extends NavControllerBase { /** * @hidden */ _isInitial: boolean; /** * @hidden */ _isEnabled: boolean = true; /** * @hidden */ _isShown: boolean = true; /** * @hidden */ _tabId: string; /** * @hidden */ _btnId: string; /** * @hidden */ _loaded: boolean; /** * @hidden */ isSelected: boolean; /** * @hidden */ btn: TabButton; /** * @hidden */ _tabsHideOnSubPages: boolean; /** * @input {Page} Set the root page for this tab. */ @Input() root: any; /** * @input {object} Any nav-params to pass to the root page of this tab. */ @Input() rootParams: any; /** * @input {string} The URL path name to represent this tab within the URL. */ @Input() tabUrlPath: string; /** * @input {string} The title of the tab button. */ @Input() tabTitle: string; /** * @input {string} The icon for the tab button. */ @Input() tabIcon: string; /** * @input {string} The badge for the tab button. */ @Input() tabBadge: string; /** * @input {string} The badge color for the tab button. */ @Input() tabBadgeStyle: string; /** * @input {boolean} If true, enable the tab. If false, * the user cannot interact with this element. * Default: `true`. */ @Input() get enabled(): boolean { return this._isEnabled; } set enabled(val: boolean) { this._isEnabled = isTrueProperty(val); } /** * @input {boolean} If true, the tab button is visible within the * tabbar. Default: `true`. */ @Input() get show(): boolean { return this._isShown; } set show(val: boolean) { this._isShown = isTrueProperty(val); } /** * @input {boolean} If true, swipe to go back is enabled. */ @Input() get swipeBackEnabled(): boolean { return this._sbEnabled; } set swipeBackEnabled(val: boolean) { this._sbEnabled = isTrueProperty(val); } /** * @input {boolean} If true, hide the tabs on child pages. */ @Input() get tabsHideOnSubPages(): boolean { return this._tabsHideOnSubPages; } set tabsHideOnSubPages(val: boolean) { this._tabsHideOnSubPages = isTrueProperty(val); } /** * @output {Tab} Emitted when the current tab is selected. */ @Output() ionSelect: EventEmitter = new EventEmitter(); constructor( parent: Tabs, app: App, config: Config, plt: Platform, keyboard: Keyboard, elementRef: ElementRef, zone: NgZone, renderer: Renderer, cfr: ComponentFactoryResolver, private _cd: ChangeDetectorRef, gestureCtrl: GestureController, transCtrl: TransitionController, @Optional() private linker: DeepLinker, private _dom: DomController, ) { // A Tab is a NavController for its child pages super(parent, app, config, plt, keyboard, elementRef, zone, renderer, cfr, gestureCtrl, transCtrl, linker, _dom); this.id = parent.add(this); this._tabsHideOnSubPages = config.getBoolean('tabsHideOnSubPages'); this._tabId = 'tabpanel-' + this.id; this._btnId = 'tab-' + this.id; } /** * @hidden */ @ViewChild('viewport', {read: ViewContainerRef}) set _vp(val: ViewContainerRef) { this.setViewport(val); } /** * @hidden */ ngOnInit() { this.tabBadgeStyle = this.tabBadgeStyle ? this.tabBadgeStyle : 'default'; } /** * @hidden */ load(opts: NavOptions, done?: Function) { if (!this._loaded && this.root) { this.setElementClass('show-tab', true); this.push(this.root, this.rootParams, opts, done); this._loaded = true; } else { // if this is not the Tab's initial load then we need // to refresh the tabbar and content dimensions to be sure // they're lined up correctly this._dom.read(() => { this.resize(); }); done(true); } } /** * @hidden */ resize() { const active = this.getActive(); if (!active) { return; } const content = active.getIONContent(); content && content.resize(); } /** * @hidden */ _viewAttachToDOM(viewCtrl: ViewController, componentRef: ComponentRef, viewport: ViewContainerRef) { const isTabSubPage = (this._tabsHideOnSubPages && viewCtrl.index > 0); if (isTabSubPage) { viewport = this.parent.portal; } super._viewAttachToDOM(viewCtrl, componentRef, viewport); if (isTabSubPage) { // add the .tab-subpage css class to tabs pages that should act like subpages const pageEleRef = viewCtrl.pageRef(); if (pageEleRef) { this._renderer.setElementClass(pageEleRef.nativeElement, 'tab-subpage', true); } } } /** * @hidden */ setSelected(isSelected: boolean) { this.isSelected = isSelected; this.setElementClass('show-tab', isSelected); this.setElementAttribute('aria-hidden', (!isSelected).toString()); if (isSelected) { // this is the selected tab, detect changes this._cd.reattach(); } else { // this tab is not selected, do not detect changes this._cd.detach(); } } /** * @hidden */ get index(): number { return this.parent.getIndex(this); } /** * @hidden */ updateHref(component: any, data: any) { if (this.btn && this.linker) { let href = this.linker.createUrl(this, component, data) || '#'; this.btn.updateHref(href); } } /** * @hidden */ ngOnDestroy() { this.destroy(); } }