更新记录

1.0.2(2023-11-01)

更换App端转换本地链接的方法; 添加App端文件拓展名过滤;

1.0.1(2023-09-04)

优化部分逻辑

1.0.0(2023-09-03)

支持图片、视频选择上传;H5、微信小程序,APP支持文件选择上传

查看更多

平台兼容性

Vue2 Vue3
×
App 快应用 微信小程序 支付宝小程序 百度小程序 字节小程序 QQ小程序
app-vue
钉钉小程序 快手小程序 飞书小程序 京东小程序
H5-Safari Android Browser 微信浏览器(Android) QQ浏览器(Android) Chrome IE Edge Firefox PC-Safari
×

xe-upload

说明

不占用页面位置的上传组件;

H5、App、微信小程序中可上传图片,视频和文件;其他端暂时只能上传图片和视频

上传图片通过chooseMediachooseImage实现

上传视频通过chooseMediachooseVideo实现

H5端上传文件通过chooseFile实现

App上传文件通过renderjs实现

微信小程序上传文件通过chooseMessageFile实现

使用

<!-- 也可以下载示例项目查看使用方法 -->
<template>
    <view>
        <button @click="handleUploadClick">上传</button>
        <xe-upload ref="XeUpload" :options="uploadOptions" @callback="handleUploadCallback"></xe-upload>
    </view>
</template>

<script>
export default {
    data() {
        return {
            uploadOptions: {
                // url: 'http://192.168.31.185:3000/api/upload', // 不传入上传地址则返回本地链接
            },
        };
    },
    methods: {
        handleUploadClick() {
            // 使用默认配置则不需要传入第二个参数
            // type: ['image', 'video', 'file'];
            this.$refs.XeUpload.upload('file', {});
            // this.$refs.XeUpload.upload('image', {
            //  count: 6,
            //  sizeType: ['original', 'compressed'],
            //  sourceType: ['album'],
            // });
        },
        handleUploadCallback(e) {
            // e.type: ['choose', 'success', 'warning']
            // choose 是options没有传入url,返回临时链接时触发
            // success 是上传成功返回对应的数据时触发
            // warning 上传或者选择文件失败触发
            // ......
        },
    },
};
</script>

Attributes

参数 说明 类型 默认值
options 请求配置(参数与uni.uploadFile的参数一致) object { name: 'file' }

Events

事件名 说明 参数
callback 接收数据 { type, data }

callback type

参数 说明
warning 提示信息(warning回调)
success 上传成功(success回调)
choose 选择文件(choose回调)

callback data

'callback.type === success' : [
    {
        "size": 176579, // 选择的文件的大小
        "name": "Kafka.pdf", // 选择的文件的名称(小程序端可能会没有)
        "type": "application/pdf",
        "tempFilePath": "_doc/uniapp_temp/Kafka-16988473328760.pdf", // 临时路径
        "fileType": "file", // 文件类型[image, video, file]
        "response": {
            "result": {
                "fileName": "Kafka.pdf",
                "filePath": `http://localhost:3000/upload/e51d814b649122fc64892d0bc6383d07.pdf`,
            },
            "success": true,
        }, // 上传返回的信息
    }
]

'callback.type === choose' : [
    {
        "size": 176579, // 选择的文件的大小
        "name": "Kafka.pdf", // 选择的文件的名称(小程序端可能会没有)
        "type": "application/pdf",
        "tempFilePath": "_doc/uniapp_temp/Kafka-16988473328760.pdf", // 文件临时路径
        "fileType": "file", // 文件类型[image, video, file]
    }
]

注意事项

1、options入参中如果url为空,则choose回调的data列表中只有选择文件能得到的信息和临时路径,临时路径可用于自定义上传方法;传入url选择文件后会自动上传到服务器,此时choose回调不会触发,而是执行success回调,success回调的data列表会包括选择文件能得到的信息

2、当uni.chooseMedia可用时,会优先使用uni.chooseMedia

3、具体使用可下载示例项目运行查看完整示例

隐私、权限声明

1. 本插件需要申请的系统权限列表:

2. 本插件采集的数据、发送的服务器地址、以及数据用途说明:

3. 本插件是否包含广告,如包含需详细说明广告表达方式、展示频率:

许可协议

MIT协议

使用中有什么不明白的地方,就向插件作者提问吧~ 我要提问