Transfer穿梭框

    用直观的方式在两栏中移动元素，完成选择行为。

    选择一个或以上的选项后，点击对应的方向键，可以把选中的选项移动到另一栏。其中，左边一栏为 ，右边一栏为 target，API 的设计也反映了这两个概念。

    想要了解更多关于单独引入组件的内容，可以在快速上手页面进行查看。

    最基本的用法，展示了 nzDataSource 每行的渲染函数 nzRender 以及回调函数 nzChange、nzSelectChange 的用法。

    1. import { Component, OnInit } from '@angular/core';
    3. @Component({
    4.   selector: 'nz-demo-transfer-basic',
    5.   template: `
    6.     <nz-transfer
    7.       [nzDataSource]="list"
    8.       [nzDisabled]="disabled"
    9.       [nzTitles]="['Source', 'Target']"
    10.       (nzSelectChange)="select($event)"
    11.       (nzChange)="change($event)"
    12.     >
    13.     </nz-transfer>
    14.     <div style="margin-top: 8px;">
    15.       <nz-switch [(ngModel)]="disabled" nzCheckedChildren="disabled" nzUnCheckedChildren="disabled"></nz-switch>
    16.       <div></div>
    17.     </div>
    18.   `
    19. })
    20. export class NzDemoTransferBasicComponent implements OnInit {
    21.   // tslint:disable-next-line:no-any
    22.   list: any[] = [];
    23.   disabled = false;
    25.   ngOnInit(): void {
    26.     for (let i = 0; i < 20; i++) {
    27.       this.list.push({
    28.         key: i.toString(),
    29.         title: `content${i + 1}`,
    30.         disabled: i % 3 < 1
    31.       });
    32.     }
    34.     [2, 3].forEach(idx => (this.list[idx].direction = 'right'));
    35.   }
    37.   select(ret: {}): void {
    38.     console.log('nzSelectChange', ret);
    39.   }
    41.   change(ret: {}): void {
    42.     console.log('nzChange', ret);
    43.   }
    44. }

    Transfer穿梭框 - 图2

    带搜索框

    带搜索框的穿梭框，可以自定义搜索函数。

    穿梭框高级用法，可配置操作文案，可定制宽高，可对底部进行自定义渲染。

    1. import { Component, OnInit } from '@angular/core';
    2. import { NzMessageService } from 'ng-zorro-antd/message';
    4. @Component({
    5.   selector: 'nz-demo-transfer-advanced',
    6.   template: `
    7.     <nz-transfer
    8.       [nzDataSource]="list"
    9.       nzShowSearch
    10.       [nzOperations]="['to right', 'to left']"
    11.       [nzListStyle]="{ 'width.px': 250, 'height.px': 300 }"
    12.       [nzRender]="render"
    13.       [nzFooter]="footer"
    14.       (nzSelectChange)="select($event)"
    15.       (nzChange)="change($event)"
    16.     >
    17.       <ng-template #render let-item> {{ item.title }}-{{ item.description }} </ng-template>
    18.       <ng-template #footer let-direction>
    19.         <button nz-button (click)="reload(direction)" [nzSize]="'small'" style="float: right; margin: 5px;">
    20.           reload
    21.         </button>
    22.       </ng-template>
    23.     </nz-transfer>
    24.   `
    25. })
    26. export class NzDemoTransferAdvancedComponent implements OnInit {
    27.   list: Array<{ key: string; title: string; description: string; direction: string }> = [];
    29.   ngOnInit(): void {
    30.     this.getData();
    31.   }
    33.     const ret: Array<{ key: string; title: string; description: string; direction: string }> = [];
    34.     for (let i = 0; i < 20; i++) {
    35.       ret.push({
    36.         key: i.toString(),
    37.         title: `content${i + 1}`,
    38.         description: `description of content${i + 1}`,
    39.         direction: Math.random() * 2 > 1 ? 'right' : ''
    40.       });
    41.     }
    42.     this.list = ret;
    43.   }
    45.   reload(direction: string): void {
    46.     this.getData();
    47.     this.msg.success(`your clicked ${direction}!`);
    48.   }
    50.   select(ret: {}): void {
    51.     console.log('nzSelectChange', ret);
    52.   }
    54.   change(ret: {}): void {
    55.     console.log('nzChange', ret);
    56.   }
    58.   constructor(public msg: NzMessageService) {}
    59. }

    Transfer穿梭框 - 图4

    自定义渲染行数据

    自定义渲染每一个 Transfer Item，可用于渲染复杂数据。

    1. import { Component, OnInit } from '@angular/core';
    2. import { TransferCanMove, TransferItem } from 'ng-zorro-antd/transfer';
    4. import { delay } from 'rxjs/operators';
    6. @Component({
    7.   selector: 'nz-demo-transfer-can-move',
    8.   template: `
    9.     <nz-transfer
    10.       [nzDataSource]="list"
    11.       [nzCanMove]="canMove"
    12.       (nzSelectChange)="select($event)"
    13.       (nzChange)="change($event)"
    14.     >
    15.     </nz-transfer>
    16.   `
    17. })
    18. export class NzDemoTransferCanMoveComponent implements OnInit {
    19.   list: Array<{ key: string; title: string; disabled: boolean; direction?: string }> = [];
    21.   ngOnInit(): void {
    22.     for (let i = 0; i < 20; i++) {
    23.       this.list.push({
    24.         key: i.toString(),
    25.         title: `content${i + 1}`,
    26.         disabled: i % 3 < 1
    27.       });
    28.     }
    30.     [2, 3].forEach(idx => (this.list[idx].direction = 'right'));
    31.   }
    33.   canMove(arg: TransferCanMove): Observable<TransferItem[]> {
    34.     if (arg.direction === 'right' && arg.list.length > 0) {
    35.       arg.list.splice(0, 1);
    36.     }
    37.     // or
    38.     // if (arg.direction === 'right' && arg.list.length > 0) delete arg.list[0];
    39.     return of(arg.list).pipe(delay(1000));
    40.   }
    42.   select(ret: {}): void {
    43.     console.log('nzSelectChange', ret);
    44.   }
    46.   change(ret: {}): void {
    47.     console.log('nzChange', ret);
    48.   }
    49. }

    Transfer穿梭框 - 图6

    表格穿梭框

    使用 Table 组件作为自定义渲染列表。

    使用 Tree 组件作为自定义渲染列表。

    1. // tslint:disable: no-any
    2. import { ChangeDetectionStrategy, Component, ViewChild } from '@angular/core';
    3. import { NzTreeNode } from 'ng-zorro-antd/core';
    4. import { TransferChange, TransferItem } from 'ng-zorro-antd/transfer';
    5. import { NzTreeComponent } from 'ng-zorro-antd/tree';
    7. @Component({
    8.   selector: 'nz-demo-transfer-tree-transfer',
    9.   template: `
    10.     <nz-transfer
    11.       [nzShowSelectAll]="false"
    12.       [nzRenderList]="[leftRenderList, null]"
    13.       (nzChange)="change($event)"
    14.     >
    15.       <ng-template #leftRenderList let-items let-onItemSelectAll="onItemSelectAll" let-onItemSelect="onItemSelect">
    16.         <nz-tree #tree [nzData]="treeData" nzExpandAll nzBlockNode>
    17.           <ng-template #nzTreeTemplate let-node>
    18.             <span
    19.               class="ant-tree-checkbox"
    20.               [class.ant-tree-checkbox-disabled]="node.isDisabled"
    21.               [class.ant-tree-checkbox-checked]="node.isChecked"
    22.               (click)="checkBoxChange(node, onItemSelect)"
    23.             >
    24.               <span class="ant-tree-checkbox-inner"></span>
    25.             </span>
    26.             <span
    27.               (click)="checkBoxChange(node, onItemSelect)"
    28.               class="ant-tree-node-content-wrapper ant-tree-node-content-wrapper-open"
    29.               >{{ node.title }}</span
    30.             >
    31.           </ng-template>
    32.         </nz-tree>
    33.       </ng-template>
    34.     </nz-transfer>
    35.   `,
    36.   changeDetection: ChangeDetectionStrategy.OnPush
    37. })
    38. export class NzDemoTransferTreeTransferComponent {
    39.   @ViewChild('tree', { static: true }) tree: NzTreeComponent;
    40.   list: any[] = [
    41.     { id: 1, parentid: 0, title: 'parent 1' },
    42.     { id: 2, parentid: 1, title: 'leaf 1-1', disabled: true, isLeaf: true },
    43.     { id: 3, parentid: 1, title: 'leaf 1-2', isLeaf: true }
    44.   ];
    45.   treeData = this.generateTree(this.list);
    46.   checkedNodeList: NzTreeNode[] = [];
    48.   private generateTree(arr: TransferItem[]): TransferItem[] {
    49.     const tree: TransferItem[] = [];
    50.     const mappedArr: any = {};
    51.     let arrElem: TransferItem;
    52.     let mappedElem: TransferItem;
    54.     for (let i = 0, len = arr.length; i < len; i++) {
    55.       arrElem = arr[i];
    56.       mappedArr[arrElem.id] = { ...arrElem };
    57.       mappedArr[arrElem.id].children = [];
    58.     }
    60.     for (const id in mappedArr) {
    61.       if (mappedArr.hasOwnProperty(id)) {
    62.         mappedElem = mappedArr[id];
    63.         if (mappedElem.parentid) {
    64.           mappedArr[mappedElem.parentid].children.push(mappedElem);
    65.         } else {
    67.         }
    68.       }
    69.     }
    70.     return tree;
    71.   }
    73.   checkBoxChange(node: NzTreeNode, onItemSelect: (item: TransferItem) => void): void {
    74.     if (node.isDisabled) {
    75.       return;
    76.     }
    77.     node.isChecked = !node.isChecked;
    78.     if (node.isChecked) {
    79.       this.checkedNodeList.push(node);
    80.     } else {
    81.       const idx = this.checkedNodeList.indexOf(node);
    82.       if (idx !== -1) {
    83.         this.checkedNodeList.splice(idx, 1);
    84.       }
    85.     }
    86.     const item = this.list.find(w => w.id === node.origin.id);
    87.     onItemSelect(item);
    88.   }
    90.   change(ret: TransferChange): void {
    91.     const isDisabled = ret.to === 'right';
    92.     this.checkedNodeList.forEach(node => {
    93.       node.isDisabled = isDisabled;
    94.       node.isChecked = isDisabled;
    95.     });
    96.   }

    TransferItem

    参数说明类型默认值
    title标题，用于显示及搜索关键字判断string-
    direction指定数据方向，若指定 right 为右栏，其他情况为左栏'left' | 'right'-
    disabled指定checkbox为不可用状态booleanfalse
    checked指定checkbox为选中状态booleanfalse

    TransferCanMove

    TransferChange

    参数说明类型默认值
    from数据方向'left' | 'right'-
    to数据方向'left' | 'right'-
    list数据源TransferItem[][]

    TransferSearchChange

    nzRenderList

    参数说明类型默认值
    direction渲染列表的方向'left' | 'right'-
    disabled是否禁用列表boolean-
    items过滤后的数据TransferItem[]-
    onItemSelect勾选条目(item: TransferItem) => void-
    onItemSelectAll勾选一组条目-