github
/
element
mirror of https://github.com/ElemeFE/element
1
0
Fork 0
Code Issues Releases Wiki Activity

improve upload docs (#2899)

pull/1873/merge
baiyaaaaa 2017-02-20 11:34:59 +08:00 committed by cinwell.li
parent 7c104b9bbd
commit 9ee825b9fe
2 changed files with 169 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

92
examples/docs/en-US/upload.md
View File

@ -11,7 +11,27 @@
url: 'https://fuss10.elemecdn.com/3/63/4e7f3a15429bfda99bce42a18cdd1jpeg.jpeg?imageMogr2/thumbnail/360x360/format/webp/quality/100', url: 'https://fuss10.elemecdn.com/3/63/4e7f3a15429bfda99bce42a18cdd1jpeg.jpeg?imageMogr2/thumbnail/360x360/format/webp/quality/100',
status: 'finished' status: 'finished'
}], }],
imageUrl: '' fileList2: [{
name: 'food.jpeg',
url: 'https://fuss10.elemecdn.com/3/63/4e7f3a15429bfda99bce42a18cdd1jpeg.jpeg?imageMogr2/thumbnail/360x360/format/webp/quality/100',
status: 'finished'
}, {
name: 'food2.jpeg',
url: 'https://fuss10.elemecdn.com/3/63/4e7f3a15429bfda99bce42a18cdd1jpeg.jpeg?imageMogr2/thumbnail/360x360/format/webp/quality/100',
status: 'finished'
}],
fileList3: [{
name: 'food.jpeg',
url: 'https://fuss10.elemecdn.com/3/63/4e7f3a15429bfda99bce42a18cdd1jpeg.jpeg?imageMogr2/thumbnail/360x360/format/webp/quality/100',
status: 'finished'
}, {
name: 'food2.jpeg',
url: 'https://fuss10.elemecdn.com/3/63/4e7f3a15429bfda99bce42a18cdd1jpeg.jpeg?imageMogr2/thumbnail/360x360/format/webp/quality/100',
status: 'finished'
}],
imageUrl: '',
dialogImageUrl: '',
dialogVisible: false
}; };
}, },
methods: { methods: {
@ -28,6 +48,10 @@
handlePreview(file) { handlePreview(file) {
console.log(file); console.log(file);
}, },
handlePictureCardPreview(file) {
this.dialogImageUrl = file.url;
this.dialogVisible = true;
},
submitUpload() { submitUpload() {
this.$refs.upload.submit(); this.$refs.upload.submit();
}, },
@ -45,6 +69,9 @@
this.$message.error('Avatar picture size can not exceed 2MB!'); this.$message.error('Avatar picture size can not exceed 2MB!');
} }
return isJPG && isLt2M; return isJPG && isLt2M;
},
handleChange(file, fileList) {
this.fileList3 = fileList.slice(-3);
} }
} }
} }
@ -88,7 +115,7 @@ Upload files by clicking or drag-and-drop
### User avatar upload ### User avatar upload
Use beforeUpload hook to limit the upload file format and size. Use `before-upload` hook to limit the upload file format and size.
::: demo ::: demo
```html ```html
@ -132,25 +159,35 @@ Use beforeUpload hook to limit the upload file format and size.
### Photo Wall ### Photo Wall
Use listType to change the fileList style. Use `list-type` to change the fileList style.
::: demo ::: demo
```html ```html
<el-upload <el-upload
action="http://localhost:9000/upload" action="http://localhost:9000/upload"
list-type="picture-card" list-type="picture-card"
:on-preview="handlePreview" :on-preview="handlePictureCardPreview"
:on-remove="handleRemove"> :on-remove="handleRemove">
<i class="el-icon-plus"></i> <i class="el-icon-plus"></i>
</el-upload> </el-upload>
<el-dialog v-model="dialogVisible" size="tiny">
<img width="100%" :src="dialogImageUrl" alt="">
</el-dialog>
<script> <script>
export default { export default {
data() {
return {
dialogImageUrl: '',
dialogVisible: false
};
},
methods: { methods: {
handleRemove(file, fileList) { handleRemove(file, fileList) {
console.log(file, fileList); console.log(file, fileList);
}, },
handlePreview(file) { handlePictureCardPreview(file) {
console.log(file); this.dialogImageUrl = file.url;
this.dialogVisible = true;
} }
} }
} }
@ -167,7 +204,7 @@ Use listType to change the fileList style.
action="http://localhost:9000/upload" action="http://localhost:9000/upload"
:on-preview="handlePreview" :on-preview="handlePreview"
:on-remove="handleRemove" :on-remove="handleRemove"
:file-list="fileList" :file-list="fileList2"
list-type="picture"> list-type="picture">
<el-button size="small" type="primary">Click to upload</el-button> <el-button size="small" type="primary">Click to upload</el-button>
<div slot="tip" class="el-upload__tip">jpg/png files with a size less than 500kb</div> <div slot="tip" class="el-upload__tip">jpg/png files with a size less than 500kb</div>
@ -176,7 +213,7 @@ Use listType to change the fileList style.
export default { export default {
data() { data() {
return { return {
fileList: [{name: 'food.jpeg', url: 'https://fuss10.elemecdn.com/3/63/4e7f3a15429bfda99bce42a18cdd1jpeg.jpeg?imageMogr2/thumbnail/360x360/format/webp/quality/100'}, {name: 'food2.jpeg', url: 'https://fuss10.elemecdn.com/3/63/4e7f3a15429bfda99bce42a18cdd1jpeg.jpeg?imageMogr2/thumbnail/360x360/format/webp/quality/100'}] fileList2: [{name: 'food.jpeg', url: 'https://fuss10.elemecdn.com/3/63/4e7f3a15429bfda99bce42a18cdd1jpeg.jpeg?imageMogr2/thumbnail/360x360/format/webp/quality/100'}, {name: 'food2.jpeg', url: 'https://fuss10.elemecdn.com/3/63/4e7f3a15429bfda99bce42a18cdd1jpeg.jpeg?imageMogr2/thumbnail/360x360/format/webp/quality/100'}]
}; };
}, },
methods: { methods: {
@ -192,6 +229,45 @@ Use listType to change the fileList style.
``` ```
::: :::
### File list control
Use `on-change` hook function to control upload file list
::: demo
```html
<el-upload
class="upload-demo"
action="http://localhost:9000/upload"
:on-change="handleChange"
:file-list="fileList3">
<el-button size="small" type="primary">Click to upload</el-button>
<div slot="tip" class="el-upload__tip">jpg/png files with a size less than 500kb</div>
</el-upload>
<script>
export default {
data() {
return {
fileList3: [{
name: 'food.jpeg',
url: 'https://fuss10.elemecdn.com/3/63/4e7f3a15429bfda99bce42a18cdd1jpeg.jpeg?imageMogr2/thumbnail/360x360/format/webp/quality/100',
status: 'finished'
}, {
name: 'food2.jpeg',
url: 'https://fuss10.elemecdn.com/3/63/4e7f3a15429bfda99bce42a18cdd1jpeg.jpeg?imageMogr2/thumbnail/360x360/format/webp/quality/100',
status: 'finished'
}]
};
},
methods: {
handleChange(file, fileList) {
this.fileList3 = fileList.slice(-3);
}
}
}
</script>
```
:::
### Drag to upload ### Drag to upload
You can drag your file to a certain area to upload it. You can drag your file to a certain area to upload it.

95
examples/docs/zh-CN/upload.md
View File

@ -51,7 +51,27 @@
url: 'https://fuss10.elemecdn.com/3/63/4e7f3a15429bfda99bce42a18cdd1jpeg.jpeg?imageMogr2/thumbnail/360x360/format/webp/quality/100', url: 'https://fuss10.elemecdn.com/3/63/4e7f3a15429bfda99bce42a18cdd1jpeg.jpeg?imageMogr2/thumbnail/360x360/format/webp/quality/100',
status: 'finished' status: 'finished'
}], }],
imageUrl: '' fileList2: [{
name: 'food.jpeg',
url: 'https://fuss10.elemecdn.com/3/63/4e7f3a15429bfda99bce42a18cdd1jpeg.jpeg?imageMogr2/thumbnail/360x360/format/webp/quality/100',
status: 'finished'
}, {
name: 'food2.jpeg',
url: 'https://fuss10.elemecdn.com/3/63/4e7f3a15429bfda99bce42a18cdd1jpeg.jpeg?imageMogr2/thumbnail/360x360/format/webp/quality/100',
status: 'finished'
}],
fileList3: [{
name: 'food.jpeg',
url: 'https://fuss10.elemecdn.com/3/63/4e7f3a15429bfda99bce42a18cdd1jpeg.jpeg?imageMogr2/thumbnail/360x360/format/webp/quality/100',
status: 'finished'
}, {
name: 'food2.jpeg',
url: 'https://fuss10.elemecdn.com/3/63/4e7f3a15429bfda99bce42a18cdd1jpeg.jpeg?imageMogr2/thumbnail/360x360/format/webp/quality/100',
status: 'finished'
}],
imageUrl: '',
dialogImageUrl: '',
dialogVisible: false
}; };
}, },
methods: { methods: {
@ -68,6 +88,10 @@
handlePreview(file) { handlePreview(file) {
console.log(file); console.log(file);
}, },
handlePictureCardPreview(file) {
this.dialogImageUrl = file.url;
this.dialogVisible = true;
},
submitUpload() { submitUpload() {
this.$refs.upload.submit(); this.$refs.upload.submit();
}, },
@ -85,6 +109,9 @@
this.$message.error('上传头像图片大小不能超过 2MB!'); this.$message.error('上传头像图片大小不能超过 2MB!');
} }
return isJPG && isLt2M; return isJPG && isLt2M;
},
handleChange(file, fileList) {
this.fileList3 = fileList.slice(-3);
} }
} }
} }
@ -96,7 +123,6 @@
### 点击上传 ### 点击上传
::: demo 通过 slot 你可以传入自定义的上传按钮类型和文字提示。 ::: demo 通过 slot 你可以传入自定义的上传按钮类型和文字提示。
```html ```html
<el-upload <el-upload
@ -130,7 +156,7 @@
### 用户头像上传 ### 用户头像上传
使用 beforeUpload 限制用户上传的图片格式和大小。 使用 `before-upload` 限制用户上传的图片格式和大小。
::: demo ::: demo
```html ```html
@ -174,25 +200,35 @@
### 照片墙 ### 照片墙
使用 listType 属性来设置文件列表的样式。 使用 `list-type` 属性来设置文件列表的样式。
::: demo ::: demo
```html ```html
<el-upload <el-upload
action="http://localhost:9000/upload" action="http://localhost:9000/upload"
list-type="picture-card" list-type="picture-card"
:on-preview="handlePreview" :on-preview="handlePictureCardPreview"
:on-remove="handleRemove"> :on-remove="handleRemove">
<i class="el-icon-plus"></i> <i class="el-icon-plus"></i>
</el-upload> </el-upload>
<el-dialog v-model="dialogVisible" size="tiny">
<img width="100%" :src="dialogImageUrl" alt="">
</el-dialog>
<script> <script>
export default { export default {
data() {
return {
dialogImageUrl: '',
dialogVisible: false
};
},
methods: { methods: {
handleRemove(file, fileList) { handleRemove(file, fileList) {
console.log(file, fileList); console.log(file, fileList);
}, },
handlePreview(file) { handlePictureCardPreview(file) {
console.log(file); this.dialogImageUrl = file.url;
this.dialogVisible = true;
} }
} }
} }
@ -209,7 +245,7 @@
action="http://localhost:9000/upload" action="http://localhost:9000/upload"
:on-preview="handlePreview" :on-preview="handlePreview"
:on-remove="handleRemove" :on-remove="handleRemove"
:file-list="fileList" :file-list="fileList2"
list-type="picture"> list-type="picture">
<el-button size="small" type="primary">点击上传</el-button> <el-button size="small" type="primary">点击上传</el-button>
<div slot="tip" class="el-upload__tip">只能上传jpg/png文件，且不超过500kb</div> <div slot="tip" class="el-upload__tip">只能上传jpg/png文件，且不超过500kb</div>
@ -218,7 +254,7 @@
export default { export default {
data() { data() {
return { return {
fileList: [{name: 'food.jpeg', url: 'https://fuss10.elemecdn.com/3/63/4e7f3a15429bfda99bce42a18cdd1jpeg.jpeg?imageMogr2/thumbnail/360x360/format/webp/quality/100'}, {name: 'food2.jpeg', url: 'https://fuss10.elemecdn.com/3/63/4e7f3a15429bfda99bce42a18cdd1jpeg.jpeg?imageMogr2/thumbnail/360x360/format/webp/quality/100'}] fileList2: [{name: 'food.jpeg', url: 'https://fuss10.elemecdn.com/3/63/4e7f3a15429bfda99bce42a18cdd1jpeg.jpeg?imageMogr2/thumbnail/360x360/format/webp/quality/100'}, {name: 'food2.jpeg', url: 'https://fuss10.elemecdn.com/3/63/4e7f3a15429bfda99bce42a18cdd1jpeg.jpeg?imageMogr2/thumbnail/360x360/format/webp/quality/100'}]
}; };
}, },
methods: { methods: {
@ -234,6 +270,45 @@
``` ```
::: :::
### 上传文件列表控制
通过 `on-change` 钩子函数来对列表进行控制
::: demo
```html
<el-upload
class="upload-demo"
action="http://localhost:9000/upload"
:on-change="handleChange"
:file-list="fileList3">
<el-button size="small" type="primary">点击上传</el-button>
<div slot="tip" class="el-upload__tip">只能上传jpg/png文件，且不超过500kb</div>
</el-upload>
<script>
export default {
data() {
return {
fileList3: [{
name: 'food.jpeg',
url: 'https://fuss10.elemecdn.com/3/63/4e7f3a15429bfda99bce42a18cdd1jpeg.jpeg?imageMogr2/thumbnail/360x360/format/webp/quality/100',
status: 'finished'
}, {
name: 'food2.jpeg',
url: 'https://fuss10.elemecdn.com/3/63/4e7f3a15429bfda99bce42a18cdd1jpeg.jpeg?imageMogr2/thumbnail/360x360/format/webp/quality/100',
status: 'finished'
}]
};
},
methods: {
handleChange(file, fileList) {
this.fileList3 = fileList.slice(-3);
}
}
}
</script>
```
:::
### 拖拽上传 ### 拖拽上传
::: demo ::: demo
@ -303,7 +378,7 @@
| on-success | 可选参数, 文件上传成功时的钩子 | function(response, file, fileList) | — | — | | on-success | 可选参数, 文件上传成功时的钩子 | function(response, file, fileList) | — | — |
| on-error | 可选参数, 文件上传失败时的钩子 | function(err, file, fileList) | — | — | | on-error | 可选参数, 文件上传失败时的钩子 | function(err, file, fileList) | — | — |
| on-progress | 可选参数, 文件上传时的钩子 | function(event, file, fileList) | — | — | | on-progress | 可选参数, 文件上传时的钩子 | function(event, file, fileList) | — | — |
| on-change | 可选参数, 文件状态改变时的钩子 | function(file, fileList) | — | — | | on-change | 可选参数, 文件状态改变时的钩子，上传成功或者失败时都会被调用 | function(file, fileList) | — | — |
| before-upload | 可选参数, 上传文件之前的钩子，参数为上传的文件，若返回 false 或者 Promise 则停止上传。 | function(file) | — | — | | before-upload | 可选参数, 上传文件之前的钩子，参数为上传的文件，若返回 false 或者 Promise 则停止上传。 | function(file) | — | — |
| list-type | 文件列表的类型 | string | text/picture/picture-card | text | | list-type | 文件列表的类型 | string | text/picture/picture-card | text |
| auto-upload | 是否在选取文件后立即进行上传 | boolean | — | true | | auto-upload | 是否在选取文件后立即进行上传 | boolean | — | true |