UNPKG

ionic-angular

Version:

A powerful framework for building mobile and progressive web apps with JavaScript and Angular

391 lines 13 kB
var __extends = (this && this.__extends) || (function () { var extendStatics = Object.setPrototypeOf || ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) || function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; }; return function (d, b) { extendStatics(d, b); function __() { this.constructor = d; } d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __()); }; })(); import { ChangeDetectorRef, Component, ComponentFactoryResolver, ElementRef, ErrorHandler, EventEmitter, Input, NgZone, Optional, Output, Renderer, ViewChild, ViewContainerRef, ViewEncapsulation } 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 { NavControllerBase } from '../../navigation/nav-controller-base'; import { Platform } from '../../platform/platform'; import { Tabs } from './tabs'; import { TransitionController } from '../../transitions/transition-controller'; /** * @name Tab * @description * The Tab component, written `<ion-tab>`, 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 * <ion-tabs> * <ion-tab [root]="chatRoot" tabTitle="Chat" tabIcon="chat"></ion-tab> * </ion-tabs> * ``` * * 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 * <ion-tabs> * <ion-tab [root]="chatRoot" [rootParams]="chatParams" tabTitle="Chat" tabIcon="chat"></ion-tab> * </ion-tabs> * ``` * * ```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 * <ion-tabs> * <ion-tab (ionSelect)="chat()" tabTitle="Show Modal"></ion-tab> * </ion-tabs>pop * ``` * * ```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} */ var Tab = (function (_super) { __extends(Tab, _super); function Tab(parent, app, config, plt, elementRef, zone, renderer, cfr, _cd, gestureCtrl, transCtrl, linker, _dom, errHandler) { var _this = // A Tab is a NavController for its child pages _super.call(this, parent, app, config, plt, elementRef, zone, renderer, cfr, gestureCtrl, transCtrl, linker, _dom, errHandler) || this; _this._cd = _cd; _this.linker = linker; _this._dom = _dom; /** * @hidden */ _this._isEnabled = true; /** * @hidden */ _this._isShown = true; /** * @output {Tab} Emitted when the current tab is selected. */ _this.ionSelect = new EventEmitter(); _this.id = parent.add(_this); _this._tabsHideOnSubPages = config.getBoolean('tabsHideOnSubPages'); _this._tabId = 'tabpanel-' + _this.id; _this._btnId = 'tab-' + _this.id; return _this; } Object.defineProperty(Tab.prototype, "enabled", { /** * @input {boolean} If true, enable the tab. If false, * the user cannot interact with this element. * Default: `true`. */ get: function () { return this._isEnabled; }, set: function (val) { this._isEnabled = isTrueProperty(val); }, enumerable: true, configurable: true }); Object.defineProperty(Tab.prototype, "show", { /** * @input {boolean} If true, the tab button is visible within the * tabbar. Default: `true`. */ get: function () { return this._isShown; }, set: function (val) { this._isShown = isTrueProperty(val); }, enumerable: true, configurable: true }); Object.defineProperty(Tab.prototype, "tabsHideOnSubPages", { /** * @input {boolean} If true, hide the tabs on child pages. */ get: function () { return this._tabsHideOnSubPages; }, set: function (val) { this._tabsHideOnSubPages = isTrueProperty(val); }, enumerable: true, configurable: true }); Object.defineProperty(Tab.prototype, "_vp", { /** * @hidden */ set: function (val) { this.setViewport(val); }, enumerable: true, configurable: true }); /** * @hidden */ Tab.prototype.ngOnInit = function () { this.tabBadgeStyle = this.tabBadgeStyle ? this.tabBadgeStyle : 'default'; }; /** * @hidden */ Tab.prototype.load = function (opts) { var _this = this; var segment = this._segment; if (segment || (!this._loaded && this.root)) { this.setElementClass('show-tab', true); // okay, first thing we need to do if check if the view already exists var nameToUse = segment && segment.name ? segment.name : this.root; var dataToUse = segment ? segment.data : this.rootParams; var numViews = this.length() - 1; for (var i = numViews; i >= 0; i--) { var viewController = this.getByIndex(i); if (viewController && (viewController.id === nameToUse || viewController.component === nameToUse)) { if (i === numViews) { // this is the last view in the stack and it's the same // as the segment so there's no change needed return Promise.resolve(); } else { // it's not the exact view as the end // let's have this nav go back to this exact view return this.popTo(viewController, { animate: false, updateUrl: false, }); } } } var promise = null; if (segment && segment.defaultHistory && segment.defaultHistory.length && this._views.length === 0) { promise = this.linker.initViews(segment).then(function (views) { return _this.setPages(views, opts); }); } else { promise = this.push(nameToUse, dataToUse, opts); } return promise.then(function () { _this._segment = null; _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(function () { _this.resize(); }); return Promise.resolve(); } }; /** * @hidden */ Tab.prototype.resize = function () { var active = this.getActive(); if (!active) { return; } var content = active.getIONContent(); content && content.resize(); }; /** * @hidden */ Tab.prototype._viewAttachToDOM = function (viewCtrl, componentRef, viewport) { var isTabSubPage = (this._tabsHideOnSubPages && viewCtrl.index > 0); if (isTabSubPage) { viewport = this.parent.portal; } _super.prototype._viewAttachToDOM.call(this, viewCtrl, componentRef, viewport); if (isTabSubPage) { // add the .tab-subpage css class to tabs pages that should act like subpages var pageEleRef = viewCtrl.pageRef(); if (pageEleRef) { this._renderer.setElementClass(pageEleRef.nativeElement, 'tab-subpage', true); } } }; /** * @hidden */ Tab.prototype.setSelected = function (isSelected) { 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(); } }; Object.defineProperty(Tab.prototype, "index", { /** * @hidden */ get: function () { return this.parent.getIndex(this); }, enumerable: true, configurable: true }); /** * @hidden */ Tab.prototype.updateHref = function (component, data) { if (this.btn && this.linker) { var href = this.linker.createUrl(this.parent, component, data) || '#'; this.btn.updateHref(href); } }; /** * @hidden */ Tab.prototype.ngOnDestroy = function () { this.destroy(); }; /** * @hidden */ Tab.prototype.getType = function () { return 'tab'; }; Tab.prototype.goToRoot = function (opts) { return this.setRoot(this.root, this.rootParams, opts, null); }; Tab.decorators = [ { type: Component, args: [{ selector: 'ion-tab', template: '<div #viewport></div><div class="nav-decor"></div>', host: { '[attr.id]': '_tabId', '[attr.aria-labelledby]': '_btnId', 'role': 'tabpanel' }, encapsulation: ViewEncapsulation.None, },] }, ]; /** @nocollapse */ Tab.ctorParameters = function () { return [ { type: Tabs, }, { type: App, }, { type: Config, }, { type: Platform, }, { type: ElementRef, }, { type: NgZone, }, { type: Renderer, }, { type: ComponentFactoryResolver, }, { type: ChangeDetectorRef, }, { type: GestureController, }, { type: TransitionController, }, { type: DeepLinker, decorators: [{ type: Optional },] }, { type: DomController, }, { type: ErrorHandler, }, ]; }; Tab.propDecorators = { 'root': [{ type: Input },], 'rootParams': [{ type: Input },], 'tabUrlPath': [{ type: Input },], 'tabTitle': [{ type: Input },], 'tabIcon': [{ type: Input },], 'tabBadge': [{ type: Input },], 'tabBadgeStyle': [{ type: Input },], 'enabled': [{ type: Input },], 'show': [{ type: Input },], 'tabsHideOnSubPages': [{ type: Input },], 'ionSelect': [{ type: Output },], '_vp': [{ type: ViewChild, args: ['viewport', { read: ViewContainerRef },] },], }; return Tab; }(NavControllerBase)); export { Tab }; //# sourceMappingURL=tab.js.map