3.7.4 • Published 1 year ago

uxcore-uploader v3.7.4

Weekly downloads
16
License
MIT
Repository
github
Last release
1 year ago

Uxcore Uploader

npm package


uxcore-uploader component for react

$ git clone https://github.com/uxcore/uxcore-uploader
$ cd uxcore-uploader
$ npm start

see https://uxco.re/components/uploader/ for details.

上传组件, 封装UploadCore核心组件, 作为UI层.

API

reset()

重置文件队列

Props

nametypedefaultSince Ver.description
className
localestringzh-cn1.1.10国际化,目前支持 zh-cn, en-uspl-pl
fileListarray[]1.2.3用于展示的文件列表, 见说明 “fileList 更新说明”
isOnlyImgbooleanfalse1.2.1是否以图片形式展示
isVisualbooleanfalse2.0.0是否可视化展示
hideUploadIconbooleanfalse3.2.2在可视化展示下,达到容量(queueCapcity)后是否隐藏上传入口
corestring/Corenull唯一标识或者UploadCore对象, 防止重复创建, 当传入UploadCore对象时,下列参数和事件设置均无效
namestring'file'上传文件字段名称
urlstring''响应上传服务器地址
paramsobject/arraynull上传文件额外参数
headersarraynull上传文件额外头
withCredentialsboolfalse上传文件是否自动附带cookie等信息
timeoutint0上传超时限制 0表示不限制
chunkEnableboolfalse是否允许分片上传
chunkSizesize0文件分片大小, 默认单位b,0不分片
chunkRetriesint0文件分片上传重试次数
chunkProcessThreadsint2分片上传并发数
processThreadsint2文件上传并发数
queueCapcityint0队列容量,0无限;
autoPendingbooltrue是否选择后自动等待上传
multiplebooltrue是否多选
acceptstring/arraynull允许文件类型, chrome 下的已知问题
sizeLimitsize0文件大小限制, 0表示不限制
preventDuplicateboolfalse是否防止文件重复
readOnlyboolfalse3.0.0是否以只读方式显示图片,有该属性时请fileList不能为空
showErrFilebooltrue3.2.0是否显示上传出错的文件项
actionOnQueueLimitstringerror1.5.10当队列超长时采取的策略:error, 抛错;cover, 覆盖

fileList 的最小格式 (格式稍显麻烦,是为了 onChange 的返回值可以传回给 fileList)

[
    {
        name: '', // 文件名称,列表形式必填
        ext: '', // 文件扩展名。例如 jpg。可选,不填时无法根据类型展示对应图标
        fileType: '', // 文件 mimetypes 类型。 例如 image/jpg。 可选,不填时无法根据类型展示对应图标
        response: {
            url: xxx,  // 文件链接,必填
            canRemove: true, // 是否可以删除,可选
            downloadUrl: 'xxxx', // 下载 URL,可选
        }
    }
]

fileList 更新说明

Since 3.3.10 版本,当前已存在的文件列表数据不需要自己再组装一个 response 结构,组件内部会根据顶层数据来组装:

[
  {
    name: 'My File',
    ext: '.jpg',
    fileType: 'image/jpg',
    url: 'https://www.foo.bar/aaa.jpg',
    previewUrl: '', // 可选
    canRemove: true // 可选
  }
]

Events

nameargumentsdescription
onChangefileList在上传成功或文件移除后触发,返回文件队列,包括自己传入的fileList
onCancelfile文件移除后触发,上传的文件和默认列表的文件格式会有所不同,文件格式参见下面的 fileList 格式
onfileuploaderrorFile, Error文件上传失败

onChange 的 fileList 的枚举格式有如下几种

[
    // 上传后的文件的格式, response 即服务器返回的值
    {
        id: 'xxxx', // 如果 response.content 中有提供
        url: 'xxx', // 如果 response.content 中有提供
        previewUrl: 'xxx', // 如果 response.content 中有提供
        type: 'upload',
        ext: file.ext,
        name: file.name,
        response: JSON.parse(file.response)
    },
    // 预览用文件的格式, `props.fileList` 相关, responce 即 `props.fileList` 里传入的格式。
    {
        type: 'list',
        response: file
    },
    // 被删除的文件的格式
    {
        type: 'delete',
        subType: 'list/upload', // 与上面两种类型对应,用于解析 response
        response: file // 与上面的 subType 相对应
    }
]

