上传 Uploader

用于将本地图片上传到服务器，可以展示上传进度、结果预览。

使用

API

安装使用

import { TiUploader } from '@titian-design/mobile-react'

用法示例

基础用法

选择完文件后，立即执行上传操作。

const App: React.FC = () => {
  return (
    <>
       <TiUploader
          url="https://api.bayfiles.com/upload"
          size="small"
          chooseText="请选择文件"
        />
    </>
  )
}

自定义参数

自定义header

const App: React.FC = () => {
  const params = {
    name: 'picture',
    header: {
      'content-type': 'multipart/form-data'
    }
  }
  const afterUpload = (res) => {
    // 这里的res是你自定义的上传接口的返回值
    const data = JSON.parse(res.data);
    if (data.errcode !== '0') {
      return {
        status: 'fail'
      };
    }
    return {
      path: data.data.url,
      status: 'done'
    };
  }
  const change = (file, fileList) => {
    // 上传完成/删除完成后调用
    console.log(file, fileList);
  }
  return (
    <>
       <TiUploader
          url="https://api.bayfiles.com/upload"
          image-params={ params }
          afterUpload={ afterUpload }
          onChange="change"
        />
    </>
  )
}

手动上传

通过设置 immediately 为 false，并调用 submit() 方法，可以手动控制上传时机。

const App: React.FC = () => {

  const beforeUpload = (event: any) => {
    console.log("beforeUpload", event);
  };

  const doSubmit = (event: any) => {
    if (uploaderRef.current) {
      uploaderRef.current.submit();
    }
    console.log("doSubmit", event);
  };

  return (
    <>
       <TiUploader
          ref={uploaderRef}
          url="https://api.bayfiles.com/upload"
          size="small"
          count={10}
          beforeUpload={beforeUpload}
          immediately={false}
          chooseText="请选择"
        />
    </>
  )
}

自定义上传, 仅使用组件样式

const App: React.FC = () => {
  const [fileList, setFileList] = useState([
    {
      path: 'https://xxxxx.png',
      fileType: 'image',
      status: 'done',
    },
  ]);
  const afterChoose = (selectedList, existsList) => {
    // 上传之前你可以根据需求，比如size，来过滤selectedList
    YOUR_UPLOAD().then(() => {
      // 在你的上传回调里设置fileList，主要设置路径path，和状态status => 成功: done，失败：fail，上传中：'upload'
      setFileList([
        ...existsList,
        ...selectedList.map(el => ({
          ...el,
          path: 'https://xxxxx.png',
          status: 'done', // 上传失败的话 这里设置  fail
        })),
      ]);
    });
    // 这里return出去的是走后续上传的文件
    return selectedList.map(el => ({ ...el, status: 'upload' }));
  };
  const onChange = e => {
    setFileList(e.detail.fileList);
  };

  return (
    <TiUploader value={fileList} immediately={false} afterChoose={afterChoose} onChange={onChange}></TiUploader>
  )
}

TiUploader API

属性 Properties

