Upload 上传

文件选择上传和拖拽上传控件。

何时使用

上传是将信息（网页、文字、图片、视频等）通过网页或者上传工具发布到远程服务器上的过程。

• 当需要上传一个或一些文件时。
• 当需要展现上传的进度时。
• 当需要使用拖拽交互时。

代码演示

点击上传

经典款式，用户点击按钮弹出文件选择框。

​
import React from 'react';
import ReactDOM from 'react-dom';
import { Upload, message, Button, Icon } from 'choerodon-ui';
​
const props = {
  name: 'file',
  action: '//jsonplaceholder.typicode.com/posts/',
  headers: {
    authorization: 'authorization-text',
  },
  onChange(info) {
    if (info.file.status !== 'uploading') {
      console.log(info.file, info.fileList);
    }
    if (info.file.status === 'done') {
      message.success(`${info.file.name} file uploaded successfully`);
    } else if (info.file.status === 'error') {
      message.error(`${info.file.name} file upload failed.`);
    }
  },
};
​
ReactDOM.render(
  <Upload {...props}>
    <Button>
      <Icon type="file_upload" /> Click to Upload
    </Button>
  </Upload>,
  document.getElementById('container'),

用户头像

点击上传用户头像，并使用 beforeUpload 限制用户上传的图片格式和大小。

beforeUpload 的返回值可以是一个 Promise 以支持也支持异步检查：示例。

​
import React from 'react';
import ReactDOM from 'react-dom';
import { Upload, Icon, message } from 'choerodon-ui';
​
function getBase64(img, callback) {
  const reader = new FileReader();
  reader.addEventListener('load', () => callback(reader.result));
  reader.readAsDataURL(img);
}
​
function beforeUpload(file) {
  const isJPG = file.type === 'image/jpeg';
  if (!isJPG) {
    message.error('You can only upload JPG file!');
  }
  const isLt2M = file.size / 1024 / 1024 < 2;
  if (!isLt2M) {
    message.error('Image must smaller than 2MB!');
  }
  return isJPG && isLt2M;
}
​
class Avatar extends React.Component {
  state = {
    loading: false,
  };
​
  handleChange = (info) => {
    if (info.file.status === 'uploading') {
      this.setState({ loading: true });
      return;
    }
    if (info.file.status === 'done') {
      // Get this url from response in real world.

已上传的文件列表

使用 defaultFileList 设置已上传的内容。

​
import React from 'react';
import ReactDOM from 'react-dom';
import { Upload, Button, Icon } from 'choerodon-ui';
​
const props = {
  action: '//jsonplaceholder.typicode.com/posts/',
  onChange({ file, fileList }) {
    if (file.status !== 'uploading') {
      console.log(file, fileList);
    }
  },
  defaultFileList: [
    {
      uid: 1,
      name: 'xxx.png',
      status: 'done',
      reponse: 'Server Error 500', // custom error message to show
      url: 'http://www.baidu.com/xxx.png',
    },
    {
      uid: 2,
      name: 'yyy.png',
      status: 'done',
      url: 'http://www.baidu.com/yyy.png',
    },
    {
      uid: 3,
      name: 'zzz.png',
      status: 'error',
      reponse: 'Server Error 500', // custom error message to show
      url: 'http://www.baidu.com/zzz.png',
    },
  ],

照片墙

用户可以上传图片并在列表中显示缩略图。当上传照片数到达限制后，上传按钮消失。

​
import React from 'react';
import ReactDOM from 'react-dom';
import { Upload, Icon, Modal } from 'choerodon-ui';
​
class PicturesWall extends React.Component {
  state = {
    previewVisible: false,
    previewImage: '',
    fileList: [
      {
        uid: -1,
        name: 'xxx.png',
        status: 'done',
        url:
          'https://zos.alipayobjects.com/rmsportal/jkjgkEfvpUPVyRjUImniVslZfWPnJuuZ.png',
      },
    ],
  };
​
  handleCancel = () => this.setState({ previewVisible: false });
​
  handlePreview = (file) => {
    this.setState({
      previewImage: file.url || file.thumbUrl,
      previewVisible: true,
    });
  };
​
  handleChange = ({ fileList }) => this.setState({ fileList });
​
  render() {
    const { previewVisible, previewImage, fileList } = this.state;
    const uploadButton = (

完全控制的上传列表

使用 fileList 对列表进行完全控制，可以实现各种自定义功能，以下演示三种情况：

1. 上传列表数量的限制。

2. 读取远程路径并显示链接。

3. 按照服务器返回信息筛选成功上传的文件。

​
import React from 'react';
import ReactDOM from 'react-dom';
import { Upload, Button, Icon } from 'choerodon-ui';
​
class MyUpload extends React.Component {
  state = {
    fileList: [
      {
        uid: -1,
        name: 'xxx.png',
        status: 'done',
        url: 'http://www.baidu.com/xxx.png',
      },
    ],
  };
​
  handleChange = (info) => {
    let fileList = info.fileList;
​
    // 1. Limit the number of uploaded files
    //    Only to show two recent uploaded files, and old ones will be replaced by the new
    fileList = fileList.slice(-2);
​
    // 2. read from response and show file link
    fileList = fileList.map((file) => {
      if (file.response) {
        // Component will show file.url as link
        file.url = file.response.url;
      }
      return file;

拖拽上传

把文件拖入指定区域，完成上传，同样支持点击上传。

设置 multiple 后，在 IE10+ 可以一次上传多个文件。

​
import React from 'react';
import ReactDOM from 'react-dom';
import { Upload, Icon, message } from 'choerodon-ui';
​
const Dragger = Upload.Dragger;
​
const props = {
  name: 'file',
  multiple: true,
  action: '//jsonplaceholder.typicode.com/posts/',
  onChange(info) {
    const status = info.file.status;
    if (status !== 'uploading') {
      console.log(info.file, info.fileList);
    }
    if (status === 'done') {
      message.success(`${info.file.name} file uploaded successfully.`);
    } else if (status === 'error') {
      message.error(`${info.file.name} file upload failed.`);
    }
  },
};
​
ReactDOM.render(
  <Dragger {...props}>
    <p className="c7n-upload-drag-icon">
      <Icon type="inbox" />
    </p>
    <p className="c7n-upload-text">Click or drag file to this area to upload</p>
    <p className="c7n-upload-hint">
      Support for a single or bulk upload. Strictly prohibit from uploading
      company data or other band files
    </p>
  </Dragger>,
  document.getElementById('container'),

图片列表样式

上传文件为图片，可展示本地缩略图。IE8/9 不支持浏览器本地缩略图展示（Ref），可以写 thumbUrl 属性来代替。

​
import React from 'react';
import ReactDOM from 'react-dom';
import { Upload, Button, Icon } from 'choerodon-ui';
​
const fileList = [
  {
    uid: -1,
    name: 'xxx.png',
    status: 'done',
    url:
      'https://zos.alipayobjects.com/rmsportal/jkjgkEfvpUPVyRjUImniVslZfWPnJuuZ.png',
    thumbUrl:
      'https://zos.alipayobjects.com/rmsportal/jkjgkEfvpUPVyRjUImniVslZfWPnJuuZ.png',
  },
  {
    uid: -2,
    name: 'yyy.png',
    status: 'done',
    url:
      'https://zos.alipayobjects.com/rmsportal/jkjgkEfvpUPVyRjUImniVslZfWPnJuuZ.png',
    thumbUrl:
      'https://zos.alipayobjects.com/rmsportal/jkjgkEfvpUPVyRjUImniVslZfWPnJuuZ.png',
  },
];
​
const props = {
  action: '//jsonplaceholder.typicode.com/posts/',
  listType: 'picture',
  defaultFileList: [...fileList],
};
​
const props2 = {
  action: '//jsonplaceholder.typicode.com/posts/',
  listType: 'picture',
  defaultFileList: [...fileList],
  className: 'upload-list-inline',
};
​
ReactDOM.render(
  <div>
    <Upload {...props}>
      <Button>
        <Icon type="file_upload" /> upload

手动上传

beforeUpload 返回 false 后，手动上传文件。

​
import React from 'react';
import ReactDOM from 'react-dom';
import { Upload, Button, Icon, message } from 'choerodon-ui';
import reqwest from 'reqwest';
​
class Demo extends React.Component {
  state = {
    fileList: [],
    uploading: false,
  };
​
  handleUpload = () => {
    const { fileList } = this.state;
    const formData = new FormData();
    fileList.forEach((file) => {
      formData.append('files[]', file);
    });
​
    this.setState({
      uploading: true,
    });
​
    // You can use any AJAX library you like
    reqwest({
      url: '//jsonplaceholder.typicode.com/posts/',
      method: 'post',
      processData: false,
      data: formData,
      success: () => {
        this.setState({
          fileList: [],

可拖拽照片墙

用户可以上传图片并在列表中显示缩略图，可拖拽照片墙。当上传照片数到达限制后，上传按钮消失。

​
import React from 'react';
import ReactDOM from 'react-dom';
import { Upload, Icon, Modal } from 'choerodon-ui';
​
class PicturesWall extends React.Component {
  state = {
    previewVisible: false,
    previewImage: '',
    fileList: [{
      uid: -1,
      name: 'xxx.png',
      status: 'done',
      url: 'https://zos.alipayobjects.com/rmsportal/jkjgkEfvpUPVyRjUImniVslZfWPnJuuZ.png',
    },{
      uid: -2,
      name: 'xxx.png',
      status: 'done',
      url: 'https://zos.alipayobjects.com/rmsportal/jkjgkEfvpUPVyRjUImniVslZfWPnJuuZ.png',
    },{
      uid: -3,
      name: 'xxx.png',
      status: 'done',
      url: 'https://zos.alipayobjects.com/rmsportal/jkjgkEfvpUPVyRjUImniVslZfWPnJuuZ.png',
    }, {
      uid: -4,
      name: 'test.jpg',
      status: 'done',
      url: 'https://s1.ax1x.com/2020/07/05/Up8j76.jpg',
    }],
  };
​
  handleCancel = () => this.setState({ previewVisible: false });
​

API

服务端上传接口实现可以参考 jQuery-File-Upload。

onChange

上传中、完成、失败都会调用这个函数。

文件状态改变的回调，返回为：

{
  file: { /* ... */ },
  fileList: [ /* ... */ ],
  event: { /* ... */ },
}

1. file 当前操作的文件对象。

   {
     uid: 'uid',      // 文件唯一标识，建议设置为负数，防止和内部产生的 id 冲突
     name: 'xx.png'   // 文件名
     status: 'done', // 状态有：uploading done error removed
     response: '{"status": "success"}', // 服务端响应内容
     linkProps: '{"download": "image"}', // 下载链接额外的 HTML 属性
   }

2. fileList 当前的文件列表。

3. event 上传中的服务端响应内容，包含了上传进度等信息，高级浏览器支持。

显示下载链接

请使用 fileList 属性设置数组项的 url 属性进行展示控制。

customRequest

• https://github.com/react-component/upload#customrequest

IE note

• https://github.com/react-component/upload#ie89-note