mirror of
https://github.com/element-plus/element-plus.git
synced 2024-12-27 03:01:14 +08:00
93ee392932
* fix(components): upload photo-wall wrap * refactor(components): upload conent with props by tsx * fix: type generate for upload sfc tsx * Revert "fix: type generate for upload sfc tsx" This reverts commitbeeb9fb164. * Revert "refactor(components): upload conent with props by tsx" This reverts commit425e4a9f34. * fix: upload content type by as any * refactor: extract uploadContentProps to object * refactor(components): upload use tamplate instead of h * Update packages/components/upload/src/upload.vue Co-authored-by: JeremyWuuuuu <15975785+JeremyWuuuuu@users.noreply.github.com> * refactor(components): remove useless key in upload-content * refactor(components): fix type Co-authored-by: JeremyWuuuuu <15975785+JeremyWuuuuu@users.noreply.github.com>
140 lines
12 KiB
Markdown
140 lines
12 KiB
Markdown
---
|
|
title: Upload
|
|
lang: en-US
|
|
---
|
|
|
|
# Upload
|
|
|
|
Upload files by clicking or drag-and-drop
|
|
|
|
## Click to upload files
|
|
|
|
:::demo Customize upload button type and text using `slot`. Set `limit` and `on-exceed` to limit the maximum number of uploads allowed and specify method when the limit is exceeded. Plus, you can abort removing a file in the `before-remove` hook.
|
|
|
|
upload/basic
|
|
|
|
:::
|
|
|
|
## Cover previous file
|
|
|
|
:::demo Set `limit` and `on-exceed` to automatically replace the previous file when select a new file.
|
|
|
|
upload/limit-cover
|
|
|
|
:::
|
|
|
|
## User avatar upload
|
|
|
|
Use `before-upload` hook to limit the upload file format and size.
|
|
|
|
:::demo
|
|
|
|
upload/avatar
|
|
|
|
:::
|
|
|
|
## Photo Wall
|
|
|
|
Use `list-type` to change the fileList style.
|
|
|
|
:::demo
|
|
|
|
upload/photo-wall
|
|
|
|
:::
|
|
|
|
## Custom file thumbnail
|
|
|
|
Use `scoped-slot` to change default thumbnail template.
|
|
|
|
:::demo
|
|
|
|
upload/custom-thumbnail
|
|
|
|
:::
|
|
|
|
## FileList with thumbnail
|
|
|
|
:::demo
|
|
|
|
upload/file-list-with-thumbnail
|
|
|
|
:::
|
|
|
|
## File list control
|
|
|
|
Use `on-change` hook function to control upload file list
|
|
|
|
:::demo
|
|
|
|
upload/file-list
|
|
|
|
:::
|
|
|
|
## Drag to upload
|
|
|
|
You can drag your file to a certain area to upload it.
|
|
|
|
:::demo
|
|
|
|
upload/drag-and-drop
|
|
|
|
:::
|
|
|
|
## Manual upload
|
|
|
|
:::demo
|
|
|
|
upload/manual
|
|
|
|
:::
|
|
|
|
## Attributes
|
|
|
|
| Attribute | Description | Type | Accepted Values | Default |
|
|
| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ------------------------- | ------- |
|
|
| action | required, request URL | string | — | — |
|
|
| headers | request headers | object | — | — |
|
|
| method | set upload request method | string | post/put/patch | post |
|
|
| multiple | whether uploading multiple files is permitted | boolean | — | — |
|
|
| data | additions options of request | object | — | — |
|
|
| name | key name for uploaded file | string | — | file |
|
|
| with-credentials | whether cookies are sent | boolean | — | false |
|
|
| show-file-list | whether to show the uploaded file list | boolean | — | true |
|
|
| drag | whether to activate drag and drop mode | boolean | — | false |
|
|
| accept | accepted [file types](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#attr-accept), will not work when `thumbnail-mode` is `true` | string | — | — |
|
|
| on-preview | hook function when clicking the uploaded files | function(file: UploadFile): void | — | — |
|
|
| on-remove | hook function when files are removed | function(file: UploadFile, fileList: UploadFile[]): void | — | — |
|
|
| on-success | hook function when uploaded successfully | function(response: any, file: UploadFile, fileList: UploadFile[]): void | — | — |
|
|
| on-error | hook function when some errors occurs | function(error, file: UploadFile, fileList: UploadFile[]): void | — | — |
|
|
| on-progress | hook function when some progress occurs | function(evt: UploadProgressEvent, file: UploadFile, fileList: UploadFile[]): void | — | — |
|
|
| on-change | hook function when select file or upload file success or upload file fail | function(file: UploadFile, fileList: UploadFile[]): void | — | — |
|
|
| before-upload | hook function before uploading with the file to be uploaded as its parameter. If `false` is returned or a `Promise` is returned and then is rejected, uploading will be aborted | function(file: RawFile): Awaitable<void \| undefined \| null \| boolean \| File \| Blob> | — | — |
|
|
| before-remove | hook function before removing a file with the file and file list as its parameters. If `false` is returned or a `Promise` is returned and then is rejected, removing will be aborted. | function(file: UploadFile, fileList: UploadFile[]): Awaitable\<boolean\> | — | — |
|
|
| file-list | default uploaded files, e.g. [{name: 'food.jpg', url: 'https://xxx.cdn.com/xxx.jpg'}] | Array\<UploadFile\> | — | [] |
|
|
| list-type | type of fileList | string | text/picture/picture-card | text |
|
|
| auto-upload | whether to auto upload file | boolean | — | true |
|
|
| http-request | override default xhr behavior, allowing you to implement your own upload-file's request | (options: UploadRequestOptions) => XMLHttpRequest \| Promise\<unknown\> | — | — |
|
|
| disabled | whether to disable upload | boolean | — | false |
|
|
| limit | maximum number of uploads allowed | number | — | — |
|
|
| on-exceed | hook function when limit is exceeded | function(files: File[], uploadFiles: UploadFile[]): void | — | - |
|
|
|
|
## Slots
|
|
|
|
| Name | Description | Parameters |
|
|
| ------- | ---------------------------------- | ------------------------- |
|
|
| — | customize default content | - |
|
|
| trigger | content which triggers file dialog | - |
|
|
| tip | content of tips | - |
|
|
| file | content of thumbnail template. | file ( #file = { file } ) |
|
|
|
|
## Methods
|
|
|
|
| Methods Name | Description | Parameters | Default |
|
|
| ------------ | ----------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- | ----------------------------------------- |
|
|
| clearFiles | clear the file list (this method is not supported in the `before-upload` hook). | (status: Array\<"ready"\|"uploading"\|"success"\|"fail"\>) => void | ['ready', 'uploading', 'success', 'fail'] |
|
|
| abort | cancel upload request | (file: UploadFile) => void | - |
|
|
| submit | upload the file list manually | — | - |
|
|
| handleStart | select the file manually | (file: File) => void | - |
|
|
| handleRemove | remove the file manually. `file` and `rawFile` has been merged. `rawFile` will be removed in `v2.2.0` | (file: UploadFile \| UploadRawFile, rawFile?:UploadRawFile) => void | - |
|