• Upload 上传

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

    何时使用

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

    代码演示

    经典款式,用户点击按钮弹出文件选择框。
    expand code expand code
    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>,
      mountNode);
    
    使用 defaultFileList 设置已上传的内容。
    expand code expand code
    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',
      }],
    };
    
    ReactDOM.render(
      <Upload {...props}>
        <Button>
          <Icon type="file_upload" /> Upload
        </Button>
      </Upload>,
      mountNode);
    

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

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

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

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

    expand code expand code
    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;
        });
    
        // 3. filter successfully uploaded files according to response from server
        fileList = fileList.filter((file) => {
          if (file.response) {
            return file.response.status === 'success';
          }
          return true;
        });
    
        this.setState({ fileList });
      }
    
      render() {
        const props = {
          action: '//jsonplaceholder.typicode.com/posts/',
          onChange: this.handleChange,
          multiple: true,
        };
        return (
          <Upload {...props} fileList={this.state.fileList}>
            <Button>
              <Icon type="file_upload" /> upload
            </Button>
          </Upload>
        );
      }
    }
    
    ReactDOM.render(<MyUpload />, mountNode);
    
    上传文件为图片,可展示本地缩略图。IE8/9 不支持浏览器本地缩略图展示(Ref),可以写 thumbUrl 属性来代替。
    expand code expand code
    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
          </Button>
        </Upload>
        <br />
        <br />
        <Upload {...props2}>
          <Button>
            <Icon type="file_upload" /> upload
          </Button>
        </Upload>
      </div>,
      mountNode);
    

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

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

    expand code expand code
    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.
          getBase64(info.file.originFileObj, imageUrl => this.setState({
            imageUrl,
            loading: false,
          }));
        }
      }
    
      render() {
        const uploadButton = (
          <div>
            <Icon type={this.state.loading ? 'loading' : 'add'} />
            <div className="ant-upload-text">Upload</div>
          </div>
        );
        const imageUrl = this.state.imageUrl;
        return (
          <Upload
            name="avatar"
            listType="picture-card"
            className="avatar-uploader"
            showUploadList={false}
            action="//jsonplaceholder.typicode.com/posts/"
            beforeUpload={beforeUpload}
            onChange={this.handleChange}
          >
            {imageUrl ? <img src={imageUrl} alt="" /> : uploadButton}
          </Upload>
        );
      }
    }
    
    ReactDOM.render(<Avatar />, mountNode);
    
    用户可以上传图片并在列表中显示缩略图。当上传照片数到达限制后,上传按钮消失。
    expand code expand code
    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 = (
          <div>
            <Icon type="add" />
            <div className="ant-upload-text">Upload</div>
          </div>
        );
        return (
          <div className="clearfix">
            <Upload
              action="//jsonplaceholder.typicode.com/posts/"
              listType="picture-card"
              fileList={fileList}
              onPreview={this.handlePreview}
              onChange={this.handleChange}
            >
              {fileList.length >= 3 ? null : uploadButton}
            </Upload>
            <Modal visible={previewVisible} footer={null} onCancel={this.handleCancel}>
              <img alt="example" style={{ width: '100%' }} src={previewImage} />
            </Modal>
          </div>
        );
      }
    }
    
    ReactDOM.render(<PicturesWall />, mountNode);
    

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

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

    expand code expand code
    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="ant-upload-drag-icon">
          <Icon type="inbox" />
        </p>
        <p className="ant-upload-text">Click or drag file to this area to upload</p>
        <p className="ant-upload-hint">Support for a single or bulk upload. Strictly prohibit from uploading company data or other band files</p>
      </Dragger>,
      mountNode);
    
    beforeUpload 返回 false 后,手动上传文件。
    expand code expand code
    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: [],
              uploading: false,
            });
            message.success('upload successfully.');
          },
          error: () => {
            this.setState({
              uploading: false,
            });
            message.error('upload failed.');
          },
        });
      }
    
      render() {
        const { uploading } = this.state;
        const props = {
          action: '//jsonplaceholder.typicode.com/posts/',
          onRemove: (file) => {
            this.setState(({ fileList }) => {
              const index = fileList.indexOf(file);
              const newFileList = fileList.slice();
              newFileList.splice(index, 1);
              return {
                fileList: newFileList,
              };
            });
          },
          beforeUpload: (file) => {
            this.setState(({ fileList }) => ({
              fileList: [...fileList, file],
            }));
            return false;
          },
          fileList: this.state.fileList,
        };
    
        return (
          <div>
            <Upload {...props}>
              <Button>
                <Icon type="file_upload" /> Select File
              </Button>
            </Upload>
            <Button
              className="upload-demo-start"
              type="primary"
              onClick={this.handleUpload}
              disabled={this.state.fileList.length === 0}
              loading={uploading}
            >
              {uploading ? 'Uploading' : 'Start Upload' }
            </Button>
          </div>
        );
      }
    }
    
    ReactDOM.render(<Demo />, mountNode);
    

    API

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

    参数说明类型默认值
    accept接受上传的文件类型, 详见 input accept Attributestring
    action必选参数, 上传的地址string
    beforeUpload上传文件之前的钩子,参数为上传的文件,若返回 false 则停止上传。支持返回一个 Promise 对象,Promise 对象 reject 时则停止上传,resolve 时开始上传。注意:IE9 不支持该方法(file, fileList) => `booleanPromise`
    customRequest通过覆盖默认的上传行为,可以自定义自己的上传实现Function
    data上传所需参数或返回上传参数的方法object|function(file)
    defaultFileList默认已经上传的文件列表object[]
    disabled是否禁用booleanfalse
    fileList已经上传的文件列表(受控),使用此参数时,如果遇到 onChange 只调用一次的问题,请参考 #2423object[]
    headers设置上传的请求头部,IE10 以上有效object
    listType上传列表的内建样式,支持三种基本样式 text, picturepicture-cardstring‘text’
    multiple是否支持多选文件,ie10+ 支持。开启后按住 ctrl 可选择多个文件。booleanfalse
    name发到后台的文件参数名string‘file’
    showUploadList是否展示 uploadList, 可设为一个对象,用于单独设定 showPreviewIcon 和 showRemoveIconBoolean or { showPreviewIcon?: boolean, showRemoveIcon?: boolean }true
    supportServerRender服务端渲染时需要打开这个booleanfalse
    withCredentials上传请求时是否携带 cookiebooleanfalse
    onChange上传文件改变时的状态,详见 onChangeFunction
    onPreview点击文件链接或预览图标时的回调Function(file)
    onRemove  点击移除文件时的回调,返回值为 false 时不移除。支持返回一个 Promise 对象,Promise 对象 resolve(false) 或 reject 时不移除。              Function(file): `booleanPromise`

    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 属性
       }
    

    antd@1.9.0 之前,multiple 模式下,此参数为一个对象数组 [file, ...]antd@1.9.0 开始无论是否多选,均为一个对象。

    1. fileList 当前的文件列表。
    2. event 上传中的服务端响应内容,包含了上传进度等信息,高级浏览器支持。

    显示下载链接

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

    customRequest

    IE note