名称	类型	是否必填	默认值	说明	备注
value	unknown	否	-	使用 value，组件为受控模式	-
defaultValue	UploadFileParams[]	否	[]	使用 defaultValue ，组件为非受控模式
disabled	boolean	否	false	禁用交互能力
immediately	boolean	否	true	是否立刻上传	-
immediatelyChoose	boolean	否	true	点击后立即选择	-
size	small | large	否	small	组件尺寸	-
chooseText	string	否		选择器文案	-
chooseIcon	string	否	plus	选择器 icon	-
sourceType	array	否	['album', 'camera']	选择图片的来源	-
camera	back | front	否	back	仅在 sourceType 为 camera 时生效，使用前置或后置摄像头	-
count	number	否	9	选择文件/图片/视频的数量	-
url	string	否	-	上传地址	-
preview	Function	否		自定义预览组件。默认使用内置的预览工具	-
choose	Function	否		选择函数	-
beforeChoose	Function	否		选择前的处理函数	-
afterChoose	Function	否		选择后的处理函数	-
beforeUpload	Function	否		- 上传前置方法 可用用于处理上传参数	-
upload	Function	否		自定义上传方法，不传则使用内置的上传方法	-
complete	Function	否		上传完成/删除完成后调用	-
afterUpload	Function	否		上传后置方法，后置处理返回结果	-
uploadExercise	'' | loading | progress	否	loading	上传中展示风格	-
imageParams	Record<string, any>	否	{}	上传图片参数；当不传自定义 beforeUpload 方法时，可以传该参数作为内部 beforeUpload 的参数	-
videoParams	Record<string, any>	否	{}	上传视频参数；当不传自定义 beforeUpload 方法时，可以传该参数作为内部 beforeUpload 的参数	-
fileParams	Record<string, any>	否	{}	上传文件参数；当不传自定义 beforeUpload 方法时，可以传该参数作为内部 beforeUpload 的参数	-
imageResultFormat	(string | number)[]	否	[]	图片参数；当不传自定义 afterUpload 方法时，可以传该参数作为内部 afterUpload 的参数	-
videoResultFormat	(string | number)[]	否	[]	视频参数；当不传自定义 afterUpload 方法时，可以传该参数作为内部 afterUpload 的参数	-
fileResultFormat	(string | number)[]	否	[]	文件参数；当不传自定义 afterUpload 方法时，可以传该参数作为内部 afterUpload 的参数	-
accept	string	否	/	http 的 accept 参数，指定文件类型	-
extStyle	string	否	''	容器样式	-

事件 Events

名称	参数列表	描述	备注
onChange	(e: CustomEvent<{ file: UploadFile; fileList: UploadFile[]; uploading: boolean }>) => void	上传处理
onError	(e: CustomEvent<{ status: string; message: string; }>) => void	错误事件
onChoose	(e: CustomEvent<any>) => void	选择事件

外部样式类 External Classes

名称	说明	备注
extClass	根节点可扩展的类名	-
extThumBoxClass	缩略图容器类名	--
extThumTipClass	缩略图容器提示类名	--
extThumClass	缩略图类名	--
extThumImageClass	缩略图-图片类名	--
extThumVideoClass	缩略图-视频类名	--
extThumOtherClass	缩略图-其他类名	--
extActionClass	选择器-类名	--

CSS 变量 CSS Variable

变量	默认值	说明	备注
--uploader-name-color	var(--neutral-color-4, #c4c4c4)	上传文件展示区文字颜色	-
--uploader-name-font-size	24px	上传文件展示区文字大小	-
--uploader-action-bg-color	var(--neutral-color-7, #f5f5f5)	上传区背景色	-
--uploader-action-text-color	var(--neutral-color-4, #c4c4c4)	上传区文字颜色	-
--uploader-icon-color	var(--neutral-color-3, #9e9e9e)	上传区 icon 颜色	-
--uploader-disabled-color	@neutral-color-5	上传区禁用 icon、(失败)文字颜色	-
--uploader-fail-color	var(--neutral-color-9, #ffffff)	上传文件失败文字颜色	-
--uploader-fail-bg-color	var(--neutral-color-1, #212121)	上传文件失败背景颜色	-
--uploader-loading-color	var(--neutral-color-9, #ffffff)	上传文件 loading 颜色	-
--uploader-loading-bg-color	var(--neutral-color-1, #212121)	上传文件 loading 背景颜色	-
--uploader-small-size	120px	上传文件小尺寸容器大小	-
--uploader-small-margin	24px	上传文件小尺寸容器外边距	-
--uploader-small-radius	calc(var(--base-radius-size, 0px) + 8px)	上传文件小尺寸容器圆角	-
--uploader-large-size	216px	上传文件大尺寸容器大小	-
--uploader-large-margin	24px	上传文件大尺寸容器外边距	-
--uploader-large-radius	calc(var(--base-radius-size, 0px) + 12px)	上传文件大尺寸容器圆角	-

数据结构 Data Structure

文件 UploadFile

interface UploadFile extends UploadFileExternal {
  key: string;
}

interface UploadFileExternal {
  path: string;
  poster?: string;
  size: number;
  name: string;
  duration?: number;
  fileType: UploadType;
  status: UploadStatus;
}