Skip to content

Commit 517cc9b

Browse files
committed
Merge branch 'main' into doc/card
# Conflicts: # db/TDesign.db
2 parents 7e7c58e + 05f3848 commit 517cc9b

File tree

20 files changed

+84
-69
lines changed

20 files changed

+84
-69
lines changed

db/TDesign.db

0 Bytes
Binary file not shown.

packages/products/tdesign-react/src/image-viewer/image-viewer.en-US.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@ name | type | default | description | required
88
className | String | - | 类名 | N
99
style | Object | - | 样式,Typescript:`React.CSSProperties` | N
1010
closeBtn | TNode | true | Typescript:`boolean \| TNode`[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/src/common.ts) | N
11-
closeOnEscKeydown | Boolean | - | trigger image viewer close event on `ESC` keydown | N
11+
closeOnEscKeydown | Boolean | true | trigger image viewer close event on `ESC` keydown | N
1212
closeOnOverlay | Boolean | - | \- | N
1313
draggable | Boolean | undefined | \- | N
14-
imageScale | Object | - | Typescript:`ImageScale` `interface ImageScale { max: number; min: number; step: number }`[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/src/image-viewer/type.ts) | N
14+
imageScale | Object | - | Typescript:`ImageScale` `interface ImageScale { max: number; min: number; step: number; defaultScale?: number; }`[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/src/image-viewer/type.ts) | N
1515
images | Array | [] | Typescript:`Array<string \| File \| ImageInfo>` `interface ImageInfo { mainImage: string \| File; thumbnail?: string \| File; download?: boolean }`[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/src/image-viewer/type.ts) | N
1616
index | Number | 0 | \- | N
1717
defaultIndex | Number | 0 | uncontrolled property | N
@@ -21,8 +21,8 @@ showOverlay | Boolean | undefined | \- | N
2121
title | TNode | - | preview title。Typescript:`string \| TNode`[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/src/common.ts) | N
2222
trigger | TNode | - | trigger element。Typescript:`TNode \| TNode<{ open: () => void }>`[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/src/common.ts) | N
2323
viewerScale | Object | - | Typescript:`ImageViewerScale` `interface ImageViewerScale { minWidth: number; minHeight: number }`[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/src/image-viewer/type.ts) | N
24-
visible | Boolean | false | \- | N
25-
defaultVisible | Boolean | false | uncontrolled property | N
24+
visible | Boolean | false | hide or show image viewer | N
25+
defaultVisible | Boolean | false | hide or show image viewer。uncontrolled property | N
2626
zIndex | Number | - | \- | N
2727
onClose | Function | | Typescript:`(context: { trigger: 'close-btn' \| 'overlay' \| 'esc'; e: MouseEvent \| KeyboardEvent }) => void`<br/> | N
2828
onIndexChange | Function | | Typescript:`(index: number, context: { trigger: 'prev' \| 'next' \| 'current' }) => void`<br/> | N

