❀Native Penguin Milk

    react-uploader
    TypeScript icon, indicating that this package has built-in type declarations

    1.8.0Β β€’Β PublicΒ β€’Β Published

    React Uploader

    React File Upload Widget
    (With Integrated Cloud Storage)

    React Wrapper for Uploader β€’ Developed by Upload.io


    Twitter URL

    Quick Start β€” Try on CodePen

    Upload Widget Demo

    To implement the above widget:

    npm install react-uploader
    import { Uploader } from "uploader";
    import { UploadButton } from "react-uploader";
    
    const uploader = new Uploader({
      // Get production API keys from Upload.io
      apiKey: "free"
    });
    
    <UploadButton uploader={uploader}
                  options={{multi: true}}
                  onComplete={files => console.log(files)}>
      {({onClick}) =>
        <button onClick={onClick}>
          Upload a file...
        </button>
      }
    </UploadButton>

    Installation

    Install via NPM:

    npm install react-uploader

    Or via YARN:

    yarn add react-uploader

    Or via a <script> tag:

    <script src="https://js.upload.io/react-uploader/v1"></script>

    Usage

    Initialize once at the start of your application:

    import { Uploader } from "uploader";
    
    // Get production API keys from Upload.io
    const uploader = new Uploader({
      apiKey: "free"
    });

    Then choose a UI component:

    UploadButton

    The UploadButton component uses a render prop to provide an onClick callback to your button element.

    When clicked, a file upload modal will appear:

    import { UploadButton } from "react-uploader";
    
    <UploadButton uploader={uploader}
                  options={{multi: true}}
                  onComplete={files => console.log(files)}>
      {({onClick}) =>
        <button onClick={onClick}>
          Upload a file...
        </button>
      }
    </UploadButton>

    Required props:

    • uploader
    • children

    Optional props:

    • options
    • onComplete

    UploadDropzone

    The UploadDropzone component renders an inline drag-and-drop file upload dropzone:

    import { UploadDropzone } from "react-uploader";
    
    <UploadDropzone uploader={uploader}
                    options={{multi: true}}
                    onUpdate={files => console.log(files)}
                    width="600px"
                    height="375px" />

    Required props:

    • uploader

    Optional props:

    • options
    • onUpdate
    • width
    • height

    The Result

    The callbacks receive a Array<UploaderResult>:

    {
      fileUrl: "https://upcdn.io/FW25...",          // The URL to use when serving this file.
    
      editedFile: undefined,                        // The edited file (if present). Same as below.
    
      originalFile: {
        accountId: "FW251aX",                       // The Upload.io account that owns the file.
        file: { ... },                              // DOM file object (from the <input> element).
        fileId: "FW251aXa9ku...",                   // The uploaded file ID.
        fileUrl: "https://upcdn.io/FW25...",        // The uploaded file URL.
        fileSize: 12345,                            // File size in bytes.
        mime: "image/jpeg",                         // File MIME type.
        suggestedOptimization: {
          transformationUrl: "https://upcdn.io/..", // The suggested URL for serving this file.
          transformationSlug: "thumbnail"           // Append to 'fileUrl' to produce the above URL.
        },
        tags: [                                     // Tags manually & auto-assigned to this file.
          { name: "tag1", searchable: true },
          { name: "tag2", searchable: true },
          ...
        ]
      }
    }

    Full Documentation

    React Uploader is a wrapper for Uploader β€” see the Uploader Docs πŸ“–

    Where are my files stored?

    Uploader uses Upload.io as a file storage & file hosting backend.

    Upload.io benefits developers with:

    • Zero Setup (Start uploading in the next few minutes!)
    • Pre-Integrated Storage (All you need is an Upload API key)
    • Fast File Hosting (Worldwide CDN, 300 Nodes)
    • Powerful Rules Engine (Rate Limiting, Traffic Limiting, IP Blacklisting, Expiring Links, etc)
    • File Transformations (Image Resizing, Cropping, Optimization, etc)

    πŸ”§ Can I bring my own file storage?

    Uploader's USP is to provide the fastest way to integrate end-to-end file uploads into a web app, while remaining customizable. As such, Uploader will always be closely integrated with the Upload.io platform, and there are currently no plans to support custom backends. You may, however, sync files from your Upload.io account to a custom storage target.

    Contribute

    If you would like to contribute to Uploader:

    1. Add a GitHub Star to the project (if you're feeling generous!).
    2. Determine whether you're raising a bug, feature request or question.
    3. Raise your issue or PR.

    License

    MIT

    Install

    npm i react-uploader

    DownloadsWeekly Downloads

    1,605

    Version

    1.8.0

    License

    MIT

    Unpacked Size

    508 kB

    Total Files

    34

    Last publish

    Collaborators

    • upload-io