ng-bootstrap 元件集中 tabset 元件的實現分析
阿新 • • 發佈：2019-07-19
ng-bootstrap: tabset
本文介紹了 ng-bootstrap 專案中，tabset 的實現分析。
使用方式
<ngb-tabset> 作為容器元素，其中的每個頁籤以一個 <ngb-tab> 元素定義，在 <ngb-tabset> 中包含若干個 <ngb-tab> 子元素。
在 <ngb-tab> 元素中，使用 <ng-template> 模板來定義內容，內容分為兩種：標題和內容。
標題使用 [ngbTabTitle] 指令來宣告，或者在 <ngb-tab> 元素上使用 title
內容使用 [ngbTabContent] 指令宣告。
<ngb-tabset>
<ngb-tab title="Simple">
<ng-template ngbTabContent>
<p>Raw denim you probably haven't heard of them jean shorts Austin. Nesciunt tofu stumptown aliqua, retro synth
master cleanse. Mustache cliche tempor, williamsburg carles vegan helvetica. Reprehenderit butcher retro keffiyeh
dreamcatcher synth. Cosby sweater eu banh mi, qui irure terry richardson ex squid. Aliquip placeat salvia cillum
iphone. Seitan aliquip quis cardigan american apparel, butcher voluptate nisi qui.</p>
</ng-template>
</ngb-tab>
<ngb-tab>
<ng-template ngbTabTitle><b>Fancy</b> title</ng-template>
<ng-template ngbTabContent>Food truck fixie locavore, accusamus mcsweeney's marfa nulla single-origin coffee squid.
<p>Exercitation +1 labore velit, blog sartorial PBR leggings next level wes anderson artisan four loko farm-to-table
craft beer twee. Qui photo booth letterpress, commodo enim craft beer mlkshk aliquip jean shorts ullamco ad vinyl
cillum PBR. Homo nostrud organic, assumenda labore aesthetic magna delectus mollit. Keytar helvetica VHS salvia
yr, vero magna velit sapiente labore stumptown. Vegan fanny pack odio cillum wes anderson 8-bit, sustainable jean
shorts beard ut DIY ethical culpa terry richardson biodiesel. Art party scenester stumptown, tumblr butcher vero
sint qui sapiente accusamus tattooed echo park.</p>
</ng-template>
</ngb-tab>
<ngb-tab title="Disabled" [disabled]="true">
<ng-template ngbTabContent>
<p>Sed commodo, leo at suscipit dictum, quam est porttitor sapien, eget sodales nibh elit id diam. Nulla facilisi. Donec egestas ligula vitae odio interdum aliquet. Duis lectus turpis, luctus eget tincidunt eu, congue et odio. Duis pharetra et nisl at faucibus. Quisque luctus pulvinar arcu, et molestie lectus ultrices et. Sed diam urna, egestas ut ipsum vel, volutpat volutpat neque. Praesent fringilla tortor arcu. Vivamus faucibus nisl enim, nec tristique ipsum euismod facilisis. Morbi ut bibendum est, eu tincidunt odio. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Mauris aliquet odio ac lorem aliquet ultricies in eget neque. Phasellus nec tortor vel tellus pulvinar feugiat.</p>
</ng-template>
</ngb-tab>
</ngb-tabset>
可以看到，外層元素是 <ngb-tabset>。
每個 tab 使用元素 <ngb-tab> 定義，tab 的內容使用 <ng-template> 模板定義， tab 中的內容分為兩個部分：標題和內容。
下面是使用模板的標題
<ng-template ngbTabTitle><b>Fancy</b> title</ng-template>
標題也可以在 ngb-tab 上使用 [title] 屬性定義。例如：
<ngb-tab title="Disabled" [disabled]="true">
內容部分定義，這裡使用了指令 [ngbTabContent] 便於識別。
<ng-template ngbTabContent>
<p>Sed commodo, leo at suscipit dictum, quam est porttitor sapien, eget sodales nibh elit id diam.
</p>
</ng-template>
TabSet 元件定義
從前面的使用可以看出，所有 tab 的定義都是 ngb-tabset 元素的內容，它們在使用時定義，而不是在 ngb-tabse 自己的模板中定義。
所以找到它們需要使用 ContentChildren 來找到。
@ContentChildren(NgbTab) tabs: QueryList<NgbTab>;
不使用 ContentChild 的原因是它沒有提供 descendants 的支援。
在 bootstrap 中，每個頁籤 實際上渲染成兩個部分，一個標題的列表，和當前顯示的內容。
標題列表使用一個 ul 來處理。其中使用迴圈來將所有的標題顯示出來。
而 titleTpl 是由模板定義的，所以，使用了 [ngTemplateOutlet] 來渲染出來。
<ul [class]="'nav nav-' + type + (orientation == 'horizontal'? ' ' + justifyClass : ' flex-column')" role="tablist">
<li class="nav-item" *ngFor="let tab of tabs">
<a [id]="tab.id" class="nav-link"
[class.active]="tab.id === activeId"
[class.disabled]="tab.disabled"
href (click)="select(tab.id); $event.preventDefault()"
role="tab"
[attr.tabindex]="(tab.disabled ? '-1': undefined)"
[attr.aria-controls]="(!destroyOnHide || tab.id === activeId ? tab.id + '-panel' : null)"
[attr.aria-selected]="tab.id === activeId" [attr.aria-disabled]="tab.disabled">
{{tab.title}}<ng-template [ngTemplateOutlet]="tab.titleTpl?.templateRef"></ng-template>
</a>
</li>
</ul>
title 部分並列使用了兩種來源
{{tab.title}}<ng-template [ngTemplateOutlet]="tab.titleTpl?.templateRef"></ng-template>
內容部分，由於具體內容也是使用模板定義出來，所以這裡也是使用 [ngTemplateOutlet] 渲染出來。
<div class="tab-content">
<ng-template ngFor let-tab [ngForOf]="tabs">
<div
class="tab-pane {{tab.id === activeId ? 'active' : null}}"
*ngIf="!destroyOnHide || tab.id === activeId"
role="tabpanel"
[attr.aria-labelledby]="tab.id" id="{{tab.id}}-panel">
<ng-template [ngTemplateOutlet]="tab.contentTpl?.templateRef"></ng-template>
</div>
</ng-template>
</div>
投影內容需要在 Content 型別的事件中處理。
ngAfterContentChecked() {
// auto-correct activeId that might have been set incorrectly as input
let activeTab = this._getTabById(this.activeId);
this.activeId =
activeTab ? activeTab.id : (this.tabs.length ? this.tabs.first.id : null);
}
兩個指令定義
指令的定義非常簡單，就是獲取模板的引用，以便後繼使用。
可以看到屬性名稱為 templateRef
@Directive({selector: 'ng-template[ngbTabTitle]'})
export class NgbTabTitle {
constructor(public templateRef: TemplateRef<any>) {}
}
這是 [ngbTabContent] 的定義，與上面相同，依然是定義了屬性 templateRef。
@Directive({selector: 'ng-template[ngbTabContent]'})
export class NgbTabContent {
constructor(public templateRef: TemplateRef<any>) {}
}
Tab 定義
元素型的指令，所以連模板都沒有了。
@Directive({selector: 'ngb-tab'})
內容是投影進來的。
由於在 tab 中使用了模板，並且使用指令來標識出來，它們定義在元件的模板之內，所以這裡使用了 ContentChildren 來識別。
@ContentChildren(NgbTabTitle, {descendants: false}) titleTpls: QueryList<NgbTabTitle>;
@ContentChildren(NgbTabContent, {descendants: false}) contentTpls: QueryList<NgbTabContent>
以後就可以使用 titleTpls 和 contentTpls 來使用模板了。
由於是內容，需要在 content 的事件中處理，實際上，在每個頁籤中，我們只有一個標題和一個內容的宣告。
ngAfterContentChecked() {
// We are using @ContentChildren instead of @ContentChild as in the Angular version being used
// only @ContentChildren allows us to specify the {descendants: false} option.
// Without {descendants: false} we are hitting bugs described in:
// https://github.com/ng-bootstrap/ng-bootstrap/issues/2240
this.titleTpl = this.titleTpls.first;
this.contentTpl = this.contentTpls.first;
}
See also
-
tabset