图片上传组件

54 阅读1分钟

图片上传组件

此组件参考若依后台管理图片上传组件,略微修改部分逻辑,使其适配更多场景

基础用法

vue

<image-upload v-model="form.xxx" :limit="9" :fileSize="10" :isShowTip="false"></image-upload>

1

组件代码

创建组件时,在components目录下创建ImageUpload文件夹,然后创建index.vue粘贴组件代码

vue

<template>
    <div class="component-upload-image">
        <el-upload
            multiple
            :action="uploadImgUrl"
            list-type="picture-card"
            :on-success="handleUploadSuccess"
            :before-upload="handleBeforeUpload"
            :limit="limit"
            :on-error="handleUploadError"
            :on-exceed="handleExceed"
            ref="imageUpload"
            :before-remove="handleDelete"
            :show-file-list="showFileList"
            :headers="headers"
            :file-list="fileList"
            :on-preview="handlePictureCardPreview"
            :accept="accept"
            :class="{ hide: fileList.length >= limit && showFileList, limit1: limit === 1 }"
            :data="data"
        >
            <slot v-if="$slots.default"></slot>
            <el-icon class="avatar-uploader-icon" v-else>
                <Plus />
            </el-icon>
        </el-upload>
        <!-- 上传提示 -->
        <div class="el-upload__tip" v-if="showTip">
            请上传
            <template v-if="fileSize">
                大小不超过 <b style="color: #f56c6c">{{ fileSize }}MB</b>
            </template>
            <template v-if="fileType">
                格式为 <b style="color: #f56c6c">{{ fileType.join("/") }}</b>
            </template>
            的文件
        </div>

        <!-- <el-dialog v-model="dialogVisible" title="预览" width="800px" append-to-body>
            <img :src="dialogImageUrl" style="display: block; max-width: 100%; margin: 0 auto" />
        </el-dialog> -->
        <el-image-viewer v-if="dialogVisible" @close="closeviewer" :url-list="[dialogImageUrl]" />
    </div>
</template>

<script setup>
import { getToken } from "@/utils/auth";
import { Plus } from "@element-plus/icons-vue";
//适配手机做的更改
const props = defineProps({
    modelValue: [String, Object, Array],
    // 图片数量限制
    limit: {
        type: Number,
        default: 1,
    },
    // 大小限制(MB)
    fileSize: {
        type: Number,
        default: 5,
    },
    // 文件类型, 例如['png', 'jpg', 'jpeg']
    fileType: {
        type: Array,
        default: () => ["png", "jpg", "jpeg"],
    },
    // 是否显示提示
    isShowTip: {
        type: Boolean,
        default: true,
    },
    data: {
        type: Object,
        default: () => {
            type: "0";
        },
    },
    showFileList: {
        type: Boolean,
        default: true,
    },
});

const { proxy } = getCurrentInstance();
const emit = defineEmits();
const number = ref(0);
const uploadList = ref([]);
const dialogImageUrl = ref("");
const dialogVisible = ref(false);
const baseUrl = import.meta.env.VITE_APP_BASE_API;
const uploadImgUrl = ref(import.meta.env.VITE_APP_BASE_API + "/common/upload"); // 上传的图片服务器地址
const headers = ref({ Authorization: "Bearer " + getToken() });
const fileList = ref([]);
const showTip = computed(() => props.isShowTip && (props.fileType || props.fileSize));
const accept = computed(() => props.fileType && "." + props.fileType.join(",."));

watch(
    () => props.modelValue,
    (val) => {
        if (val) {
            // 首先将值转为数组
            const list = Array.isArray(val) ? val : props.modelValue.split(",");
            // 然后将数组转为对象数组
            fileList.value = list.map((item) => {
                if (typeof item === "string") {
                    if (item.indexOf(baseUrl) === -1) {
                        item = { name: item, url: item };
                    } else {
                        item = { name: item, url: item };
                    }
                }
                return item;
            });
        } else {
            fileList.value = [];
            return [];
        }
    },
    { deep: true, immediate: true }
);

// 上传前loading加载
function handleBeforeUpload(file) {
    let isImg = false;
    if (props.fileType.length) {
        let fileExtension = "";
        if (file.name.lastIndexOf(".") > -1) {
            fileExtension = file.name.slice(file.name.lastIndexOf(".") + 1);
        }
        isImg = props.fileType.some((type) => {
            if (file.type.indexOf(type) > -1) return true;
            if (fileExtension && fileExtension.indexOf(type) > -1) return true;
            return false;
        });
    } else {
        isImg = file.type.indexOf("image") > -1;
    }
    if (!isImg) {
        proxy.$modal.msgError(`文件格式不正确, 请上传${props.fileType.join("/")}图片格式文件!`);
        return false;
    }
    if (props.fileSize) {
        const isLt = file.size / 1024 / 1024 < props.fileSize;
        if (!isLt) {
            proxy.$modal.msgError(`上传图片大小不能超过 ${props.fileSize} MB!`);
            return false;
        }
    }
    proxy.$modal.loading("正在上传图片,请稍候...");
    number.value++;
}

// 文件个数超出
function handleExceed(files) {
    // 当上传文件为1个且不显示文件列表时,覆盖上传文件 适配手机做的更改
    if (props.limit === 1 && !props.showFileList) {
        // 重置上传状态
        proxy.$refs.imageUpload.clearFiles();
        uploadList.value = [];
        fileList.value = [];
        number.value = 0;

        // 上传文件
        const file = files[0];
        file.uid = Date.now() + 1;
        proxy.$refs.imageUpload.handleStart(file);
        fileList.value.push(file);
        proxy.$refs.imageUpload.submit();
    } else {
        proxy.$modal.msgError(`上传文件数量不能超过 ${props.limit} 个!`);
    }
}

