List列表

    最基础的列表展示，可承载文字、列表、图片、段落，常用于后台数据展示页面。

    简单列表

    列表拥有大、中、小三种尺寸。

    通过设置 为 large``small 分别把按钮设为大、小尺寸。若不设置 size，则尺寸为中。

    可通过设置 nzHeader 和 nzFooter，来自定义列表头部和尾部。

    1. import { Component } from '@angular/core';
    2. import { NzMessageService } from 'ng-zorro-antd/message';
    4. @Component({
    5.   selector: 'nz-demo-list-simple',
    6.   template: `
    7.     <h3 [ngStyle]="{ 'margin-bottom.px': 16 }">Default Size</h3>
    8.     <nz-list nzBordered nzHeader="Header" nzFooter="Footer">
    9.       <nz-list-item *ngFor="let item of data">
    10.         <span nz-typography><mark>[ITEM]</mark></span>
    11.         {{ item }}
    12.       </nz-list-item>
    13.     </nz-list>
    15.     <h3 [ngStyle]="{ margin: '16px 0' }">Small Size</h3>
    16.     <nz-list nzBordered nzSize="small">
    17.       <nz-list-header>Header</nz-list-header>
    18.       <nz-list-item *ngFor="let item of data">item</nz-list-item>
    19.       <nz-list-footer>Footer</nz-list-footer>
    20.     </nz-list>
    22.     <h3 [ngStyle]="{ margin: '16px 0' }">Large Size</h3>
    23.     <ul nz-list [nzDataSource]="data" nzBordered nzSize="large">
    24.       <nz-list-header>Header</nz-list-header>
    25.       <li nz-list-item *ngFor="let item of data" nzNoFlex>
    26.         <ul nz-list-item-actions>
    27.           <nz-list-item-action>
    28.             <a (click)="msg.info('edit')">edit</a>
    29.           </nz-list-item-action>
    30.         </ul>
    31.         {{ item }}
    32.       </li>
    33.       <nz-list-footer>Footer</nz-list-footer>
    34.     </ul>
    35.   `
    36. })
    37. export class NzDemoListSimpleComponent {
    38.   data = [
    39.     'Racing car sprays burning fuel into crowd.',
    40.     'Japanese princess to wed commoner.',
    41.     'Australian walks 100km after outback crash.',
    42.     'Man charged over missing wedding girl.',
    43.     'Los Angeles battles huge wildfires.'
    44.   ];
    46.   constructor(public msg: NzMessageService) {}
    47. }

    List列表 - 图2

    基础列表

    基础列表。

    加载更多

    1. // tslint:disable:no-any
    2. import { HttpClient } from '@angular/common/http';
    3. import { Component, OnInit } from '@angular/core';
    4. import { NzMessageService } from 'ng-zorro-antd/message';
    6. const count = 5;
    7. const fakeDataUrl = 'https://randomuser.me/api/?results=5&inc=name,gender,email,nat&noinfo';
    9. @Component({
    10.   selector: 'nz-demo-list-loadmore',
    11.   template: `
    12.     <nz-list class="demo-loadmore-list" [nzLoading]="initLoading">
    13.       <nz-list-item *ngFor="let item of list">
    14.         <ng-container *ngIf="!item.loading">
    15.           <nz-list-item-meta
    16.             nzAvatar="https://zos.alipayobjects.com/rmsportal/ODTLcjxAfvqbxHnVXCYX.png"
    17.             nzDescription="Ant Design, a design language for background applications, is refined by Ant UED Team"
    18.           >
    19.             <nz-list-item-meta-title>
    20.               <a href="https://ng.ant.design">{{ item.name.last }}</a>
    21.             </nz-list-item-meta-title>
    22.           </nz-list-item-meta>
    23.           content
    24.           <ul nz-list-item-actions>
    25.             <nz-list-item-action><a (click)="edit(item)">edit</a></nz-list-item-action>
    26.             <nz-list-item-action><a (click)="edit(item)">more</a></nz-list-item-action>
    27.           </ul>
    28.         </ng-container>
    29.         <nz-skeleton *ngIf="item.loading" [nzAvatar]="true" [nzActive]="true" [nzTitle]="false" [nzLoading]="true"> </nz-skeleton>
    30.       </nz-list-item>
    31.         <button nz-button *ngIf="!loadingMore" (click)="onLoadMore()">loading more</button>
    32.       </div>
    33.     </nz-list>
    34.   `,
    35.   styles: [
    36.     `
    37.       .demo-loadmore-list {
    38.         min-height: 350px;
    39.       }
    40.       .loadmore {
    41.         text-align: center;
    42.         margin-top: 12px;
    43.         height: 32px;
    44.         line-height: 32px;
    45.       }
    46.     `
    47.   ]
    48. })
    49. export class NzDemoListLoadmoreComponent implements OnInit {
    50.   initLoading = true; // bug
    51.   loadingMore = false;
    53.   list: Array<{ loading: boolean; name: any }> = [];
    55.   constructor(private http: HttpClient, private msg: NzMessageService) {}
    57.   ngOnInit(): void {
    58.     this.getData((res: any) => {
    59.       this.data = res.results;
    60.       this.list = res.results;
    61.       this.initLoading = false;
    62.     });
    63.   }
    65.   getData(callback: (res: any) => void): void {
    66.     this.http.get(fakeDataUrl).subscribe((res: any) => callback(res));
    67.   }
    69.   onLoadMore(): void {
    70.     this.loadingMore = true;
    71.     this.list = this.data.concat([...Array(count)].fill({}).map(() => ({ loading: true, name: {} })));
    72.     this.http.get(fakeDataUrl).subscribe((res: any) => {
    73.       this.data = this.data.concat(res.results);
    74.       this.list = [...this.data];
    75.       this.loadingMore = false;
    76.     });
    77.   }
    79.   edit(item: any): void {
    80.     this.msg.success(item.email);
    81.   }
    82. }

    List列表 - 图4

    竖排列表样式

    通过设置 nzItemLayout 属性为 vertical 可实现竖排列表样式。

    栅格列表

    可以通过设置 nz-list 的 nzGrid 属性来实现栅格列表。

    1. import { Component } from '@angular/core';
    3. @Component({
    4.   selector: 'nz-demo-list-grid',
    5.   template: `
    6.     <nz-list nzGrid>
    7.       <div nz-row [nzGutter]="16">
    8.         <div nz-col [nzSpan]="6" *ngFor="let item of data">
    9.           <nz-list-item>
    10.             <nz-card [nzTitle]="item.title">
    11.               Card content
    12.             </nz-card>
    13.           </nz-list-item>
    14.         </div>
    15.       </div>
    16.     </nz-list>
    17.   `
    18. })
    19. export class NzDemoListGridComponent {
    20.   data = [
    21.     {
    22.       title: 'Title 1'
    23.     },
    24.     {
    25.       title: 'Title 2'
    26.     },
    27.     {
    28.       title: 'Title 3'
    29.     },
    30.     {
    31.       title: 'Title 4'
    32.     }
    33.   ];
    34. }

    List列表 - 图6

    响应式的栅格列表

    响应式的栅格列表。

    滚动加载无限长列表

    Virtualized 是在大数据列表中应用的一种技术，主要是为了减少不可见区域不必要的渲染从而提高性能，特别是数据量在成千上万条效果尤为明显。

    1. import { CollectionViewer, DataSource } from '@angular/cdk/collections';
    2. import { HttpClient } from '@angular/common/http';
    3. import { ChangeDetectionStrategy, Component } from '@angular/core';
    4. import { BehaviorSubject, Observable, Subscription } from 'rxjs';
    6. interface ItemData {
    7.   gender: string;
    8.   name: Name;
    9.   email: string;
    11. interface Name {
    12.   title: string;
    13.   first: string;
    14.   last: string;
    15. }
    17. @Component({
    18.   selector: 'nz-demo-list-infinite-load',
    19.   template: `
    20.     <div>
    21.       <cdk-virtual-scroll-viewport itemSize="73" class="demo-infinite-container">
    22.         <nz-list>
    23.           <nz-list-item *cdkVirtualFor="let item of ds">
    24.             <nz-skeleton *ngIf="!item" [nzAvatar]="true" [nzParagraph]="{ rows: 1 }"></nz-skeleton>
    25.             <nz-list-item-meta
    26.               *ngIf="item"
    27.               nzAvatar="https://zos.alipayobjects.com/rmsportal/ODTLcjxAfvqbxHnVXCYX.png"
    28.               [nzDescription]="item.email"
    29.             >
    30.               <nz-list-item-meta-title>
    31.                 <a href="https://ng.ant.design">{{ item.name.last }}</a>
    32.               </nz-list-item-meta-title>
    33.             </nz-list-item-meta>
    34.           </nz-list-item>
    36.       </cdk-virtual-scroll-viewport>
    37.     </div>
    38.   `,
    39.   styles: [
    40.     `
    41.       .demo-infinite-container {
    42.         height: 300px;
    43.         border: 1px solid #e8e8e8;
    44.         border-radius: 4px;
    45.       }
    47.       nz-list {
    48.         padding: 24px;
    49.       }
    50.     `
    51.   ],
    52.   changeDetection: ChangeDetectionStrategy.OnPush
    53. })
    54. export class NzDemoListInfiniteLoadComponent {
    55.   ds = new MyDataSource(this.http);
    57.   constructor(private http: HttpClient) {}
    58. }
    60. class MyDataSource extends DataSource<ItemData> {
    61.   private length = 100000;
    62.   private pageSize = 10;
    63.   private cachedData = Array.from<ItemData>({ length: this.length });
    64.   private fetchedPages = new Set<number>();
    65.   private dataStream = new BehaviorSubject<ItemData[]>(this.cachedData);
    66.   private subscription = new Subscription();
    68.   constructor(private http: HttpClient) {
    69.     super();
    70.   }
    72.   connect(collectionViewer: CollectionViewer): Observable<ItemData[]> {
    73.     this.subscription.add(
    74.       collectionViewer.viewChange.subscribe(range => {
    75.         const startPage = this.getPageForIndex(range.start);
    76.         const endPage = this.getPageForIndex(range.end - 1);
    77.         for (let i = startPage; i <= endPage; i++) {
    78.           this.fetchPage(i);
    79.         }
    80.       })
    81.     );
    82.     return this.dataStream;
    83.   }
    85.   disconnect(): void {
    86.     this.subscription.unsubscribe();
    87.   }
    89.   private getPageForIndex(index: number): number {
    90.     return Math.floor(index / this.pageSize);
    91.   }
    93.   private fetchPage(page: number): void {
    94.     if (this.fetchedPages.has(page)) {
    95.       return;
    96.     }
    97.     this.fetchedPages.add(page);
    99.     this.http
    100.       .get<{ results: ItemData[] }>(`https://randomuser.me/api/?results=${this.pageSize}&inc=name,gender,email,nat&noinfo`)
    101.       .subscribe(res => {
    102.         this.cachedData.splice(page * this.pageSize, this.pageSize, ...res.results);
    103.         this.dataStream.next(this.cachedData);
    104.       });
    105. }

    nz-list-emptycomponent

    列表空内容组件

    nz-list[nzGrid]component

    使用栅格布局

    nz-list-headercomponent

    列表头部位置组件

    nz-list-footercomponent

    列表脚部位置组件

    列表分页位置组件

    nz-list-load-morecomponent

    列表加载更多位置组件

    nz-list-itemcomponent

    ul[nz-list-item-actions]

    列表项操作项容器组件

    nz-list-item-actioncomponent

    列表项操作项组件

    列表项扩展内容位置组件

    nz-list-item-metacomponent

    nz-list-item-meta-titlecomponent

    列表项元信息标题部分组件

    nz-list-item-meta-descriptioncomponent

    nz-list-item-meta-avatarcomponent

    列表项元信息头像部分组件