1.0.9 • Published 6 years ago

ipfs-image-drop v1.0.9

Weekly downloads
7
License
ISC
Repository
github
Last release
6 years ago

A React component that allows dropping image files into the browser for automatic upload to IPFS

Installation

npm install ipfs-image-drop

Usage

import React from "react";
import ReactDOM from "react-dom";
import IpfsImageDrop from "ipfs-image-drop";

ReactDOM.render(
    <IpfsImageDrop
        ipfsHost="ipfs.infura.io"
        ipfsPort="5001"
        resizeWidth="100"
        onUpload={console.log} 
    />,
  document.getElementById("root")
);

Please see the examples folder for a more detailed example.

The following props are available:

ipfsHost

The host name of the IPFS node

ipfsPort

The port number of the IPFS node

resizeWidth/resizeHeight

If specified, the image will be resized to have this width/height, retaining the original aspect ratio. Note that only one resize attribute may be specified; resizeHeight or resizeWidth. If both are specified, one will be ignored.

onUpload

Function to call when the file has been uploaded to IPFS. The function will be called with an object of the following structure as the parameter:

{
    ipfsData: {
        hash: String, //IPFS hash of stored file
        path: String, //IPFS path of stored file
    },
    dataURL: String //Data URL of stored file
}

Styling

The component contains almost no styling. However, the drop zone element changes its class to reflect the current state. The following CSS selectors may be used to change the style of the drop zone depending on the state:

.IpfsImageDrop .iid-dropZone {
    /* Base style for the drop zone. */
}

.IpfsImageDrop .iid-dropZone.ready {
    /* The drop zone is ready for a file to be dropped, or a dropped file has been successfully uploaded. */
}

.IpfsImageDrop .iid-dropZone.draggingOver {
    /* A file has been dragged over the drop zone. */
}

.IpfsImageDrop .iid-dropZone.uploading {
    /* A file has been dropped into the drop zone and is being uploaded. */
}
1.0.9

6 years ago

1.0.8

6 years ago

1.0.7

6 years ago

1.0.5

6 years ago

1.0.4

6 years ago

1.0.3

6 years ago

1.0.2

6 years ago

1.0.1

6 years ago

1.0.0

6 years ago