packages/products/tdesign-react/src/image-viewer/image-viewer.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@
88
className | String | - | 类名 | N
99
style | Object | - | 样式,TS 类型:`React.CSSProperties` | N
1010
closeBtn | TNode | true | 是否展示关闭按钮,值为 `true` 显示默认关闭按钮;值为 `false` 则不显示关闭按钮;也可以完全自定义关闭按钮。TS 类型:`boolean \| TNode`[通用类型定义](https://github.com/Tencent/tdesign-react/blob/develop/src/common.ts) | N
11-
closeOnEscKeydown | Boolean | - | 按下 ESC 时是否触发图片预览器关闭事件 | N
11+
closeOnEscKeydown | Boolean | true | 按下 ESC 时是否触发图片预览器关闭事件 | N
1212
closeOnOverlay | Boolean | - | 是否在点击遮罩层时,触发预览关闭 | N
1313
draggable | Boolean | undefined | 是否允许拖拽调整位置。`mode=modal` 时,默认不允许拖拽;`mode=modeless` 时,默认允许拖拽 | N
14-
imageScale | Object | - | 图片缩放相关配置。`imageScale.max` 缩放的最大比例;`imageScale.min` 缩放的最小比例;`imageScale.step` 缩放的步长速度。TS 类型:`ImageScale` `interface ImageScale { max: number; min: number; step: number }`[详细类型定义](https://github.com/Tencent/tdesign-react/blob/develop/src/image-viewer/type.ts) | N
14+
imageScale | Object | - | 图片缩放相关配置。`imageScale.max` 缩放的最大比例;`imageScale.min` 缩放的最小比例;`imageScale.step` 缩放的步长速度; `imageScale.defaultScale` 默认的缩放比例。TS 类型:`ImageScale` `interface ImageScale { max: number; min: number; step: number; defaultScale?: number; }`[详细类型定义](https://github.com/Tencent/tdesign-react/blob/develop/src/image-viewer/type.ts) | N
1515
images | Array | [] | 图片数组。`mainImage` 表示主图,必传;`thumbnail` 表示缩略图,如果不存在,则使用主图显示;`download` 是否允许下载图片,默认允许下载。示例: `['img_url_1', 'img_url_2']``[{ thumbnail: 'small_image_url', mainImage: 'big_image_url', download: false }]`。TS 类型:`Array<string \| File \| ImageInfo>` `interface ImageInfo { mainImage: string \| File; thumbnail?: string \| File; download?: boolean }`[详细类型定义](https://github.com/Tencent/tdesign-react/blob/develop/src/image-viewer/type.ts) | N
1616
index | Number | 0 | 当前预览图片所在的下标 | N
1717
defaultIndex | Number | 0 | 当前预览图片所在的下标。非受控属性 | N

packages/products/tdesign-react/src/upload/defaultProps.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ export const uploadDefaultProps: TdUploadProps = {
1919
showUploadProgress: true,
2020
theme: 'file',
2121
uploadAllFilesInOneRequest: false,
22-
uploadPastedFiles: false,
22+
uploadPastedFiles: true,
2323
useMockProgress: true,
2424
withCredentials: false,
2525
};

packages/products/tdesign-react/src/upload/type.ts

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ export interface TdUploadProps<T extends UploadFile = UploadFile> {
4444
*/
4545
beforeUpload?: (file: UploadFile) => boolean | Promise<boolean>;
4646
/**
47-
* 透传“取消上传”按钮属性
47+
* 批量文件/图片上传,`autoUpload=false` 场景下,透传“取消上传”按钮属性
4848
*/
4949
cancelUploadButton?:
5050
| null
@@ -93,7 +93,7 @@ export interface TdUploadProps<T extends UploadFile = UploadFile> {
9393
*/
9494
formatRequest?: (requestData: { [key: string]: any }) => { [key: string]: any };
9595
/**
96-
* 用于格式化文件上传后的接口响应数据,`response` 便是接口响应的原始数据。`action` 存在时有效。<br/> 此函数的返回值 `error` 或 `response.error` 会作为错误文本提醒,如果存在会判定为本次上传失败。<br/> 此函数的返回值 `url` 或 `response.url` 会作为上传成功后的链接
96+
* 用于格式化文件上传后的接口响应数据,`response` 便是接口响应的原始数据。`action` 存在时有效。<br/> 示例返回值:`{ error, url, status, files }` <br/> 此函数的返回值 `error` 会作为错误文本提醒,表示上传失败的原因,如果存在会判定为本次上传失败。<br/> 此函数的返回值 `url` 会作为单个文件上传成功后的链接。<br/> `files` 表示一个请求同时上传多个文件后的文件列表
9797
*/
9898
formatResponse?: (response: any, context: FormatResponseContext) => ResponseType;
9999
/**
@@ -196,15 +196,15 @@ export interface TdUploadProps<T extends UploadFile = UploadFile> {
196196
*/
197197
uploadAllFilesInOneRequest?: boolean;
198198
/**
199-
* 透传“点击上传”按钮属性
199+
* 批量文件/图片上传,`autoUpload=false` 场景下,透传“点击上传”按钮属性
200200
*/
201201
uploadButton?:
202202
| null
203203
| ButtonProps
204204
| TNode<{ disabled: boolean; uploading: boolean; uploadFiles: () => void; uploadText: string }>;
205205
/**
206206
* 是否允许粘贴上传剪贴板中的文件
207-
* @default false
207+
* @default true
208208
*/
209209
uploadPastedFiles?: boolean;
210210
/**
@@ -346,7 +346,10 @@ export interface UploadFile extends PlainObject {
346346
url?: string;
347347
}
348348

349-
export type ResponseType = { error?: string; url?: string } & Record<string, any>;
349+
export type ResponseType = { error?: string; url?: string; status?: 'fail' | 'success'; files?: UploadFile[] } & Record<
350+
string,
351+
any
352+
>;
350353

351354
export interface FormatResponseContext {
352355
file: UploadFile;

packages/products/tdesign-react/src/upload/upload.en-US.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ allowUploadDuplicateFile | Boolean | false | allow to upload duplicate name file
1414
autoUpload | Boolean | true | post upload request automatically after files being selected | N
1515
beforeAllFilesUpload | Function | - | before all files upload, return false can stop uploading file。Typescript:`(file: UploadFile[]) => boolean \| Promise<boolean>` | N
1616
beforeUpload | Function | - | stop one of files to upload。Typescript:`(file: UploadFile) => boolean \| Promise<boolean>` | N
17-
cancelUploadButton | Object / Function | - | click to cancel upload button props。Typescript:`null \| ButtonProps \| TNode<{ disabled: boolean; cancelUploadText: string; cancelUpload: (ctx: { e: MouseEvent }) => void }>`[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/src/common.ts) | N
17+
cancelUploadButton | TNode | - | cancel upload button props, which showed on `autoUpload=false` and multiple files/images upload。Typescript:`null \| ButtonProps \| TNode<{ disabled: boolean; cancelUploadText: string; cancelUpload: (ctx: { e: MouseEvent }) => void }>`[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/src/common.ts) | N
1818
children | TNode | - | to define upload trigger elements if `draggable=false`, to define drag elements if `draggable=true`。Typescript:`string \| TNode`[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/src/common.ts) | N
1919
data | Object | - | extra request data of uploading. `formatRequest` can redefine all request data。Typescript:`Record<string, any> \| ((files: UploadFile[]) => Record<string, any>)` | N
2020
disabled | Boolean | - | make upload to be disabled | N
@@ -25,7 +25,7 @@ files | Array | [] | Typescript:`Array<T>` | N
2525
defaultFiles | Array | [] | uncontrolled property。Typescript:`Array<T>` | N
2626
format | Function | - | to redefine `UploadFile` data structure。Typescript:`(file: File) => UploadFile` | N
2727
formatRequest | Function | - | redefine request data。Typescript:`(requestData: { [key: string]: any }) => { [key: string]: any }` | N
28-
formatResponse | Function | - | redefine response data structure。Typescript:`(response: any, context: FormatResponseContext) => ResponseType ` `type ResponseType = { error?: string; url?: string } & Record<string, any>` `interface FormatResponseContext { file: UploadFile; currentFiles?: UploadFile[] }`[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/src/upload/type.ts) | N
28+
formatResponse | Function | - | redefine response data structure。Typescript:`(response: any, context: FormatResponseContext) => ResponseType ` `type ResponseType = { error?: string; url?: string; status?: 'fail' \| 'success'; files?: UploadFile[] } & Record<string, any>` `interface FormatResponseContext { file: UploadFile; currentFiles?: UploadFile[] }`[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/src/upload/type.ts) | N
2929
headers | Object | - | HTTP Request Header。Typescript:`{[key: string]: string}` | N
3030
imageViewerProps | Object | - | ImageViewer Component Props。Typescript:`ImageViewerProps`[ImageViewer API Documents](./image-viewer?tab=api)[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/src/upload/type.ts) | N
3131
inputAttributes | Object | - | add attributes to HTML element `input`。Typescript:`CSSProperties` | N
@@ -48,8 +48,8 @@ tips | TNode | - | tips text below upload component, define it's color with `sta
4848
trigger | TElement | - | trigger elements UI。Typescript:`TNode<TriggerContext>` `interface TriggerContext { dragActive?: boolean; files: UploadFile[] }`[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/src/common.ts)[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/src/upload/type.ts) | N
4949
triggerButtonProps | Object | - | trigger button props, it can be used to change color/size/href/... of the trigger button。Typescript:`ButtonProps`[Button API Documents](./button?tab=api)[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/src/upload/type.ts) | N
5050
uploadAllFilesInOneRequest | Boolean | false | uploading all files in one request | N
51-
uploadButton | TNode | - | click to upload button props。Typescript:`null \| ButtonProps \| TNode<{ disabled: boolean; uploading: boolean; uploadFiles: () => void; uploadText: string }>`[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/src/common.ts) | N
52-
uploadPastedFiles | Boolean | false | allow to upload files in clipboard after pasting | N
51+
uploadButton | TNode | - | upload button props, which showed on `autoUpload=false` and multiple files/images upload。Typescript:`null \| ButtonProps \| TNode<{ disabled: boolean; uploading: boolean; uploadFiles: () => void; uploadText: string }>`[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/src/common.ts) | N
52+
uploadPastedFiles | Boolean | true | allow to upload files in clipboard after pasting | N
5353
useMockProgress | Boolean | true | use mock progress, instead of real progress | N
5454
withCredentials | Boolean | false | uploading request with cookie | N
5555
onCancelUpload | Function | | Typescript:`() => void`<br/>trigger on cancel button click | N

0 commit comments

Comments
 (0)