Uploader 文件上传

介绍

用于将本地的图片或文件上传至服务器，并在上传过程中展示预览图和上传进度。目前 Uploader 组件不包含将文件上传至服务器的接口逻辑，该步骤需要自行实现。

该组件可上传图片，视频，音频。基于uniapp的图片及视频上传等API。

基础用法

文件上传完毕后会触发 after-read 回调函数，获取到对应的 回调信息。

<z-uploader :after-read="afterRead" />

const afterRead = (file) => {
  // 此时可以自行将文件上传至服务器
  console.log(file);
};

文件预览

通过 v-model 可以绑定已经上传的文件列表，并展示文件列表的预览图。

<z-uploader v-model="fileList" multiple />

import { ref } from 'vue';
const fileList = ref([
  { url: 'https://cdn.zebraui.com/zebra-ui/images/swipe-demo/swipe1.jpg' },
  { url: 'https://cdn.zebraui.com/zebra-ui/images/swipe-demo/swipe2.jpg' }
])

上传状态

通过 status 属性可以标识上传状态，uploading 表示上传中，failed 表示上传失败，done 表示上传完成。

<z-uploader v-model="fileListStatus" :after-read="afterReadStatus" />

const fileListStatus = ref([
  {
    url: 'https://cdn.zebraui.com/zebra-ui/images/swipe-demo/swipe1.jpg',
    status: 'uploading',
    message: '上传中...'
  },
  {
    url: 'https://cdn.zebraui.com/zebra-ui/images/swipe-demo/swipe2.jpg',
    status: 'failed',
    message: '上传失败'
  }
])
const afterReadStatus = (file: any) => {
  file.status = 'uploading'
  file.message = '上传中...'

  setTimeout(() => {
    file.status = 'failed'
    file.message = '上传失败'
  }, 1000)
}

限制上传数量

通过 max-count 属性可以限制上传文件的数量，上传数量达到限制后，会自动隐藏上传区域。

<z-uploader v-model="fileListMax" multiple :max-count="2" />

const fileListMax = ref([])

限制上传大小

通过 max-size 属性可以限制上传文件的大小，超过大小的文件会被自动过滤，这些文件信息可以通过 oversize 事件获取。

<z-uploader
  v-model="fileListSize"
  multiple
  :max-size="500 * 1024"
  @oversize="onOversize"
/>

import { ref } from 'vue'
import { useToast } from '../../uni_modules/zebra-ui'
const toast = useToast()
const onOversize = () => {
  toast.showToast('文件大小不能超过 500kb')
}

自定义上传样式

通过默认插槽可以自定义上传区域的样式。

<z-uploader>
  <z-button icon="upload" type="primary">上传文件</z-button>
</z-uploader>

自定义预览样式

通过 preview-cover 插槽可以自定义覆盖在预览区域上方的内容。

<z-uploader v-model="fileList">
  <template #preview-cover="{ file }">
    <view class="preview-cover z-ellipsis">{{
      file?.url ? file?.url : file.file?.url
    }}</view>
  </template>
</z-uploader>

<style>
.demo-uploader {
  .preview-cover {
    position: absolute;
    bottom: 0;
    box-sizing: border-box;
    width: 100%;
    padding: 8rpx;
    font-size: 24rpx;
    color: #fff;
    text-align: center;
    background: rgb(0 0 0 / 70%);
  }
}
</style>

自定义预览大小

通过 preview-size 属性定义预览图和上传区域的大小。

<z-uploader v-model="fileList" preview-size="180rpx" />

将 preview-size 设置为数组格式，可以分别设置宽高。数组第一项对应宽度，数组第二项对应高度。

<z-uploader v-model="fileList" :preview-size="[60, 40]" />

上传前置处理

通过传入 beforeRead 函数可以在上传前进行校验和处理，返回 true 表示校验通过，返回 false 表示校验失败。支持返回 Promise 对 file 对象进行自定义处理，例如压缩图片。

<z-uploader :before-read="beforeRead" />
<z-uploader :before-read="asyncBeforeRead" />

const beforeRead = (file: any) => {
  if (file.type == 'image') {
    toast.showToast('上传图片拦截')
    return false
  }
  return true
}
const asyncBeforeRead = (file: any) =>
  new Promise((resolve, reject) => {
    if (file.type !== 'image') {
      toast.showToast('请上传图片格式文件')
      reject()
    } else {
      file.custom = {
        name: 'zebra-image-test'
      }
      resolve(file)
    }
  })

禁用文件上传

通过 disabled 属性禁用文件上传。

<z-uploader disabled />

自定义单个图片预览

在 v-model 数组中设置单个预览图片属性，支持 imageFit deletable previewSize beforeDelete。

<z-uploader v-model="fileList" :deletable="false" />

const fileListOnly = ref([
  {
    url: 'https://cdn.zebraui.com/zebra-ui/images/swipe-demo/swipe1.jpg',
    deletable: true,
    beforeDelete: () => {
      toast.showToast('删除前置处理')
    }
  },
  {
    url: 'https://cdn.zebraui.com/zebra-ui/images/swipe-demo/swipe2.jpg'
  }
])

开启覆盖上传

<z-uploader v-model="fileListRe" reupload max-count="2" />

const fileListRe = ref([
  { url: 'https://cdn.zebraui.com/zebra-ui/images/swipe-demo/swipe1.jpg' },
  { url: 'https://cdn.zebraui.com/zebra-ui/images/swipe-demo/swipe2.jpg' }
])

Props

注意：上传组件基于uniapp的上传相关api。

Events

Slots

回调参数

before-read、after-read、before-delete 执行时会传递以下回调参数：

样式变量

组件提供了下列 CSS 变量，可用于自定义样式，使用方法请参考 ConfigProvider 组件。