Other Events

nameargumentsdescription
onqueueuploadstart队列上传开始
onqueueuploadend队列上传结束
onqueuefileaddedFile队列添加了一个文件
onqueuefilefilteredFile, Error队列过滤了一个文件
onqueueerrorError队列错误
onstatchangeStat文件统计发生变化
onfileuploadstartFile文件上传开始
onfileuploadpreparingFileRequest文件上传准备时
onfileuploadpreparedFile, FileRequest文件上传准备好了
onchunkuploadpreparingChunkRequest分块上传准备时
onchunkuploadcompletingChunkResponse分块上传结束时
onfileuploadprogressFile, Progress文件上传进度中
onfileuploadendFile文件上传结束
onfileuploadcompletingFileResponse文件上传结束时
onfileuploadsuccessFile, FileResponse文件上传成功
onfileuploadcompletedFile, Status文件上传完成了
onfilestatuschangeFile, Status文件状态发生变化
onfilecancelFile文件退出
onShowFileFile, Url, Current自定义文件预览行为

具体配置信息见https://github.com/uxcore/uxcore-uploadcore/blob/master/README.md.

3.7.4

1 year ago

3.7.3

4 years ago

3.7.2

4 years ago

3.7.1

4 years ago

3.7.0

4 years ago

3.6.0

5 years ago

3.5.1

5 years ago

3.5.0

5 years ago

3.4.2

5 years ago

3.4.1

5 years ago

3.4.0

5 years ago

3.3.10

5 years ago

3.3.9

5 years ago

3.3.8

5 years ago

3.3.7

5 years ago

3.3.6

5 years ago

3.3.5

6 years ago

3.3.4

6 years ago

3.3.3

6 years ago

3.3.2

6 years ago

3.3.1

6 years ago

3.2.6

6 years ago

3.3.0

6 years ago

3.2.5

6 years ago

3.2.4

6 years ago

3.2.3

6 years ago

3.2.2

6 years ago

3.2.1

6 years ago

3.2.0

6 years ago

3.1.11

6 years ago

3.1.10

6 years ago

3.1.9

6 years ago

3.1.8

6 years ago

3.1.7

6 years ago

3.1.6

6 years ago

3.1.5

7 years ago

3.1.4

7 years ago

3.1.3

7 years ago

3.1.2

7 years ago

3.1.1

7 years ago

3.1.0

7 years ago

3.0.5

7 years ago

3.0.4

7 years ago

3.0.3

7 years ago

3.0.2

7 years ago

3.0.1

7 years ago

3.0.0

7 years ago

2.1.5

7 years ago

2.1.4

7 years ago

2.1.3

7 years ago

2.1.2

7 years ago

2.1.1

7 years ago

2.1.0

7 years ago

2.0.0

7 years ago

1.6.1

7 years ago

1.6.0

7 years ago

1.5.10

7 years ago

1.5.9

7 years ago

1.5.8

8 years ago

1.5.7

8 years ago

1.5.6

8 years ago

1.5.5

8 years ago

1.5.4

8 years ago

1.5.3

8 years ago

1.5.2

8 years ago

1.5.1

8 years ago

1.5.0

8 years ago

1.4.1

8 years ago

1.4.0

8 years ago

1.3.5

8 years ago

1.3.4

8 years ago

1.3.3

8 years ago

1.3.2

8 years ago

1.3.1

8 years ago

1.3.0

8 years ago

1.2.2

8 years ago

1.2.1

8 years ago

1.1.10

8 years ago

1.1.9

8 years ago

1.1.8

8 years ago

1.1.7

8 years ago

1.2.0

8 years ago

1.1.6

8 years ago

1.1.5

8 years ago

1.1.4

9 years ago

1.1.3

9 years ago

1.1.2

9 years ago

1.1.1

9 years ago

1.1.0

9 years ago

1.0.0-beta.5

9 years ago

1.0.0-beta.4

9 years ago

1.0.0-beta.3

9 years ago

1.0.0-beta.2

9 years ago

1.0.0-beta

9 years ago

2.0.0-beta.1

9 years ago

2.0.0-beta

9 years ago

1.0.6

9 years ago

1.0.5

9 years ago

1.0.4

9 years ago

1.0.3

9 years ago

1.0.2

9 years ago

1.0.1

9 years ago

1.0.0

9 years ago