// 上传成功回调
function handleUploadSuccess(res, file) {
    if (res.code == 0) {
        uploadList.value.push({ name: res.fileName, url: res.urlPath });
        uploadedSuccessfully();
    } else {
        number.value--;
        proxy.$modal.closeLoading();
        proxy.$modal.msgError(res.msg);
        proxy.$refs.imageUpload.handleRemove(file);
        uploadedSuccessfully();
    }
}

// 删除图片
function handleDelete(file) {
    const findex = fileList.value.map((f) => f.name).indexOf(file.name);
    if (findex > -1 && uploadList.value.length === number.value) {
        fileList.value.splice(findex, 1);
        emit("update:modelValue", listToString(fileList.value));
        return false;
    }
}

// 上传结束处理
function uploadedSuccessfully() {
    if (number.value > 0 && uploadList.value.length === number.value) {
        fileList.value = fileList.value.filter((f) => f.url !== undefined).concat(uploadList.value);
        uploadList.value = [];
        number.value = 0;
        emit("update:modelValue", listToString(fileList.value));
        proxy.$modal.closeLoading();
    }
}

// 上传失败
function handleUploadError() {
    proxy.$modal.msgError("上传图片失败");
    proxy.$modal.closeLoading();
}

// 预览
function handlePictureCardPreview(file) {
    dialogImageUrl.value = file.url;
    dialogVisible.value = true;
}
// 关闭预览
function closeviewer() {
    dialogVisible.value = false;
    dialogImageUrl.value = "";
}

// 对象转成指定字符串分隔
function listToString(list, separator) {
    let strs = "";
    separator = separator || ",";
    for (let i in list) {
        if (undefined !== list[i].url && list[i].url.indexOf("blob:") !== 0) {
            // strs += list[i].url.replace(baseUrl, '') + separator;
            strs += list[i].url + separator;
        }
    }
    return strs != "" ? strs.substr(0, strs.length - 1) : "";
}
</script>

<style scoped lang="scss">
// .el-upload--picture-card 控制加号部分
:deep(.hide .el-upload--picture-card) {
    display: none;
}

.limit1 {
    :deep(.el-upload-list__item + .el-upload--picture-card) {
        display: none;
    }
    :deep(.el-upload--picture-card) {
        border: none;
        background-color: unset;
        // --el-upload-picture-card-size: 88px 32px;

        i {
            font-size: 28px;
            color: var(--el-color-primary);
        }

        .el-upload-dragger {
            height: 100%;
            padding: 0px;
            display: flex;
            justify-content: center;
            align-items: center;
            // img{
            //     border: 1px dashed #ccc;
            // }
        }
    }
}
</style>

适配手机端

新增一个组件by-image-upload对原来的image-upload组件进行优化使用,使其在手机端更好展示

使用场景及方法

  • 场景一(单图片上传,样式及内容自定义,不显示图片列表)

20240910165825.png

使用方法

vue

<by-image-upload v-model="form.xxx" :limit="1" :fileSize="10" :isShowTip="false" :show-file-list="false">
    <div style="display: flex; flex-direction: column; align-items: center; width: 300px; height: 200px">
        <img src="@/assets/images/zhengjian.png" alt="" width="76" />
        <span style="color: #999">点击上传行医资格证照片</span>
    </div>
    <template #preview>
        <div style="width: 300px; height: 200px">
            <img :src="form.xxx" class="avatar" width="100%" height="100%" />
        </div>
    </template>
</by-image-upload>
  • 场景二(多图片上传,样式显示默认样式,显示图片列表)

image2.png

使用方法

vue

<by-image-upload v-model="form.xxx" :limit="9" :fileSize="10" :isShowTip="false" class="upload-size" />

通过添加 class 控制图片显示大小

scss

.upload-size {
    --upload-size: 120px;
    :deep(.el-upload--picture-card) {
        --el-upload-picture-card-size: var(--upload-size);
    }
    :deep(.el-upload-list__item) {
        --el-upload-list-picture-card-size: var(--upload-size);
    }
}

适配手机端组件代码

创建组件时,在components目录下创建ByImageUpload文件夹,然后创建index.vue粘贴组件代码

vue

<template>
    <ImageUpload :="$attrs" class="phone-upload" :class="{ preview: $slots.preview }">
        <slot name="preview" v-if="$slots.preview && $attrs.modelValue"></slot>
        <slot v-else-if="$slots.default"></slot>
        <el-icon class="avatar-uploader-icon" v-else>
            <Plus />
        </el-icon>
    </ImageUpload>
</template>

<script setup>
import { ref } from "vue";
import ImageUpload from "../ImageUpload/index.vue";
import { Plus } from "@element-plus/icons-vue";
</script>

<style lang="scss" scoped>
.phone-upload {
    :deep(.el-upload-list__item-actions) {
        opacity: 1 !important;
        background: none;
    }
    &.preview {
        :deep(.el-upload--picture-card) {
            width: 100%;
            height: 100%;
        }
    }

    :deep(.el-upload-list__item-preview) {
        opacity: 0 !important;
        display: block;
        width: 100%;
        height: 100%;
    }

    :deep(.el-upload-list__item-status-label) {
        opacity: 0;
    }

    :deep(.el-icon--close-tip) {
        display: none !important;
    }

    :deep(.el-upload-list__item-delete) {
        position: absolute;
        right: 0;
        top: 0;
        width: 28px;
        height: 28px;
        border-radius: 0 0 0 24px;
        background: #000000;
        opacity: 0.7;
        display: flex;
        justify-content: center;
        align-items: center;
        .el-icon {
            margin-left: 6px;

            svg {
                font-size: 18px;
            }
        }
    }
}
</style>