ionic-angular
Version:
A powerful framework for building mobile and progressive web apps with JavaScript and Angular
465 lines • 12.4 kB
JavaScript
import { ChangeDetectorRef, Component, ComponentFactoryResolver, ElementRef, ErrorHandler, 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 { 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>
* ```
*
* ```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}
*/
export class Tab extends NavControllerBase {
/**
* @param {?} parent
* @param {?} app
* @param {?} config
* @param {?} plt
* @param {?} elementRef
* @param {?} zone
* @param {?} renderer
* @param {?} cfr
* @param {?} _cd
* @param {?} gestureCtrl
* @param {?} transCtrl
* @param {?} linker
* @param {?} _dom
* @param {?} errHandler
*/
constructor(parent, app, config, plt, elementRef, zone, renderer, cfr, _cd, gestureCtrl, transCtrl, linker, _dom, errHandler) {
// A Tab is a NavController for its child pages
super(parent, app, config, plt, elementRef, zone, renderer, cfr, gestureCtrl, transCtrl, linker, _dom, errHandler);
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;
}
/**
* \@input {boolean} If true, enable the tab. If false,
* the user cannot interact with this element.
* Default: `true`.
* @return {?}
*/
get enabled() {
return this._isEnabled;
}
/**
* @param {?} val
* @return {?}
*/
set enabled(val) {
this._isEnabled = isTrueProperty(val);
}
/**
* \@input {boolean} If true, the tab button is visible within the
* tabbar. Default: `true`.
* @return {?}
*/
get show() {
return this._isShown;
}
/**
* @param {?} val
* @return {?}
*/
set show(val) {
this._isShown = isTrueProperty(val);
}
/**
* \@input {boolean} If true, hide the tabs on child pages.
* @return {?}
*/
get tabsHideOnSubPages() {
return this._tabsHideOnSubPages;
}
/**
* @param {?} val
* @return {?}
*/
set tabsHideOnSubPages(val) {
this._tabsHideOnSubPages = isTrueProperty(val);
}
/**
* @hidden
* @param {?} val
* @return {?}
*/
set _vp(val) {
this.setViewport(val);
}
/**
* @hidden
* @return {?}
*/
ngOnInit() {
this.tabBadgeStyle = this.tabBadgeStyle ? this.tabBadgeStyle : 'default';
}
/**
* @hidden
* @param {?} opts
* @param {?=} done
* @return {?}
*/
load(opts, done) {
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();
}
}
/**
* @hidden
* @return {?}
*/
resize() {
const /** @type {?} */ active = this.getActive();
if (!active) {
return;
}
const /** @type {?} */ content = active.getIONContent();
content && content.resize();
}
/**
* @hidden
* @param {?} viewCtrl
* @param {?} componentRef
* @param {?} viewport
* @return {?}
*/
_viewAttachToDOM(viewCtrl, componentRef, viewport) {
const /** @type {?} */ 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 /** @type {?} */ pageEleRef = viewCtrl.pageRef();
if (pageEleRef) {
this._renderer.setElementClass(pageEleRef.nativeElement, 'tab-subpage', true);
}
}
}
/**
* @hidden
* @param {?} isSelected
* @return {?}
*/
setSelected(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();
}
}
/**
* @hidden
* @return {?}
*/
get index() {
return this.parent.getIndex(this);
}
/**
* @hidden
* @param {?} component
* @param {?} data
* @return {?}
*/
updateHref(component, data) {
if (this.btn && this.linker) {
let /** @type {?} */ href = this.linker.createUrl(this, component, data) || '#';
this.btn.updateHref(href);
}
}
/**
* @hidden
* @return {?}
*/
ngOnDestroy() {
this.destroy();
}
}
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 = () => [
{ 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 },] },],
};
function Tab_tsickle_Closure_declarations() {
/** @type {?} */
Tab.decorators;
/**
* @nocollapse
* @type {?}
*/
Tab.ctorParameters;
/** @type {?} */
Tab.propDecorators;
/**
* @hidden
* @type {?}
*/
Tab.prototype._isInitial;
/**
* @hidden
* @type {?}
*/
Tab.prototype._isEnabled;
/**
* @hidden
* @type {?}
*/
Tab.prototype._isShown;
/**
* @hidden
* @type {?}
*/
Tab.prototype._tabId;
/**
* @hidden
* @type {?}
*/
Tab.prototype._btnId;
/**
* @hidden
* @type {?}
*/
Tab.prototype._loaded;
/**
* @hidden
* @type {?}
*/
Tab.prototype.isSelected;
/**
* @hidden
* @type {?}
*/
Tab.prototype.btn;
/**
* @hidden
* @type {?}
*/
Tab.prototype._tabsHideOnSubPages;
/**
* \@input {Page} Set the root page for this tab.
* @type {?}
*/
Tab.prototype.root;
/**
* \@input {object} Any nav-params to pass to the root page of this tab.
* @type {?}
*/
Tab.prototype.rootParams;
/**
* \@input {string} The URL path name to represent this tab within the URL.
* @type {?}
*/
Tab.prototype.tabUrlPath;
/**
* \@input {string} The title of the tab button.
* @type {?}
*/
Tab.prototype.tabTitle;
/**
* \@input {string} The icon for the tab button.
* @type {?}
*/
Tab.prototype.tabIcon;
/**
* \@input {string} The badge for the tab button.
* @type {?}
*/
Tab.prototype.tabBadge;
/**
* \@input {string} The badge color for the tab button.
* @type {?}
*/
Tab.prototype.tabBadgeStyle;
/**
* \@output {Tab} Emitted when the current tab is selected.
* @type {?}
*/
Tab.prototype.ionSelect;
/** @type {?} */
Tab.prototype._cd;
/** @type {?} */
Tab.prototype.linker;
/** @type {?} */
Tab.prototype._dom;
}
//# sourceMappingURL=tab.js.map