You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: components/transfer/doc/index.en-US.md
+51-51Lines changed: 51 additions & 51 deletions
Original file line number
Diff line number
Diff line change
@@ -20,69 +20,69 @@ import { NzTransferModule } from 'ng-zorro-antd/transfer';
20
20
21
21
## API
22
22
23
-
### nz-transfer
24
-
25
-
| Property | Description | Type | Default |
26
-
| -------- | ----------- | ---- | ------- |
27
-
|`[nzDataSource]`| Used for setting the data source. Except for the elements whose keys are `direction: 'right'` prop, or using `nzTargetKeys` prop. |`TransferItem[]`|`[]`|
28
-
|`[nzDisabled]`| Whether the transfer is disabled |`boolean`|`false`|
29
-
|`[nzTitles]`| A set of titles that are sorted from left to right. |`string[]`|`['', '']`|
30
-
|`[nzOperations]`| A set of operations that are sorted from bottom to top. |`string[]`|`['', '']`|
31
-
|`[nzListStyle]`| A custom CSS style used for rendering the transfer columns. equals to `ngStyle`|`object`| - |
32
-
|`[nzItemUnit]`| single unit |`string`|`'item'`|
33
-
|`[nzItemsUnit]`| multiple unit |`string`|`'items'`|
34
-
|`[nzRenderList]`| Customize render list, please refer to the case. |`Array<TemplateRef<void> \| null>`|`[null, null]`|
35
-
|`[nzRender]`| The function to generate the item shown on a column. please refer to the case. |`TemplateRef<void>`| - |
36
-
|`[nzFooter]`| A function used for rendering the footer. please refer to the case. |`TemplateRef<void>`| - |
37
-
|`[nzShowSearch]`| Whether a search box is shown on each column. |`boolean`|`false`|
38
-
|`[nzFilterOption]`| A function to determine whether an item should be shown in a search result list |`(inputValue: string, item: TransferItem) => boolean`| - |
39
-
|`[nzSearchPlaceholder]`| The hint text of the search box. |`string`|`'Search here'`|
40
-
|`[nzNotFoundContent]`| Text to display when a column is empty. |`string`|`'The list is empty'`|
41
-
|`[nzCanMove]`| A function to determine what items should be moved (by default all checked items are moved). please refer to the case. |`(arg: TransferCanMove) => Observable<TransferItem[]>`| - |
42
-
|`[nzSelectedKeys]`| A set of keys of selected items. |`string[]`| - |
43
-
|`[nzTargetKeys]`| A set of keys of elements that are listed on the right column. |`string[]`| - |
44
-
|`[nzStatus]`| Set validation status |`'error' \| 'warning'`| - |
45
-
|`(nzChange)`| A callback function that is executed when the transfer between columns is complete. |`EventEmitter<TransferChange>`| - |
46
-
|`(nzSearchChange)`| A callback function which is executed when search field are changed |`EventEmitter<TransferSearchChange>`| - |
47
-
|`(nzSelectChange)`| A callback function which is executed when selected items are changed. |`EventEmitter<TransferSearchChange>`| - |
|`[nzDataSource]`| Used for setting the data source. Except for the elements whose keys are `direction: 'right'` prop, or using `nzTargetKeys` prop. |`TransferItem[]`|`[]`|
28
+
|`[nzDisabled]`| Whether the transfer is disabled |`boolean`|`false`|
29
+
|`[nzTitles]`| A set of titles that are sorted from left to right. |`string[]`|`['', '']`|
30
+
|`[nzOperations]`| A set of operations that are sorted from bottom to top. |`string[]`|`['', '']`|
31
+
|`[nzListStyle]`| A custom CSS style used for rendering the transfer columns. equals to `ngStyle`|`object`| -|
32
+
|`[nzItemUnit]`| single unit |`string`|`'item'`|
33
+
|`[nzItemsUnit]`| multiple unit |`string`|`'items'`|
34
+
|`[nzRenderList]`| Customize render list, please refer to the case. |`Array<TemplateRef<void> \| null>`|`[null, null]`|
35
+
|`[nzRender]`| The function to generate the item shown on a column. please refer to the case. |`TemplateRef<void>`| -|
36
+
|`[nzFooter]`| A function used for rendering the footer. please refer to the case. |`TemplateRef<void>`| -|
37
+
|`[nzShowSearch]`| Whether a search box is shown on each column. |`boolean`|`false`|
38
+
|`[nzFilterOption]`| A function to determine whether an item should be shown in a search result list |`(inputValue: string, item: TransferItem) => boolean`| -|
39
+
|`[nzSearchPlaceholder]`| The hint text of the search box. |`string`|`'Search here'`|
40
+
|`[nzNotFoundContent]`| Text to display when a column is empty. |`string`|`'The list is empty'`|
41
+
|`[nzCanMove]`| A function to determine what items should be moved (by default all checked items are moved). please refer to the case. |`(arg: TransferCanMove) => Observable<TransferItem[]>`| -|
42
+
|`[nzSelectedKeys]`| A set of keys of selected items. |`string[]`| -|
43
+
|`[nzTargetKeys]`| A set of keys of elements that are listed on the right column. |`string[]`| -|
44
+
|`[nzStatus]`| Set validation status |`'error' \| 'warning'`| -|
45
+
|`(nzChange)`| A callback function that is executed when the transfer between columns is complete. |`EventEmitter<TransferChange>`| -|
46
+
|`(nzSearchChange)`| A callback function which is executed when search field are changed |`EventEmitter<TransferSearchChange>`| -|
47
+
|`(nzSelectChange)`| A callback function which is executed when selected items are changed. |`EventEmitter<TransferSearchChange>`| -|
48
48
49
49
#### TransferItem
50
50
51
-
| Property | Description | Type | Default |
52
-
| -------- | ----------- | ---- | ------- |
53
-
| title | Used to display and search keyword |`string`| - |
54
-
| direction | Used for setting the data source. Except the elements whose keys are `direction: 'right'` prop. |`'left' \| 'right'`| - |
55
-
| disabled | specifies whether the checkbox is disabled |`boolean`|`false`|
56
-
| checked | specifies whether the checkbox is selected |`boolean`|`false`|
0 commit comments