Skip to content

Commit

Permalink
docs(Transfer): update desc (#3398)
Browse files Browse the repository at this point in the history
  • Loading branch information
morningbao authored Nov 20, 2024
1 parent 862dfb1 commit 0f53830
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions src/transfer/components/transfer-list.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -130,15 +130,15 @@ export default mixins(keepAnimationMixins, classPrefixMixins).extend({
},
paginationProps(): TdPaginationProps {
const defaultPaginationProps: TdPaginationProps = {
size: 'small',
theme: 'simple',
totalContent: false,
pageSizeOptions: [],
};
return typeof this.pagination === 'object'
? {
...defaultPaginationProps,
...this.pagination,
size: 'small',
theme: 'simple',
current: this.currentPage,
total: this.pageTotal,
pageSize: this.pageSize,
Expand Down
2 changes: 1 addition & 1 deletion src/transfer/transfer.en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ empty | String / Array / Slot / Function | '' | Typescript:`EmptyType \| Array
footer | Array / Slot / Function | - | Typescript:`Array<string \| TNode> \| TNode<{ type: TransferListType }>`[see more ts definition](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N
keys | Object | - | alias field name in data。Typescript:`KeysType`[see more ts definition](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N
operation | Array / Slot / Function | - | Typescript:`Array<string \| TNode> \| TNode<{ direction: 'left' \| 'right' }>`[see more ts definition](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N
pagination | Object / Array | - | Typescript:`PaginationProps \| Array<PaginationProps>`[Pagination API Documents](./pagination?tab=api)[see more ts definition](https://github.com/Tencent/tdesign-vue/tree/develop/src/transfer/type.ts) | N
pagination | Object / Array | - | Typescript:`PaginationProps \| Array<PaginationProps>`[Pagination API Documents](./pagination?tab=api)Cannot configure 'theme' and 'size'`。[see more ts definition](https://github.com/Tencent/tdesign-vue/tree/develop/src/transfer/type.ts) | N
search | Boolean / Object / Array | false | Typescript:`SearchOption \| Array<SearchOption>` `type SearchOption = boolean \| InputProps`[Input API Documents](./input?tab=api)[see more ts definition](https://github.com/Tencent/tdesign-vue/tree/develop/src/transfer/type.ts) | N
showCheckAll | Boolean / Array | true | Typescript:`boolean \| Array<boolean>` | N
targetDraggable | Boolean | false | allowed to sort the target list by dragging | N
Expand Down
2 changes: 1 addition & 1 deletion src/transfer/transfer.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ empty | String / Array / Slot / Function | '' | 列表为空时呈现的内容
footer | Array / Slot / Function | - | 穿梭框底部内容。TS 类型:`Array<string \| TNode> \| TNode<{ type: TransferListType }>`[通用类型定义](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N
keys | Object | - | 用来定义 value / label / disabled 在 `data` 中对应的字段别名,示例:`{ label: 'text', value: 'id' }`,表示选项文本取 `text` 字段,选项值取 `id` 字段。TS 类型:`KeysType`[通用类型定义](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N
operation | Array / Slot / Function | - | 方向操作按钮。默认显示组件内置操作图标。自定义操作图标示例:['向左', '向右'] 或者 `[() => <i class='left' />, () => <i class='left' />]` 或者 `(h, direction) => direction === 'left' ? '《' : '》'`。TS 类型:`Array<string \| TNode> \| TNode<{ direction: 'left' \| 'right' }>`[通用类型定义](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N
pagination | Object / Array | - | 分页配置,值为空则不显示。具体 API 参考分页组件。值类型为数组,表示可分别控制源列表和目标列表分页组件。TS 类型:`PaginationProps \| Array<PaginationProps>`[Pagination API Documents](./pagination?tab=api)[详细类型定义](https://github.com/Tencent/tdesign-vue/tree/develop/src/transfer/type.ts) | N
pagination | Object / Array | - | 分页配置,值为空则不显示。具体 API 参考分页组件。不支持配置`theme``size`值类型为数组,表示可分别控制源列表和目标列表分页组件。TS 类型:`PaginationProps \| Array<PaginationProps>`[Pagination API Documents](./pagination?tab=api)[详细类型定义](https://github.com/Tencent/tdesign-vue/tree/develop/src/transfer/type.ts) | N
search | Boolean / Object / Array | false | 搜索框配置,值为 false 表示不显示搜索框;值为 true 表示显示默认搜索框;值类型为对象,用于透传 Props 到 Input 组件;值类型为数组,则分别表示控制两侧搜索框。TS 类型:`SearchOption \| Array<SearchOption>` `type SearchOption = boolean \| InputProps`[Input API Documents](./input?tab=api)[详细类型定义](https://github.com/Tencent/tdesign-vue/tree/develop/src/transfer/type.ts) | N
showCheckAll | Boolean / Array | true | 是否显示全选,值类型为数组则表示分别控制源列表和目标列表。TS 类型:`boolean \| Array<boolean>` | N
targetDraggable | Boolean | false | 是否允许通过拖拽对目标列表进行排序 | N
Expand Down

0 comments on commit 0f53830

Please sign in to comment.