代码演示
如何引入
import { Upload } from '@douyinfe/semi-ui';
基本
最基本的用法,在 children 内放置一个 Button,点击 children 内容(即放置的 Button)激活文件选择框,选择完成后自动开始上传
import React from 'react';
import { Upload, Button } from '@douyinfe/semi-ui';
import { IconUpload } from '@douyinfe/semi-icons';
() => {
return (
<Upload action="https://api.semi.design/upload">
<Button icon={<IconUpload />} theme="light">
点击上传
</Button>
</Upload>
);
};
添加提示文本
通过 prompt
插槽,设置自定义提示文本
通过 promptPosition
设置插槽位置,可选 left
、right
、bottom
,默认为 right
import React from 'react';
import { Upload, Button } from '@douyinfe/semi-ui';
import { IconUpload } from '@douyinfe/semi-icons';
() => {
const action = 'https://api.semi.design/upload';
const getPrompt = (pos, isListType) => {
let basicStyle = { display: 'flex', alignItems: 'center', color: 'grey', height: isListType ? '100%' : 32 };
let marginStyle = {
left: { marginRight: 10 },
right: { marginLeft: 10 },
};
let style = { ...basicStyle, ...marginStyle[pos] };
return <div style={style}>请上传资格认证材料</div>;
};
const button = (
<Button icon={<IconUpload />} theme="light">
点击上传
</Button>
);
const positions = ['right', 'left', 'bottom'];
return (
<>
{positions.map((pos, index) => (
<>
{index ? (
<div
style={{ marginBottom: 12, marginTop: 12, borderBottom: '1px solid var(--semi-color-border)' }}
></div>
) : null}
<Upload action={action} prompt={getPrompt(pos)} promptPosition={pos}>
{button}
</Upload>
</>
))}
</>
);
};
当 listType 为 picture 时,promptPosition 位置的参照对象为图片墙列表整体
import React from 'react';
import { Upload } from '@douyinfe/semi-ui';
import { IconPlus } from '@douyinfe/semi-icons';
() => {
const action = 'https://api.semi.design/upload';
const getPrompt = (pos, isListType) => {
let basicStyle = { display: 'flex', alignItems: 'center', color: 'grey', height: isListType ? '100%' : 32 };
let marginStyle = {
left: { marginRight: 10 },
right: { marginLeft: 10 },
};
let style = { ...basicStyle, ...marginStyle[pos] };
return <div style={style}>请上传认证材料</div>;
};
const defaultFileList = [
{
uid: '1',
name: 'dy.jpeg',
status: 'success',
size: '130kb',
url:
'https://lf3-static.bytednsdoc.com/obj/eden-cn/ptlz_zlp/ljhwZthlaukjlkulzlp/root-web-sites/dy.png',
},
{
uid: '5',
name: 'resso.jpeg',
percent: 50,
size: '222kb',
url:
'https://lf3-static.bytednsdoc.com/obj/eden-cn/ptlz_zlp/ljhwZthlaukjlkulzlp/root-web-sites/Resso.png',
},
];
const positions = ['right', 'bottom'];
return (
<>
{positions.map((pos, index) => (
<>
{index ? (
<div
style={{ marginBottom: 12, marginTop: 12, borderBottom: '1px solid var(--semi-color-border)' }}
></div>
) : null}
<Upload
action={action}
prompt={getPrompt(pos, true)}
promptPosition={pos}
listType="picture"
defaultFileList={defaultFileList}
>
<IconPlus size="extra-large" />
</Upload>
</>
))}
</>
);
};
点击头像触发上传
import React from 'react';
import { Upload, Avatar, Toast } from '@douyinfe/semi-ui';
import { IconCamera } from '@douyinfe/semi-icons';
() => {
const [url, setUrl] = useState('https://lf3-static.bytednsdoc.com/obj/eden-cn/ptlz_zlp/ljhwZthlaukjlkulzlp/root-web-sites/dy.png');
const onSuccess = (response, file) => {
Toast.success('头像更新成功');
setUrl('https://sf6-cdn-tos.douyinstatic.com/obj/ttfe/ies/semi/ttmoment.jpeg');
};
const style = {
backgroundColor: 'var(--semi-color-overlay-bg)',
height: '100%',
width: '100%',
display: 'flex',
alignItems: 'center',
justifyContent: 'center',
color: 'var(--semi-color-white)',
};
const hoverMask = (<div style={style}>
<IconCamera />
</div>);
const api = 'https://api.semi.design/upload';
let imageOnly = 'image/*';
return (
<Upload
className="avatar-upload"
action={api}
onSuccess={onSuccess}
accept={imageOnly}
showUploadList={false}
onError={() => Toast.error('上传失败')}
>
<Avatar src={url} style={{ margin: 4 }} hoverMask={hoverMask} />
</Upload>
);
};
.avatar-upload .semi-upload-add {
border-radius: 50%; // 确保只有圆是点击热区
}
自定义上传属性
通过设置 data
、headers
可添加自定义上传属性
import React from 'react';
import { Upload, Button } from '@douyinfe/semi-ui';
import { IconUpload } from '@douyinfe/semi-icons';
() => {
let action = 'https://api.semi.design/upload';
let data = {
role: 'ies',
time: new Date().getTime(),
};
let headers = {
'x-tt-semi': 'semi-upload',
};
return (
<Upload action={action} data={data} headers={headers}>
<Button icon={<IconUpload />} theme="light">
点击上传
</Button>
</Upload>
);
};
上传文件类型
通过 accept 属性(
input的原生
html` 属性)可以限制上传的文件类型。
accept
支持传入以下两种类型字符串:
- 文件后缀名集合(推荐),如 .jpg、.png 等;
- 文件类型的 MIME types 集合,可参考MDN 文档
例如只允许用户上传 PNG 和 PDF 文件,accept
可以这样写: accept = '.pdf,.png'
或 accept = 'application/pdf,image/png'
(将 PNG 与 PDF 的 MIME type 通过,
连接起来即可)。
注意事项
Upload 会在内部拦截掉不符合 accept 格式的文件,当拦截到不符合格式要求的文件时,会触发 onAcceptInvalid 方法(v1.24提供);
accept 使用后缀可以避免因为浏览器或者操作系统的不同导致 file.type 与 MIME 不兼容问题。
import React from 'react';
import { Upload, Button } from '@douyinfe/semi-ui';
import { IconUpload } from '@douyinfe/semi-icons';
() => {
let action = 'https://api.semi.design/upload';
let imageOnly = 'image/*';
let videoOnly = 'video/*';
let fileLimit = '.pdf,.png,.jpeg';
return (
<>
<Upload action={action} accept={imageOnly} style={{ marginBottom: 12 }}>
<Button icon={<IconUpload />} theme="light">
上传图片
</Button>
</Upload>
<Upload action={action} accept={videoOnly} style={{ marginBottom: 12 }}>
<Button icon={<IconUpload />} theme="light">
上传视频
</Button>
</Upload>
<Upload action={action} accept={fileLimit}>
<Button icon={<IconUpload />} theme="light">
上传 PDF, PNG, JPEG
</Button>
</Upload>
</>
);
};
上传文件夹
通过传入 directory
为 true
,可以支持上传文件夹下的所有文件
import React from 'react';
import { Upload, Button } from '@douyinfe/semi-ui';
import { IconUpload } from '@douyinfe/semi-icons';
() => {
let action = 'https://api.semi.design/upload';
return (
<>
<Upload action={action} directory>
<Button icon={<IconUpload />} theme="light">
上传文件夹
</Button>
</Upload>
</>
);
};
一次选中多个文件
通过设置 multiple
属性可以支持同时选中多个文件上传。
import React from 'react';
import { Upload, Button } from '@douyinfe/semi-ui';
import { IconUpload } from '@douyinfe/semi-icons';
() => {
let action = 'https://api.semi.design/upload';
return (
<Upload action={action} multiple>
<Button icon={<IconUpload />} theme="light">
点击上传
</Button>
</Upload>
);
};
限制文件总数量
通过设置 limit
属性可以限制最大可上传的文件数
当 limit
为1时,始终用最新上传的代替当前,并不会触发onExceed回调v1.5.0生效
import React from 'react';
import { Upload, Button } from '@douyinfe/semi-ui';
import { IconUpload } from '@douyinfe/semi-icons';
() => {
let action = 'https://api.semi.design/upload';
let limit = 1;
let onChange = props => {
console.log(props.fileList);
};
return (
<Upload
action={action}
limit={limit}
onChange={onChange}
>
<Button icon={<IconUpload />} theme="light">
点击上传(最多{limit}项)
</Button>
</Upload>
);
};
import React from 'react';
import { Upload, Button } from '@douyinfe/semi-ui';
import { IconUpload } from '@douyinfe/semi-icons';
() => {
let action = 'https://api.semi.design/upload';
let [disabled, setDisabled] = useState(false);
let limit = 2;
let onChange = props => {
let length = props.fileList.length;
if (length === limit) {
setDisabled(true);
} else {
setDisabled(false);
}
};
return (
<Upload
action={action}
limit={limit}
onExceed={() => Toast.warning(`最多只允许上传${limit}个文件`)}
onChange={onChange}
>
<Button icon={<IconUpload />} theme="light" disabled={disabled}>
点击上传(最多{limit}项)
</Button>
</Upload>
);
};
照片墙模式下,当已上传文件数量等于 limit 时,会自动隐藏上传入口
import React from 'react';
import { Upload } from '@douyinfe/semi-ui';
import { IconPlus } from '@douyinfe/semi-icons';
() => {
let action = 'https://api.semi.design/upload';
const defaultFileList = [
{
uid: '1',
name: 'dyBag.png',
status: 'success',
size: '130KB',
preview: true,
url: 'https://lf3-static.bytednsdoc.com/obj/eden-cn/ptlz_zlp/ljhwZthlaukjlkulzlp/root-web-sites/edit-bag.jpeg',
},
{
uid: '2',
name: 'dyBag2.jpeg',
status: 'success',
size: '222KB',
preview: true,
fileInstance: new File([new ArrayBuffer(2048)], 'dyBag2.jpeg', { type: 'image/png' }),
url: 'https://lf3-static.bytednsdoc.com/obj/eden-cn/ptlz_zlp/ljhwZthlaukjlkulzlp/root-web-sites/edit-bag.jpeg',
},
];
return (
<Upload
action={action}
limit={2}
listType="picture"
accept="image/*"
defaultFileList={defaultFileList}
onExceed={() => Toast.warning('最多只允许上传2个文件')}
>
<IconPlus size="extra-large" />
</Upload>
);
};
限制上传文件大小
通过 maxSize
和 minSize
属性可以自定义上传文件大小的限制,通过设置 onSizeError
可以设置超出限制时的回调。
import React from 'react';
import { Upload, Button } from '@douyinfe/semi-ui';
import { IconUpload } from '@douyinfe/semi-icons';
() => {
let action = 'https://api.semi.design/upload';
return (
<>
<Upload
action={action}
maxSize={1024}
minSize={200}
onSizeError={(file, fileList) => Toast.error(`${file.name} size invalid`)}
>
<Button icon={<IconUpload />} theme="light">
点击上传(最小 200KB,最大 1MB)
</Button>
</Upload>
</>
);
};
自定义列表操作区
listType
为 list
时,可以通过传入 renderFileOperation
来自定义列表操作区
import React from 'react';
import { Upload, Button } from '@douyinfe/semi-ui';
import { IconUpload, IconDownload, IconEyeOpened, IconDelete } from '@douyinfe/semi-icons';
() => {
let action = 'https://api.semi.design/upload';
const defaultFileList = [
{
uid: '1',
name: 'dyBag.png',
status: 'success',
size: '130KB',
preview: true,
url: 'https://lf3-static.bytednsdoc.com/obj/eden-cn/ptlz_zlp/ljhwZthlaukjlkulzlp/root-web-sites/edit-bag.jpeg',
}
];
const renderFileOperation = (fileItem) => (
<div style={{ display: 'flex', columnGap: 8, padding: '0 8px' }}>
<Button icon={<IconEyeOpened></IconEyeOpened>} type="tertiary" theme="borderless" size="small"></Button>
<Button icon={<IconDownload></IconDownload>} type="tertiary" theme="borderless" size="small"></Button>
<Button onClick={e=>fileItem.onRemove()} icon={<IconDelete></IconDelete>} type="tertiary" theme="borderless" size="small"></Button>
</div>
);
return <Upload action={action} defaultFileList={defaultFileList} itemStyle={{ width: 300 }} renderFileOperation={renderFileOperation}>
<Button icon={<IconUpload />} theme="light">点击上传</Button>
</Upload>;
};
自定义预览逻辑
listType
为 list
时,可以通过传入 previewFile
览逻辑
例如你不需要对图片类型进行缩略图预览时,可以在 previewFile
中恒定返回一个<IconFile />
假如你希望点击图片时放大预览,则可以在 previewFile
中使用 Image 组件
或者你希望使用额外的操作区来实现点击放大预览,你也可以结合 renderFileOperation
放置一些自定义元素例如 Icon 图标实现点击放大
import React from 'react';
import { Upload, Button, Image } from '@douyinfe/semi-ui';
import { IconUpload, IconFile } from '@douyinfe/semi-icons';
() => {
let action = 'https://api.semi.design/upload';
const defaultFileList = [
{
uid: '1',
name: 'dyBag.png',
status: 'success',
size: '130KB',
url: 'https://lf3-static.bytednsdoc.com/obj/eden-cn/ptlz_zlp/ljhwZthlaukjlkulzlp/root-web-sites/edit-bag.jpeg',
},
{
uid: '2',
name: 'dyBag2.png',
status: 'success',
size: '130KB',
url: 'https://lf3-static.bytednsdoc.com/obj/eden-cn/ptlz_zlp/ljhwZthlaukjlkulzlp/root-web-sites/edit-bag.jpeg',
},
];
return (
<Upload
defaultFileList={defaultFileList}
action={action}
previewFile={file => file.uid === '1' ? <IconFile size="large" /> : <Image src={file.url} />}
>
<Button icon={<IconUpload />} theme="light">
点击上传
</Button>
</Upload>
);
};
结合 renderFileOperation 与 ImagePreview 的示例,以下示例点击右侧第一个 Icon 可放大图片预览
import React, { useStae } from 'react';
import { Upload, Button, ImagePreview } from '@douyinfe/semi-ui';
import { IconUpload, IconDownload, IconEyeOpened, IconDelete, IconExpand } from '@douyinfe/semi-icons';
() => {
let action = 'https://api.semi.design/upload';
const [visible, setVisible] = useState(false);
const defaultFileList = [
{
uid: '1',
name: 'dyBag.png',
status: 'success',
size: '130KB',
preview: true,
url: 'https://lf3-static.bytednsdoc.com/obj/eden-cn/ptlz_zlp/ljhwZthlaukjlkulzlp/root-web-sites/edit-bag.jpeg',
}
];
const renderFileOperation = (fileItem) => (
<div style={{ display: 'flex', columnGap: 8, padding: '0 8px' }}>
<Button
icon={<IconExpand></IconExpand>}
type="tertiary"
theme="borderless"
size="small"
onClick={()=> setVisible(true)}
>
</Button>
<Button icon={<IconDownload></IconDownload>} type="tertiary" theme="borderless" size="small"></Button>
<Button onClick={e=>fileItem.onRemove()} icon={<IconDelete></IconDelete>} type="tertiary" theme="borderless" size="small"></Button>
<ImagePreview
src={fileItem.url}
visible={visible}
onVisibleChange={setVisible}
/>
</div>
);
return <Upload action={action} defaultFileList={defaultFileList} itemStyle={{ width: 300 }} renderFileOperation={renderFileOperation}>
<Button icon={<IconUpload />} theme="light">点击上传</Button>
</Upload>;
};
默认文件列表
通过 defaultFileList
可以展示已上传的文件。当需要预览默认文件的缩略图时,你可以将 defaultFileList
内对应 item
的 preview
属性设为 true
注意事项
defaultFileList中 uid 必须唯一,不可重复
import React from 'react';
import { Upload, Button } from '@douyinfe/semi-ui';
import { IconUpload } from '@douyinfe/semi-icons';
() => {
let action = 'https://api.semi.design/upload';
const defaultFileList = [
{
uid: '1',
name: 'dyBag.jpeg',
status: 'success',
size: '130KB',
preview: true,
url: 'https://lf3-static.bytednsdoc.com/obj/eden-cn/ptlz_zlp/ljhwZthlaukjlkulzlp/root-web-sites/edit-bag.jpeg',
},
{
uid: '2',
name: 'dyBag2.jpeg',
status: 'uploadFail',
size: '222KB',
preview: true,
fileInstance: new File([new ArrayBuffer(2048)], 'dyBag2.jpeg', { type: 'image/png' }),
url: 'https://lf3-static.bytednsdoc.com/obj/eden-cn/ptlz_zlp/ljhwZthlaukjlkulzlp/root-web-sites/edit-bag.jpeg',
},
];
return (
<>
<Upload action={action} defaultFileList={defaultFileList}>
<Button icon={<IconUpload />} theme="light">
点击上传
</Button>
</Upload>
</>
);
};
受控组件
当传入fileList
时,作为受控组件使用。需要监听 onChange 回调,并且将 fileList 回传给 Upload(注意需传入一个新的数组对象)
import React from 'react';
import { Upload, Button } from '@douyinfe/semi-ui';
import { IconUpload } from '@douyinfe/semi-icons';
() => {
const initList = [
{
uid: '1',
name: 'dyBag.jpeg',
status: 'success',
size: '130KB',
preview: true,
url: 'https://lf3-static.bytednsdoc.com/obj/eden-cn/ptlz_zlp/ljhwZthlaukjlkulzlp/root-web-sites/edit-bag.jpeg',
},
{
uid: '2',
name: 'dy.jpeg',
status: 'uploading',
size: '222KB',
percent: 50,
preview: true,
fileInstance: new File([new ArrayBuffer(2048)], 'dy.jpeg', { type: 'image/jpeg' }),
url:
'https://lf3-static.bytednsdoc.com/obj/eden-cn/ptlz_zlp/ljhwZthlaukjlkulzlp/root-web-sites/dy.png',
},
];
const [list, updateList] = useState(initList);
const onChange = ({ fileList, currentFile, event }) => {
console.log('onChange');
console.log(fileList);
console.log(currentFile);
let newFileList = [...fileList]; // spread to get new array
updateList(newFileList);
};
return (
<Upload
action="https://api.semi.design/upload"
onChange={onChange}
fileList={list}
showRetry={false}
>
<Button icon={<IconUpload />} theme="light">
点击上传
</Button>
</Upload>
);
};
图片墙
设置 listType = 'picture'
,用户可以上传图片并在列表中显示缩略图
如果通过 defaultFileList 或 fileList 设置已上传的文件列表时,会自动读取对象数组中的 url 属性用于展示图片
import React from 'react';
import { Upload } from '@douyinfe/semi-ui';
import { IconPlus } from '@douyinfe/semi-icons';
() => {
let action = 'https://api.semi.design/upload';
const defaultFileList = [
{
uid: '1',
name: 'dy.png',
status: 'success',
size: '130KB',
preview: true,
url:
'https://lf3-static.bytednsdoc.com/obj/eden-cn/ptlz_zlp/ljhwZthlaukjlkulzlp/root-web-sites/dy.png',
},
];
return (
<>
<Upload action={action} listType="picture" accept="image/*" multiple defaultFileList={defaultFileList}>
<IconPlus size="extra-large" />
</Upload>
</>
);
};
设置 showPicInfo
,可以查看图片基础信息
import React from 'react';
import { Upload } from '@douyinfe/semi-ui';
import { IconPlus } from '@douyinfe/semi-icons';
() => {
let action = 'https://api.semi.design/upload';
const defaultFileList = [
{
uid: '1',
name: 'music.png',
status: 'success',
size: '130KB',
preview: true,
url:
'https://lf3-static.bytednsdoc.com/obj/eden-cn/ptlz_zlp/ljhwZthlaukjlkulzlp/root-web-sites/Resso.png',
},
{
uid: '2',
name: 'brand.png',
status: 'success',
size: '130KB',
preview: true,
url:
'https://lf3-static.bytednsdoc.com/obj/eden-cn/ptlz_zlp/ljhwZthlaukjlkulzlp/root-web-sites/Resso.png',
},
];
return (
<>
<Upload action={action} listType="picture" showPicInfo accept="image/*" multiple defaultFileList={defaultFileList}>
<IconPlus size="extra-large" />
</Upload>
</>
);
};
图片墙放大预览
配合 Image 组件,通过 renderThumbnail API ,可以实现点击图片放大预览
import React from 'react';
import { Upload, Image } from '@douyinfe/semi-ui';
import { IconPlus } from '@douyinfe/semi-icons';
() => {
let action = 'https://api.semi.design/upload';
const defaultFileList = [
{
uid: '1',
name: 'music.png',
status: 'success',
size: '130KB',
preview: true,
url:
'https://lf3-static.bytednsdoc.com/obj/eden-cn/ptlz_zlp/ljhwZthlaukjlkulzlp/root-web-sites/Resso.png',
}
];
return (
<>
<Upload
action={action}
listType="picture"
accept="image/*"
multiple
defaultFileList={defaultFileList}
renderThumbnail={(file) => (<Image src={file.url} />)}
>
<IconPlus size="extra-large" />
</Upload>
</>
);
};
可以通过 renderPicPreviewIcon
,onPreviewClick
来自定义预览图标,当显示替换图标 showReplace
时,不会再显示预览图标
当需要自定义预览/替换功能时,需要关闭替换功能,使用 renderPicPreviewIcon
监听图标点击事件即可。
onPreviewClick
监听的是单张图片容器的点击事件
import React from 'react';
import { Upload } from '@douyinfe/semi-ui';
import { IconPlus, IconEyeOpened } from '@douyinfe/semi-icons';
() => {
let action = 'https://api.semi.design/upload';
const defaultFileList = [
{
uid: '1',
name: 'resso.png',
status: 'success',
size: '130KB',
preview: true,
url:
'https://lf3-static.bytednsdoc.com/obj/eden-cn/ptlz_zlp/ljhwZthlaukjlkulzlp/root-web-sites/Resso.png',
},
];
const handlePreview = (file) => {
const feature = "width=300,height=300";
window.open(file.url, 'imagePreview', feature);
};
return (
<>
<Upload
action={action}
listType="picture"
showPicInfo
accept="image/*"
multiple
defaultFileList={defaultFileList}
onPreviewClick={handlePreview}
renderPicPreviewIcon={()=><IconEyeOpened style={{ color: 'var(--semi-color-white)', fontSize: 24 }} />}
>
<IconPlus size="extra-large" />
</Upload>
</>
);
};
图片墙设置宽高
通过设置 picHeight, picWidth ( v2.42 后提供),可以统一设置图片墙元素的宽高
如果同时使用 renderThumbnail
return Image 组件来实现点击放大预览,你需要同时指定 Image 组件的 width 和 height
import React from 'react';
import { Upload } from '@douyinfe/semi-ui';
import { IconPlus } from '@douyinfe/semi-icons';
() => {
let action = 'https://api.semi.design/upload';
const defaultFileList = [
{
uid: '1',
name: 'image-1.jpg',
status: 'success',
size: '130KB',
preview: true,
url:
'https://lf3-static.bytednsdoc.com/obj/eden-cn/ptlz_zlp/ljhwZthlaukjlkulzlp/root-web-sites/abstract.jpg',
}
];
return (
<>
<Upload
action={action}
listType="picture"
accept="image/*"
multiple
defaultFileList={defaultFileList}
picHeight={110}
picWidth={200}
renderThumbnail={(file) => (<Image src={file.url} width={200} height={110} />)}
>
<IconPlus size="extra-large" style={{ margin: 4 }} />
点击添加图片
</Upload>
</>
);
};
设置 hotSpotLocation
自定义点击热区的顺序,默认在照片墙列表结尾
import React from 'react';
import { Upload, Select, RadioGroup, Radio } from '@douyinfe/semi-ui';
import { IconPlus, IconEyeOpened } from '@douyinfe/semi-icons';
() => {
let action = 'https://api.semi.design/upload';
const defaultFileList = [
{
uid: '1',
name: 'resso.png',
status: 'success',
size: '130KB',
preview: true,
url:
'https://lf3-static.bytednsdoc.com/obj/eden-cn/ptlz_zlp/ljhwZthlaukjlkulzlp/root-web-sites/Resso.png',
},
];
const handlePreview = (file) => {
const feature = "width=300,height=300";
window.open(file.url, 'imagePreview', feature);
};
const [hotSpotLocation, setLocation] = useState('end');
return (
<>
<RadioGroup
value={hotSpotLocation}
type='button'
onChange={e => setLocation(e.target.value)}>
<Radio value='start'>start</Radio>
<Radio value='end'>end</Radio>
</RadioGroup>
<hr />
<Upload
action={action}
listType="picture"
showPicInfo
accept="image/*"
multiple
hotSpotLocation={hotSpotLocation}
defaultFileList={defaultFileList}
onPreviewClick={handlePreview}
>
<IconPlus size="extra-large" />
</Upload>
</>
);
};
禁用
import React from 'react';
import { Upload, Button } from '@douyinfe/semi-ui';
import { IconUpload } from '@douyinfe/semi-icons';
() => {
const defaultFileList = [
{
uid: '1',
name: 'first.png',
status: 'success',
size: '130KB',
preview: true,
url: 'https://lf3-static.bytednsdoc.com/obj/eden-cn/ptlz_zlp/ljhwZthlaukjlkulzlp/root-web-sites/dy.png',
},
{
uid: '2',
name: 'second.png',
status: 'validateFail',
size: '222KB',
preview: true,
url: 'https://lf3-static.bytednsdoc.com/obj/eden-cn/ptlz_zlp/ljhwZthlaukjlkulzlp/root-web-sites/dy.png',
},
];
let action = 'https://api.semi.design/upload';
return (
<>
<Upload action={action} disabled defaultFileList={defaultFileList}>
<Button icon={<IconUpload />} theme="light" disabled>
点击上传
</Button>
</Upload>
</>
);
};
手动触发上传
uploadTrigger='custom'
,选中文件后将不会自动触发上传。需要手动调用 ref
上的 upload
方法触发
import React from 'react';
import { Upload, Button } from '@douyinfe/semi-ui';
import { IconUpload, IconPlus } from '@douyinfe/semi-icons';
class ManulUploadDemo extends React.Component {
constructor() {
super();
this.manulUpload = this.manulUpload.bind(this);
this.uploadRef = React.createRef();
}
manulUpload() {
this.uploadRef.current.upload();
}
render() {
let action = 'https://api.semi.design/upload';
return (
<div>
<Upload
accept="image/gif, image/png, image/jpeg, image/bmp, image/webp"
action={action}
uploadTrigger="custom"
ref={this.uploadRef}
onSuccess={(...v) => console.log(...v)}
onError={(...v) => console.log(...v)}
>
<Button icon={<IconPlus />} theme="light" style={{ marginRight: 8 }}>
选择文件
</Button>
</Upload>
<Button icon={<IconUpload />} theme="light" onClick={this.manulUpload}>
开始上传
</Button>
</div>
);
}
}
拖拽上传
draggable='true'
,可以使用拖拽功能
注意事项
在directory为true的情况下,因为浏览器自动做了限制,所以点击上传时不允许选单个文件,拖拽时我们认为同时允许文件夹、文件都能拖动更合理,所以不做另外的拦截处理。
import React from 'react';
import { Upload } from '@douyinfe/semi-ui';
() => (
<Upload
action="https://api.semi.design/upload"
draggable={true}
dragMainText={'点击上传文件或拖拽文件到这里'}
dragSubText="支持任意类型文件"
></Upload>
);
可以通过 dragIcon
、dragMainText
、dragSubText
快捷设置拖拽区内容
import React from 'react';
import { Upload } from '@douyinfe/semi-ui';
import { IconBolt } from '@douyinfe/semi-icons';
() => <Upload
action="https://api.semi.design/upload"
dragIcon={<IconBolt />}
draggable={true}
accept="application/pdf,.jpeg"
dragMainText={'点击上传文件或拖拽文件到这里'}
dragSubText="仅支持jpeg、pdf"
style={{ marginTop: 10 }}
></Upload>;
还可以通过 children
传入 ReactNode,完全自定义拖拽区的显示
import React from 'react';
import { Upload } from '@douyinfe/semi-ui';
import { IconBolt } from '@douyinfe/semi-icons';
() => (<Upload
action="https://api.semi.design/upload"
dragIcon={<IconBolt />}
draggable={true}
accept="application/pdf,.jpeg"
style={{ marginTop: 10 }}
>
<div className="components-upload-demo-drag-area">
<img
src="https://lf3-static.bytednsdoc.com/obj/eden-cn/ptlz_zlp/ljhwZthlaukjlkulzlp/root-web-sites/dy.png"
height="96"
alt='demo img'
style={{ borderRadius: 4 }}
/>
<div
style={{
fontSize: 14,
marginTop: 8,
flexBasis: '100%',
textAlign: 'center',
color: 'var(--semi-color-tertiary)',
}}
>
Wow, you can really dance.
</div>
</div>
</Upload>
);
Scss 样式如下
.components-upload-demo-drag-area {
border-radius: var(--semi-border-radius-small);
border: 2px dashed var(--semi-color-border);
width: 100%;
padding: 12px;
background-color: var(--semi-color-tertiary-light-default);
display: flex;
cursor: pointer;
flex-wrap: wrap;
justify-content: center;
&:hover {
background-color: var(--semi-color-primary-light-default);
border-color: var(--semi-color-primary);
}
}
上传前自定义校验
可通过 beforeUpload
钩子,对文件状态进行更新,这是在网络上传前,选择文件后进行校验,({ file: FileItem, fileList: Array<FileItem> }) => beforeUploadResult | Promise | boolean
同步校验时需返回 boolean(true 为校验通过,false 为校验失败,校验失败会阻止文件网络上传)或者一个 Object 对象,具体结构如下
// beforeUploadResult:
{
fileInstance?: File,
status?: 'success' | 'uploadFail' | 'validateFail' | 'validating' | 'uploading' | 'wait',
validateMessage?: React.ReactNode | string, // 文件的校验信息
shouldUpload: boolean, // 是否需要上传。默认为true,如果为false,该fileItem只会被展示在列表中,不会触发上传操作
autoRemove: boolean, // 是否从fileList中移除该文件,默认为false
}
import React from 'react';
import { Upload, Button } from '@douyinfe/semi-ui';
import { IconUpload } from '@douyinfe/semi-icons';
class ValidateDemo extends React.Component {
constructor(props) {
super(props);
this.state = {};
this.beforeUpload = this.beforeUpload.bind(this);
this.transformFile = this.transformFile.bind(this);
this.count = 0;
}
transformFile(fileInstance) {
if (this.count === 0) {
let newFile = new File([fileInstance], 'newFileName', { type: 'image/png' });
return newFile;
} else {
return fileInstance;
}
}
beforeUpload({ file, fileList }) {
let result;
if (this.count > 0) {
result = {
autoRemove: false,
fileInstance: file.fileInstance,
shouldUpload: true,
};
} else {
result = {
autoRemove: false,
fileInstance: file.fileInstance,
status: 'validateFail',
shouldUpload: false,
};
}
this.count = this.count + 1;
return result;
}
render() {
return (
<Upload
action="https://api.semi.design/upload"
transformFile={this.transformFile}
beforeUpload={this.beforeUpload}
>
<Button icon={<IconUpload />} theme="light">
点击上传(上传前同步校验)
</Button>
</Upload>
);
}
}
异步校验时,需返回 Promise,Promise resolve 代表检验通过,reject 代表校验失败,不会触发上传。
resolve/reject 时可以传入 object(结构同上 beforeUploadResult)
import React from 'react';
import { Upload, Button } from '@douyinfe/semi-ui';
import { IconUpload } from '@douyinfe/semi-icons';
class AsyncBeforeUploadDemo extends React.Component {
constructor(props) {
super(props);
this.state = {};
this.beforeUpload = this.beforeUpload.bind(this);
this.count = 0;
}
beforeUpload({ file, fileList }) {
let result;
return new Promise((resolve, reject) => {
if (this.count > 1) {
result = {
autoRemove: false,
shouldUpload: true,
};
this.count = this.count + 1;
resolve(result);
} else {
result = {
autoRemove: false,
fileInstance: file.fileInstance,
status: 'validateFail',
shouldUpload: false,
validateMessage: `第${this.count + 1}个注定失败`,
};
this.count = this.count + 1;
reject(result);
}
});
}
render() {
return (
<Upload action="https://api.semi.design/upload" beforeUpload={this.beforeUpload}>
<Button icon={<IconUpload />} theme="light">
点击上传(上传前异步校验)
</Button>
</Upload>
);
}
}
上传后更新文件信息
可以通过 afterUpload
钩子,对文件状态,校验信息,文件名进行更新。
({ response: any, file: FileItem, fileList: Array<FileItem> }) => afterUploadResult
afterUpload
在上传完成后(xhr.onload
)且没有发生错误的情况下触发,需返回一个 Object 对象(不支持异步返回),具体结构如下
// afterUploadResult:
{
status?: 'success' | 'uploadFail' | 'validateFail' | 'validating' | 'uploading' | 'wait';
// 文件的校验信息
validateMessage?: React.ReactNode | string;
// 是否从fileList中移除该文件,默认为false
autoRemove?: boolean;
// 文件的名称
name?: string;
// 预览文件的url,一般为当次上传请求中 Server 接收到文件后返回的存储地址,v2.63后支持传入。
// 之前的版本也可以通过 onChange 中结合 status 手动更新受控 fileList 中的属性实现
url?: string
}
import React from 'react';
import { Upload, Button } from '@douyinfe/semi-ui';
import { IconUpload } from '@douyinfe/semi-icons';
() => {
const afterUpload = ({ response, file }) => {
// 可以根据业务接口返回,决定当次上传是否成功
if (response.status_code === 200) {
return {
autoRemove: false,
status: 'uploadFail',
validateMessage: '内容不合法',
name: 'RenameByServer.jpg',
url: 'https://lf3-static.bytednsdoc.com/obj/eden-cn/ptlz_zlp/ljhwZthlaukjlkulzlp/root-web-sites/edit-bag.jpeg'
};
} else {
return {};
}
};
return (
<Upload action="https://api.semi.design/upload" afterUpload={afterUpload}>
<Button icon={<IconUpload />} theme="light">
点击上传
</Button>
</Upload>
)
}
自定义请求
当传入 customRequest 时, 相当于使用的自定义的请求方法替换了 upload 内置的 xhr 请求,用户需要自行接管上传行为。
可在入参中获取到当前操作的 file 对象,用户自行实现上传过程,并且在适当的时候调用 customRequest 入参中的 onProgress、onError、onSuccess 以更新 Upload 组件内部状态进而驱动 UI 更新
customRequest 包含以下入参
{
// 当前文件名称
fileName: string,
// 用户设置的props.data
data: object,
// FileItem,具体结构参考下面的文档
file: FileItem,
// original File Object which extends Blob, 浏览器实际获取到的文件对象(https://developer.mozilla.org/zh-CN/docs/Web/API/File)
fileInstance: File,
// 上传过程中应调用的函数,event需要包含 total、loaded属性
onProgress: (event: { total: number, loaded: number }) => any,
// 上传出错时应调用的函数
onError: (userXhr: { status: number }, e: event) => any,
// 上传成功后应调用的函数, response为上传成功后的请求结果
onSuccess: (response: any, e?: event) => any,
// 用户设置的props.withCredentials
withCredentials: boolean,
// 用户设置的props.action
action: string,
}
import React from 'react';
import { Upload, Button } from '@douyinfe/semi-ui';
import { IconUpload } from '@douyinfe/semi-icons';
() => {
const mockRequest = ({ file, onProgress, onError, onSuccess }) => {
let count = 0;
let interval = setInterval(() => {
if (count === 100) {
clearInterval(interval);
onSuccess();
return;
}
onProgress({ total: 100, loaded: count });
count += 20;
}, 500);
};
return (
<Upload action="https://api.semi.design/upload" customRequest={mockRequest}>
<Button icon={<IconUpload />} theme="light">
点击上传
</Button>
</Upload>
);
};