@apexhub/apex-ui-react 0.0.0-stage → 1.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +37 -2
- package/dist/en_US.d.ts +191 -0
- package/dist/index.cjs +40692 -0
- package/dist/index.d.ts +6869 -0
- package/dist/index.mjs +40676 -0
- package/dist/llm/alert.tokens.txt +44 -0
- package/dist/llm/alert.txt +167 -0
- package/dist/llm/apex-provider.txt +368 -0
- package/dist/llm/auto-complete.tokens.txt +77 -0
- package/dist/llm/auto-complete.txt +373 -0
- package/dist/llm/avatar.tokens.txt +38 -0
- package/dist/llm/avatar.txt +199 -0
- package/dist/llm/breadcrumb.tokens.txt +193 -0
- package/dist/llm/breadcrumb.txt +251 -0
- package/dist/llm/button.tokens.txt +470 -0
- package/dist/llm/button.txt +262 -0
- package/dist/llm/card.tokens.txt +27 -0
- package/dist/llm/card.txt +95 -0
- package/dist/llm/cascader.tokens.txt +253 -0
- package/dist/llm/cascader.txt +898 -0
- package/dist/llm/checkbox.tokens.txt +28 -0
- package/dist/llm/checkbox.txt +332 -0
- package/dist/llm/collapse.tokens.txt +84 -0
- package/dist/llm/collapse.txt +330 -0
- package/dist/llm/date-picker.tokens.txt +171 -0
- package/dist/llm/date-picker.txt +424 -0
- package/dist/llm/divider.tokens.txt +22 -0
- package/dist/llm/divider.txt +161 -0
- package/dist/llm/drawer.tokens.txt +71 -0
- package/dist/llm/drawer.txt +369 -0
- package/dist/llm/dropdown.tokens.txt +59 -0
- package/dist/llm/dropdown.txt +420 -0
- package/dist/llm/form.tokens.txt +26 -0
- package/dist/llm/form.txt +341 -0
- package/dist/llm/grid.txt +419 -0
- package/dist/llm/image.tokens.txt +28 -0
- package/dist/llm/image.txt +428 -0
- package/dist/llm/input-number.tokens.txt +159 -0
- package/dist/llm/input-number.txt +486 -0
- package/dist/llm/input.tokens.txt +136 -0
- package/dist/llm/input.txt +422 -0
- package/dist/llm/layout.tokens.txt +29 -0
- package/dist/llm/layout.txt +298 -0
- package/dist/llm/menu.tokens.txt +87 -0
- package/dist/llm/menu.txt +680 -0
- package/dist/llm/message.tokens.txt +25 -0
- package/dist/llm/message.txt +301 -0
- package/dist/llm/modal.tokens.txt +96 -0
- package/dist/llm/modal.txt +584 -0
- package/dist/llm/notification.tokens.txt +79 -0
- package/dist/llm/notification.txt +383 -0
- package/dist/llm/pagination.tokens.txt +33 -0
- package/dist/llm/pagination.txt +208 -0
- package/dist/llm/popover.tokens.txt +28 -0
- package/dist/llm/popover.txt +233 -0
- package/dist/llm/progress.tokens.txt +83 -0
- package/dist/llm/progress.txt +279 -0
- package/dist/llm/radio.tokens.txt +21 -0
- package/dist/llm/radio.txt +348 -0
- package/dist/llm/rate.tokens.txt +20 -0
- package/dist/llm/rate.txt +241 -0
- package/dist/llm/select.tokens.txt +160 -0
- package/dist/llm/select.txt +830 -0
- package/dist/llm/skeleton.tokens.txt +15 -0
- package/dist/llm/skeleton.txt +275 -0
- package/dist/llm/spin.tokens.txt +21 -0
- package/dist/llm/spin.txt +294 -0
- package/dist/llm/steps.tokens.txt +30 -0
- package/dist/llm/steps.txt +300 -0
- package/dist/llm/switch.tokens.txt +38 -0
- package/dist/llm/switch.txt +216 -0
- package/dist/llm/table.tokens.txt +94 -0
- package/dist/llm/table.txt +1046 -0
- package/dist/llm/tabs.tokens.txt +78 -0
- package/dist/llm/tabs.txt +306 -0
- package/dist/llm/tag.tokens.txt +76 -0
- package/dist/llm/tag.txt +305 -0
- package/dist/llm/tooltip.tokens.txt +22 -0
- package/dist/llm/tooltip.txt +304 -0
- package/dist/llm/tree-select.tokens.txt +174 -0
- package/dist/llm/tree-select.txt +762 -0
- package/dist/llm/tree.tokens.txt +36 -0
- package/dist/llm/tree.txt +505 -0
- package/dist/llm/typography.tokens.txt +60 -0
- package/dist/llm/typography.txt +413 -0
- package/dist/llm/upload.tokens.txt +201 -0
- package/dist/llm/upload.txt +706 -0
- package/dist/llms-full.txt +16689 -0
- package/dist/llms-theme.txt +32 -0
- package/dist/llms.txt +59 -0
- package/dist/locale/en_US.cjs +160 -0
- package/dist/locale/en_US.d.ts +4 -0
- package/dist/locale/en_US.mjs +161 -0
- package/dist/locale/zh_CN.cjs +160 -0
- package/dist/locale/zh_CN.d.ts +4 -0
- package/dist/locale/zh_CN.mjs +161 -0
- package/dist/style.css +19619 -0
- package/dist/zh_CN.d.ts +191 -0
- package/llms-full.txt +16689 -0
- package/llms-theme.txt +32 -0
- package/llms.txt +59 -0
- package/package.json +118 -3
- package/src/alert/llm.txt +167 -0
- package/src/alert/tokens.txt +44 -0
- package/src/apex-provider/llm.txt +368 -0
- package/src/auto-complete/llm.txt +373 -0
- package/src/auto-complete/tokens.txt +77 -0
- package/src/avatar/llm.txt +199 -0
- package/src/avatar/tokens.txt +38 -0
- package/src/breadcrumb/llm.txt +251 -0
- package/src/breadcrumb/tokens.txt +193 -0
- package/src/button/llm.txt +262 -0
- package/src/button/tokens.txt +470 -0
- package/src/card/llm.txt +95 -0
- package/src/card/tokens.txt +27 -0
- package/src/cascader/llm.txt +898 -0
- package/src/cascader/tokens.txt +253 -0
- package/src/checkbox/llm.txt +332 -0
- package/src/checkbox/tokens.txt +28 -0
- package/src/collapse/llm.txt +330 -0
- package/src/collapse/tokens.txt +84 -0
- package/src/date-picker/llm.txt +424 -0
- package/src/date-picker/tokens.txt +171 -0
- package/src/divider/llm.txt +161 -0
- package/src/divider/tokens.txt +22 -0
- package/src/drawer/llm.txt +369 -0
- package/src/drawer/tokens.txt +71 -0
- package/src/dropdown/llm.txt +420 -0
- package/src/dropdown/tokens.txt +59 -0
- package/src/form/llm.txt +341 -0
- package/src/form/tokens.txt +26 -0
- package/src/grid/llm.txt +419 -0
- package/src/image/llm.txt +428 -0
- package/src/image/tokens.txt +28 -0
- package/src/input/llm.txt +422 -0
- package/src/input/tokens.txt +136 -0
- package/src/input-number/llm.txt +486 -0
- package/src/input-number/tokens.txt +159 -0
- package/src/layout/llm.txt +298 -0
- package/src/layout/tokens.txt +29 -0
- package/src/menu/llm.txt +680 -0
- package/src/menu/tokens.txt +87 -0
- package/src/message/llm.txt +301 -0
- package/src/message/tokens.txt +25 -0
- package/src/modal/llm.txt +584 -0
- package/src/modal/tokens.txt +96 -0
- package/src/notification/llm.txt +383 -0
- package/src/notification/tokens.txt +79 -0
- package/src/pagination/llm.txt +208 -0
- package/src/pagination/tokens.txt +33 -0
- package/src/popover/llm.txt +233 -0
- package/src/popover/tokens.txt +28 -0
- package/src/progress/llm.txt +279 -0
- package/src/progress/tokens.txt +83 -0
- package/src/radio/llm.txt +348 -0
- package/src/radio/tokens.txt +21 -0
- package/src/rate/llm.txt +241 -0
- package/src/rate/tokens.txt +20 -0
- package/src/select/llm.txt +830 -0
- package/src/select/tokens.txt +160 -0
- package/src/skeleton/llm.txt +275 -0
- package/src/skeleton/tokens.txt +15 -0
- package/src/spin/llm.txt +294 -0
- package/src/spin/tokens.txt +21 -0
- package/src/steps/llm.txt +300 -0
- package/src/steps/tokens.txt +30 -0
- package/src/switch/llm.txt +216 -0
- package/src/switch/tokens.txt +38 -0
- package/src/table/llm.txt +1046 -0
- package/src/table/tokens.txt +94 -0
- package/src/tabs/llm.txt +306 -0
- package/src/tabs/tokens.txt +78 -0
- package/src/tag/llm.txt +305 -0
- package/src/tag/tokens.txt +76 -0
- package/src/tooltip/llm.txt +304 -0
- package/src/tooltip/tokens.txt +22 -0
- package/src/tree/llm.txt +505 -0
- package/src/tree/tokens.txt +36 -0
- package/src/tree-select/llm.txt +762 -0
- package/src/tree-select/tokens.txt +174 -0
- package/src/typography/llm.txt +413 -0
- package/src/typography/tokens.txt +60 -0
- package/src/upload/llm.txt +706 -0
- package/src/upload/tokens.txt +201 -0
|
@@ -0,0 +1,706 @@
|
|
|
1
|
+
# Upload
|
|
2
|
+
|
|
3
|
+
> Upload:需要将本地文件上传到服务端,并展示上传进度与结果列表时。
|
|
4
|
+
|
|
5
|
+
包:`@apexhub/apex-ui-react`;版本:`1.2.0`(当前源码快照,发布状态以安装包版本为准)。
|
|
6
|
+
|
|
7
|
+
公开导出:`canPreviewFile`、`configureUploadLimits`、`formatFileSize`、`getFileExtension`、`getFileFormatIconName`、`getFileKind`、`getFilePreviewKind`、`getFilePreviewUrl`、`getUploadLimits`、`isDocumentFile`、`isImageFile`、`resetUploadLimits`、`UPLOAD_DEFAULT_MAX_COUNT`、`UPLOAD_DEFAULT_MAX_FILE_SIZE`、`UPLOAD_LIST_IGNORE`、`Upload`。
|
|
8
|
+
|
|
9
|
+
以下 API 属于 Apex UI;不要据 antd 的同名组件推断额外属性或默认值。默认值列的空缺表示未声明,不代表 `false`。
|
|
10
|
+
|
|
11
|
+
## 快速开始
|
|
12
|
+
|
|
13
|
+
```tsx
|
|
14
|
+
import { Upload } from '@apexhub/apex-ui-react'
|
|
15
|
+
|
|
16
|
+
import type { UploadProps } from '@apexhub/apex-ui-react'
|
|
17
|
+
|
|
18
|
+
import '@apexhub/apex-ui-react/style.css'
|
|
19
|
+
|
|
20
|
+
function uploadDemoImageDataUrl(
|
|
21
|
+
fill: string,
|
|
22
|
+
label: string,
|
|
23
|
+
width = 200,
|
|
24
|
+
height = 200,
|
|
25
|
+
): string {
|
|
26
|
+
const fontSize = Math.round(Math.min(width, height) * 0.2)
|
|
27
|
+
return (
|
|
28
|
+
'data:image/svg+xml;utf8,' +
|
|
29
|
+
encodeURIComponent(
|
|
30
|
+
`<svg xmlns="http://www.w3.org/2000/svg" width="${width}" height="${height}"><rect width="100%" height="100%" fill="${fill}"/><text x="50%" y="55%" dominant-baseline="middle" fill="white" font-family="Arial,sans-serif" font-size="${fontSize}" text-anchor="middle">${label}</text></svg>`,
|
|
31
|
+
)
|
|
32
|
+
)
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
const UPLOAD_DEMO_IMAGE = uploadDemoImageDataUrl('#7B61FF', 'IMG')
|
|
36
|
+
|
|
37
|
+
const UPLOAD_DEMO_IMAGE_BLUR = uploadDemoImageDataUrl('#5B8DEF', 'BLUR')
|
|
38
|
+
|
|
39
|
+
const UPLOAD_DEMO_IMAGE_GRAY = uploadDemoImageDataUrl('#888888', 'ERR')
|
|
40
|
+
|
|
41
|
+
const UPLOAD_DEMO_IMAGE_LARGE = uploadDemoImageDataUrl('#7B61FF', 'UP', 400, 400)
|
|
42
|
+
|
|
43
|
+
const uploadDemoCustomRequest: NonNullable<UploadProps['customRequest']> = ({
|
|
44
|
+
onSuccess,
|
|
45
|
+
}) => {
|
|
46
|
+
window.setTimeout(() => {
|
|
47
|
+
onSuccess?.({ url: UPLOAD_DEMO_IMAGE_LARGE })
|
|
48
|
+
}, 300)
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
export default () => <Upload customRequest={uploadDemoCustomRequest} listType="text" />
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
## 何时使用
|
|
55
|
+
|
|
56
|
+
- 需要将本地文件上传到服务端,并展示上传进度与结果列表时。
|
|
57
|
+
- 图片场景可使用 `listType="picture"` 或 `picture-card` 展示缩略图。
|
|
58
|
+
- 大文件、分片上传或自定义签名流程请使用 `customRequest` 完全接管上传逻辑。
|
|
59
|
+
|
|
60
|
+
## API
|
|
61
|
+
|
|
62
|
+
仅使用类型定义支持的属性;原生属性、ref 目标和事件签名因组件而异。关联类型用于解释字段结构;只有「导出类型」中的名称可从包根导入。
|
|
63
|
+
|
|
64
|
+
### Upload
|
|
65
|
+
|
|
66
|
+
| 属性 | 说明 | 类型 | 必填 | 默认值 |
|
|
67
|
+
| --- | --- | --- | --- | --- |
|
|
68
|
+
| accept | 接受的文件类型 | `string \| UploadAcceptObject` | 否 | — |
|
|
69
|
+
| action | 上传地址;可为异步函数以动态解析 URL | `string \| ((file: File) => Promise<string>)` | 否 | — |
|
|
70
|
+
| beforeUpload | 上传前钩子;返回 `false` 或 reject 的 Promise 则不上传;<br>返回 `File`/`Blob` 则上传该对象;返回 `UPLOAD_LIST_IGNORE` 则不展示在列表 | `( file: File, fileList: File[], ) => File \| Blob \| boolean \| UploadListIgnore \| Promise<File \| Blob \| boolean \| UploadListIgnore>` | 否 | — |
|
|
71
|
+
| customRequest | 自定义上传实现;可通过 `info.defaultRequest` 调用内置上传 | `( options: UploadRequestOptions, info: { defaultRequest: (option: UploadRequestOptions) => void }, ) => void \| Promise<void>` | 否 | — |
|
|
72
|
+
| data | 上传附加字段或动态生成附加字段 | `Record<string, unknown> \| ((file: File) => Record<string, unknown> \| Promise<Record<string, unknown>>)` | 否 | — |
|
|
73
|
+
| defaultFileList | 非受控模式下的初始文件列表 | `UploadFile[]` | 否 | — |
|
|
74
|
+
| disabled | 是否禁用文件选择、拖拽及列表修改操作;已有文件仍可预览、下载。<br>text/picture 正常与手动文件行使用禁用样式,上传中与错误文件保留状态色。 | `boolean` | 否 | `false` |
|
|
75
|
+
| fileList | 受控文件列表 | `UploadFile[]` | 否 | — |
|
|
76
|
+
| headers | 上传请求头 | `Record<string, string>` | 否 | — |
|
|
77
|
+
| isImageUrl | 自定义是否按图片渲染缩略图 | `(file: UploadFile) => boolean` | 否 | — |
|
|
78
|
+
| prefixIcon | text 列表文件名前的装饰图标,可传节点或按文件返回节点。<br>未传或返回 undefined 时使用默认文件格式图标;null/false 隐藏图标。<br>不影响 picture/picture-card 缩略图或右侧操作图标。 | `React.ReactNode \| ((file: UploadFile) => React.ReactNode)` | 否 | — |
|
|
79
|
+
| itemRender | 自定义列表项节点 | `( originNode: React.ReactElement, file: UploadFile, fileList: UploadFile[], actions: { download: () => void preview: () => void remove: () => void }, ) => React.ReactNode` | 否 | — |
|
|
80
|
+
| listType | 列表展示形态 | `"picture" \| "text" \| "picture-card"` | 否 | `'text'` |
|
|
81
|
+
| variant | 触发区与 text/picture 列表项的视觉变体(`picture-card` 列表项仍用 `apex-picture-upload`)。 | `"default" \| "elevated"` | 否 | `'default'` |
|
|
82
|
+
| maxCount | 最大上传数量;为 `1` 时始终保留最新文件。<br>`picture-card` 未传时默认使用 `UPLOAD_DEFAULT_MAX_COUNT`(10)。 | `number` | 否 | — |
|
|
83
|
+
| maxSize | 单文件最大体积(字节)。<br>`picture-card` 未传时默认使用 `UPLOAD_DEFAULT_MAX_FILE_SIZE`(20 MB)。 | `number` | 否 | — |
|
|
84
|
+
| method | HTTP 方法 | `string` | 否 | `'post'` |
|
|
85
|
+
| multiple | 是否支持多选文件 | `boolean` | 否 | `false` |
|
|
86
|
+
| name | 上传字段名 | `string` | 否 | `'file'` |
|
|
87
|
+
| openFileDialogOnClick | 点击触发区是否打开文件选择框 | `boolean` | 否 | `true` |
|
|
88
|
+
| showUploadList | 是否展示上传列表;对象形式可配置操作图标 | `boolean \| ShowUploadListConfig` | 否 | `true` |
|
|
89
|
+
| withCredentials | 上传请求是否携带 cookie | `boolean` | 否 | `false` |
|
|
90
|
+
| onChange | 文件状态变化回调 | `(info: UploadChangeParam) => void` | 否 | — |
|
|
91
|
+
| onDrop | 拖入文件时触发(`Upload.Dragger`) | `(event: React.DragEvent<HTMLDivElement>) => void` | 否 | — |
|
|
92
|
+
| onDownload | 点击下载时的回调 | `(file: UploadFile) => void` | 否 | — |
|
|
93
|
+
| onPreview | 点击预览时的回调;返回 `false` 可阻止内置预览层 | `(file: UploadFile) => void \| false` | 否 | — |
|
|
94
|
+
| onRemove | 移除文件前的回调;返回 `false` 或 reject 则不移除 | `(file: UploadFile) => boolean \| void \| Promise<boolean \| void>` | 否 | — |
|
|
95
|
+
| children | 触发区内容(按钮、加号卡片等) | `React.ReactNode` | 否 | — |
|
|
96
|
+
| ref | 根节点 ref | `React.Ref<HTMLDivElement>` | 否 | — |
|
|
97
|
+
|
|
98
|
+
### UploadListType
|
|
99
|
+
|
|
100
|
+
上传列表展示形态
|
|
101
|
+
|
|
102
|
+
```typescript
|
|
103
|
+
type UploadListType = 'text' | 'picture' | 'picture-card'
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
### UploadVariant
|
|
107
|
+
|
|
108
|
+
Upload trigger / text & picture list item surface variant
|
|
109
|
+
|
|
110
|
+
```typescript
|
|
111
|
+
type UploadVariant = 'default' | 'elevated'
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
### UploadFileStatus
|
|
115
|
+
|
|
116
|
+
单个文件的上传状态
|
|
117
|
+
|
|
118
|
+
```typescript
|
|
119
|
+
type UploadFileStatus = 'error' | 'done' | 'uploading' | 'removed'
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
### UploadListIgnore
|
|
123
|
+
|
|
124
|
+
```typescript
|
|
125
|
+
type UploadListIgnore = typeof UPLOAD_LIST_IGNORE
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
### UploadFile
|
|
129
|
+
|
|
130
|
+
继承:`File`;本节列出新增或重声明字段。
|
|
131
|
+
|
|
132
|
+
上传文件对象,保持与既有业务兼容:继承浏览器 `File` 并附带列表渲染字段。
|
|
133
|
+
|
|
134
|
+
| 属性 | 说明 | 类型 | 必填 | 默认值 |
|
|
135
|
+
| --- | --- | --- | --- | --- |
|
|
136
|
+
| uid | 唯一标识;未设置时由组件生成 | `string` | 是 | — |
|
|
137
|
+
| name | 文件名 | `string` | 是 | — |
|
|
138
|
+
| status | 上传状态 | `"error" \| "done" \| "uploading" \| "removed"` | 否 | — |
|
|
139
|
+
| percent | 上传进度 0–100 | `number` | 否 | — |
|
|
140
|
+
| thumbUrl | 缩略图地址(本地或远程) | `string` | 否 | — |
|
|
141
|
+
| url | 下载/预览地址 | `string` | 否 | — |
|
|
142
|
+
| response | 服务端响应体 | `unknown` | 否 | — |
|
|
143
|
+
| error | 错误对象 | `Error` | 否 | — |
|
|
144
|
+
| originFileObj | 原始 File(便于从 `info.file` 取原文件) | `File` | 否 | — |
|
|
145
|
+
|
|
146
|
+
### UploadProgressEvent
|
|
147
|
+
|
|
148
|
+
上传进度事件(百分比范围 0–100)
|
|
149
|
+
|
|
150
|
+
| 属性 | 说明 | 类型 | 必填 | 默认值 |
|
|
151
|
+
| --- | --- | --- | --- | --- |
|
|
152
|
+
| percent | — | `number` | 是 | — |
|
|
153
|
+
|
|
154
|
+
### UploadChangeParam
|
|
155
|
+
|
|
156
|
+
泛型参数:`<T extends UploadFile = UploadFile>`。
|
|
157
|
+
|
|
158
|
+
`onChange` 回调参数
|
|
159
|
+
|
|
160
|
+
| 属性 | 说明 | 类型 | 必填 | 默认值 |
|
|
161
|
+
| --- | --- | --- | --- | --- |
|
|
162
|
+
| file | — | `T` | 是 | — |
|
|
163
|
+
| fileList | — | `T[]` | 是 | — |
|
|
164
|
+
| event | — | `ProgressEvent` | 否 | — |
|
|
165
|
+
|
|
166
|
+
### ShowUploadListConfig
|
|
167
|
+
|
|
168
|
+
`showUploadList` 为对象时的配置
|
|
169
|
+
|
|
170
|
+
| 属性 | 说明 | 类型 | 必填 | 默认值 |
|
|
171
|
+
| --- | --- | --- | --- | --- |
|
|
172
|
+
| extra | — | `React.ReactNode \| ((file: UploadFile) => React.ReactNode)` | 否 | — |
|
|
173
|
+
| showTrigger | 是否展示上传触发区(按钮 / `picture-card` 的「+」卡片)。<br>设为 `false` 时仅展示已上传列表,适用于只读预览。 | `boolean` | 否 | `true` |
|
|
174
|
+
| showPreviewIcon | — | `boolean \| ((file: UploadFile) => boolean)` | 否 | — |
|
|
175
|
+
| showRemoveIcon | 是否展示删除图标;disabled 时默认隐藏,显式展示时按钮仍禁用 | `boolean \| ((file: UploadFile) => boolean)` | 否 | — |
|
|
176
|
+
| showDownloadIcon | 是否展示下载图标;picture-card 默认 `false`,可显式设为 `true` 开启 | `boolean \| ((file: UploadFile) => boolean)` | 否 | — |
|
|
177
|
+
| previewIcon | — | `React.ReactNode \| ((file: UploadFile) => React.ReactNode)` | 否 | — |
|
|
178
|
+
| removeIcon | — | `React.ReactNode \| ((file: UploadFile) => React.ReactNode)` | 否 | — |
|
|
179
|
+
| downloadIcon | — | `React.ReactNode \| ((file: UploadFile) => React.ReactNode)` | 否 | — |
|
|
180
|
+
|
|
181
|
+
### UploadAcceptObject
|
|
182
|
+
|
|
183
|
+
`accept` 对象形式
|
|
184
|
+
|
|
185
|
+
| 属性 | 说明 | 类型 | 必填 | 默认值 |
|
|
186
|
+
| --- | --- | --- | --- | --- |
|
|
187
|
+
| format | 与原生 input `accept` 相同 | `string` | 是 | — |
|
|
188
|
+
| filter | `native` 使用浏览器过滤;函数返回 `true` 表示接受 | `'native' \| ((file: File) => boolean)` | 否 | — |
|
|
189
|
+
|
|
190
|
+
### UploadRequestOptions
|
|
191
|
+
|
|
192
|
+
`customRequest` 请求参数
|
|
193
|
+
|
|
194
|
+
| 属性 | 说明 | 类型 | 必填 | 默认值 |
|
|
195
|
+
| --- | --- | --- | --- | --- |
|
|
196
|
+
| action | — | `string` | 是 | — |
|
|
197
|
+
| file | — | `File \| Blob` | 是 | — |
|
|
198
|
+
| fileName | 上传文件名;当 `file` 是普通 Blob 时用于保留原文件名 | `string` | 否 | — |
|
|
199
|
+
| filename | multipart/form-data 字段名 | `string` | 否 | — |
|
|
200
|
+
| data | — | `Record<string, unknown>` | 否 | — |
|
|
201
|
+
| headers | — | `Record<string, string>` | 否 | — |
|
|
202
|
+
| method | — | `string` | 否 | — |
|
|
203
|
+
| withCredentials | — | `boolean` | 否 | — |
|
|
204
|
+
| onProgress | — | `(event: UploadProgressEvent) => void` | 否 | — |
|
|
205
|
+
| onError | — | `(error: Error, body?: unknown) => void` | 否 | — |
|
|
206
|
+
| onSuccess | — | `(body: unknown) => void` | 否 | — |
|
|
207
|
+
|
|
208
|
+
### UploadDraggerProps
|
|
209
|
+
|
|
210
|
+
`Upload.Dragger` 与 `Upload` 共用同一套 Props
|
|
211
|
+
|
|
212
|
+
**类型别名**:`UploadDraggerProps` 即 `UploadProps`,字段见上文 `### Upload`。
|
|
213
|
+
|
|
214
|
+
等价写法:`UploadDraggerProps` ≡ `UploadProps`
|
|
215
|
+
|
|
216
|
+
### 导出类型
|
|
217
|
+
|
|
218
|
+
另可从 `@apexhub/apex-ui-react` 导入:`FileKind`、`FilePreviewKind`、`ShowUploadListConfig`、`UploadAcceptObject`、`UploadChangeParam`、`UploadDraggerProps`、`UploadFile`、`UploadFileStatus`、`UploadLimitsConfig`、`UploadListIgnore`、`UploadListType`、`UploadProgressEvent`、`UploadProps`、`UploadRequestOptions`(与上文子类型配合使用)。
|
|
219
|
+
|
|
220
|
+
## 代码演示
|
|
221
|
+
|
|
222
|
+
### 多文件上传
|
|
223
|
+
|
|
224
|
+
设置 `multiple` 允许一次选择多个文件。
|
|
225
|
+
|
|
226
|
+
```tsx
|
|
227
|
+
import { Upload } from '@apexhub/apex-ui-react'
|
|
228
|
+
|
|
229
|
+
import type { UploadProps } from '@apexhub/apex-ui-react'
|
|
230
|
+
|
|
231
|
+
function uploadDemoImageDataUrl(
|
|
232
|
+
fill: string,
|
|
233
|
+
label: string,
|
|
234
|
+
width = 200,
|
|
235
|
+
height = 200,
|
|
236
|
+
): string {
|
|
237
|
+
const fontSize = Math.round(Math.min(width, height) * 0.2)
|
|
238
|
+
return (
|
|
239
|
+
'data:image/svg+xml;utf8,' +
|
|
240
|
+
encodeURIComponent(
|
|
241
|
+
`<svg xmlns="http://www.w3.org/2000/svg" width="${width}" height="${height}"><rect width="100%" height="100%" fill="${fill}"/><text x="50%" y="55%" dominant-baseline="middle" fill="white" font-family="Arial,sans-serif" font-size="${fontSize}" text-anchor="middle">${label}</text></svg>`,
|
|
242
|
+
)
|
|
243
|
+
)
|
|
244
|
+
}
|
|
245
|
+
|
|
246
|
+
const UPLOAD_DEMO_IMAGE = uploadDemoImageDataUrl('#7B61FF', 'IMG')
|
|
247
|
+
|
|
248
|
+
const UPLOAD_DEMO_IMAGE_BLUR = uploadDemoImageDataUrl('#5B8DEF', 'BLUR')
|
|
249
|
+
|
|
250
|
+
const UPLOAD_DEMO_IMAGE_GRAY = uploadDemoImageDataUrl('#888888', 'ERR')
|
|
251
|
+
|
|
252
|
+
const UPLOAD_DEMO_IMAGE_LARGE = uploadDemoImageDataUrl('#7B61FF', 'UP', 400, 400)
|
|
253
|
+
|
|
254
|
+
const uploadDemoCustomRequest: NonNullable<UploadProps['customRequest']> = ({
|
|
255
|
+
onSuccess,
|
|
256
|
+
}) => {
|
|
257
|
+
window.setTimeout(() => {
|
|
258
|
+
onSuccess?.({ url: UPLOAD_DEMO_IMAGE_LARGE })
|
|
259
|
+
}, 300)
|
|
260
|
+
}
|
|
261
|
+
|
|
262
|
+
export default () => <Upload customRequest={uploadDemoCustomRequest} listType="text" multiple />
|
|
263
|
+
```
|
|
264
|
+
|
|
265
|
+
### 已上传文件列表
|
|
266
|
+
|
|
267
|
+
通过 `defaultFileList` 展示不同状态的文件。文本列表显示文件类型图标,附件行提供默认、悬停、按下、禁用、上传中和错误样式。
|
|
268
|
+
|
|
269
|
+
内置 DOC、DOCX、GIF、JPEG、JPG、OFD、PDF、PNG、TXT、XLSX 十种 Figma 格式图标,按文件扩展名优先、MIME 类型其次识别(扩展名不区分大小写),未知格式回退通用文件图标。文件名前的图标固定为 20px;可通过 `Icon` 的 `docx-format`、`ofd-format`、`txt-format` 等名称独立使用。
|
|
270
|
+
|
|
271
|
+
```tsx
|
|
272
|
+
import type { UploadFile } from '@apexhub/apex-ui-react'
|
|
273
|
+
|
|
274
|
+
import { Upload } from '@apexhub/apex-ui-react'
|
|
275
|
+
|
|
276
|
+
import type { UploadProps } from '@apexhub/apex-ui-react'
|
|
277
|
+
|
|
278
|
+
function uploadDemoImageDataUrl(
|
|
279
|
+
fill: string,
|
|
280
|
+
label: string,
|
|
281
|
+
width = 200,
|
|
282
|
+
height = 200,
|
|
283
|
+
): string {
|
|
284
|
+
const fontSize = Math.round(Math.min(width, height) * 0.2)
|
|
285
|
+
return (
|
|
286
|
+
'data:image/svg+xml;utf8,' +
|
|
287
|
+
encodeURIComponent(
|
|
288
|
+
`<svg xmlns="http://www.w3.org/2000/svg" width="${width}" height="${height}"><rect width="100%" height="100%" fill="${fill}"/><text x="50%" y="55%" dominant-baseline="middle" fill="white" font-family="Arial,sans-serif" font-size="${fontSize}" text-anchor="middle">${label}</text></svg>`,
|
|
289
|
+
)
|
|
290
|
+
)
|
|
291
|
+
}
|
|
292
|
+
|
|
293
|
+
const UPLOAD_DEMO_IMAGE = uploadDemoImageDataUrl('#7B61FF', 'IMG')
|
|
294
|
+
|
|
295
|
+
const UPLOAD_DEMO_IMAGE_BLUR = uploadDemoImageDataUrl('#5B8DEF', 'BLUR')
|
|
296
|
+
|
|
297
|
+
const UPLOAD_DEMO_IMAGE_GRAY = uploadDemoImageDataUrl('#888888', 'ERR')
|
|
298
|
+
|
|
299
|
+
const UPLOAD_DEMO_IMAGE_LARGE = uploadDemoImageDataUrl('#7B61FF', 'UP', 400, 400)
|
|
300
|
+
|
|
301
|
+
const uploadDemoCustomRequest: NonNullable<UploadProps['customRequest']> = ({
|
|
302
|
+
onSuccess,
|
|
303
|
+
}) => {
|
|
304
|
+
window.setTimeout(() => {
|
|
305
|
+
onSuccess?.({ url: UPLOAD_DEMO_IMAGE_LARGE })
|
|
306
|
+
}, 300)
|
|
307
|
+
}
|
|
308
|
+
|
|
309
|
+
const defaultFileList = [
|
|
310
|
+
{
|
|
311
|
+
uid: '1',
|
|
312
|
+
name: 'example.png',
|
|
313
|
+
status: 'done',
|
|
314
|
+
url: 'https://example.com/1.png',
|
|
315
|
+
},
|
|
316
|
+
{
|
|
317
|
+
uid: '2',
|
|
318
|
+
name: 'uploading.png',
|
|
319
|
+
status: 'uploading',
|
|
320
|
+
percent: 50,
|
|
321
|
+
},
|
|
322
|
+
{ uid: '3', name: 'error.png', status: 'error' },
|
|
323
|
+
] as unknown as UploadFile[]
|
|
324
|
+
|
|
325
|
+
export default () => (
|
|
326
|
+
<Upload
|
|
327
|
+
customRequest={uploadDemoCustomRequest}
|
|
328
|
+
listType="text"
|
|
329
|
+
defaultFileList={defaultFileList}
|
|
330
|
+
/>
|
|
331
|
+
)
|
|
332
|
+
```
|
|
333
|
+
|
|
334
|
+
### 自定义前置图标
|
|
335
|
+
|
|
336
|
+
`prefixIcon` 仅替换 text 列表文件名前的图标,不影响右侧操作图标或图片缩略图。不传或回调返回 `undefined` 时保留默认文件格式图标;传入或返回 `null`/`false` 时隐藏。
|
|
337
|
+
|
|
338
|
+
```tsx
|
|
339
|
+
import { Upload, type UploadFile, type UploadProps } from '@apexhub/apex-ui-react'
|
|
340
|
+
|
|
341
|
+
const files: UploadFile[] = [
|
|
342
|
+
Object.assign(new File(['notes'], 'notes.txt', { type: 'text/plain' }), {
|
|
343
|
+
uid: 'notes',
|
|
344
|
+
status: 'done' as const,
|
|
345
|
+
}),
|
|
346
|
+
Object.assign(new File(['report'], 'report.pdf', { type: 'application/pdf' }), {
|
|
347
|
+
uid: 'report',
|
|
348
|
+
status: 'done' as const,
|
|
349
|
+
}),
|
|
350
|
+
]
|
|
351
|
+
|
|
352
|
+
const prefixIcon: UploadProps['prefixIcon'] = (file) =>
|
|
353
|
+
file.name.endsWith('.txt') ? (
|
|
354
|
+
<svg viewBox="0 0 20 20" fill="none" stroke="currentColor">
|
|
355
|
+
<path d="M4 2h8l4 4v12H4zM12 2v4h4M7 10h6M7 14h6" />
|
|
356
|
+
</svg>
|
|
357
|
+
) : undefined
|
|
358
|
+
|
|
359
|
+
export default () => (
|
|
360
|
+
<Upload defaultFileList={files} prefixIcon={prefixIcon} showUploadList={{ showTrigger: false }} />
|
|
361
|
+
)
|
|
362
|
+
```
|
|
363
|
+
|
|
364
|
+
### 图片列表
|
|
365
|
+
|
|
366
|
+
`listType="picture"` 以缩略图形式展示文件。
|
|
367
|
+
|
|
368
|
+
```tsx
|
|
369
|
+
import type { UploadFile } from '@apexhub/apex-ui-react'
|
|
370
|
+
|
|
371
|
+
import { Upload } from '@apexhub/apex-ui-react'
|
|
372
|
+
|
|
373
|
+
import type { UploadProps } from '@apexhub/apex-ui-react'
|
|
374
|
+
|
|
375
|
+
function uploadDemoImageDataUrl(
|
|
376
|
+
fill: string,
|
|
377
|
+
label: string,
|
|
378
|
+
width = 200,
|
|
379
|
+
height = 200,
|
|
380
|
+
): string {
|
|
381
|
+
const fontSize = Math.round(Math.min(width, height) * 0.2)
|
|
382
|
+
return (
|
|
383
|
+
'data:image/svg+xml;utf8,' +
|
|
384
|
+
encodeURIComponent(
|
|
385
|
+
`<svg xmlns="http://www.w3.org/2000/svg" width="${width}" height="${height}"><rect width="100%" height="100%" fill="${fill}"/><text x="50%" y="55%" dominant-baseline="middle" fill="white" font-family="Arial,sans-serif" font-size="${fontSize}" text-anchor="middle">${label}</text></svg>`,
|
|
386
|
+
)
|
|
387
|
+
)
|
|
388
|
+
}
|
|
389
|
+
|
|
390
|
+
const UPLOAD_DEMO_IMAGE = uploadDemoImageDataUrl('#7B61FF', 'IMG')
|
|
391
|
+
|
|
392
|
+
const UPLOAD_DEMO_IMAGE_BLUR = uploadDemoImageDataUrl('#5B8DEF', 'BLUR')
|
|
393
|
+
|
|
394
|
+
const UPLOAD_DEMO_IMAGE_GRAY = uploadDemoImageDataUrl('#888888', 'ERR')
|
|
395
|
+
|
|
396
|
+
const UPLOAD_DEMO_IMAGE_LARGE = uploadDemoImageDataUrl('#7B61FF', 'UP', 400, 400)
|
|
397
|
+
|
|
398
|
+
const uploadDemoCustomRequest: NonNullable<UploadProps['customRequest']> = ({
|
|
399
|
+
onSuccess,
|
|
400
|
+
}) => {
|
|
401
|
+
window.setTimeout(() => {
|
|
402
|
+
onSuccess?.({ url: UPLOAD_DEMO_IMAGE_LARGE })
|
|
403
|
+
}, 300)
|
|
404
|
+
}
|
|
405
|
+
|
|
406
|
+
const defaultFileList = [
|
|
407
|
+
{
|
|
408
|
+
uid: '1',
|
|
409
|
+
name: 'example.png',
|
|
410
|
+
status: 'done',
|
|
411
|
+
thumbUrl: UPLOAD_DEMO_IMAGE,
|
|
412
|
+
},
|
|
413
|
+
{
|
|
414
|
+
uid: '2',
|
|
415
|
+
name: 'uploading.png',
|
|
416
|
+
status: 'uploading',
|
|
417
|
+
percent: 50,
|
|
418
|
+
thumbUrl: UPLOAD_DEMO_IMAGE_BLUR,
|
|
419
|
+
},
|
|
420
|
+
{
|
|
421
|
+
uid: '3',
|
|
422
|
+
name: 'error.png',
|
|
423
|
+
status: 'error',
|
|
424
|
+
thumbUrl: UPLOAD_DEMO_IMAGE_GRAY,
|
|
425
|
+
},
|
|
426
|
+
] as unknown as UploadFile[]
|
|
427
|
+
|
|
428
|
+
export default () => (
|
|
429
|
+
<Upload
|
|
430
|
+
customRequest={uploadDemoCustomRequest}
|
|
431
|
+
listType="picture"
|
|
432
|
+
defaultFileList={defaultFileList}
|
|
433
|
+
/>
|
|
434
|
+
)
|
|
435
|
+
```
|
|
436
|
+
|
|
437
|
+
### 表面变体
|
|
438
|
+
|
|
439
|
+
`variant` 控制触发区和 text/picture 列表项的表面:`default`(默认)或 `elevated`。`picture-card` 列表项保持卡片样式。
|
|
440
|
+
|
|
441
|
+
```tsx
|
|
442
|
+
import type { UploadFile } from '@apexhub/apex-ui-react'
|
|
443
|
+
|
|
444
|
+
import { Typography, Upload } from '@apexhub/apex-ui-react'
|
|
445
|
+
|
|
446
|
+
import type { UploadProps } from '@apexhub/apex-ui-react'
|
|
447
|
+
|
|
448
|
+
function uploadDemoImageDataUrl(
|
|
449
|
+
fill: string,
|
|
450
|
+
label: string,
|
|
451
|
+
width = 200,
|
|
452
|
+
height = 200,
|
|
453
|
+
): string {
|
|
454
|
+
const fontSize = Math.round(Math.min(width, height) * 0.2)
|
|
455
|
+
return (
|
|
456
|
+
'data:image/svg+xml;utf8,' +
|
|
457
|
+
encodeURIComponent(
|
|
458
|
+
`<svg xmlns="http://www.w3.org/2000/svg" width="${width}" height="${height}"><rect width="100%" height="100%" fill="${fill}"/><text x="50%" y="55%" dominant-baseline="middle" fill="white" font-family="Arial,sans-serif" font-size="${fontSize}" text-anchor="middle">${label}</text></svg>`,
|
|
459
|
+
)
|
|
460
|
+
)
|
|
461
|
+
}
|
|
462
|
+
|
|
463
|
+
const UPLOAD_DEMO_IMAGE = uploadDemoImageDataUrl('#7B61FF', 'IMG')
|
|
464
|
+
|
|
465
|
+
const UPLOAD_DEMO_IMAGE_BLUR = uploadDemoImageDataUrl('#5B8DEF', 'BLUR')
|
|
466
|
+
|
|
467
|
+
const UPLOAD_DEMO_IMAGE_GRAY = uploadDemoImageDataUrl('#888888', 'ERR')
|
|
468
|
+
|
|
469
|
+
const UPLOAD_DEMO_IMAGE_LARGE = uploadDemoImageDataUrl('#7B61FF', 'UP', 400, 400)
|
|
470
|
+
|
|
471
|
+
const uploadDemoCustomRequest: NonNullable<UploadProps['customRequest']> = ({
|
|
472
|
+
onSuccess,
|
|
473
|
+
}) => {
|
|
474
|
+
window.setTimeout(() => {
|
|
475
|
+
onSuccess?.({ url: UPLOAD_DEMO_IMAGE_LARGE })
|
|
476
|
+
}, 300)
|
|
477
|
+
}
|
|
478
|
+
|
|
479
|
+
const defaultFileList: UploadFile[] = [
|
|
480
|
+
Object.assign(new File(['项目需求说明'], '需求说明.txt', { type: 'text/plain' }), {
|
|
481
|
+
uid: 'requirements',
|
|
482
|
+
status: 'done' as const,
|
|
483
|
+
url: `data:text/plain;charset=utf-8,${encodeURIComponent('项目需求说明')}`,
|
|
484
|
+
}),
|
|
485
|
+
Object.assign(
|
|
486
|
+
new File(['文件名,状态\n需求说明.txt,已上传'], '上传清单.csv', { type: 'text/csv' }),
|
|
487
|
+
{
|
|
488
|
+
uid: 'upload-list',
|
|
489
|
+
status: 'done' as const,
|
|
490
|
+
url: `data:text/csv;charset=utf-8,${encodeURIComponent('文件名,状态\n需求说明.txt,已上传')}`,
|
|
491
|
+
},
|
|
492
|
+
),
|
|
493
|
+
]
|
|
494
|
+
|
|
495
|
+
export default () => (
|
|
496
|
+
<>
|
|
497
|
+
<Typography.Title level={4}>默认表面</Typography.Title>
|
|
498
|
+
<Upload
|
|
499
|
+
variant="default"
|
|
500
|
+
defaultFileList={defaultFileList}
|
|
501
|
+
customRequest={uploadDemoCustomRequest}
|
|
502
|
+
/>
|
|
503
|
+
<Typography.Title level={4}>Elevated 表面</Typography.Title>
|
|
504
|
+
<Upload
|
|
505
|
+
variant="elevated"
|
|
506
|
+
defaultFileList={defaultFileList}
|
|
507
|
+
customRequest={uploadDemoCustomRequest}
|
|
508
|
+
/>
|
|
509
|
+
</>
|
|
510
|
+
)
|
|
511
|
+
```
|
|
512
|
+
|
|
513
|
+
### 照片墙
|
|
514
|
+
|
|
515
|
+
`listType="picture-card"` 以卡片栅格展示,适合图片上传场景。
|
|
516
|
+
|
|
517
|
+
```tsx
|
|
518
|
+
import type { UploadFile } from '@apexhub/apex-ui-react'
|
|
519
|
+
|
|
520
|
+
import { Upload } from '@apexhub/apex-ui-react'
|
|
521
|
+
|
|
522
|
+
import type { UploadProps } from '@apexhub/apex-ui-react'
|
|
523
|
+
|
|
524
|
+
function uploadDemoImageDataUrl(
|
|
525
|
+
fill: string,
|
|
526
|
+
label: string,
|
|
527
|
+
width = 200,
|
|
528
|
+
height = 200,
|
|
529
|
+
): string {
|
|
530
|
+
const fontSize = Math.round(Math.min(width, height) * 0.2)
|
|
531
|
+
return (
|
|
532
|
+
'data:image/svg+xml;utf8,' +
|
|
533
|
+
encodeURIComponent(
|
|
534
|
+
`<svg xmlns="http://www.w3.org/2000/svg" width="${width}" height="${height}"><rect width="100%" height="100%" fill="${fill}"/><text x="50%" y="55%" dominant-baseline="middle" fill="white" font-family="Arial,sans-serif" font-size="${fontSize}" text-anchor="middle">${label}</text></svg>`,
|
|
535
|
+
)
|
|
536
|
+
)
|
|
537
|
+
}
|
|
538
|
+
|
|
539
|
+
const UPLOAD_DEMO_IMAGE = uploadDemoImageDataUrl('#7B61FF', 'IMG')
|
|
540
|
+
|
|
541
|
+
const UPLOAD_DEMO_IMAGE_BLUR = uploadDemoImageDataUrl('#5B8DEF', 'BLUR')
|
|
542
|
+
|
|
543
|
+
const UPLOAD_DEMO_IMAGE_GRAY = uploadDemoImageDataUrl('#888888', 'ERR')
|
|
544
|
+
|
|
545
|
+
const UPLOAD_DEMO_IMAGE_LARGE = uploadDemoImageDataUrl('#7B61FF', 'UP', 400, 400)
|
|
546
|
+
|
|
547
|
+
const uploadDemoCustomRequest: NonNullable<UploadProps['customRequest']> = ({
|
|
548
|
+
onSuccess,
|
|
549
|
+
}) => {
|
|
550
|
+
window.setTimeout(() => {
|
|
551
|
+
onSuccess?.({ url: UPLOAD_DEMO_IMAGE_LARGE })
|
|
552
|
+
}, 300)
|
|
553
|
+
}
|
|
554
|
+
|
|
555
|
+
const defaultFileList = [
|
|
556
|
+
{
|
|
557
|
+
uid: '1',
|
|
558
|
+
name: 'example.png',
|
|
559
|
+
status: 'done',
|
|
560
|
+
thumbUrl: UPLOAD_DEMO_IMAGE,
|
|
561
|
+
},
|
|
562
|
+
{
|
|
563
|
+
uid: '2',
|
|
564
|
+
name: 'uploading.png',
|
|
565
|
+
status: 'uploading',
|
|
566
|
+
thumbUrl: UPLOAD_DEMO_IMAGE_BLUR,
|
|
567
|
+
},
|
|
568
|
+
{ uid: '3', name: 'error.png', status: 'error' },
|
|
569
|
+
] as unknown as UploadFile[]
|
|
570
|
+
|
|
571
|
+
export default () => (
|
|
572
|
+
<Upload
|
|
573
|
+
customRequest={uploadDemoCustomRequest}
|
|
574
|
+
listType="picture-card"
|
|
575
|
+
defaultFileList={defaultFileList}
|
|
576
|
+
/>
|
|
577
|
+
)
|
|
578
|
+
```
|
|
579
|
+
|
|
580
|
+
### 拖拽上传
|
|
581
|
+
|
|
582
|
+
使用 `Upload.Dragger` 提供拖拽区域,拖入文件即可上传。
|
|
583
|
+
|
|
584
|
+
```tsx
|
|
585
|
+
import { Typography, Upload } from '@apexhub/apex-ui-react'
|
|
586
|
+
|
|
587
|
+
import type { UploadProps } from '@apexhub/apex-ui-react'
|
|
588
|
+
|
|
589
|
+
function uploadDemoImageDataUrl(
|
|
590
|
+
fill: string,
|
|
591
|
+
label: string,
|
|
592
|
+
width = 200,
|
|
593
|
+
height = 200,
|
|
594
|
+
): string {
|
|
595
|
+
const fontSize = Math.round(Math.min(width, height) * 0.2)
|
|
596
|
+
return (
|
|
597
|
+
'data:image/svg+xml;utf8,' +
|
|
598
|
+
encodeURIComponent(
|
|
599
|
+
`<svg xmlns="http://www.w3.org/2000/svg" width="${width}" height="${height}"><rect width="100%" height="100%" fill="${fill}"/><text x="50%" y="55%" dominant-baseline="middle" fill="white" font-family="Arial,sans-serif" font-size="${fontSize}" text-anchor="middle">${label}</text></svg>`,
|
|
600
|
+
)
|
|
601
|
+
)
|
|
602
|
+
}
|
|
603
|
+
|
|
604
|
+
const UPLOAD_DEMO_IMAGE = uploadDemoImageDataUrl('#7B61FF', 'IMG')
|
|
605
|
+
|
|
606
|
+
const UPLOAD_DEMO_IMAGE_BLUR = uploadDemoImageDataUrl('#5B8DEF', 'BLUR')
|
|
607
|
+
|
|
608
|
+
const UPLOAD_DEMO_IMAGE_GRAY = uploadDemoImageDataUrl('#888888', 'ERR')
|
|
609
|
+
|
|
610
|
+
const UPLOAD_DEMO_IMAGE_LARGE = uploadDemoImageDataUrl('#7B61FF', 'UP', 400, 400)
|
|
611
|
+
|
|
612
|
+
const uploadDemoCustomRequest: NonNullable<UploadProps['customRequest']> = ({
|
|
613
|
+
onSuccess,
|
|
614
|
+
}) => {
|
|
615
|
+
window.setTimeout(() => {
|
|
616
|
+
onSuccess?.({ url: UPLOAD_DEMO_IMAGE_LARGE })
|
|
617
|
+
}, 300)
|
|
618
|
+
}
|
|
619
|
+
|
|
620
|
+
export default () => (
|
|
621
|
+
<Upload.Dragger
|
|
622
|
+
accept=".jpg,.jpeg,.png,.gif,.pdf,.docx,.xlsx,.ofd"
|
|
623
|
+
multiple
|
|
624
|
+
maxCount={10}
|
|
625
|
+
maxSize={20 * 1024 * 1024}
|
|
626
|
+
customRequest={uploadDemoCustomRequest}
|
|
627
|
+
>
|
|
628
|
+
<Typography.Text>点击或拖拽文件到此处上传</Typography.Text>
|
|
629
|
+
<Typography.Text variant="caption">
|
|
630
|
+
支持jpg、jpeg、png、gif、pdf、docx、xlsx、ofd,最多10个,单文件不超过20MB
|
|
631
|
+
</Typography.Text>
|
|
632
|
+
</Upload.Dragger>
|
|
633
|
+
)
|
|
634
|
+
```
|
|
635
|
+
|
|
636
|
+
### 禁用状态
|
|
637
|
+
|
|
638
|
+
`disabled` 时禁止选择文件、拖拽、删除与重试;已有文件仍可预览、下载。text/picture 的正常和手动文件行使用禁用样式,上传中与错误文件保留状态色。删除按钮默认隐藏,显式设置 `showUploadList.showRemoveIcon` 时按配置展示,但仍不可点击。
|
|
639
|
+
|
|
640
|
+
```tsx
|
|
641
|
+
import { Upload } from '@apexhub/apex-ui-react'
|
|
642
|
+
|
|
643
|
+
import type { UploadProps } from '@apexhub/apex-ui-react'
|
|
644
|
+
|
|
645
|
+
function uploadDemoImageDataUrl(
|
|
646
|
+
fill: string,
|
|
647
|
+
label: string,
|
|
648
|
+
width = 200,
|
|
649
|
+
height = 200,
|
|
650
|
+
): string {
|
|
651
|
+
const fontSize = Math.round(Math.min(width, height) * 0.2)
|
|
652
|
+
return (
|
|
653
|
+
'data:image/svg+xml;utf8,' +
|
|
654
|
+
encodeURIComponent(
|
|
655
|
+
`<svg xmlns="http://www.w3.org/2000/svg" width="${width}" height="${height}"><rect width="100%" height="100%" fill="${fill}"/><text x="50%" y="55%" dominant-baseline="middle" fill="white" font-family="Arial,sans-serif" font-size="${fontSize}" text-anchor="middle">${label}</text></svg>`,
|
|
656
|
+
)
|
|
657
|
+
)
|
|
658
|
+
}
|
|
659
|
+
|
|
660
|
+
const UPLOAD_DEMO_IMAGE = uploadDemoImageDataUrl('#7B61FF', 'IMG')
|
|
661
|
+
|
|
662
|
+
const UPLOAD_DEMO_IMAGE_BLUR = uploadDemoImageDataUrl('#5B8DEF', 'BLUR')
|
|
663
|
+
|
|
664
|
+
const UPLOAD_DEMO_IMAGE_GRAY = uploadDemoImageDataUrl('#888888', 'ERR')
|
|
665
|
+
|
|
666
|
+
const UPLOAD_DEMO_IMAGE_LARGE = uploadDemoImageDataUrl('#7B61FF', 'UP', 400, 400)
|
|
667
|
+
|
|
668
|
+
const uploadDemoCustomRequest: NonNullable<UploadProps['customRequest']> = ({
|
|
669
|
+
onSuccess,
|
|
670
|
+
}) => {
|
|
671
|
+
window.setTimeout(() => {
|
|
672
|
+
onSuccess?.({ url: UPLOAD_DEMO_IMAGE_LARGE })
|
|
673
|
+
}, 300)
|
|
674
|
+
}
|
|
675
|
+
|
|
676
|
+
export default () => <Upload customRequest={uploadDemoCustomRequest} disabled />
|
|
677
|
+
```
|
|
678
|
+
|
|
679
|
+
## DOM 结构
|
|
680
|
+
|
|
681
|
+
源码声明的静态 `data-slot`:`upload-list-trigger`、`upload-list-item-thumb`、`upload-list-item-progress`、`upload-picture-card-mask`、`upload-actions`、`upload-list-item-retry`、`upload-list-item-icon`、`upload-list-item-name`、`upload-list-item-size`、`upload-list`、`upload`、`upload-input`、`upload-action-icon`。具体节点随模式和状态出现,不表示固定嵌套顺序。
|
|
682
|
+
|
|
683
|
+
## 样式定制
|
|
684
|
+
|
|
685
|
+
优先使用本组件公开的尺寸、类型和状态属性。换肤与变量覆盖方式见 [主题指南](../../llms-theme.txt)。
|
|
686
|
+
|
|
687
|
+
需要定制具体样式时再读取 [Token 明细](./tokens.txt),其中包含用途、定义值及适用作用域。常规组件使用无需加载该文件。
|
|
688
|
+
|
|
689
|
+
## FAQ
|
|
690
|
+
|
|
691
|
+
### 上传失败后如何重试?
|
|
692
|
+
|
|
693
|
+
列表项 `status="error"` 且存在 `originFileObj` 时会展示「点击重试」,点击后使用同一原始文件和 `uid` 重新发起上传。远程列表文件没有本地二进制数据时不会展示重试,避免把空文件上传到服务器。text/picture 附件行使用错误底色、描边与文字色,文本列表的文件类型图标同步使用错误色;重试使用链接样式。picture-card 保持缩略图与原有卡片底色,不增加独立 error 图标。
|
|
694
|
+
|
|
695
|
+
### 为什么没有 antd 的线型进度条?
|
|
696
|
+
|
|
697
|
+
v1 列表 uploading 态使用圆形 Spin 指示进度,不提供 antd 线型 `progress` 配置。需要线型进度请通过 `itemRender` 或 `customRequest` 自行扩展。
|
|
698
|
+
|
|
699
|
+
### `beforeUpload` 返回 `'LIST_IGNORE'` 是什么效果?
|
|
700
|
+
|
|
701
|
+
文件不会出现在上传列表中,也不会触发上传。可返回字符串 `'LIST_IGNORE'`,或从包中导入常量 `UPLOAD_LIST_IGNORE`(值同为 `'LIST_IGNORE'`)。
|
|
702
|
+
|
|
703
|
+
|
|
704
|
+
### Upload 能预览 PDF 或 Office 文件吗?
|
|
705
|
+
|
|
706
|
+
不能。默认预览仅对图片生效(通过 `Image.PreviewGroup`)。非图片文件需使用 `onPreview` 回调自行实现,例如在新窗口打开文件 URL 或调用第三方文档预览服务。
|