mirror of
https://gitee.com/element-plus/element-plus.git
synced 2024-12-14 01:11:25 +08:00
c6bed151a5
* feat(website): init viteperss (#3162) * init vitepress * Finish homepage * relayout page * partial finish * update * update use lang * remove font weight; change font size * docs: optimize docs folder structure * reorganize project * fix ssr issue * fix build issues Co-authored-by: Kevin <sxzz@sxzz.moe> Co-authored-by: zouhang <zouhang@didiglobal.com> * feat(website) integrate with crowdin (#3218) - Introduce Crowdin CLI - Add script for fetching Crowdin token from env - Add script for local development * fix formatting * update codeblocks (#3249) * feat(docs): update website preview script - Update azure preview build script - Eliminate dead links * bootstrap docs * fix homepage layout issue * fix formating * Finish ToC and codepen integration * reorganized files and fix issue that causes demo unavailable after build * feat(docs): migration documentations (#3283) * feat(docs): migration documentations - Move documentations to docs/ * remove unused files * docs: [popconfirm] migrate document (#3285) * feat(docs): migrate documentation from space.md to upload.md (#3292) - Upload documentations acorrodingly * docs: [date-picker] migrate document (#3289) * docs: [date-picker] migrate document * fix: typo * docs: [slider] migrate document (#3287) * docs: migrate documents (#3290) * docs: migrate-datetime-picker * docs: migrate descriptions * docs: migrate dialog * docs: migrate divider * docs: migrate drawer * docs: migrate drapdown * docs: fix drapdown * docs: migrate empty * docs: migrate form * docs: add scoped for style * docs: simplify toRefs * chore: update doc (#3297) * chore: update doc * chore: update doc * chore: update doc * feat(docs): migrate documentations from infinite-scroll to page-header (#3303) - Update docs accordingly - Update CodePen icon to match style - Update component name to match others * docs: migrate documentions (#3293) migrate list: * image * popover * scrollbar * radio * rate * skeleton * select * select-v2 * reault * progress * pagination * chore: update doc (#3305) Co-authored-by: 0song <0song@gmail.com> * Fix broken pipeline * chore: update demo plugin * website perfection * fix hydration bug * docs: update guide (#3342) * WIP docs * docs: update docs * add dark mode * make dev fetch components from local instead of node_modules Co-authored-by: msidolphin <msidolphin@outlook.com> Co-authored-by: Aex <spryti@qq.com> Co-authored-by: 0song <82012629+0song@users.noreply.github.com> Co-authored-by: 0song <0song@gmail.com> Co-authored-by: zouhang <zouhang@didiglobal.com> Co-authored-by: 三咲智子 <sxzz@sxzz.moe> * fix(docs): fix codepen code example issue (#3380) * fix(docs): fix codepen code example issue - Add lang="ts" for all example files - Fix codepen import error * revert changes in resource.vue * feat(docs): complete crowdin integration (#3408) * Update mds for preparing the integration script * deprecate old website * update sponsors and even handler for resize * update build script for preview * fix preview-build error * fix preview-build error * fix preview-build error * fix preview-build error * fix preview-build error * update deploy script and some bugs * Fix existing issue * chore(project): add dev preview workflow * chore(project): rename dev to staging * update the size of toc * update staging-preview script * update preview scripts * enable website build for preview * fix build error * final commitment for update the details * remove azure pipeline * move docs ignores into docs and update date Co-authored-by: Kevin <sxzz@sxzz.moe> Co-authored-by: zouhang <zouhang@didiglobal.com> Co-authored-by: msidolphin <msidolphin@outlook.com> Co-authored-by: Aex <spryti@qq.com> Co-authored-by: 0song <82012629+0song@users.noreply.github.com> Co-authored-by: 0song <0song@gmail.com>
123 lines
9.4 KiB
Markdown
123 lines
9.4 KiB
Markdown
# 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
|
||
|
||
:::
|
||
|
||
## 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-album
|
||
|
||
:::
|
||
|
||
## 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 | — | — |
|
||
| 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) | — | — |
|
||
| on-remove | hook function when files are removed | function(file, fileList) | — | — |
|
||
| on-success | hook function when uploaded successfully | function(response, file, fileList) | — | — |
|
||
| on-error | hook function when some errors occurs | function(err, file, fileList) | — | — |
|
||
| on-progress | hook function when some progress occurs | function(event, file, fileList) | — | — |
|
||
| on-change | hook function when select file or upload file success or upload file fail | function(file, fileList) | — | — |
|
||
| 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) | — | — |
|
||
| 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, fileList) | — | — |
|
||
| thumbnail-mode | whether thumbnail is displayed | boolean | — | false |
|
||
| file-list | default uploaded files, e.g. [{name: 'food.jpg', url: 'https://xxx.cdn.com/xxx.jpg'}] | array | — | [] |
|
||
| 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 | function | — | — |
|
||
| disabled | whether to disable upload | boolean | — | false |
|
||
| limit | maximum number of uploads allowed | number | — | — |
|
||
| on-exceed | hook function when limit is exceeded | function(files, fileList) | — | - |
|
||
|
||
## Slots
|
||
|
||
| Name | Description |
|
||
| ------- | ---------------------------------- |
|
||
| trigger | content which triggers file dialog |
|
||
| tip | content of tips |
|
||
|
||
## Methods
|
||
|
||
| Methods Name | Description | Parameters |
|
||
| ------------ | --------------------------------------------------------------------------------------- | --------------------------- |
|
||
| clearFiles | clear the uploaded file list (this method is not supported in the `before-upload` hook) | — |
|
||
| abort | cancel upload request | （ file: fileList's item ） |
|
||
| submit | upload the file list manually | — |
|