From 1a9a2dd1c3d49a391aa98b231dc548ba7523efc3 Mon Sep 17 00:00:00 2001 From: Artur Androsovych Date: Thu, 12 May 2022 11:44:56 +0300 Subject: [PATCH] docs(module:transfer): update `index.en-US.md` (#7416) --- components/transfer/doc/index.en-US.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/components/transfer/doc/index.en-US.md b/components/transfer/doc/index.en-US.md index 4341b07b88..0537e3f20a 100644 --- a/components/transfer/doc/index.en-US.md +++ b/components/transfer/doc/index.en-US.md @@ -10,9 +10,9 @@ Double column transfer choice box. ## When To Use -Transfer the elements between two columns in an intuitive and efficient way. +Transfer the elements between two columns intuitively and efficiently. -One or more elements can be selected from either column, one click on the proper 'direction' button, and the transfer is done. The left column is considered the 'source' and the right column is considered the 'target'. As you can see in the API description, these names are reflected in. +The left column is considered the 'source', and the right column is considered the 'target'. One or more elements can be selected from either column, one click on the proper 'direction' button, and the transfer is done. As you can see in the API description, these names are reflected in. ```ts import { NzTransferModule } from 'ng-zorro-antd/transfer'; @@ -24,21 +24,21 @@ import { NzTransferModule } from 'ng-zorro-antd/transfer'; | Property | Description | Type | Default | | -------- | ----------- | ---- | ------- | -| `[nzDataSource]` | Used for setting the source data. Except the elements whose keys are `direction: 'right'` prop , or using `nzTargetKeys` prop. | `TransferItem[]` | `[]` | -| `[nzDisabled]` | Whether disabled transfer | `boolean` | `false` | +| `[nzDataSource]` | Used for setting the data source. Except for the elements whose keys are `direction: 'right'` prop, or using `nzTargetKeys` prop. | `TransferItem[]` | `[]` | +| `[nzDisabled]` | Whether the transfer is disabled | `boolean` | `false` | | `[nzTitles]` | A set of titles that are sorted from left to right. | `string[]` | `['', '']` | | `[nzOperations]` | A set of operations that are sorted from bottom to top. | `string[]` | `['', '']` | -| `[nzListStyle]` | A custom CSS style used for rendering the transfer columns. equal `ngStyle` | `object` | - | +| `[nzListStyle]` | A custom CSS style used for rendering the transfer columns. equals to `ngStyle` | `object` | - | | `[nzItemUnit]` | single unit | `string` | `'item'` | | `[nzItemsUnit]` | multiple unit | `string` | `'items'` | | `[nzRenderList]` | Customize render list, please refer to the case. | `Array \| null>` | `[null, null]` | | `[nzRender]` | The function to generate the item shown on a column. please refer to the case. | `TemplateRef` | - | | `[nzFooter]` | A function used for rendering the footer. please refer to the case. | `TemplateRef` | - | -| `[nzShowSearch]` | If included, a search box is shown on each column. | `boolean` | `false` | -| `[nzFilterOption]` | A function to determine whether an item should show in search result list | `(inputValue: string, item: TransferItem) => boolean` | - | +| `[nzShowSearch]` | Whether a search box is shown on each column. | `boolean` | `false` | +| `[nzFilterOption]` | A function to determine whether an item should be shown in a search result list | `(inputValue: string, item: TransferItem) => boolean` | - | | `[nzSearchPlaceholder]` | The hint text of the search box. | `string` | `'Search here'` | | `[nzNotFoundContent]` | Text to display when a column is empty. | `string` | `'The list is empty'` | -| `[nzCanMove]` | Two verification when transfer choice box. please refer to the case. | `(arg: TransferCanMove) => Observable` | - | +| `[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` | - | | `[nzSelectedKeys]` | A set of keys of selected items. | `string[]` | - | | `[nzTargetKeys]` | A set of keys of elements that are listed on the right column. | `string[]` | - | | `(nzChange)` | A callback function that is executed when the transfer between columns is complete. | `EventEmitter` | - | @@ -50,7 +50,7 @@ import { NzTransferModule } from 'ng-zorro-antd/transfer'; | Property | Description | Type | Default | | -------- | ----------- | ---- | ------- | | title | Used to display and search keyword | `string` | - | -| direction | Used for setting the source data. Except the elements whose keys are `direction: 'right'` prop. | `'left' \| 'right'` | - | +| direction | Used for setting the data source. Except the elements whose keys are `direction: 'right'` prop. | `'left' \| 'right'` | - | | disabled | specifies whether the checkbox is disabled | `boolean` | `false` | | checked | specifies whether the checkbox is selected | `boolean` | `false` |