Upload 上传组件

Upload 组件是一个基于 ElementPlus 上传组件的封装组件, 提供了文件上传功能和增强配置.

基本用法

tsx

import { defineOption } from '@xiaohaih/json-form-plus';

defineOption({
    avatar: {
        t: 'upload',
        label: '头像',
        action: '/api/upload',
        accept: 'image/*',
    },
});

Props

除了共享 Props 和 ElUpload 自带的 Props 外, Upload 组件还支持以下特定属性:

httpRequest

类型: (option: UploadRequestOptions) => Promise<unknown> | XMLHttpRequest | void
默认: -

重声明该字段并做优化, 内部处理 success 和 promise 结果只执行一次

beforeUpload

类型: UploadHooks['beforeUpload']
默认: -

上传前的钩子函数(做了大小限制以及重复文件处理)

buttonText

类型: string
默认: '上传图片'

上传按钮显示的文字

buttonAttrs

类型: 请参考 https://element-plus.org/zh-CN/component/button.html#button-attributes
默认: -

上传按钮的属性

fileMaxSize

类型: number
默认: -

上传文件的最大大小

fileMaxSizeToast

类型: (file: File, size: number) => void
默认: (file: File, size: number) => ElMessage.error(`上传文件(\${file.name})大小不能超过\${~~((size / 1024 / 1024) \* 100) / 100}M\`)

超过限制的文件大小时的提示语

fileRepeatToast

类型: (file: File) => void
默认: (file: File) => ElMessage.error(\`不能重复上传文件(\${file.name})\`)

上传相同文件时的提示语

override

类型: boolean
默认: -

是否开启覆盖上传 - 当 limit 为 1 时生效

插槽

插槽项请参考 ElUpload.slots
插槽实际的 Props 等于插槽自带的 Props + SlotProps

插槽示例

tsx

defineOption({
    avatar: {
        t: 'upload',
        label: '头像',
        itemSlots: {
            default: () => h('div', '点我上传'),
            tip: () => h('div', '只能上传图片啊~~~'),
        },
    },
});

SlotProps 声明如下

export interface SlotProps {
    /**
     * 获取传递给 FormItem props
     * 可参考 https://element-plus.org/zh-CN/component/form.html#formitem-api
     */
    getFormItemProps: () => Record<string, any>;
    /** 获取传递给当前 ElementPlus 组件 props */
    getItemProps: () => Record<string, any>;
    /** 获取传递给当前组件 props */
    getProps: () => Record<string, any>;
    /** 额外的参数(纯纯的语法糖配置) */
    extraOptions: {
        /** 传递给组件的值 */
        modelValue: any;
        /** 数据源 */
        options: any;
        /** 更新值 */
        onChange: (value: any) => void;
    };
    /** 封装给组件的通用选项 */
    plain: PlainReturnValue;
}

/** usePlain 的返回值 */
export interface PlainReturnValue {
    /** 覆盖 props 的最新的值(defaultValue, initialValue) */
    coverProps: Record<'defaultValue' | 'initialValue', any>;
    /** HForm 暴露给组件的选项 */
    wrapper: WrapperProvideValue;
    /** 在特定时机中 HForm 会调用该选项下的方法 */
    option: CommonMethod;
    /** 数据加载状态 */
    loading: Ref<boolean>;
    /** 可主动获取远程数据 */
    getOptions: (trigger: 'initial' | 'depend' | 'other', option?: {
        /** 筛选值 */
        filterValue?: string;
    }) => Promise<void>;
    /** 当前组件的值 */
    checked: Ref<any>;
    /** 获取当前组件提交给后端的值 */
    getQuery: () => Record<string, any>;
    /** 远程数据(getOptions 返回的数据) */
    remoteOption: Ref<Record<string, any>[]>;
    /** 优先返回 remoteOption, 其次返回外部传递的 options */
    finalOption: ComputedRef<Record<string, any>[]>;
    /** 是否隐藏组件 */
    insetHide: ComputedRef<boolean>;
    /** 更新值但不触发外部的搜索事件 */
    updateCheckedValue: (value: any) => void;
    /**
     * 更新值并根据 HForm realtime 状态判断
     * - realtime: true 则触发搜索事件
     * - realtime: false 则仅更新值(等同于 updateCheckedValue 函数)
     */
    change: (value: any) => void;
    /** 等同于 updateCheckedValue, 只是可以选择不传值(用来兼容低版本) */
    trigger: (value?: any) => void;
    /** 触发搜索事件 */
    search: () => void;
    /** 重置 */
    reset: () => void;
    /** 传递给 HForm 的 readonly 属性 */
    globalReadonly: Ref<boolean>;
    /** 传递给 HForm 的 disabled 属性 */
    globalDisabled: Ref<boolean>;
}

/** 组件提供给 HForm 的选项 */
export interface CommonMethod {
    /** 重置 */
    reset: () => void;
    /** 更新 HForm 中 query 的值 */
    updateWrapperQuery: () => void;
    /** 校验方法 */
    validator?: (query: Record<string, string>) => Promise<any> | any;
    /** 获取该组件拼接的参数 */
    getQuery: () => Record<string, any>;
    /** 在 watch 中 backfill 改变后, 需要执行回调 */
    onChangeByBackfill?: () => void;
}

/** HForm 暴露给组件的选项 */
export interface WrapperProvideValue {
    /** 表单是否只读 */
    readonly?: Ref<boolean | undefined>;
    /** 表单是否禁用 */
    disabled?: Ref<boolean | undefined>;
    /**
     * 是否实时触发
     */
    realtime: Ref<boolean | undefined>;
    /**
     * 子组件需主动注册组件, 否则不会生效
     * @param {CommonMethod} config 提供父组件校验, 重置等方法
     *
     * @returns {() => void} 取消注册 - 默认会自动取消, 如果是异步任务内注册, 需自己手动取消
     */
    register: (config: CommonMethod) => () => void;
    /**
     * 子组件通知父级更新 query 中的值 - 静默修改, 不触发搜索事件
     * @param {string} field 更新的字段
     * @param {*} value 更新的值
     * @param {string} nativeField 原始提供的字段(不受 as, fields 等属性的影响)
     */
    updateQueryValue: (field: string, value: any, nativeField: string) => void;
    /**
     * 子组件内部值发生了变动, 由父级决定是否触发搜索事件(实时搜索时需要区分这两种方式)
     * @param {string | string[]} [tryFields] 比较 query[tryFields] 与 backfill[tryFields]是否一致, 不一致时才触发搜索
     */
    insetSearch: (tryFields?: string | string[]) => void;
    /**
     * 提供给组件内部的直接触发到外部的搜索事件
     */
    search: () => Promise<string | void>;
    /** 删除内部无引用的字段 */
    removeUnreferencedField: (field: string) => void;
    /** 所有条件的 options 数据 */
    options: Record<string, any[]>;
}

示例

基础文件上传 + 图片上传

tsx

defineOption({
    file: {
        t: 'upload',
        label: '文件',
        action: '/api/upload',
        accept: '.pdf,.doc,.docx',
        limit: 5,
    },
    image: {
        t: 'upload',
        label: '图片',
        action: '/api/upload/image',
        accept: 'image/*',
        listType: 'picture-card',
        limit: 1,
        fileMaxSize: 2 * 1024 * 1024 // 2MB
    },
});

点我查看在线示例

自定义上传 + 拖拽上传

tsx

defineOption({
    document: {
        t: 'upload',
        label: '文档',
        async httpRequest(options) {
            const formData = new FormData();
            formData.append('file', options.file);

            const response = await fetch('/api/upload', {
                method: 'POST',
                body: formData
            });

            const result = await response.json();
            if (result.success) {
                options.onSuccess(result.data);
            }
            else {
                options.onError(new Error(result.message));
            }
        },
    },
    files: {
        t: 'upload',
        label: '文件',
        action: '/api/upload',
        drag: true,
        multiple: true,
        buttonText: '点击或拖拽文件到此处上传',
        itemSlots: {
            default: () => h('div', { style: { margin: '0 40px', fontSize: '30px' } }, '+'),
        },
    },
});

点我查看在线示例

注意事项

支持 ElFormItem 组件所有的 Props
支持 ElUpload 组件所有的 Props
可以通过 fileMaxSize 设置文件大小限制
通过 limit 属性限制上传文件数量

tips: 当 ElFormItem 组件与 ElUpload 组件的 Props 冲突时

可通过 formItemProps 将属性传递给 ElFormItem
可通过 staticProps 将属性传递给 ElUpload

Upload 上传组件 ​

基本用法 ​

Props ​

httpRequest ​

beforeUpload ​

buttonText ​

buttonAttrs ​

fileMaxSize ​

fileMaxSizeToast ​

fileRepeatToast ​

override ​

插槽 ​

示例 ​

基础文件上传 + 图片上传 ​

自定义上传 + 拖拽上传 ​

注意事项 ​